IInputMethod2::GetImData

A version of this page is also available for

Windows Embedded CE 6.0 R3

4/8/2010

This method is implemented to send data from the current input method (IM) to the current application.

Syntax

HRESULT GetImData( 
  DWORD dwSize, 
  void* pvImData
);

Parameters

• dwSize
  Specifies the size of the buffer pointed to by pvImData.

• pvImData
  Void pointer to a block of data in the application. The application is requesting that the IM fill the block with information. 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

On Windows Embedded CE, the software-based input panel calls this method when an application has asked for IM-specific information in the SipGetInfo function. The application does this by providing a non-NULL pointer for the pvImData member of the SIPINFO structure. The IM can then pass information directly to the application. Use this method and IInputMethod2::SetImData to send data to and from an application.

Requirements

See Also

Reference

SipGetInfo
IInputMethod2::SetImData
SIPINFO