UniQueryCompChar()--Number of Composite Character Sequences API

Syntax

  #include <UniChar.h>

  int UniQueryCompChar(void *reserved,
                          const UniChar *ucs,
                          size_t       *composite_count);

  Service Program: QTQULSFN

  Default Public Authority: *USE

  Threadsafe: No

The UniQueryCompChar--Number of Composite Character Sequences function computes the number of composite character sequences in the code element array pointed to by ucs. The function sets composite_count to be the number of sequences that consist of a base character followed by zero or more combining characters up to, but not including, the null code element.

Authorities and Locks

None.

Parameters

reserved: INPUT; PTR(SPP)
The reserved parameter must be set to null.
ucs: INPUT; PTR(SPP)
The composite character sequence to be analyzed.
composite_count: OUTPUT; PTR(SPP)
This is set to the number of composite character sequences in the code element array pointed to by ucs.

Return Value

zero: UniQueryCompChar function was successful. The value returned in composite_count is the number of sequences found in ucs.
non-zero: UniQueryCompChar was not successful and composite_count is set to zero.

Error Conditions

If UniQueryCompChar is not successful, the return value indicates one of the following errors:

UNI_BADOBJ	UniQueryCompChar function detected that the reserved parameter is not null.
UNI_INVALID	UniQueryCompChar function detected that ucs is a null pointer.
UNI_NODATA	UniQueryCompChar function detected that ucs points to a null code element.
UNI_COMP_FOUND	UniQueryCompChar function detected that ucs points to a combining character.
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 ]