IInputMethod::SetImData

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method is implemented to respond to an application's request to set input method (IM)-specific data within the IM.

Syntax

HRESULT SetImData( 
  DWORD dwSize, 
  void* pvImData
);

Parameters

  • dwSize
    Specifies the size of the buffer pointed to by pvImData.
  • pvImData
    Void pointer to a data buffer in the application. The application is providing information for the IM. The size and format of the data are defined by the IM.

Return Value

Return S_OK to indicate success. Return the appropriate HRESULT value to indicate failure.

Remarks

Use this method and IInputMethod::GetImData to send data to and from an application.

On Windows Embedded CE, the software-based input panel calls SetImInfo when an application has asked to alter IM-specific information in the SipSetInfo function. This is done by the application providing a non-null pointer for the pvImData member of the SIPINFO structure. The application can then pass information directly to the IM.

Requirements

Header sip.h
Library uuid.lib
Windows Embedded CE Windows CE 2.01 and later
Windows Mobile Windows Mobile Version 5.0 and later

See Also

Reference

SipSetInfo
IInputMethod::GetImData
SIPINFO