BROWSEINFO

Other versions of this page are also available for the following:

• Windows Embedded CE 6.0 R3

8/28/2008

This structure receives information about a folder selected by the user in a dialog box that an application created by calling the SHBrowseForFolder function.

Syntax

typedef struct _browseinfo {
  HWND hwndOwner;
  LPCITEMIDLIST pidlRoot;
  LPTSTR pszDisplayName;
  LPCTSTR lpszTitle;
  UINT ulFlags;
  BFFCALLBACK lpfn;
  LPARAM lParam;
  int iImage;
} BROWSEINFO, *PBROWSEINFO, *LPBROWSEINFO;

Members

• hwndOwner
  Handle to the window that owns the dialog box.

• pidlRoot
  Pointer to an ITEMIDLIST structure (PIDL) that specifies the location of the root folder from which to start browsing. Only the specified folder and any subfolders that are beneath the specified folder in the namespace hierarchy appear in the dialog box. This member can be NULL; in that case, the namespace root is used.

• pszDisplayName
  Pointer to a buffer that receives the display name of the folder that the user selects. The size of this buffer is assumed to be MAX_PATH bytes.

• lpszTitle
  Pointer to a null-terminated string that is displayed above the tree view control in the dialog box. You can use this string to specify instructions to the user.

• ulFlags
  Unsigned integer that specifies the options for the dialog box. This member can include a zero or a combination of values. The following table shows the possible values.

  Value	Description
  BIF_EDITBOX	Includes an edit control in the Browse For Folder dialog box that allows the user to type the name of an item.
  BIF_STATUSTEXT	Includes a status area in the dialog box. The callback function can set the status text by sending a BFFM_SETSTATUSTEXT message to the dialog box.
  BIF_VALIDATE	Calls the BrowseCallbackProc function for the application with the BFFM_VALIDATEFAILED message if the user types an invalid name into the edit box. This value is ignored if you do not specify BIF_EDITBOX.

• lpfn
  Pointer to an application-defined function that the dialog box calls when an event occurs. For more information, see the BrowseCallbackProc function. This member can be NULL.

• lParam
  Application-defined value that the dialog box passes to the callback function, if you specify a callback function.

• iImage
  Integer that receives an index for the image associated with the selected folder. The image is specified as an index to the system image list.

Requirements

Header	shlobj.h
Windows Embedded CE	Windows CE .NET 4.0 and later

See Also

Reference

Standard Shell Structures
BrowseCallbackProc
SHBrowseForFolder
ITEMIDLIST