Compare two wide strings up to a number of wchar_t values.
Defined in <SDL3/SDL_stdinc.h>
int SDL_wcsncmp(const wchar_t *str1, const wchar_t *str2, size_t maxlen);| str1 | The first string to compare. NULL is not permitted! |
| str2 | The second string to compare. NULL is not permitted! |
| maxlen | The maximum number of wchar_t to compare. |
Returns less than zero if str1 is "less than" str2, greater than zero if str1 is "greater than" str2, and zero if the strings match exactly.
This only compares wchar_t values; it does not care if the string is well-formed UTF-16 (or UTF-32, depending on your platform's wchar_t size), or uses valid Unicode values.
Note that while this function is intended to be used with UTF-16 (or UTF-32, depending on your platform's definition of wchar_t), it is comparing raw wchar_t values and not Unicode codepoints: maxlen specifies a wchar_t limit! If the limit lands in the middle of a multi-wchar UTF-16 sequence, it will only compare a portion of the final character.
maxlen specifies a maximum number of wchar_t to compare; if the strings match to this number of wide chars (or both have matched to a null-terminator character before this count), they will be considered equal.
It is safe to call this function from any thread.
This function is available since SDL 3.0.0.
CategoryAPI, CategoryAPIFunction