IInputMethod::GetImData

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.

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

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 HRESULTvalue 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 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 IInputMethod::SetImDatato send data to and from an application.

Requirements

Runs On	Versions	Defined in	Include	Link to
Windows CE OS	2.01 and later	Sip.h

Note This API is part of the complete Windows CE OS package as provided by Microsoft. The functionality of a particular platform is determined by the original equipment manufacturer (OEM) and some devices may not support this API.