CMINVOKECOMMANDINFO structure (shobjidl_core.h)
Contains information needed by IContextMenu::InvokeCommand to invoke a shortcut menu command.
typedef struct _CMINVOKECOMMANDINFO {
DWORD cbSize;
DWORD fMask;
HWND hwnd;
LPCSTR lpVerb;
LPCSTR lpParameters;
LPCSTR lpDirectory;
int nShow;
DWORD dwHotKey;
HANDLE hIcon;
} CMINVOKECOMMANDINFO;
cbSize
Type: DWORD
The size of this structure, in bytes.
fMask
Type: DWORD
Zero, or one or more of the following flags.
The dwHotKey member is valid.
The hIcon member is valid. As of Windows Vista this flag is not used.
The system is prevented from displaying user interface elements (for example, error messages) while carrying out a command.
If a shortcut menu handler needs to create a new process, it will normally create a new console. Setting the CMIC_MASK_NO_CONSOLE flag suppresses the creation of a new console.
This flag is valid only when referring to a 16-bit Windows-based application. If set, the application that the shortcut points to runs in a private Virtual DOS Machine (VDM). See Remarks.
Wait for the DDE conversation to terminate before returning.
Windows Vista and later. The implementation of IContextMenu::InvokeCommand should be synchronous, not returning before it is complete. Since this is recommended, calling applications that specify this flag cannot guarantee that this request will be honored if they are not familiar with the implementation of the verb that they are invoking.
The SHIFT key is pressed. Use this instead of polling the current state of the keyboard that may have changed since the verb was invoked.
The CTRL key is pressed. Use this instead of polling the current state of the keyboard that may have changed since the verb was invoked.
Indicates that the implementation of IContextMenu::InvokeCommand might want to keep track of the item being invoked for features like the "Recent documents" menu.
Do not perform a zone check. This flag allows ShellExecuteEx to bypass zone checking put into place by IAttachmentExecute.
hwnd
Type: HWND
A handle to the window that is the owner of the shortcut menu. An extension can also use this handle as the owner of any message boxes or dialog boxes it displays.
lpVerb
Type: LPCSTR
The address of a null-terminated string that specifies the language-independent name of the command to carry out. This member is typically a string when a command is being activated by an application. The system provides predefined constant values for the following command strings.
| Constant | Command string |
|---|---|
| CMDSTR_RUNAS | "RunAs" |
| CMDSTR_PRINT | "Print" |
| CMDSTR_PREVIEW | "Preview" |
| CMDSTR_OPEN | "Open" |
This is not a fixed set; new canonical verbs can be invented by context menu handlers and applications can invoke them.
If a canonical verb exists and a menu handler does not implement the canonical verb, it must return a failure code to enable the next handler to be able to handle this verb. Failing to do this will break functionality in the system including ShellExecute.
Alternatively, rather than a pointer, this parameter can be MAKEINTRESOURCE(offset) where offset is the menu-identifier offset of the command to carry out. Implementations can use the IS_INTRESOURCE macro to detect that this alternative is being employed. The Shell uses this alternative when the user chooses a menu command.
lpParameters
Type: LPCSTR
An optional string containing parameters that are passed to the command. The format of this string is determined by the command that is to be invoked. This member is always NULL for menu items inserted by a Shell extension.
lpDirectory
Type: LPCSTR
An optional working directory name. This member is always NULL for menu items inserted by a Shell extension.
nShow
Type: int
A set of SW_ values to pass to the ShowWindow function if the command displays a window or starts an application.
dwHotKey
Type: DWORD
An optional keyboard shortcut to assign to any application activated by the command. If the fMask parameter does not specify CMIC_MASK_HOTKEY, this member is ignored.
hIcon
Type: HANDLE
An icon to use for any application activated by the command. If the fMask member does not specify CMIC_MASK_ICON, this member is ignored.
Although the IContextMenu::InvokeCommand declaration specifies a CMINVOKECOMMANDINFO structure for the pici parameter, it can also accept a CMINVOKECOMMANDINFOEX structure. If you are implementing this method, you must inspect cbSize to determine which structure has been passed.
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP [desktop apps only] |
| Minimum supported server | Windows 2000 Server [desktop apps only] |
| Header | shobjidl_core.h (include Shobjidl.h) |