SetInputScopes2 Function

The application must call SetInputScope with IS_DEFAULT before a window is destroyed to clear the reference of the interface.

Syntax

HRESULT SetInputScopes2(
  __in  HWND hwnd,
  __in  const InputScope *pInputScopes,
  __in  UINT cInputScopes,
  __in  IEnumString *pEnumString,
  __in  WCHAR *pszRegExp,
  __in  WCHAR *pszSRGS
);

Parameters

hwnd [in]

The window to set the scope on. This call will replace whatever scope may have been on the hwnd before.

pInputScopes [in]

Pointer to an array of input scopes. May be NULL. If not NULL, all of the scopes contained within will be set as the input scope of the hwnd with equal weighting. Use IS_DEFAULT to accept all other input as well (this is the "don’t coerce" option).

cInputScopes [in]

A count of the number of input scopes in pInputScopes. Must be zero if rgScopes is NULL, must be non-zero if pInputScopes is non-NULL.

pEnumString [in]

IenumString interface pointer of the phrase list.

pszRegExp [in]

Pointer to a NULL-terminated string describing the regular expression to be recognized. May be NULL.

pszSRGS [in]

Pointer to a NULL-terminated XML string that provides speech-specific hints and rules to aid in speech recognition. The XML format conforms to the Speech Recognition Grammar Specification (SRGS) standard, outlined at http://www.w3.org/TR/speech-grammar. Can be NULL. $

Return Value

ValueMeaning
S_OKThe input scope set or cleared successfully.

 

Remarks

The application must call SetInputScope with IS_DEFAULT before a window is destroyed to clear the reference of the interface.

Requirements

Minimum supported clientWindows XP
Minimum supported serverWindows Server 2003
HeaderInputScope.idl and InputScope.h
DLLMsctf.dll

Send comments about this topic to Microsoft

Build date: 7/14/2009

Tags :


Page view tracker