IVsIME.GetImmContext(IntPtr, UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

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.

Retrieves the Input Method Editor (IME) context for a given window. Use before getting or setting IME information using methods such as GetImmCompositionString(UInt32, UInt32, String, Int32).

public:
 int GetImmContext(IntPtr hwnd, [Runtime::InteropServices::Out] System::UInt32 % phimc);

public int GetImmContext (IntPtr hwnd, out uint phimc);

abstract member GetImmContext : nativeint * uint32 -> int

Public Function GetImmContext (hwnd As IntPtr, ByRef phimc As UInteger) As Integer

Parameters

hwnd: IntPtr
nativeint

[in] Handle for the editor window.

phimc: UInt32

[out] Pointer to a handle to the IME context.

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::GetImmContext(  
   [in] HWND hwnd,   
   [out] HIMC * phimc  
);

Applies to