Microsoft Speech SDK
SAPI 5.1
ISpSREngine::SetPropertyString
ISpSREngine::SetPropertyString sets a string property value on the SR engine.
HRESULT SetPropertyString(
SPPROPSRC eSrc,
void *pvSrcObj,
const WCHAR *pName,
const WCHAR *pValue
);
Parameters
- eSrc
- [in] One of the types specified in the SPPROPSRC enumeration sequence. (This will currently always be SPPROPSRC_RECO_INST).
- pvSrcObj
- [in] Pointer to additional information. (Currently always NULL).
- pName
- [in] String containing the property name.
- pValue
- [in] String value that the property should be set to.
Return values
| Value | Description | S_OK | Function completed successfully. Engine supports this property attribute and has set it to the requested value. |
|---|---|
| S_FALSE | Function completed successfully but engine does not support this property. |
| FAILED(hr) | Appropriate error message. |
Remarks
Applications can use properties to control run-time results of the SR engine. The application can set and get values for specific attributes on the engine. Some values are predefined by SAPI and others may be added by an engine. See SAPI 5.0 SR Properties White Paper for more details.
This method is called on the engine by SAPI when the application calls ISpProperties::SetPropertyString on its recognition context object. If the engine returns S_OK from this method, indicating that it supports this property and has changed the value for it, SAPI will send an SPEI_PROPERTY_STRING_CHANGE event to all contexts to inform them of this change.