Share via


IVsIME.SetImmCandidateWindow(UInt32, CANDIDATEFORM[], Int32) Method

Definition

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

public:
 int SetImmCandidateWindow(System::UInt32 HIMC, cli::array <Microsoft::VisualStudio::Shell::Interop::CANDIDATEFORM> ^ lpcf, [Runtime::InteropServices::Out] int % pfRetVal);
int SetImmCandidateWindow(unsigned int HIMC, std::Array <Microsoft::VisualStudio::Shell::Interop::CANDIDATEFORM> const & lpcf, [Runtime::InteropServices::Out] int & pfRetVal);
public int SetImmCandidateWindow (uint HIMC, Microsoft.VisualStudio.Shell.Interop.CANDIDATEFORM[] lpcf, out int pfRetVal);
abstract member SetImmCandidateWindow : uint32 * Microsoft.VisualStudio.Shell.Interop.CANDIDATEFORM[] * int -> int
Public Function SetImmCandidateWindow (HIMC As UInteger, lpcf As CANDIDATEFORM(), ByRef pfRetVal As Integer) As Integer

Parameters

HIMC
UInt32

[in] Handle to the IME input context.

lpcf
CANDIDATEFORM[]
pfRetVal
Int32

[out] Error return value. Set to zero when there is an error. Nonzero otherwise.

Returns

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  
);  

Applies to