ISpSREngine::GetPropertyString
Other versions of this page are also available for the following:
.gif "A hyphen indicates that the information in this topic is not relevant for this platform, or that the platform does not support the API that is listed.")
.gif "A checkmark indicates that the information in this topic is relevant for this platform, and that any API listed is also supported on this platform.")
8/28/2008
This method gets a property string from the SR engine. SAPI calls this method when an application queries the associated recognition context object that implements ISpRecoContext.
Before calling the method, SAPI must allocate memory for the property string using CoTaskMemAlloc. SAPI must delete the allocated memory after this method returns.
Syntax
HRESULT GetPropertyString(
SPPROPSRC eSrc,
void* pvSrcObj,
const WCHAR* pName,
WCHAR** ppCoMemValue
);
Parameters
- eSrc
[in] A property source. Possible values are defined for the SPPROPSRC enumeration. Currently the only supported value is SPPROPSRC_RECO_INST.
- pvSrcObj
[in] Pointer to additional information. Currently this value is always NULL.
- pName
[in] Pointer to the property string name.
- ppCoMemValue
[out] Address of a pointer to the property string value, or NULL if the engine does not support the requested string.
Return Value
The following table shows the possible return values.
| Value | Description |
|---|---|
S_OK |
Function completed successfully. Engine supports the property string and has returned a value for it. |
S_FALSE |
Function completed successfully but engine does not support the property string. |
FAILED(hr) |
Appropriate error message. |
Remarks
Applications can set and get properties to control run-time results of the SR engine. Some values are predefined by SAPI and others can be added by an engine. See also ISpSREngine::SetPropertyString.
Requirements
| Header | sapiddk.h, sapiddk.idl |
| Library | sapilib.lib |
| Windows Embedded CE | Windows CE .NET 4.1 and later |