SHGetInputContext

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

For Windows Mobile devices, the SHGetInputContext function retrieves the current state of a context feature of an input window.

Syntax

HRESULT SHGetInputContext (
  HWND hwnd,
  DWORD dwFeature,
  LPVOID lpValue,
  LPDWORD lpdwSize
);

Parameters

• hwnd
  [in] Handle to the window whose context feature is being retrieved.

• dwFeature
  [in] The context feature to retrieve, specified by a value from the SHIC_FEATURE enumeration. For more information, see Remarks.

• lpValue
  [out] Reference to a buffer that contains the requested feature value.

• lpdwSize
  [in, out] The size of the output buffer. If lpValue is input as NULL, the necessary size of the buffer is returned in lpdwSize.

Return Value

S_OK

The function completed successfully.

ERROR_INVALID_PARAMETER

The hwnd or lpdwSize parameter was NULL.

ERROR_NOT_SUPPORTED

The feature specified by the dwFeature parameter was invalid.

ERROR_INSUFFICIENT_BUFFER

The buffer was too small to contain the requested feature value.

Remarks

The context features that can be retrieved are determined by the SHIC_FEATURE enumeration. One of the enumerators of SHIC_FEATURE must be passed as the dwFeature parameter of SHGetInputContext.

For any context feature that was not explicitly defined through SHSetInputContext, the value of that feature is taken from the window's SHIC CLASS. If the class does not define it, the value is taken from the window's parent window. Finally, if no windows in the parent chain have an explicitly set value, the value returned is the default for that feature.

Requirements

See Also

Reference

SHSetInputContext