This is the interface delivered by text ordering service elements, providing string ordering using a particular text collation sequence.
This method must be supported in every implementation of this interface.
Syntax
DmaRC IdmaTextOrdering::CompareStrings (
pDmaString pString1,
pDmaString pString2,
pDmaInteger32 pResult)
Parameters
Name | Mode | Description |
pString1 | input | Pointer to a DmaString |
pString2 | input | Pointer to a DmaString |
pResult | output | Return value indicating whether string1 is greater than, equal or less than string2 |
This method has semantics identical to the POSIX strcoll function in that it returns a result value of 0 if the strings are lexically identical, less than 0 if string1 is lexically less than string2 and greater than 0 if string1 is lexically greater than string2.
The CompareStrings method implements the lexical comparison per the conventions of the collation sequence offered by the text ordering service element. If the collation sequence is locale-dependent, then the locale with which the text ordering service object was instantiated will apply.
Return Values
Name | Description |
DMARC_BAD_PARAMETER | (E_INVALIDARG) Invalid input parameter. |
DMARC_OK | (S_OK) Success. |