WindowPane.IOleCommandTarget.QueryStatus Method

Article
07/12/2014

Gets the status of the commands.

Namespace: Microsoft.VisualStudio.Shell
Assembly: Microsoft.VisualStudio.Shell.11.0 (in Microsoft.VisualStudio.Shell.11.0.dll)

Syntax

'Declaration
Private Function QueryStatus ( _
    ByRef guidGroup As Guid, _
    nCmdId As UInteger, _
    oleCmd As OLECMD(), _
    oleText As IntPtr _
) As Integer Implements IOleCommandTarget.QueryStatus

int IOleCommandTarget.QueryStatus(
    ref Guid guidGroup,
    uint nCmdId,
    OLECMD[] oleCmd,
    IntPtr oleText
)

private:
virtual int QueryStatus(
    Guid% guidGroup, 
    unsigned int nCmdId, 
    array<OLECMD>^ oleCmd, 
    IntPtr oleText
) sealed = IOleCommandTarget::QueryStatus

private abstract QueryStatus : 
        guidGroup:Guid byref * 
        nCmdId:uint32 * 
        oleCmd:OLECMD[] * 
        oleText:IntPtr -> int  
private override QueryStatus : 
        guidGroup:Guid byref * 
        nCmdId:uint32 * 
        oleCmd:OLECMD[] * 
        oleText:IntPtr -> int

JScript does not support explicit interface implementations.

Parameters

guidGroup
Type: System.Guid%

Unique identifier of the command group. All the commands that are passed in the prgCmds array must belong to the group that is specified by guidCmdGroup.

nCmdId
Type: System.UInt32

The number of commands in the prgCmds array.

oleCmd
Type: array<Microsoft.VisualStudio.OLE.Interop.OLECMD[]

A caller-allocated array of OLECMD structures that indicate the commands for which the caller requires status information. This method fills the cmdf member of each structure with values taken from the OLECMDF enumeration.

oleText
Type: System.IntPtr

Pointer to an OLECMDTEXTF structure to return a name and/or status information of a single command. Can be nulla null reference (Nothing in Visual Basic) to indicate that the caller does not require this information.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Implements

IOleCommandTarget.QueryStatus(Guid%, UInt32, array<OLECMD[], IntPtr)

Remarks

Visual Studio calls this method to get the status of your commands. You do not need to override this method.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via