ISpRecoResult::GetRecoContext

Microsoft Speech SDK

The Microsoft.com Speech website Microsoft Speech SDK SAPI 5.1

ISpRecoResult::GetRecoContext

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

HRESULT GetRecoContext(
   ISpRecoContext   **ppRecoContext
);

Parameters

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

Value Description
S_OK Function completed successfully.
E_POINTER ppRecoContext is invalid or bad.
FAILED(hr) Appropriate error message.

Example

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.

    HRESULT hr = S_OK;

    DWORD dwMaxAlternates;

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

   // get the associated ISpRecoContext
   hr = cpRecoResult->GetRecoContext(&cpRecoContext);
   // Check hr

   hr = cpRecoContext->GetMaxAlternates(&dwMaxAlternates);
   // Check hr