UniNextCompChar()--Advance to Next Composite Character Sequence API
Syntax
#include <UniChar.h> int UniNextCompChar(void *reserved, UniChar *ucs, UniChar **next_sequence);
Service Program: QTQULSFN
Default Public Authority: *USE
Threadsafe: No
The UniNextCompChar--Advance to Next Composite Character Sequence function locates the next non-combining character in the string ucs.
Authorities and Locks
None.
Parameters
- reserved
- INPUT; PTR(SPP)
This parameter must be set to null.
- ucs
- INPUT; PTR(SPP)
The composite character sequence to be analyzed.
- next_sequence
- OUTPUT; PTR(SPP)
This is set to the next non-combining character.
Return Value
- zero
- UniNextCompChar function was successful. The value returned in next_sequence is a pointer to the next non-combining character in ucs.
- non-zero
- UniNextCompChar was not successful and next_sequence is set to the NULL pointer.
Error Conditions
If UniNextCompChar is not successful, the return value indicates one of the following errors:
UNI_BADOBJ | UniNextCompChar function detected that the reserved parameter is not null. |
UNI_INVALID | UniNextCompChar function detected that ucs is a null pointer. |
UNI_NODATA | UniNextCompChar function detected that ucs points to a null code element. |
UNI_COMP_FOUND | UniNextCompChar function detected that ucs points to a combining character. The caller should advance ucs by one UniChar and call the function again until this error no longer occurs. |
UNI_RANGE | UniQueryCompCharLen function detected that the value to be set in element_count was too large to fit. |
API introduced: V3R6
[ Back to top | National Language Support APIs | APIs by category ]