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

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public:
 int SetImmCompositionString(System::UInt32 HIMC, System::UInt32 dwIndex, System::String ^ bstrCompString, System::String ^ bstrReadString, [Runtime::InteropServices::Out] int % pfRetVal);

int SetImmCompositionString(unsigned int HIMC, unsigned int dwIndex, std::wstring const & bstrCompString, std::wstring const & bstrReadString, [Runtime::InteropServices::Out] int & pfRetVal);

public int SetImmCompositionString (uint HIMC, uint dwIndex, string bstrCompString, string bstrReadString, out int pfRetVal);

abstract member SetImmCompositionString : uint32 * uint32 * string * string * int -> int

Public Function SetImmCompositionString (HIMC As UInteger, dwIndex As UInteger, bstrCompString As String, bstrReadString As String, ByRef pfRetVal As Integer) As Integer

Parameters

HIMC: UInt32

[in] Handle to the IME input context.

dwIndex: UInt32

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

bstrCompString: String

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

bstrReadString: String

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

pfRetVal: Int32

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

Returns

Int32

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsIME::SetImmCompositionString(  
   [in] HIMC himc,   
   [in] DWORD dwIndex,   
   [in] BSTR bstrCompString,   
   [in] BSTR bstrReadString,   
   [out] BOOL * pfRetVal  
);

Applies to

Share via