getmccoll() — Get next collating element from string

Standards

Format

#include <collate.h>

collel_t getmccoll(char **src);

General description

If the object pointed to by src is not a NULL pointer, the getmccoll() library function determines the longest sequence of bytes in the array pointed to by src that constitute a valid multicharacter 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 byte of the multicharacter collating element processed.

Returned value

If successful, getmccoll() 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 NULL character, getmccoll() returns 0.

Related information

• collate.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
• getwmccoll() — Get next collating element from wide string
• ismccollel() — Identify a multicharacter collating element
• maxcoll() — Return maximum collating element
• strtocoll() — Return collating element for string