CABINETSTATE structure (shlobj_core.h)

[CABINETSTATE is available for use in the operating systems specified in the Requirements section. It may be altered or unavailable in subsequent versions.]

Holds the global configuration for Windows Explorer and Windows Internet Explorer. This structure is used in the ReadCabinetState and WriteCabinetState functions.

Syntax

typedef struct {
  WORD cLength;
  WORD nVersion;
  BOOL fFullPathTitle : 1;
  BOOL fSaveLocalView : 1;
  BOOL fNotShell : 1;
  BOOL fSimpleDefault : 1;
  BOOL fDontShowDescBar : 1;
  BOOL fNewWindowMode : 1;
  BOOL fShowCompColor : 1;
  BOOL fDontPrettyNames : 1;
  BOOL fAdminsCreateCommonGroups : 1;
  UINT fUnusedFlags : 7;
  UINT fMenuEnumFilter;
} CABINETSTATE, *LPCABINETSTATE;

Members

cLength

Type: WORD

The size of the structure, in bytes.

nVersion

Type: WORD

fFullPathTitle

Type: BOOL

TRUE

Display the full path in the title bar.

FALSE

Display only the file name in the title bar.

fSaveLocalView

Type: BOOL

TRUE

Remember each folder's view settings.

FALSE

Use global settings for all folders.

fNotShell

Type: BOOL

Not used.

fSimpleDefault

Type: BOOL

Not used.

fDontShowDescBar

Type: BOOL

Not used.

fNewWindowMode

Type: BOOL

TRUE

Display in a new window.

FALSE

Display in the current window.

fShowCompColor

Type: BOOL

TRUE

Show encrypted or compressed NTFS files in color.

FALSE

Do not show encrypted or compressed NTFS files in color.

fDontPrettyNames

Type: BOOL

Not used.

fAdminsCreateCommonGroups

Type: BOOL

Used when an administrator installs an application that places an icon in the Start menu.

TRUE

Add the icon to the Start menu for all users (CSIDL_COMMON_STARTMENU). This is the default value.

FALSE

Add the icon to only the current user (CSIDL_STARTMENU).

fUnusedFlags

Type: UINT

Not used.

fMenuEnumFilter

Type: UINT

One or both of the following flags.

SHCONTF_FOLDERS

Display folders.

SHCONTF_NONFOLDERS

Display non-folder items.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Header	shlobj_core.h (include Shlobj.h)