SetupIterateCabinet

The SetupIterateCabinet function iterates through all the files in a cabinet and sends a notification to a callback function for each file found.

BOOL SetupIterateCabinet(
  PCTSTR CabinetFile,            // name of the cabinet file
  DWORD Reserved,                // this parameter is not used
  PSP_FILE_CALLBACK MsgHandler,  // callback routine to use
  PVOID Context                  // callback routine context
);
 

Parameters

CabinetFile

Specifies the cabinet (.CAB) file to iterate through.

Reserved

Not currently used.

MsgHandler

Supplies a pointer to a routine that will process the notifications SetupIterateCabinet returns as it iterates through the files in the cabinet file. The callback routine may then return a value specifying whether to decompress, copy, or skip the file.

Context

Specifies the context value that is passed into the routine specified in MsgHandler. This enables the callback routine to track values between notifications, without having to use global variables.

Return Values

If the function succeeds, the return value is a non-zero value.

If the function fails, the return value is zero. To get extended error information, call GetLastError.

QuickInfo

  Windows NT: Use version 4.0 and later.
  Windows: Use Windows 95 and later.
  Windows CE: Unsupported.
  Header: Declared in setupapi.h.
  Import Library: Link with setupapi.lib.

See Also

Overview, Functions