ISpSREngine::SetPropertyNum (Windows CE 5.0)

Send Feedback

This method sets a numerical property for the SR engine. SAPI calls this method when an application makes property settings to the associated speech recognition context object that implements ISpRecoContext. If this method returns S_OK, indicating that it supports the property and has changed its value, SAPI sends an SPEI_PROPERTY_NUM_CHANGE event to all speech recognition contexts to inform them of the change.

HRESULT SetPropertyNum(  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
    [in] Value to set for the property.

Return Values

The following table shows the possible return values.

Value Description
S_OK Function completed successfully. Engine supports this property 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 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::GetPropertyNum.

Requirements

OS Versions: Windows CE .NET 4.1 and later.
Header: Sapiddk.h, Sapiddk.idl.
Link Library: Sapilib.lib.

See Also

ISpSREngine | SAPI Interfaces

Send Feedback on this topic to the authors

Feedback FAQs

© 2006 Microsoft Corporation. All rights reserved.