Important:
This is retired content. This content is outdated and is no longer being maintained. It is provided as a courtesy for individuals who are still using these technologies. This content may contain URLs that were valid when originally published, but now link to sites or pages that no longer exist.
A version of this page is also available for
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 HRESULTvalue 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 SipGetInfofunction. The application does this by providing a non-NULL pointer for the pvImDatamember of the SIPINFOstructure. The IM can then pass information directly to the application. Use this method and IInputMethod2::SetImDatato send data to and from an application.

Requirements

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

See Also