SpFindBestToken

  • Article

This function enumerates the tokens for the specified category, and finds the single token that best matches the supplied attributes.

inline HRESULT SpFindBestToken(
  const WCHAR* pszCategoryId, 
  const WCHAR* pszReqAttribs, 
  const WCHAR* pszOptAttribs, 
  ISpObjectToken** ppObjectToken
);

Parameters

  • pszCategoryId
    [in] Pointer to the identifier for the category.
  • pszReqAttribs
    [in] Pointer to required attributes for the token.
  • pszOptAttribs
    [in] Pointer to optional attributes for the token.
  • ppObjectToken
    [out] Address of a pointer to an object implementing ISpObjectToken.

Return Values

The following table shows the possible return values.

Value Description
S_OK Function completed successfully.
SPERR_NOT_FOUND No items match the given attributes.
FAILED(hr) Appropriate error message.

Requirements

OS Versions: Windows CE .NET 4.1 and later.
Header: Sphelper.h.
Link Library: Sapilib.lib.

See Also

SAPI Functions

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.