xref: /libuv/src/strscpy.h (revision 7ae0c954)
1 /* Copyright libuv project contributors. All rights reserved.
2  *
3  * Permission is hereby granted, free of charge, to any person obtaining a copy
4  * of this software and associated documentation files (the "Software"), to
5  * deal in the Software without restriction, including without limitation the
6  * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
7  * sell copies of the Software, and to permit persons to whom the Software is
8  * furnished to do so, subject to the following conditions:
9  *
10  * The above copyright notice and this permission notice shall be included in
11  * all copies or substantial portions of the Software.
12  *
13  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
18  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
19  * IN THE SOFTWARE.
20  */
21 
22 #ifndef UV_STRSCPY_H_
23 #define UV_STRSCPY_H_
24 
25 /* Include uv.h for its definitions of size_t and ssize_t.
26  * size_t can be obtained directly from <stddef.h> but ssize_t requires
27  * some hoop jumping on Windows that I didn't want to duplicate here.
28  */
29 #include "uv.h"
30 
31 /* Copies up to |n-1| bytes from |s| to |d| and always zero-terminates
32  * the result, except when |n==0|. Returns the number of bytes copied
33  * or UV_E2BIG if |d| is too small.
34  *
35  * See https://www.kernel.org/doc/htmldocs/kernel-api/API-strscpy.html
36  */
37 ssize_t uv__strscpy(char* d, const char* s, size_t n);
38 
39 #endif  /* UV_STRSCPY_H_ */
40