ISpSREngineSite::GetResource

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

HRESULT GetResource(
   SPRULEHANDLE   hRule,
   WCHAR         *pszResourceName,
   WCHAR        **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	Description
S_OK	Function completed successfully and the rule contained a resource of the correct name.
S_FALSE	Function completed successfully but no resource was found.
E_INVALIDARG	pszResourceName points to invalid string.
E_POINTER	ppCoMemResource invalid or bad.
E_NOTIMPL	Method is not implemented.
SPERR_INVALID_HANDLE	Invalid hRule handle.
FAILED (hr)	Appropriate error message.

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.