getwmccoll() — Get next collating element from wide string
Standards
Standards / Extensions | C or C++ | Dependencies |
---|---|---|
C Library | both |
Format
#include <collate.h>
collel_t getwmccoll(wchar_t **src);
General description
If the object pointed to by src is not a NULL pointer, the getwmccoll() library function determines the longest sequence of wide characters in the array pointed to by str that constitute a valid multi-wide-character collating element. It then produces the value of type collel_t corresponding to that collating element. The object pointed to by src is assigned the address just past the last wide character of the multi-wide-character collating element processed.
Returned value
If successful, getwmccoll() returns the value of type collel_t that represents the collating element found.
If the object pointed to by src is a NULL pointer or if it points to a NULL wide character, getwmccoll() returns 0.
If the object pointed to by src points to a non-valid wide character, getwmccoll() returns -1 and sets errno to EILSEQ.
Related information
- collate.h
- wchar.h
- cclass() — Return characters in a character class
- collequiv() — Return a list of equivalent collating elements
- collorder() — Return list of collating elements
- collrange() — Calculate the range list of collating elements
- colltostr() — Return a string for a collating element
- getmccoll() — Get next collating element from string
- ismccollel() — Identify a multicharacter collating element
- maxcoll() — Return maximum collating element
- strtocoll() — Return collating element for string