ISpSREngine::GetPropertyString (SAPI 5.3)

Speech API 5.3
Microsoft Speech API 5.3


ISpSREngine::GetPropertyString retrieves a string property value from the SR engine. 

HRESULT GetPropertyString(
   SPPROPSRC                                eSrc,
   void                                    *pvSrcObj,
   LPCWSTR                                 *pName,
   [annotation("__deref_out")] LPWSTR     **ppCoMemValue


[in] One of the types specified in the SPPROPSRC enumeration sequence. (This will currently always be SPPROPSRC_RECO_INST).
[in] Pointer to additional information. (Currently always NULL).
[in] String containing the property name.
[out] Pointer to a string that the SR engine should supply with the property value string. The string should be allocated with CoTaskMemAlloc; SAPI will delete the allocated memory after return from this function. If the engine does not support this property attribute, the parameter should be NULL.

Return values

S_OKFunction completed successfully. Engine supports this property attribute and has returned a value for it.
S_FALSEFunction completed successfully but engine does not support this property.
FAILED(hr)Appropriate error message.


Applications can use properties to control run-time results of the SR engine. The application can set and retrieve 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.

SAPI calls this method on an engine when the application calls ISpProperties::GetPropertyString using its recognition context object.