Dela via


ViewFilter.QueryParameterList Method

Called to obtain the parameter for the specified command.

Namespace:  Microsoft.VisualStudio.Package
Assemblies:   Microsoft.VisualStudio.Package.LanguageService.10.0 (in Microsoft.VisualStudio.Package.LanguageService.10.0.dll)
  Microsoft.VisualStudio.Package.LanguageService (in Microsoft.VisualStudio.Package.LanguageService.dll)
  Microsoft.VisualStudio.Package.LanguageService.12.0 (in Microsoft.VisualStudio.Package.LanguageService.12.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.11.0 (in Microsoft.VisualStudio.Package.LanguageService.11.0.dll)
  Microsoft.VisualStudio.Package.LanguageService.9.0 (in Microsoft.VisualStudio.Package.LanguageService.9.0.dll)

Syntax

'Declaration
Protected Overridable Function QueryParameterList ( _
    ByRef guidCmdGroup As Guid, _
    nCmdId As UInteger, _
    nCmdexecopt As UInteger, _
    pvaIn As IntPtr, _
    pvaOut As IntPtr _
) As Integer
protected virtual int QueryParameterList(
    ref Guid guidCmdGroup,
    uint nCmdId,
    uint nCmdexecopt,
    IntPtr pvaIn,
    IntPtr pvaOut
)
protected:
virtual int QueryParameterList(
    Guid% guidCmdGroup, 
    unsigned int nCmdId, 
    unsigned int nCmdexecopt, 
    IntPtr pvaIn, 
    IntPtr pvaOut
)
abstract QueryParameterList : 
        guidCmdGroup:Guid byref * 
        nCmdId:uint32 * 
        nCmdexecopt:uint32 * 
        pvaIn:IntPtr * 
        pvaOut:IntPtr -> int  
override QueryParameterList : 
        guidCmdGroup:Guid byref * 
        nCmdId:uint32 * 
        nCmdexecopt:uint32 * 
        pvaIn:IntPtr * 
        pvaOut:IntPtr -> int
protected function QueryParameterList(
    guidCmdGroup : Guid, 
    nCmdId : uint, 
    nCmdexecopt : uint, 
    pvaIn : IntPtr, 
    pvaOut : IntPtr
) : int

Parameters

  • guidCmdGroup
    Type: Guid%

    [in] The GUID of the command group.

  • nCmdId
    Type: UInt32

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

  • nCmdexecopt
    Type: UInt32

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

  • pvaIn
    Type: IntPtr

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

  • pvaOut
    Type: IntPtr

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

Return Value

Type: 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.

Remarks

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 QueryStatus method if the nCmdexecopt parameter contains the OLECMDEXECOPT_SHOWHELP option.

.NET Framework Security

See Also

Reference

ViewFilter Class

Microsoft.VisualStudio.Package Namespace