IVsIME.Notify Method

Article
03/06/2013

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

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

Syntax

'Declaration
Function Notify ( _
    HIMC As UInteger, _
    dwAction As UInteger, _
    dwIndex As UInteger, _
    dwValue As UInteger, _
    <OutAttribute> ByRef pfRetVal As Integer _
) As Integer

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

int Notify(
    [InAttribute] unsigned int HIMC, 
    [InAttribute] unsigned int dwAction, 
    [InAttribute] unsigned int dwIndex, 
    [InAttribute] unsigned int dwValue, 
    [OutAttribute] int% pfRetVal
)

abstract Notify : 
        HIMC:uint32 * 
        dwAction:uint32 * 
        dwIndex:uint32 * 
        dwValue:uint32 * 
        pfRetVal:int byref -> int

function Notify(
    HIMC : uint, 
    dwAction : uint, 
    dwIndex : uint, 
    dwValue : uint, 
    pfRetVal : int
) : int

Parameters

HIMC
Type: System.UInt32
[in] Handle to the IME context.

dwAction
Type: System.UInt32
[in] The notification code indicating the change. For values of this argument, see ImmNotifyIME.

dwIndex
Type: System.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
Type: System.UInt32
[in] An additional argument used with some values of dwAction. For more information, see ImmNotifyIME.

pfRetVal
Type: System.Int32%
[out] Nonzero value if method is successful; a zero value otherwise.

Return Value

Type: System.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
);

.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.