IVsFilterKeys.TranslateAccelerator(MSG[], UInt32, Guid, UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

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.

Takes a Windows message, translates it into a command, and, optionally, executes the command.

public:
 int TranslateAccelerator(cli::array <Microsoft::VisualStudio::OLE::Interop::MSG> ^ pMsg, System::UInt32 dwFlags, [Runtime::InteropServices::Out] Guid % pguidCmd, [Runtime::InteropServices::Out] System::UInt32 % pdwCmd);

public int TranslateAccelerator (Microsoft.VisualStudio.OLE.Interop.MSG[] pMsg, uint dwFlags, out Guid pguidCmd, out uint pdwCmd);

abstract member TranslateAccelerator : Microsoft.VisualStudio.OLE.Interop.MSG[] * uint32 * Guid * uint32 -> int

Public Function TranslateAccelerator (pMsg As MSG(), dwFlags As UInteger, ByRef pguidCmd As Guid, ByRef pdwCmd As UInteger) As Integer

Parameters

pMsg: MSG[]

[in] Pointer to the Windows message.

dwFlags: UInt32

[in] Bit flags to determine whether or not to perform default actions, or to execute the command. Values formed from the __VSTRANSACCELFLAGS enumeration.

pguidCmd: Guid

[out] Pointer to the GUID of the corresponding command.

pdwCmd: UInt32

[out] Pointer to the identifier of the command.

Returns

Int32

If the message does or will translate to a command, the method returns S_OK and fills the pguidCmd and pdwCmd parameters with the command's GUID and ID. If the message does not or will not translate to a command, the method returns S_FALSE, and sets the two parameters to zero.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsFilterKeys::TranslateAccelerator(  
   [in] LPMSG pMsg,   
   [in] VSTRANSACCELFLAGS dwFlags,   
   [out] GUID *pguidCmd,   
   [out] DWORD *pdwCmd  
);

Applies to