ISpObjectTokenEnumBuilder::Sort

Microsoft Speech SDK

The Microsoft.com Speech website Microsoft Speech SDK SAPI 5.1

ISpObjectTokenEnumBuilder::Sort

ISpObjectTokenEnumBuilder::Sort sorts the list of enumerated object tokens.

HRESULT Sort(
   const WCHAR   *pszTokenIdToListFirst
);

Parameters

pszTokenIdToListFirst
Address of a null-terminated string of tokenId for the first token in the sorted list.

Return values

Value Description
S_OK Function completed successfully.
E_POINTER Invalid pointer.
SPERR_UNINITIALIZED The object has not been properly initialized.
FAILED(hr) Appropriate error message.

If the optional attributes of the EnumBuilder have been set, the first token in the EnumBuilder after the Sort call will be the token that matches the optional attributes best, not the token that pszTokenIdToListFirst refers to.