OleMenuCommandService::IOleCommandTarget::QueryStatus Method (Guid, UInt32, array<OLECMD>^, IntPtr)
This API supports the product infrastructure and is not intended to be used directly from your code.
Sets command status.
Assembly: Microsoft.VisualStudio.Shell.14.0 (in Microsoft.VisualStudio.Shell.14.0.dll)
private: virtual int QueryStatus( Guid% commandGroup, unsigned int nCmdId, array<OLECMD>^ oleCmd, IntPtr oleText ) sealed = IOleCommandTarget::QueryStatus
Parameters
- commandGroup
-
Type:
System::Guid
System.Guid guidGroup. The menu group. This implementation maps the group to CommandID.Guid.
- nCmdId
-
Type:
System::UInt32
System.UInt32 nCmdId. The ID code of the command. This implementation maps nCmdId to CommandID.ID.
- oleCmd
-
Type:
array<Microsoft.VisualStudio.OLE.Interop::OLECMD>^
Microsoft.OLE.Interop._tagOLECMD[] oleCmd. A command structure that contains data about the status of the command.
- oleText
-
Type:
System::IntPtr
System.IntPtr oleText. A pointer to a text BSTR. If the command is a verb the name of the verb will be filled in here.
Return Value
Type: System::Int32An HRESULT code indicating the success or failure of the call. The following HRESULTs may be returned:
Value | Description |
|---|---|
The command was successfully invoked. | |
The group GUID did not match the commandID’s Guid property for any command or verb. | |
The group was found, but there is no command or verb with an ID that matches. This is also returned if the OleStatus property of a command that was found returns zero. |
This method is defined as a private interface implementation for IOleCommandTarget. To make use of it, a tool or document window generally implements IOleCommandTarget itself, and then forwards calls to the implementation contained in MenuCommandService. This implementation of QueryStatus uses FindCommand if a command exists, and then sets oleCmd.cmdf to the status code returned by the command’s OleStatus property.