IVsIME.Notify(UInt32, UInt32, UInt32, UInt32, 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.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.

Notifies the Input Method Editor (IME) of changes to the IME input context. The method is a wrapper for ImmNotifyIME.

public:
 int Notify(System::UInt32 HIMC, System::UInt32 dwAction, System::UInt32 dwIndex, System::UInt32 dwValue, [Runtime::InteropServices::Out] int % pfRetVal);

int Notify(unsigned int HIMC, unsigned int dwAction, unsigned int dwIndex, unsigned int dwValue, [Runtime::InteropServices::Out] int & pfRetVal);

public int Notify (uint HIMC, uint dwAction, uint dwIndex, uint dwValue, out int pfRetVal);

abstract member Notify : uint32 * uint32 * uint32 * uint32 * int -> int

Public Function Notify (HIMC As UInteger, dwAction As UInteger, dwIndex As UInteger, dwValue As UInteger, ByRef pfRetVal As Integer) As Integer

Parameters

HIMC: UInt32

[in] Handle to the IME context.

dwAction: UInt32

[in] The notification code indicating the change. For values of this argument, see ImmNotifyIME.

dwIndex: UInt32

[in] The index of a candidate list, or a value indicating a change in the composition string. For values of this argument, see ImmNotifyIME.

dwValue: UInt32

[in] An additional argument used with some values of dwAction. For more information, see ImmNotifyIME.

pfRetVal: Int32

[out] Nonzero value if method is successful; a zero value 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::Notify(  
   [in] HIMC himc,   
   [in] DWORD dwAction,   
   [in] DWORD dwIndex,  
   [in] DWORD dwValue,   
   [out] BOOL * pfRetVal  
);

Applies to

Share via