Share via


ISpRecoResult::GetRecoContext (Windows Embedded CE 6.0)

1/6/2010

This method gets the recognition context object that is associated with this result.

Syntax

HRESULT GetRecoContext(
  ISpRecoContext** ppRecoContext
);

Parameters

  • ppRecoContext
    [out] Address of a pointer to an object implementing ISpRecoContext. The caller must call IUnknown::Release on the references when it is finished with the object.

Return Value

The following table shows the possible 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 this method 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

Requirements

Header sapi.h, sapi.idl
Library sapilib.lib
Windows Embedded CE Windows CE .NET 4.1 and later

See Also

Reference

ISpRecoResult
SAPI Interfaces