ISpRecognizer::GetRecoProfile (SAPI 5.3)

Speech API 5.3
Microsoft Speech API 5.3


ISpRecognizer::GetRecoProfile retrieves the current recognition profile token.

HRESULT GetRecoProfile(
   ISpObjectToken   **ppToken


[out] Address of a pointer of an ISpObjectToken that receives the profile information.

Return values

S_OKFunction completed successfully.
E_POINTERThe ppToken is a bad or invalid pointer.
FAILED(hr)Appropriate error message.


A recognition profile represents a single user and training sessions on the system. The user can create, delete, and set the current profile using Speech properties in Control Panel. SAPI will always create the engine using the current default profile. This method can be used to find which profile is currently being used.

If an application needs to store information in a specific recognition profile, it can use the ISpObjectToken::GetStorageFilename method.


The following code snippet illustrates the use of ISpRecognizer::GetRecoProfile to determine the profile name

// Declare local identifiers:
HRESULT                      hr = S_OK;
CComPtr<ISpRecognizer>       cpRecognizer;
CComPtr<ISpObjectToken>      cpObjectToken;
WCHAR                        *pwszRecoProfileName;

// Get the current recognizer's recognition profile token.
hr = cpRecognizer->GetRecoProfile(&cpObjectToken;);

if (SUCCEEDED(hr))
   // Get the reco profile name (that is, the default value of the token).
   hr = cpObjectToken->GetStringValue(NULL, &pwszRecoProfileName;);

if (SUCCEEDED(hr))
   // Do stuff here.