Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

SetupIterateCabinet Function

[This function is available for use in the operating systems indicated in the Requirements section. It may be altered or unavailable in subsequent versions. SetupAPI should no longer be used for installing applications. Instead, use the Windows Installer for developing application installers. SetupAPI continues to be used for installing device drivers.]

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(
  __in  PCTSTR CabinetFile,
  __in  DWORD Reserved,
  __in  PSP_FILE_CALLBACK MsgHandler,
  __in  PVOID Context


CabinetFile [in]

Cabinet (.CAB) file to iterate through.

Reserved [in]

Not currently used.

MsgHandler [in]

Pointer to a FileCallback 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 [in]

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 Value

If the function succeeds, the return value is a nonzero value.

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


Minimum supported client

Windows 2000 Professional

Minimum supported server

Windows 2000 Server







Unicode and ANSI names

SetupIterateCabinetW (Unicode) and SetupIterateCabinetA (ANSI)

See Also




Build date: 8/19/2010

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

© 2014 Microsoft. All rights reserved.