C string handling

"C string" redirects here. For other uses, see C string (disambiguation).

The C programming language has a set of functions implementing operations on strings (character strings and byte strings) in its standard library. Various operations, such as copying, concatenation, tokenization and searching are supported. For character strings, the standard library uses the convention that strings are null-terminated: a string of n characters is represented as an array of n + 1 elements, the last of which is a "NUL" character.

The only support for strings in the programming language proper is that the compiler translates quoted string constants into null-terminated strings.

Definitions

A string is a contiguous sequence of code units terminated by the first zero code (\0, corresponding to the null character). In C, there are two types of strings: string, which is sometimes called byte string which uses the type chars as code units (one char is at least 8 bits), and wide string which uses the type wchar_t as code units.

A common misconception is that all char arrays are strings, because string literals are converted to arrays during the compilation (or translation) phase. It is important to remember that a string ends at the first zero code unit. An array or string literal that contains a zero before the last byte therefore contains a string, or possibly several strings, but is not itself a string. Conversely, it is possible to create a char array that is not null-terminated and is thus not a string: char is often used as a small integer when needing to save memory.

The term pointer to a string is used in C to describe a pointer to the initial (lowest-addressed) byte of a string. In C, pointers are used to pass strings to functions. Documentation (including this page) will often use the term string to mean pointer to a string.

The term length of a string is used in C to describe the number of bytes preceding the zero byte. strlen is a standardised function commonly used to determine the length of a string. A common mistake is to not realize that a string uses one more unit of memory than this length, in order to store the zero that ends the string.

Character encodings

Each string ends at the first occurrence of the zero code unit of the appropriate kind (char or wchar_t). Consequently, a byte string can contain non-NUL characters in ASCII or any ASCII extension, but not characters in encodings such as UTF-16 (even though a 16-bit code unit might be nonzero, its high or low byte might be zero). The encodings that can be stored in wide strings are defined by the width of wchar_t. In most implementations, wchar_t is at least 16 bits, and so all 16-bit encodings, such as UCS-2, can be stored. If wchar_t is 32-bits, then 32-bit encodings, such as UTF-32, can be stored.

Variable-width encodings can be used in both byte strings and wide strings. String length and offsets are measured in bytes or wchar_t, not in "characters", which can be confusing to beginning programmers. UTF-8 and Shift JIS are often used in C byte strings, while UTF-16 is often used in C wide strings when wchar_t is 16 bits. Truncating strings with variable length characters using functions like strncpy can produce invalid sequences at the end of the string. This can be unsafe if the truncated parts are interpreted by code that assumes the input is valid.

Support for Unicode literals such as char foo[512] = "φωωβαρ";(UTF-8) or wchar_t foo[512] = L"φωωβαρ"; (UTF-16 or UTF-32) is implementation defined, and may require that the source code be in the same encoding. Some compilers or editors will require entering all non-ASCII characters as \xNN sequences for each byte of UTF-8, and/or \uNNNN for each word of UTF-16.

Overview of functions

Most of the functions that operate on C strings are declared in the string.h header (cstring in C++), while functions that operate on C wide strings are declared in the wchar.h header (cwchar in C++). These headers also contain declarations of functions used for handling memory buffers; the name is thus something of a misnomer.

Functions declared in string.h are extremely popular since, as a part of the C standard library, they are guaranteed to work on any platform which supports C. However, some security issues exist with these functions, such as potential buffer overflows when not used carefully and properly, causing the programmers to prefer safer and possibly less portable variants, out of which some popular ones are listed below. Some of these functions also violate const-correctness by accepting a const string pointer and returning a non-const pointer within the string. To correct this, some have been separated into two overloaded functions in the C++ version of the standard library.

In historical documentation the term "character" was often used instead of "byte" for C strings, which leads many to believe that these functions somehow do not work for UTF-8. In fact all lengths are defined as being in bytes and this is true in all implementations, and these functions work as well with UTF-8 as with single-byte encodings. The BSD documentation has been fixed to make this clear, but POSIX, Linux, and Windows documentation still uses "character" in many places where "byte" or "wchar_t" is the correct term.

Functions for handling memory buffers can process sequences of bytes that include null-byte as part of the data. Names of these functions typically start with mem, as opposite to the str prefix.

Constants and types

Name	Notes
NULL	Macro expanding to the null pointer constant; that is, a constant representing a pointer value which is guaranteed not to be a valid address of an object in memory.
wchar_t	Type used for a code unit in wide strings, usually either 16 or 32 bits. No specific interpretation is specified for these code units; the C standard requires of a wchar_t only that it be at least as large as a char, not that it can actually store Unicode code points or UTF-16 code units.
wint_t	Integer type that can hold any value of a wchar_t as well as the value of the macro WEOF. This type is unchanged by integral promotions. Usually a 32 bit signed value.
mbstate_t	Contains all the information about the conversion state required from one call to a function to the other.

Functions

	Byte string	Wide string	Description
String manipulation	strcpy	wcscpy	Copies one string to another
	strncpy	wcsncpy	Writes exactly n bytes/wchar_t, copying from source or adding nulls
	strcat	wcscat	Appends one string to another
	strncat	wcsncat	Appends no more than n bytes/wchar_t from one string to another
	strxfrm	wcsxfrm	Transforms a string according to the current locale
String examination	strlen	wcslen	Returns the length of the string
	strcmp	wcscmp	Compares two strings (three-way comparison)
	strncmp	wcsncmp	Compares a specific number of bytes/wchar_t in two strings
	strcoll	wcscoll	Compares two strings according to the current locale
	strchr	wcschr	Finds the first occurrence of a byte/wchar_t in a string
	strrchr	wcsrchr	Finds the last occurrence of a byte/wchar_t in a string
	strspn	wcsspn	Finds in a string the first occurrence of a byte/wchar_t not in a set
	strcspn	wcscspn	Finds in a string the last occurrence of a byte/wchar_t not in a set
	strpbrk	wcspbrk	Finds in a string the first occurrence of a byte/wchar_t in a set
	strstr	wcsstr	Finds the first occurrence of a substring in a string
	strtok	wcstok	Splits a string into tokens
Miscellaneous	strerror	N/A	Returns a string containing a message derived from an error code
Memory manipulation	memset	wmemset	Fills a buffer with a repeated byte/wchar_t
	memcpy	wmemcpy	Copies one buffer to another
	memmove	wmemmove	Copies one buffer to another, possibly overlapping, buffer
	memcmp	wmemcmp	Compares two buffers (three-way comparison)
	memchr	wmemchr	Finds the first occurrence of a byte/wchar_t in a buffer

Multibyte functions

Name	Description
mblen	Returns the number of bytes in the next multibyte character
mbtowc	Converts the next multibyte character to a wide character
wctomb	Converts a wide character to its multibyte representation
mbstowcs	Converts a multibyte string to a wide string
wcstombs	Converts a wide string to a multibyte string
btowc	Convert a single-byte character to wide character, if possible
wctob	Convert a wide character to a single-byte character, if possible
mbsinit	Checks if a state object represents initial state
mbrlen	Returns the number of bytes in the next multibyte character, given state
mbrtowc	Converts the next multibyte character to a wide character, given state
wcrtomb	Converts a wide character to its multibyte representation, given state
mbsrtowcs	Converts a multibyte string to a wide string, given state
wcsrtombs	Converts a wide string to a multibyte string, given state

"state" is used by encodings that rely on history such as shift states. This is not needed by UTF-8 or UTF-32. UTF-16 uses them to keep track of surrogate pairs and to hide the fact that it actually is a multi-word encoding.

Numeric conversions

Byte string	Wide string	Description
atof	N/A	converts a string to a floating-point value
atoi atol atoll	N/A	converts a string to an integer (C99)
strtof (C99) strtod strtold (C99)	wcstof (C99) wcstod wcstold (C99)	converts a string to a floating-point value
strtol strtoll	wcstol wcstoll	converts a string to a signed integer
strtoul strtoull	wcstoul wcstoull	converts a string to an unsigned integer

The C standard library contains several functions for numeric conversions. The functions that deal with byte strings are defined in the stdlib.h header (cstdlib header in C++). The functions that deal with wide strings are defined in the wchar.h header (cwchar header in C++).

The strtoxxx functions are not const-correct, since they accept a const string pointer and return a non-const pointer within the string. Also, since the Normative Amendment 1 (C95), atoxx functions are considered subsumed by strtoxxx functions, for which reason neither C95 nor any later standard provides wide-character versions of these functions.

Popular extensions

Name	Platform	Description
memccpy	SVID, POSIX	copies up to specified number of bytes between two memory areas, which must not overlap, stopping when a given byte is found.
mempcpy	GNU	a variant of memcpy returning a pointer to the byte following the last written byte
strcasecmp	POSIX, BSD	case-insensitive versions of strcmp
strcat_s	C (2011) and ISO/IEC WDTR 24731	a variant of strcat that checks the destination buffer size before copying
strcpy_s	C (2011) and ISO/IEC WDTR 24731	a variant of strcpy that checks the destination buffer size before copying
strdup	POSIX	allocates and duplicates a string
strerror_r	POSIX 1, GNU	a variant of strerror that is thread-safe. The GNU version is incompatible with the POSIX one.
stricmp	Various	case-insensitive versions of strcmp
strlcpy	BSD, Solaris	a variant of strcpy that truncates the result to fit in the destination buffer
strlcat	BSD, Solaris	a variant of strcat that truncates the result to fit in the destination buffer
strsignal	POSIX:2008	returns string representation of a signal code. Not thread safe.
strtok_r	POSIX	a variant of strtok that is thread-safe

Replacements

Despite the well-established need to replace strcat and strcpy with functions that do not allow buffer overflows, no accepted standard has arisen. This is partly due to the mistaken belief by many C programmers that strncat and strncpy have the desired behavior; however, neither function was designed for this (they were intended to manipulate null-padded fixed-size string buffers, a data format less commonly used in modern software), and the behavior and arguments are non-intuitive and often written incorrectly even by expert programmers.

The most popular replacement are the strlcat and strlcpy functions, which appeared in OpenBSD 2.4 in December, 1998. These functions always write one NUL to the destination buffer, truncating the result if necessary, and return the size of buffer that would be needed, which allows detection of the truncation and provides a size for creating a new buffer that will not truncate. They have been criticized on the basis of encouraging the use of C strings and creating more problems than initially trying to solve. Consequently, they have not been included in the GNU C library (used by software on Linux), although they are implemented in OpenBSD, FreeBSD, NetBSD, Solaris, OS X, and QNX. The lack of GNU C library support has not stopped various library authors from using it and bundling a replacement, among other SDL, GLib, ffmpeg, rsync, and even internally in the Linux kernel. Open source implementations for these functions are available.

As part of its 2004 Security Development Lifecycle, Microsoft introduced a family of "secure" functions, such as strcpy_s and strcat_s (along with many others); these functions were later standardized with some minor changes, and are now part of the optional C11 (Annex K) as proposed by ISO/IEC WDTR 24731. These functions perform runtime integrity checks of their arguments; if the checks fail, a user-specified "runtime-constraint handler" function is called. If the user has not specified such a function, the default behavior is implementation-defined. Microsoft's C runtime will abort the program when the constraints are violated. Some functions perform destructive operations before calling the runtime-constraint handler; for example, strcat_s sets the destination to the empty string, which can make it difficult to recover from error conditions or debug them. These functions attracted considerable criticism because initially they were implemented only on Windows, and at the same time warning messages started to be produced by Microsoft Visual C++, suggesting the programmers to use these functions instead of standard ones. This has been speculated by some to be an attempt by Microsoft to lock developers into its platform. Although open-source implementations of these functions are available, these functions are not present in common Unix C libraries. Experience with the safe functions has shown significant problems with their adoption and the removal of the optional C11 (Annex K) is proposed for the next revision of the standard

If the string length is known, then memcpy or memmove can be more efficient than strcpy, so some programs use them to optimize C string manipulation. They accept a buffer length as a parameter, so they can be employed to prevent buffer overflows in a manner similar to the aforementioned functions.

See also

• C syntax § Strings – source code syntax, including backslash escape sequences
• String functions
• Null-terminated string

External links

• Fast memcpy in C, multiple C coding examples to target different types of CPU instruction architectures