Legacy Document

Important: The information in this document is obsolete and should not be used for new development.

PATH Mac OS 8 and 9 Developer Documentation > Text Encoding Conversion Manager

Programming With the Text Encoding Conversion Manager

UCGetCharProperty

Obtains a specified Unicode property for a Unicode character.

OSStatus UCGetCharProperty( const UniChar *charPtr, UniCharCount textLength, UCCharPropertyType propType, UCCharPropertyValue *propValue);

charPtr: A pointer to a UTF-16 Unicode character, which may be a single 16-bit value or a surrogate pair (a sequence of two 16-bit values)
textLength: The length of Unicode text at the position indicated by charPtr. This is only used to verify that the text contains at least as many 16-bit units as are required for a single character.
propType: A tag of type UCCharPropertyType indicating the requested property type See the section Unicode Character Properties for more information.
propValue: A pointer to a variable of type UCCharPropertyValue. On output, this variable contains the value of the requested property type.
function result: A result code. The function returns paramErr if charPtr is NULL, if textLength is 0, or if propValue is NULL. It returns resNotFound if it cannot locate data for the specified property.

DISCUSSION

For a Unicode character indicated by charPtr, this function can return a particular property from among the set of properties defined by the Unicode Consortium and supported by this function.

VERSION NOTES

Introduced with Text Encoding Conversion Manager 1.5.