ISpRecoResult::GetRecoContext (SAPI 5.3)

Speech API 5.3
Microsoft Speech API 5.3


ISpRecoResult::GetRecoContext returns the recognition context object that is associated with this result.

HRESULT GetRecoContext(
   ISpRecoContext   **ppRecoContext


[out] A pointer that receives the recognition context interface pointer. The caller must call ::Release on the ISpRecoContext references when it is finished.

Return values

S_OKFunction completed successfully.
E_POINTERppRecoContext is invalid or bad.
FAILED(hr)Appropriate error message.


The following code snippet illustrates the use of ISpRecoResult::GetRecoContext to retrieve a reference to the ISpRecoContext instance that is associated with a recognized phrase and determine the maximum number of CFG alternates that can be generated for it.

// Declare local identifiers:
HRESULT                       hr = S_OK;
CComPtr<ISpRecoContext>       cpRecoContext;
CComPtr<ISpRecoResult>        cpRecoResult;
DWORD                         dwMaxAlternates;

// ... Obtain a recognition result object from the recognizer ...

// Get the associated ISpRecoContext.
hr = cpRecoResult->GetRecoContext(&cpRecoContext;);

if (SUCCEEDED(hr))
   // Get maximum number of CFG alternates.
   hr = cpRecoContext->GetMaxAlternates(&dwMaxAlternates;);

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