IExplorerCommand::EnumSubCommands method (shobjidl_core.h)

Article
02/22/2024

Retrieves an enumerator for a command's subcommands.

Syntax

HRESULT EnumSubCommands(
  [out] IEnumExplorerCommand **ppEnum
);

Parameters

[out] ppEnum

Type: IEnumExplorerCommand**

When this method returns successfully, contains an IEnumExplorerCommand interface pointer that can be used to walk the set of subcommands.

Return value

Type: HRESULT

If this method succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

Subcommands are displayed as menu drop-down items through the use of a Split button when commands are exposed at the top of a Windows Explorer window. In that position, only the default command button is given an icon. In a normal menu, the icons for all commands are shown.

Subcommands which themselves have subcommands are not supported by Windows Explorer. When a command has its own subcommands, it must designate this status by specifying ECF_HASSUBCOMMANDS in the IExplorerCommand::GetFlags call.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	shobjidl_core.h (include Shobjidl.h)

Share via