logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

SDL_strncmp - Compare two UTF-8 strings up to a number of bytes.

Availability

       This function is available since SDL 3.2.0.

Simple Directmedia Layer                           SDL 3.2.20                                     SDL_strncmp(3)

Description

       Due to the nature of UTF-8 encoding, this will work with Unicode strings, since effectively this function
       just compares bytes until it hits a null-terminating character. Also due to the nature of UTF-8, this can
       be used with SDL_qsort() to put strings in (roughly) alphabetical order.

       Note  that  while this function is intended to be used with UTF-8, it is doing a bytewise comparison, and
       maxlen specifies a _byte_ limit! If the limit lands in the middle of a multi-byte UTF-8 sequence, it will
       only compare a portion of the final character.

       maxlen specifies a maximum number of bytes to compare; if the strings match to this number of  bytes  (or
       both  have  matched  to a null-terminator character before this number of bytes), they will be considered
       equal.

Function Parameters

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 _bytes_ to compare.

Name

       SDL_strncmp - Compare two UTF-8 strings up to a number of bytes.

Return Value

       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.

Synopsis

#include<SDL3/SDL_stdinc.h>intSDL_strncmp(constchar*str1,constchar*str2,size_tmaxlen);

Thread Safety

       It is safe to call this function from any thread.

See Also