UCDisposeCollator(_:)

Declaration

func UCDisposeCollator(_ collatorRef: UnsafeMutablePointer<CollatorRef?>!) -> OSStatus

Parameters

• collatorRef:

  A reference to a valid collator object. The UCDisposeCollator function sets *collatorRef to NULL.

Return Value

A result code.

Discussion

To perform Unicode string comparison, you must supply locale and collation specifications to a collation function such as UCCompareText(_:_:_:_:_:_:_:). You provide this information by means of a collator object, created via the function UCCreateCollator(_:_:_:_:). When finished with the collator object, you should dispose of it using the function UCDisposeCollator.

See Also

Comparing Unicode Strings

• UCCreateCollator(_:_:_:_:)
• UCCompareText(_:_:_:_:_:_:_:)
• UCGetCollationKey(_:_:_:_:_:_:)
• UCCompareCollationKeys(_:_:_:_:_:_:)
• UCCompareTextDefault(_:_:_:_:_:_:_:)
• UCCompareTextNoLocale(_:_:_:_:_:_:_:)