Share via


Note

Please see Azure Cognitive Services for Speech documentation for the latest supported speech solutions.

Microsoft Speech Platform

ISpProperties::SetPropertyString

ISpProperties::SetPropertyString sets a text property corresponding to the specified name.

<pre IsFakePre="true" xmlns="http://www.w3.org/1999/xhtml"> <strong>HRESULT SetPropertyString(</strong> <strong>LPCWSTR</strong> *<em>pName</em>, <strong>[annotation("__deref_out"), out, string] LPCWSTR</strong> *<em>pValue</em> <strong>);</strong> </pre>

Parameters

  • pName
    [in, string] Null-terminated string containing the property name.
  • pValue
    [in, string] Null-terminated string containing the property value.

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 speech recognition engine supports the property, the Speech Platform will fire a property-changed event (see SPEI_PROPERTY_STRING_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::PropertyStringValue).