Share via


IVsIME.GetImmCompositionString(UInt32, UInt32, String, Int32) Method

Definition

Retrieves information about the composition string. Wrapper for a call to ImmGetCompositionString.

public:
 int GetImmCompositionString(System::UInt32 HIMC, System::UInt32 dwIndex, [Runtime::InteropServices::Out] System::String ^ % pbstrCompString, [Runtime::InteropServices::Out] int % plRetVal);
int GetImmCompositionString(unsigned int HIMC, unsigned int dwIndex, [Runtime::InteropServices::Out] std::wstring const & & pbstrCompString, [Runtime::InteropServices::Out] int & plRetVal);
public int GetImmCompositionString (uint HIMC, uint dwIndex, out string pbstrCompString, out int plRetVal);
abstract member GetImmCompositionString : uint32 * uint32 * string * int -> int
Public Function GetImmCompositionString (HIMC As UInteger, dwIndex As UInteger, ByRef pbstrCompString As String, ByRef plRetVal As Integer) As Integer

Parameters

HIMC
UInt32

[in] Handle to the IME context.

dwIndex
UInt32

[in] Index of the information to retrieve. For more information about possible values, see IME Composition String Values.

pbstrCompString
String

[out] Binary buffer—not a Unicode string. Allocated using SysAllocStringByteLen. For more information, see ImmSetCompositionStringand ImmGetCompositionString.

plRetVal
Int32

[out] Pointer to the return value. Contains the number of bytes copied to the destination buffer or, if dwBufLen is zero, the buffer size, in bytes, needed to receive all of the information. The size is always in bytes, even if the requested data is a Unicode string.On error, set to one of the two values: IMM_ERROR_NODATA, or IMM_ERROR_GENERAL.

Returns

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsIME::GetImmCompositionString(  
   [in] HIMC himc,   
   [in] DWORD dwIndex,   
   [out] BSTR *pbstrCompString,   
   [out] LONG * plRetVal  
);  

Applies to