ISpObjectTokenCategory::SetId

  • Article

This method sets the category identifier. The client can call this method only once.

HRESULT SetId(
  const WCHAR* pszCategoryId,
  BOOL fCreateIfNotExist
);

Parameters

  • pszCategoryId
    [in] Pointer to a null-terminated string specifying the category identifier. SAPI-defined categories are listed in Token Category identifiers.
  • fCreateIfNotExist
    [in] Value indicating if the method should create the category if it does not already exist. Set this value to TRUE to create the category, and to FALSE otherwise.

Return Values

The following table shows the possible return values.

Value Description
S_OK Function completed successfully.
SPERR_ALREADY_INITIALIZED Category interface is already initialized.
E_INVALIDARG pszCategoryId is invalid or bad.
FAILED(hr) Appropriate error message.

Requirements

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

See Also

ISpObjectTokenCategory | SAPI Interfaces

 Last updated on Saturday, April 10, 2004

© 1992-2003 Microsoft Corporation. All rights reserved.