ISpProperties::SetPropertyNum (Microsoft Speech Platform)

Microsoft Speech Platform SDK 11

Microsoft Speech Platform

ISpProperties::SetPropertyNum

ISpProperties::SetPropertyNum sets a numeric property corresponding to the specified name.

HRESULT SetPropertyNum(
   LPCWSTR       *pName,
   LONG           lValue
 );

Parameters

pName
[in] Null-terminated string containing the property name. Valid values are listed in the SR Properties section of the SAPI 5.0 SR Properties White Paper.
lValue
[in] The property value to set.

Return values

Value Description
S_OK Function completed successfully.
S_FALSE SR engine does not support specified property name.
E_INVALIDARG One or more parameters are invalid.
FAILED(hr) SR engine returned specific error.

Remarks

If the SR engine supports the property, SAPI will fire a property-changed event (see SPEI_PROPERTY_NUM_CHANGE) to all interested recognizer contexts (ISpRecoContext). Broadcasting the corresponding event notifies any recognizer contexts that had interests in the property (see CSpEvent::PropertyName and CSpEvent::PropertyNumValue).