IVsIME::GetImmCompositionString Method (UInt32, UInt32, String^, Int32)

Visual Studio 2015

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

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

Syntax

C++

int GetImmCompositionString(
	unsigned int HIMC,
	unsigned int dwIndex,
	[OutAttribute] String^% pbstrCompString,
	[OutAttribute] int% plRetVal
)

Parameters

HIMC: Type: System::UInt32
[in] Handle to the IME context.

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

pbstrCompString

Type: System::String^

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

and ImmGetCompositionString.

plRetVal

Type: System::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.

Return Value

Type: System::Int32

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

Remarks

COM Signature

From vsshell.idl:

C++

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