Implements several methods that enable you to work with pointers to identifier lists (PIDLs).

class CShellManager : public CObject  

The methods of the CShellManager class all deal with PIDLs. A PIDL is a unique identifier for a shell object.

You should not create a CShellManager object manually. It will be created automatically by the framework of your application. However, you should call CWinAppEx::InitShellManager during the initialization process of your application. To get a pointer to the shell manager for your application, call CWinAppEx::GetShellManager.

CObject

CShellManager

Header: afxshellmanager.h

Displays a dialog box that enables the user to select a shell folder.

BOOL BrowseForFolder(
    CString& strOutFolder,  
    CWnd* pWndParent = NULL,  
    LPCTSTR lplszInitialFolder = NULL,  
    LPCTSTR lpszTitle = NULL,  
    UINT ulFlags = BIF_RETURNONLYFSDIRS,  
    LPINT piFolderImage = NULL);

[out] strOutFolder
The string used by the method to store the path of the selected folder.

[in] pWndParent
A pointer to the parent window.

[in] lplszInitialFolder
A string that contains the folder that is selected by default when the dialog box is displayed.

[in] lpszTitle
The title for the dialog box.

[in] ulFlags
Flags specifying options for the dialog box. See BROWSEINFO for the detailed description.

[out] piFolderImage
A pointer to the integer value where the method writes the image index of the selected folder.

Nonzero if the user selects a folder from the dialog box; otherwise 0.

When you call this method, the application creates and shows a dialog box that enables the user to select a folder. The method will write the path of the folder into the strOutFolder parameter.

The following example demonstrates how to retrieve a reference to a CShellManager object by using the CWinAppEx::GetShellManager method and how to use the BrowseForFolder method. This code snippet is part of the Explorer sample.

[!code-cppNVC_MFC_Explorer#6]

Creates a new list containing two PIDLs.

LPITEMIDLIST ConcatenateItem(
    LPCITEMIDLIST pidl1,  
    LPCITEMIDLIST pidl2);

[in] pidl1
The first item.

[in] pidl2
The second item.

A pointer to the new item list if the function succeeds, otherwise NULL.

This method creates a new ITEMIDLIST large enough to contain both pidl1 and pidl2. It then copies pidl1 and pidl2 to the new list.

Copies an item list.

LPITEMIDLIST CopyItem(LPCITEMIDLIST pidlSource);

[in] pidlSource
The original item list.

A pointer to the newly created item list if successful; otherwise NULL.

The newly created item list has the same size as the source item list.

Creates a new PIDL.

LPITEMIDLIST CreateItem(UINT cbSize);

[in] cbSize
The size of the item list.

A pointer to the created item list if successful; otherwise NULL.

Constructs a CShellManager object.

CShellManager();

In most cases, you do not have to create a CShellManager directly. By default, the framework creates one for you. To get a pointer to the CShellManager, call CWinAppEx::GetShellManager. If you do create a CShellManager manually, you must initialize it with the method CWinAppEx::InitShellManager.

Deletes an item list.

void FreeItem(LPITEMIDLIST pidl);

[in] pidl
An item list to delete.

Returns the number of items in an item list.

UINT GetItemCount(LPCITEMIDLIST pidl);

[in] pidl
A pointer to an item list.

The number of items in the item list.

Returns the size of an item list.

UINT GetItemSize(LPCITEMIDLIST pidl);

[in] pidl
A pointer to an item list.

The size of the item list.

Retrieves the next item from a pointer to an item identifier list (PIDL).

LPITEMIDLIST GetNextItem(LPCITEMIDLIST pidl);

[in] pidl
The list of items to iterate.

A pointer to the next item in the list.

If there are no more items in the list, this method returns NULL.

Retrieves the parent of a pointer to an item identifier list (PIDL).

int GetParentItem(
    LPCITEMIDLIST lpidl,  
    LPITEMIDLIST& lpidlParent);

[in] lpidl
A PIDL whose parent will be retrieved.

[out] lpidlParent
A reference to a PIDL where the method will store the result.

The level of the parent PIDL.

The level of a PIDL is relative to the desktop. The desktop PIDL is considered to have a level of 0.

Retrieves the pointer to an item identifier list (PIDL) from the item identified by a string path.

HRESULT ItemFromPath(
    LPCTSTR lpszPath,  
    LPITEMIDLIST& pidl);

[in] lpszPath
A string that specifies the path for the item.

[out] pidl
A reference to a PIDL. The method uses this PIDL to store the pointer to its return value.

Returns NOERROR if successful; an OLE-defined error value.

Hierarchy Chart
Classes