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

Visual Studio 2015
 

Sets the characters, attributes, and clauses of the composition and reading strings. Provides a wrapper for .ime_5vqf

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

C#
C++
F#
VB
Copy 
int SetImmCompositionString(
	unsigned int HIMC,
	unsigned int dwIndex,
	String^ bstrCompString,
	String^ bstrReadString,
	[OutAttribute] int% pfRetVal
)

Parameters

HIMC
Type: System::UInt32

[in] Handle to the IME input context.

dwIndex
Type: System::UInt32

[in] Determines which elements are set. For a list of values, see ImmSetCompositionString.

bstrCompString
Type: System::String^

[in] Binary buffer for or containing the composition string. Not a Unicode string. For more information, see ImmSetCompositionString.

bstrReadString
Type: System::String^

[in] Binary buffer for or containing the composition string. Not a Unicode string. For more information, see ImmSetCompositionString.

pfRetVal
Type: System::Int32

[out] Error return value. Set to a nonzero value when there is no error. Zero otherwise.

Return Value

Type: System::Int32

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

From vsshell.idl:

C++
Copy 
HRESULT IVsIME::SetImmCompositionString(
   [in] HIMC himc, 
   [in] DWORD dwIndex, 
   [in] BSTR bstrCompString, 
   [in] BSTR bstrReadString, 
   [out] BOOL * pfRetVal
);
Return to top
Show: