Carbon


CountUnicodeMappings

Header: UnicodeConverter.h Carbon status: Supported

Counts available mappings that meet the specified matching criteria.

OSStatus CountUnicodeMappings (
    OptionBits iFilter, 
    ConstUnicodeMappingPtr iFindMapping, 
    ItemCount *oActualCount
);
Parameter descriptions
iFilter

Filter control flags representing the six subfields of the Unicode mapping structure that this function uses to match against in determining which mappings on the system to return to your application. The filter control enumeration, described in “Filter Control Masks”, define the constants for the subfield’s flags and their masks. You can include in the search criteria any of the three text encoding subfields for both the Unicode encoding and the other specified encoding. For any flag not turned on, the subfield value is ignored and the function does not check the corresponding subfield of the mappings on the system.

iFindMapping

A structure of type UnicodeMapping containing the text encodings whose field values are to be matched.

oActualCount

On return, a pointer to the number of matching mappings found.

function result

A result code.

DISCUSSION

You can filter on any of the three text encoding subfields of the Unicode mapping structure’s unicodeEncoding specification and on any of the three text encoding subfields of the structure’s otherEncoding specification. The iFilter parameter consists of a set of six control flags that you set to identify which of the corresponding six subfields to include in the match count. No filtering is performed on fields for which you do not set the corresponding filter control flag.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.


© 2000 Apple Computer, Inc. (Last Updated 7/17/2000)