ExpansionProvider.HandlePostExec Method

Definition

Called after a command has been executed.

public:
 virtual bool HandlePostExec(Guid % guidCmdGroup, System::UInt32 nCmdId, System::UInt32 nCmdexecopt, bool commit, IntPtr pvaIn, IntPtr pvaOut);
public virtual bool HandlePostExec (ref Guid guidCmdGroup, uint nCmdId, uint nCmdexecopt, bool commit, IntPtr pvaIn, IntPtr pvaOut);
abstract member HandlePostExec : Guid * uint32 * uint32 * bool * nativeint * nativeint -> bool
override this.HandlePostExec : Guid * uint32 * uint32 * bool * nativeint * nativeint -> bool
Public Overridable Function HandlePostExec (ByRef guidCmdGroup As Guid, nCmdId As UInteger, nCmdexecopt As UInteger, commit As Boolean, 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).

commit
Boolean

[in] This is true if the code snippet has been committed to the source file.

pvaIn
IntPtr

nativeint

[in] An unmarshaled pointer to a Variant 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 to hold the result of the command, if any.

Returns

If the command was handled, returns true; otherwise, returns false to let the caller handle the command.

Remarks

This method is called after a command is executed. This allows the expansion provider a chance to finish any snippet expansion details.

The base method handles only the RETURN command and then only if an expansion was started in the HandlePreExec method; in this case, the EndTemplateEditing method is called to end the editing session — but only if the commit parameter is true — and true is returned to indicate the RETURN command was handled (this prevents formatting of the span which could mess up the format specified by the snippet itself).

Applies to