ViewFilter.HandlePreExec(Guid, UInt32, UInt32, IntPtr, IntPtr) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Package

Assembly:: Microsoft.VisualStudio.Package.LanguageService.14.0.dll

Assembly:: Microsoft.VisualStudio.Package.LanguageService.15.0.dll

Package:: Microsoft.VisualStudio.Package.LanguageService.15.0 v17.12.40392

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.

Handles pre-processing before a command is executed.

public:
 virtual bool HandlePreExec(Guid % guidCmdGroup, System::UInt32 nCmdId, System::UInt32 nCmdexecopt, IntPtr pvaIn, IntPtr pvaOut);

public virtual bool HandlePreExec (ref Guid guidCmdGroup, uint nCmdId, uint nCmdexecopt, IntPtr pvaIn, IntPtr pvaOut);

abstract member HandlePreExec : Guid * uint32 * uint32 * nativeint * nativeint -> bool
override this.HandlePreExec : Guid * uint32 * uint32 * nativeint * nativeint -> bool

Public Overridable Function HandlePreExec (ByRef guidCmdGroup As Guid, nCmdId As UInteger, nCmdexecopt As UInteger, pvaIn As IntPtr, pvaOut As IntPtr) As Boolean

Parameters

guidCmdGroup: Guid

[in] The GUID of the command group.

nCmdId: UInt32

[in] The specific ID of the command from the command group. This identifies the command to execute.

nCmdexecopt: UInt32

[in] Additional parameters for the command (packed into a 32-bit value).

pvaIn: IntPtr
nativeint

[in] An unmarshaled pointer to a Variant object holding any parameters required by the command. This can be a null value indicating there are no additional parameters.

pvaOut: IntPtr
nativeint

[in, out] An unmarshaled pointer to a Variant object to hold the result of the command, if any.

Returns

Boolean

Returns true if the command was actually handled in the pre-processing; otherwise, returns false.

Remarks

This method is called before a command is executed. However, this method can handle the command itself, in which case this method returns true, indicating the command needs no further processing.

The base method obtains the expansion provider and calls the HandlePreExec method on the ExpansionProvider object if the object exists. If the expansion provider handles the call then this method does nothing else. Otherwise, all commands supported by the base ViewFilter class are handled here and true is returned. Returns false, if the command is not supported.

Applies to

Sdílet prostřednictvím