IVsIME.SetImmCandidateWindow Method

Sets aspects of the candidate list window. Provides a wrapper for ImmSetCandidateWindow.

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

Syntax

'Declaration
Function SetImmCandidateWindow ( _
    HIMC As UInteger, _
    lpcf As CANDIDATEFORM(), _
    <OutAttribute> ByRef pfRetVal As Integer _
) As Integer
int SetImmCandidateWindow(
    uint HIMC,
    CANDIDATEFORM[] lpcf,
    out int pfRetVal
)
int SetImmCandidateWindow(
    [InAttribute] unsigned int HIMC, 
    [InAttribute] array<CANDIDATEFORM>^ lpcf, 
    [OutAttribute] int% pfRetVal
)
abstract SetImmCandidateWindow : 
        HIMC:uint32 * 
        lpcf:CANDIDATEFORM[] * 
        pfRetVal:int byref -> int
function SetImmCandidateWindow(
    HIMC : uint, 
    lpcf : CANDIDATEFORM[], 
    pfRetVal : int
) : int

Parameters

  • HIMC
    Type: UInt32

    [in] Handle to the IME input context.

  • pfRetVal
    Type: Int32%

    [out] Error return value. Set to zero when there is an error. Nonzero 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::SetImmCandidateWindow(
   [in] HIMC himc, 
   [in] CANDIDATEFORM * lpcf, 
   [out] BOOL * pfRetVal
);

.NET Framework Security

See Also

Reference

IVsIME Interface

Microsoft.VisualStudio.Shell.Interop Namespace