Edit

Share via

ReadCabinetState function (shlobj_core.h)

  • Article

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

Fills a CABINETSTATE structure with information from the registry.

Syntax

BOOL ReadCabinetState(
  [out] CABINETSTATE *pcs,
  [in]  int          cLength
);

Parameters

[out] pcs

Type: CABINETSTATE*

When this function returns, contains a pointer to a CABINETSTATE structure that contains either information pulled from the registry or default information.

[in] cLength

Type: int

The size of the structure pointed to by pcs, in bytes.

Return value

Type: BOOL

Returns TRUE if the returned structure contains information from the registry. Returns FALSE if the structure contains default information.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header shlobj_core.h (include Shlobj.h)
Library Shell32.lib
DLL Shell32.dll (version 5.0 or later)