INameSpaceTreeControl::AppendRoot method (shobjidl_core.h)

Article
02/22/2024

Appends a Shell item to the list of roots in a tree.

Syntax

HRESULT AppendRoot(
  [in] IShellItem       *psiRoot,
  [in] SHCONTF          grfEnumFlags,
  [in] NSTCROOTSTYLE    grfRootStyle,
  [in] IShellItemFilter *pif
);

Parameters

[in] psiRoot

Type: IShellItem*

Pointer to the Shell item that is being appended.

[in] grfEnumFlags

Type: SHCONTF

Enumerates the qualities of the root and all of its children. One or more of the values of type SHCONTF. These flags can be combined using a bitwise OR.

[in] grfRootStyle

Type: NSTCROOTSTYLE

Specifies the style of the root that is being appended. One or more of the following values:

NSTCRS_VISIBLE (0x0000)

The root is visible as well as the items. Mutually exclusive with NSTCRS_HIDDEN.

NSTCRS_HIDDEN (0x0001)

The root is hidden so that the children only are visible. Mutually exclusive with NSTCRS_VISIBLE.

NSTCRS_EXPANDED (0x0002)

The root is expanded upon initialization.

[in] pif

Type: IShellItemFilter*

Pointer to the IShellItemFilter that enables you to filter which items in the tree are displayed. If supplied, every item is customizable with a SHCONTF flag. This value can be NULL if no filter is required.

Return value

Type: HRESULT

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

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