IVsUIShell.TranslateAcceleratorAsACmd(MSG[]) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

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.

Causes the environment to use the active key binding table to convert, if possible, a keyboard message into the appropriate command, then route the command using the usual command routing mechanism.

public:
 int TranslateAcceleratorAsACmd(cli::array <Microsoft::VisualStudio::OLE::Interop::MSG> ^ pMsg);

int TranslateAcceleratorAsACmd(std::Array <Microsoft::VisualStudio::OLE::Interop::MSG> const & pMsg);

public int TranslateAcceleratorAsACmd (Microsoft.VisualStudio.OLE.Interop.MSG[] pMsg);

abstract member TranslateAcceleratorAsACmd : Microsoft.VisualStudio.OLE.Interop.MSG[] -> int

Public Function TranslateAcceleratorAsACmd (pMsg As MSG()) As Integer

Parameters

pMsg: MSG[]

[in] Pointer to a message structure.

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 IVsUIShell::TranslateAcceleratorAsACmd(  
   [in] LPMSG pMsg  
);

This method is intended to be called by in-place components in their implementation of TranslateCntrAccelerator. This makes it possible for the in-place component to give priority for keystrokes to the usual command bindings of the environment before making it possible for them to be handled by a nested OLE object.

Applies to

Share via