ISpSREngine::GetPropertyNum (Windows CE 5.0)
This method gets a numerical property from the SR engine. SAPI calls this method when an application queries the associated recognition context object that implements ISpRecoContext.
HRESULT GetPropertyNum( SPPROPSRC eSrc, void* pvSrcObj, const WCHAR* pName, LONG* lValue);
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 name. - lValue
[out] Pointer to the value of the property, or NULL if the SR engine does not support the requested property.
Return Values
The following table shows the possible return values.
| Value | Description |
|---|---|
| S_OK | Function completed successfully. Engine supports the property and has returned a value for it. |
| S_FALSE | Function completed successfully but engine does not support the property. |
| 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::SetPropertyNum.
Requirements
OS Versions: Windows CE .NET 4.1 and later.
Header: Sapiddk.h, Sapiddk.idl.
Link Library: Sapilib.lib.
See Also
Send Feedback on this topic to the authors