IInputMethod2::GetImData

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

At a Glance

Header file: Sip.h
Windows CE Versions: 2.12 and later

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 Values

An appropriate HRESULT value is returned.

Remarks

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

See Also

IInputMethod2::SetImData, SIPINFO