Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All
Important This document may not represent best practices for current development, links to downloads and other resources may no longer be valid. Current recommended version can be found here.

ViewFilter.QueryParameterList Method

Called to obtain the parameter for the specified command.

This method is not CLS-compliant.  

Namespace: Microsoft.VisualStudio.Package
Assembly: Microsoft.VisualStudio.Package.LanguageService (in microsoft.visualstudio.package.languageservice.dll)

protected virtual int QueryParameterList (
	ref Guid guidCmdGroup,
	uint nCmdId,
	uint nCmdexecopt,
	IntPtr pvaIn,
	IntPtr pvaOut
)
protected int QueryParameterList (
	/** @ref */ Guid guidCmdGroup, 
	UInt32 nCmdId, 
	UInt32 nCmdexecopt, 
	IntPtr pvaIn, 
	IntPtr pvaOut
)
JScript does not support passing value-type arguments by reference.

Parameters

guidCmdGroup

[in] The GUID of the command group.

nCmdId

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

nCmdexecopt

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

pvaIn

[in] Always a null reference (Nothing in Visual Basic).

pvaOut

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

Return Value

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 Microsoft.VisualStudio.OLE.Interop.IOleCommandTarget.QueryStatus method if the nCmdexecopt parameter contains the OLECMDEXECOPT_SHOWHELP option.

Community Additions

ADD
Show:
© 2015 Microsoft