OleMenuCommandService::IOleCommandTarget::Exec Method (Guid, UInt32, UInt32, IntPtr, IntPtr)

 

This API supports the product infrastructure and is not intended to be used directly from your code.

Executes the selected command.

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

private:
virtual int Exec(
	Guid% commandGroup,
	unsigned int nCmdId,
	unsigned int nCmdExcept,
	IntPtr pIn,
	IntPtr vOut
) sealed = IOleCommandTarget::Exec

Parameters

commandGroup
Type: System::Guid

The menu group. This implementation maps the group to CommandID.Guid.

nCmdId
Type: System::UInt32

The ID code of the command. This implementation maps nCmdId to CommandID.ID.

nCmdExcept
Type: System::UInt32

The number of command options. This implementation ignores this parameter.

pIn
Type: System::IntPtr

The actual command options. This implementation ignores this parameter.

vOut
Type: System::IntPtr

Output data for the command. This implementation ignores this parameter.

Return Value

Type: System::Int32

An HRESULT code indicating the success or failure of the call. The following HRESULTs may be returned:

Value

Description

S_OK

The command was successfully invoked.

OLECMDERR_E_UNKNOWNGROUP

The group GUID did not match the commandID’s Guid property for any command or verb.

OLECMDERR_E_NOTSUPPORTED

The group was found, but there is no command or verb with an ID that matches. This is also returned if the OleStatus property of a command that was found returns zero.

This method is defined as a private interface implementation for IOleCommandTarget. To make use of it, a tool or document window generally implements IOleCommandTarget itself, and then forwards calls to the implementation contained in MenuCommandService. This implementation of Exec uses FindCommand to determine if a command exists, and invokes the command if it is disabled.

Return to top
Show: