Function SDL_strncmp

pub unsafe extern "C" fn SDL_strncmp(
    str1: *const i8,
    str2: *const i8,
    maxlen: usize,
) -> i32
Available on crate feature dep_sdl3 only.
Expand description

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

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.

§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.

§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.

§Thread safety

It is safe to call this function from any thread.

§Availability

This function is available since SDL 3.2.0.