CABINET_INFO_A structure (setupapi.h)

The CABINET_INFO structure stores information about a cabinet file. The SetupIterateCabinet function specifies this structure as a parameter when it sends a SPFILENOTIFY_NEEDNEWCABINET notification to the cabinet callback routine.

Syntax

typedef struct _CABINET_INFO_A {
  PCSTR  CabinetPath;
  PCSTR  CabinetFile;
  PCSTR  DiskName;
  USHORT SetId;
  USHORT CabinetNumber;
} CABINET_INFO_A, *PCABINET_INFO_A;

Members

CabinetPath

Path to the cabinet file.

CabinetFile

Name of the cabinet file.

DiskName

Name of the source media that contains the cabinet file.

SetId

Identifier of the current set. This number is generated by the software that builds the cabinet.

CabinetNumber

Number of the cabinet. This number is generated by the software that builds the cabinet and is generally a zero- or 1-based index indicating the ordinal of the position of the cabinet within a set.

Remarks

Note

The setupapi.h header defines CABINET_INFO as an alias that automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that is not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Header	setupapi.h

See also

FILE_IN_CABINET_INFO

Overview

SPFILENOTIFY_NEEDNEWCABINET

Structures