ViewFilter::QueryParameterList Method (Guid, UInt32, UInt32, IntPtr, IntPtr)

 

Called to obtain the parameter for the specified command.

Namespace:   Microsoft.VisualStudio.Package
Assembly:  Microsoft.VisualStudio.Package.LanguageService.14.0 (in Microsoft.VisualStudio.Package.LanguageService.14.0.dll)

protected:
virtual int QueryParameterList(
	Guid% guidCmdGroup,
	unsigned int nCmdId,
	unsigned int nCmdexecopt,
	IntPtr pvaIn,
	IntPtr pvaOut
)

Parameters

guidCmdGroup
Type: System::Guid

[in] The GUID of the command group.

nCmdId
Type: System::UInt32

[in] The ID of the command for which to get the parameter.

nCmdexecopt
Type: System::UInt32

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

pvaIn
Type: System::IntPtr

[in] Always null.

pvaOut
Type: System::IntPtr

[in, out] An unmarshaled pointer to a Variant object to hold the parameter of the command expressed as a string.

Return Value

Type: System::Int32

If successful, returns S_OK; otherwise, returns an error code. A typical error code is OLECMDERR_E_NOTSUPPORTED if parameters on methods are not supported.

This method is typically called from an implementation of the QueryStatus method when the nCmdexecopt parameter contains the OLECMDEXECOPT_SHOWHELP option in order to return a text representation of the parameters.

If you have added support for additional commands in your language service and any of those commands have parameter lists, then you must derive a class from the ViewFilter class and override this method.

The base class always returns OLECMDERR_E_NOTSUPPORTED.

In the default managed package framework implementation of the language service classes, this method is called from the M:Microsoft.VisualStudio.Package.ViewFilter.Microsoft.VisualStudio.OLE.Interop.IOleCommandTarget.QueryStatus(System.Guid@,System.UInt32,Microsoft.VisualStudio.OLE.Interop.OLECMD[],System.IntPtr) method if the nCmdexecopt parameter contains the OLECMDEXECOPT_SHOWHELP option.

Return to top
Show: