Share via

ISpSREngineSite::GetResource (SAPI 5.3)

  • Article

Microsoft Speech API 5.3

ISpSREngineSite::GetResource

ISpSREngineSite::GetResource retrieves a named resource from a grammar.

  
    HRESULT GetResource(
   SPRULEHANDLE     hRule,
   LPCWSTR         *pszResourceName,
   LPWSTR         **ppCoMemResource
);

Parameters

  • hRule
    [in] The rule handle.
  • pszResourceName
    [in] Null-terminated string containing the name of the resource to recover.
  • ppCoMemResource
    [out] The resource associated with the rule. Applications calling this method must call CoTaskMemFree() to free memory associated with this resource.

Return values

Value
S_OK
S_FALSE
E_INVALIDARG
E_POINTER
E_NOTIMPL
SPERR_INVALID_HANDLE
FAILED (hr)

Remarks

Within a CFG, each rule can contain one or more named strings containing arbitrary string data. The engine can recover this data using ::GetResource and passing in the rule handle and resource name.