IVsIME.SetImmCompositionString Method
Sets the characters, attributes, and clauses of the composition and reading strings. Provides a wrapper for ImmSetCompositionString.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)
Syntax
'Declaration
Function SetImmCompositionString ( _
HIMC As UInteger, _
dwIndex As UInteger, _
bstrCompString As String, _
bstrReadString As String, _
<OutAttribute> ByRef pfRetVal As Integer _
) As Integer
int SetImmCompositionString(
uint HIMC,
uint dwIndex,
string bstrCompString,
string bstrReadString,
out int pfRetVal
)
int SetImmCompositionString(
[InAttribute] unsigned int HIMC,
[InAttribute] unsigned int dwIndex,
[InAttribute] String^ bstrCompString,
[InAttribute] String^ bstrReadString,
[OutAttribute] int% pfRetVal
)
abstract SetImmCompositionString :
HIMC:uint32 *
dwIndex:uint32 *
bstrCompString:string *
bstrReadString:string *
pfRetVal:int byref -> int
function SetImmCompositionString(
HIMC : uint,
dwIndex : uint,
bstrCompString : String,
bstrReadString : String,
pfRetVal : int
) : int
Parameters
HIMC
Type: UInt32[in] Handle to the IME input context.
dwIndex
Type: UInt32[in] Determines which elements are set. For a list of values, see ImmSetCompositionString.
bstrCompString
Type: String[in] Binary buffer for or containing the composition string. Not a Unicode string. For more information, see ImmSetCompositionString.
bstrReadString
Type: String[in] Binary buffer for or containing the composition string. Not a Unicode string. For more information, see ImmSetCompositionString.
pfRetVal
Type: Int32%[out] Error return value. Set to a nonzero value when there is no error. Zero otherwise.
Return Value
Type: 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
);
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.