devela::_dep::sdl3::sys::stdinc

Function SDL_wcsncmp

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

Compare two wide strings up to a number of wchar_t values.

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.

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