Windows Setup API

https://learn.microsoft.com/en-us/windows/win32/setupapi/
Admin
Windows Setup API is a set of functions that enable setup applications to queue and install files,...
Tokens:42,946
Snippets:438
Trust Score:10
Update:3 days ago
Show doc for...
Tokens:
Raw
### SetupInstallFromINFSection

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/updating-registry-information

This example demonstrates how to call SetupInstallFromINFSection to install registry information from an INF file section, processing all operations except file operations.

```APIDOC
## SetupInstallFromINFSection

### Description
Installs the specified section of an INF file, processing the specified installation operations. In this example, it is used to update registry information by processing all operations except file operations.

### Syntax
```
Test = SetupInstallFromINFSection (
     NULL,                     //Window to own any dialog boxes
                               //created 
     MyInf,                    //INF file containing the section 
     MySection,                //the section to install
     SPINST_ALL ^ SPINST_FILES,//which installation operations 
                               //to process
     NULL,                     //the relative root key
     NULL,                     //the source root path
     0,                        //copy style
     NULL,                     //Message handler routine
     NULL,                     //Context
     NULL,                     //Device info set
     NULL                      //device info data
);
```

### Parameters
- **OwnerWindow** (HWND) - Optional - Window to own any dialog boxes created. In the example, it is NULL because only file operations generate dialog boxes.
- **InfFileName** (PCTSTR) - Required - INF file containing the section to process. In the example, it is MyInf.
- **SectionName** (PCTSTR) - Required - The section to be installed. In the example, it is MySection.
- **Flags** (DWORD) - Required - Which installation operations to process. In the example, SPINST_ALL ^ SPINST_FILES specifies all operations except file operations.
- **RelativeKeyRoot** (HKEY) - Optional - The relative root key. In the example, it is NULL.
- **SourceRootPath** (PCTSTR) - Optional - The source root path. In the example, it is NULL.
- **CopyFlags** (DWORD) - Optional - Copy style. In the example, it is 0.
- **MsgHandler** (PSP_FILE_CALLBACK) - Optional - Message handler routine. In the example, it is NULL.
- **Context** (PVOID) - Optional - Context. In the example, it is NULL.
- **DeviceInfoSet** (HDEVINFO) - Optional - Device info set. In the example, it is NULL.
- **DeviceInfoData** (PSP_DEVINFO_DATA) - Optional - Device info data. In the example, it is NULL.

### Remarks
- The function can be called with SPINST_INIFILES, SPINST_REGISTRY, or SPINST_INI2REG flags to update registry information.
- It is recommended to wait until all necessary file copy operations are completed before altering registry information.
- Since no copy operations are being processed, the CopyFlags, MsgHandler, Context, DeviceInfoSet, and DeviceInfoData parameters are not specified in the example.

```

--------------------------------

### SetupInstallFile

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Installs a file.

```APIDOC
## SetupInstallFile

### Description
Installs a file.

### Function
SetupInstallFile
```

--------------------------------

### SetupGetSourceInfo Example

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/extracting-file-information-from-the-inf-file

This example demonstrates how to use the SetupGetSourceInfo function to retrieve the human-readable description of a source media from an INF file.

```APIDOC
## SetupGetSourceInfo

### Description
Retrieves information about a source media from an INF file, such as the description.

### Syntax
```cpp
BOOL SetupGetSourceInfo(
  HINF  MyInf,
  UINT  SourceId,
  DWORD InfoLevel,
  PTSTR Buffer,
  DWORD MaxBufSize,
  PDWORD BufSize
);
```

### Parameters
- **MyInf** (HINF) - Required - Handle to the INF file to access.
- **SourceId** (UINT) - Required - Identifier for a specific source media.
- **InfoLevel** (DWORD) - Required - Specifies which information to retrieve. Use SRCINFO_DESCRIPTION to retrieve the source media description.
- **Buffer** (PTSTR) - Required - Pointer to a buffer that receives the information.
- **MaxBufSize** (DWORD) - Required - Size allocated for the buffer.
- **BufSize** (PDWORD) - Required - Pointer to a variable that receives the buffer size actually needed.

### Return Value
Returns TRUE if successful, FALSE otherwise. If BufSize is greater than MaxBufSize, the function returns FALSE and GetLastError returns ERROR_INSUFFICIENT_BUFFER.

### Example
```cpp
#include <windows.h>
#include <setupapi.h>

BOOL test;  
HINF MyInf;
UINT SourceId;
PTSTR Buffer;
DWORD MaxBufSize;
DWORD BufSize;

int main()  
{ 
  test = SetupGetSourceInfo (
    MyInf,   //Handle to the INF file to access                
    SourceId, //Id of the source media                 
    SRCINFO_DESCRIPTION, //which information to retrieve     
    Buffer, //a pointer to the buffer to receive the information                     
    MaxBufSize,  //the size allocated for the buffer 
    &BufSize    //buffer size actually needed
  );
  return 0;
}
```
```

--------------------------------

### INF Install Section Syntax Example

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-install-section-example

A sample Install section demonstrating the use of Copyfiles, Delfiles, UpdateInis, AddReg, and DelReg keys to reference other sections in the INF file.

```text
[MyInstallSection]
Copyfiles=DataFiles, ProgramFiles
Delfiles=OldFiles
UpdateInis=NewIniInfo
AddReg=NewRegistryInfo, MoreNewRegistryInfo
DelReg=OldRegistryInfo, MoreOldRegistryInfo
```

--------------------------------

### SetupInstallFileEx

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Installs a file and returns a variable indicating whether or not the file was in use.

```APIDOC
## SetupInstallFileEx

### Description
Installs a file and returns a variable indicating whether or not the file was in use.

### Function
SetupInstallFileEx
```

--------------------------------

### SetupInstallFromInfSection

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Performs the directives specified in an INF file Install section.

```APIDOC
## SetupInstallFromInfSection

### Description
Performs the directives specified in an INF file Install section.

### Function
SetupInstallFromInfSection
```

--------------------------------

### Open an INF file with SetupOpenInfFile

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/opening-the-inf-file

This example demonstrates how to open an INF file and retrieve a handle, with the Class parameter set to NULL to ignore INF class information.

```C++
HINF MyInf;                //variable to hold the INF handle
UINT ErrorLine;            //variable to hold errors returned
BOOL test=0;                 //variable to receive function success
 
MyInf = SetupOpenInfFile (
      szInfFileName,       //the filename of the inf file to open
      NULL,                //optional class information
      INF_STYLE_WIN4,      //the inf style
      &ErrorLine           //line number of the syntax error
);
```

--------------------------------

### Update registry information using SetupInstallFromINFSection

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/updating-registry-information

This example demonstrates calling SetupInstallFromINFSection with the SPINST_ALL ^ SPINST_FILES flags to process all INI and registry operations while excluding file operations.

```C
Test = SetupInstallFromINFSection (
     NULL,                     //Window to own any dialog boxes
                               //created 
     MyInf,                    //INF file containing the section 
     MySection,                //the section to install
     SPINST_ALL ^ SPINST_FILES,//which installation operations 
                               //to process
     NULL,                     //the relative root key
     NULL,                     //the source root path
     0,                        //copy style
     NULL,                     //Message handler routine
     NULL,                     //Context
     NULL,                     //Device info set
     NULL                      //device info data
);
```

--------------------------------

### Retrieve source media description with SetupGetSourceInfo

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/extracting-file-information-from-the-inf-file

This example demonstrates using SetupGetSourceInfo to fetch the human-readable description of source media. If the provided buffer size is insufficient, the function returns FALSE and GetLastError returns ERROR_INSUFFICIENT_BUFFER.

```C++
#include <windows.h>
#include <setupapi.h>

BOOL test;  
HINF MyInf;
UINT SourceId;
PTSTR Buffer;
DWORD MaxBufSize;
DWORD BufSize;

int main()  
{ 

test = SetupGetSourceInfo (
     MyInf,   //Handle to the INF file to access                
     SourceId, //Id of the source media                 
     SRCINFO_DESCRIPTION, //which information to retrieve     
     Buffer, //a pointer to the buffer to receive the information                     
     MaxBufSize,  //the size allocated for the buffer 
     &BufSize    //buffer size actually needed
);
  
return 0;
}
```

--------------------------------

### SetupInstallFilesFromInfSection

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Queues all the files specified in the Copy Files, Delete Files, and Rename Files sections that are listed by an Install section.

```APIDOC
## SetupInstallFilesFromInfSection

### Description
Queues all the files specified in the Copy Files, Delete Files, and Rename Files sections that are listed by an Install section.

### Function
SetupInstallFilesFromInfSection
```

--------------------------------

### Commit the file queue using SetupCommitFileQueue

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/committing-the-queue

This example demonstrates calling SetupCommitFileQueue with the default callback routine. It requires a valid queue handle, an owner window for dialogs, and a context initialized by SetupInitDefaultQueueCallback.

```cpp
test = SetupCommitFileQueue (
     OwnerWindow,          //window that will own dialog boxes
                           //created by the callback routine
     MyQueue,              //the queue to commit
  
                           //use the default callback routine
     SetupDefaultQueueCallback,  
  
     Context               //context information that will be 
                           //  used by the callback routine
);
```

--------------------------------

### SetupInstallServicesFromInfSection

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Performs service installation and deletion operations as specified in a Service section of an INF file.

```APIDOC
## SetupInstallServicesFromInfSection

### Description
Performs service installation and deletion operations as specified in a Service section of an INF file.

### Function
SetupInstallServicesFromInfSection
```

--------------------------------

### SetupAddInstallSectionToDiskSpaceList

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/disk-space-list-functions

Adds all the file operations in an Install section of an INF file to the disk-space list.

```APIDOC
## SetupAddInstallSectionToDiskSpaceList

### Description
Adds all the file operations in an Install section of an INF file to the disk-space list.

### Function
SetupAddInstallSectionToDiskSpaceList

### Parameters
No parameters are documented in the source.

### Return Value
No return value is documented in the source.
```

--------------------------------

### Setup API Notifications

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/notifications

A list of all notification codes used by the setup functions. Each notification represents a specific state or event during setup operations.

```APIDOC
## Setup API Notifications

### Description
All notification codes that setup functions can send to callback routines. Individual functions use a subset of these notifications.

### Notifications
- **SPFILENOTIFY_COPYERROR** - An error occurred during a file copy operation.
- **SPFILENOTIFY_DELETEERROR** - An error occurred during a file deletion operation.
- **SPFILENOTIFY_ENDCOPY** - A file copy operation has ended.
- **SPFILENOTIFY_ENDDELETE** - A file deletion operation has ended.
- **SPFILENOTIFY_ENDQUEUE** - The queue has finished committing.
- **SPFILENOTIFY_ENDREGISTRATION** - The registration or unregistration of the file has finished.
- **SPFILENOTIFY_ENDRENAME** - A file rename operation has ended.
- **SPFILENOTIFY_ENDSUBQUEUE** - A subqueue (either copy, rename or delete) has ended.
- **SPFILENOTIFY_FILEEXTRACTED** - The file has been extracted from the cabinet.
- **SPFILENOTIFY_FILEINCABINET** - A file is encountered in the cabinet.
- **SPFILENOTIFY_FILEOPDELAYED** - The file was in use, and the current operation has been delayed until the system is rebooted.
- **SPFILENOTIFY_LANGMISMATCH** - The language of the current operation does not match the system language.
- **SPFILENOTIFY_NEEDMEDIA** - New source media is required.
- **SPFILENOTIFY_NEEDNEWCABINET** - The current file is continued in the next cabinet.
- **SPFILENOTIFY_QUEUESCAN** - A node in the file queue has been scanned.
- **SPFILENOTIFY_QUEUESCAN_EX** - A node in the file queue has been scanned.
- **SPFILENOTIFY_QUEUESCAN_SIGNERINFO** - A node in the file queue has been scanned.
- **SPFILENOTIFY_RENAMEERROR** - An error occurred during a file rename operation.
- **SPFILENOTIFY_STARTCOPY** - A file copy operation has started.
- **SPFILENOTIFY_STARTDELETE** - A file delete operation has started.
- **SPFILENOTIFY_STARTQUEUE** - The queue has started to commit.
- **SPFILENOTIFY_STARTREGISTRATION** - The registration or unregistration of the file has started.
- **SPFILENOTIFY_STARTRENAME** - A file rename operation has started.
- **SPFILENOTIFY_STARTSUBQUEUE** - A subqueue (either copy, rename or delete) has started.
- **SPFILENOTIFY_TARGETEXISTS** - A copy of the specified file already exists on the target.
- **SPFILENOTIFY_TARGETNEWER** - A newer version of the specified file exists on the target.
```

--------------------------------

### Enqueue copy operations with SetupQueueCopySection

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/creating-a-queue-and-queuing-file-operations

This example demonstrates how to use SetupQueueCopySection to add all file copy operations defined in a specific INF section to an existing file queue.

```C
test = SetupQueueCopySection(
     MyQueue,                  \\Handle to the open queue
     "A:\",                    \\Source root path
     MyInf,                    \\Inf containing the source info
     NULL,                     \\specifies that MyInf contains 
                               \\  the section to copy as well
     MySection,                \\the name of the section to queue
  
                               \\flags specifying the copy style
     SP_COPY_NOSKIP | SP_COPY_NOBROWSE,
);
```

--------------------------------

### SetupGetMultiSzField

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Returns a list of strings, starting at the specified field of a line in an INF file.

```APIDOC
## SetupGetMultiSzField

### Description
Returns a list of strings, starting at the specified field of a line in an INF file.

### Function
SetupGetMultiSzField
```

--------------------------------

### SetupOpenAppendInfFile

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/opening-and-closing-an-inf-file

Appends additional INF files to an already opened INF file, similar to an include statement, allowing subsequent setup functions to access information in the appended files.

```APIDOC
## SetupOpenAppendInfFile

### Description
Appends additional INF files to an opened INF file. This is functionally similar to an include statement. When subsequent setup functions reference the open INF file, they will also access information in the appended files. If no INF file is specified, it appends the file(s) specified by the LayoutFile key in the Version section of the open INF file.

### Method
Function

### Endpoint
SetupOpenAppendInfFile

### Parameters
- **FileName** (string) - Optional - The name of the INF file to append. If not specified, the file(s) specified by the LayoutFile key in the Version section are appended.
- **InfHandle** (HINF) - Required - Handle to the opened INF file.
- **ErrorLine** (UINT*) - Optional - Pointer to a variable that receives the line number where an error occurred.

### Response
Returns TRUE if successful, FALSE otherwise.
```

--------------------------------

### Callback Routine Syntax

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/notifications

The syntax for a callback routine that receives notifications from setup functions. The callback routine is called with a context, a notification code, and two additional parameters.

```APIDOC
## Callback Routine Syntax

### Description
Defines the signature for a callback routine that processes notifications sent by setup functions.

### Syntax
```
MsgHandler(          //the specified callback routine
    Context,         //context used by the callback routine
    Notification,    //notification code
    Param1,          //additional notification information
    Param2           //additional notification information
);
```

### Parameters
- **Context** (void pointer) - Required - Context used by the callback routine. A pointer to a context variable or structure that the callback routine can use to store information that must persist between subsequent calls.
- **Notification** (unsigned integer) - Required - Notification code specifying an event or state that causes the setup function to call the callback routine.
- **Param1** (unsigned integer) - Optional - Additional notification information. If it returns information that is not an unsigned integer, it is cast to an unsigned integer and must be recast to its original data type before use.
- **Param2** (unsigned integer) - Optional - Additional notification information. If it returns information that is not an unsigned integer, it is cast to an unsigned integer and must be recast to its original data type before use.

### Return Value
An unsigned integer that the callback routine returns to the setup function. Depending on the setup function, this value can specify an operation or user selection, or it may be ignored.
```

--------------------------------

### SetupGetSourceFileLocation

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Gets the source disk ordinal and path (relative to source root) where the source file is located.

```APIDOC
## SetupGetSourceFileLocation

### Description
Gets the source disk ordinal and path (relative to source root) where the source file is located.

### Function
SetupGetSourceFileLocation
```

--------------------------------

### SetupGetSourceFileSize

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Gets the file size for an individual source file or a Copy Files section of an INF file.

```APIDOC
## SetupGetSourceFileSize

### Description
Gets the file size for an individual source file or a Copy Files section of an INF file.

### Function
SetupGetSourceFileSize
```

--------------------------------

### SourceDisksNames section example

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-sourcedisksnames-and-sourcedisksfiles-sections-example

An example of a SourceDisksNames section that specifies a tag and a cabinet file for media verification.

```INF
[SourceDisksNames]
1="Dajava" , "Dajava.cab",,, 0x10,"Dajava.tag"
```

--------------------------------

### SetupGetTargetPath

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Gets the target path for a Copy Files section in an INF file.

```APIDOC
## SetupGetTargetPath

### Description
Gets the target path for a Copy Files section in an INF file.

### Function
SetupGetTargetPath
```

--------------------------------

### SetupOpenFileQueue

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/file-queue-functions

Initializes and returns a handle to the file queue.

```APIDOC
## SetupOpenFileQueue

### Description
Initializes and returns a handle to the file queue.

### Function
SetupOpenFileQueue
```

--------------------------------

### SetupRemoveInstallSectionFromDiskSpaceList

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/disk-space-list-functions

Removes all the file operations in the Install section of an INF file from the disk-space list.

```APIDOC
## SetupRemoveInstallSectionFromDiskSpaceList

### Description
Removes all the file operations in the Install section of an INF file from the disk-space list.

### Function
SetupRemoveInstallSectionFromDiskSpaceList

### Parameters
No parameters are documented in the source.

### Return Value
No return value is documented in the source.
```

--------------------------------

### SetupLogFile

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/using-the-file-log

Adds an entry to the file log after a handle is obtained from SetupInitializeFileLog.

```APIDOC
## SetupLogFile

### Description
Adds an entry to the file log.

### Method
Function

### Endpoint
SetupLogFile

### Parameters
#### FileLogHandle
- **FileLogHandle** (HANDLE) - Required - Handle to the file log returned by SetupInitializeFileLog.

### Return Value
Returns a Boolean value indicating success or failure.
```

--------------------------------

### SetupPromptForDisk

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/disk-prompting-and-error-handling-functions

Generates a dialog box that prompts the user for a media disk or source file location.

```APIDOC
## SetupPromptForDisk

### Description
Generates a dialog box that prompts the user for a media disk or source file location.

### Function
SetupPromptForDisk

### Parameters
None documented.

### Return Value
Not documented.

### Remarks
This function is part of the Windows Setup API and provides a user interface for prompting the user.
```

--------------------------------

### SetupOpenInfFile

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/opening-and-closing-an-inf-file

Opens an INF file and returns a handle to it, which is required before accessing information in the INF file.

```APIDOC
## SetupOpenInfFile

### Description
Opens an INF file and returns a handle to the INF file. This handle is required for subsequent setup functions to access the INF file's information.

### Method
Function

### Endpoint
SetupOpenInfFile

### Parameters
- **FileName** (string) - Required - The name of the INF file to open.
- **InfClass** (string) - Optional - The class of the INF file.
- **InfStyle** (DWORD) - Optional - The style of the INF file.
- **ErrorLine** (UINT*) - Optional - Pointer to a variable that receives the line number where an error occurred.

### Response
Returns a handle to the opened INF file if successful, or INVALID_HANDLE_VALUE otherwise.
```

--------------------------------

### SetupGetInfInformation

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Returns information about an INF file (by Line member of an INFCONTEXT or filename).

```APIDOC
## SetupGetInfInformation

### Description
Returns information about an INF file (by Line member of an INFCONTEXT or filename).

### Function
SetupGetInfInformation
```

--------------------------------

### SPFILENOTIFY_STARTDELETE

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/spfilenotify-startdelete

Notification sent to the callback function when the queue starts a file delete operation. The callback routine should return FILEOP_ABORT, FILEOP_DOIT, or FILEOP_SKIP.

```APIDOC
## SPFILENOTIFY_STARTDELETE

### Description
Notification sent to the callback function when the queue starts a file delete operation.

### Parameters
- **Param1** (UINT) - Required - Pointer to a FILEPATHS structure.
- **Param2** (UINT) - Required - Always has the value FILEOP_DELETE.

### Return Value
The callback routine should return one of the following values:
- **FILEOP_ABORT** - Abort the queue commit. The callback routine should call SetLastError to indicate the reason for aborting. SetupCommitFileQueue returns FALSE and a subsequent call to GetLastError returns the error code set by the callback routine during the call to SetLastError.
- **FILEOP_DOIT** - Perform the file copy operation.
- **FILEOP_SKIP** - Skip the current copy operation.

### Requirements
- Minimum supported client: Windows XP [desktop apps only]
- Minimum supported server: Windows Server 2003 [desktop apps only]
- Header: Setupapi.h

### See Also
- Overview
- Notifications
- FILEPATHS
- SetupCommitFileQueue
- SetupDefaultQueueCallback
```

--------------------------------

### SetupGetSourceInfo

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Retrieves the path, tag file, or description for a source.

```APIDOC
## SetupGetSourceInfo

### Description
Retrieves the path, tag file, or description for a source.

### Function
SetupGetSourceInfo
```

--------------------------------

### SPFILENOTIFY_STARTRENAME

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/spfilenotify-startrename

Notification sent to the callback function when the queue starts a file rename operation. The callback routine should return one of the specified values to control the operation.

```APIDOC
## SPFILENOTIFY_STARTRENAME

### Description
The SPFILENOTIFY_STARTRENAME notification is sent to the callback function when the queue starts a file rename operation.

### Parameters
- **Param1** (UINT) - Required - Pointer to a FILEPATHS structure.
- **Param2** (UINT) - Required - Always has the value FILEOP_RENAME.

### Return Value
The callback routine should return one of the following values:
- **FILEOP_ABORT** - Abort the queue commit. The callback routine should call SetLastError to indicate the reason for termination. SetupCommitFileQueue returns FALSE and a subsequent call to GetLastError returns the error code set by the callback routine during the call to SetLastError.
- **FILEOP_DOIT** - Perform the file copy operation.
- **FILEOP_SKIP** - Skip the current copy operation.

### Requirements
- Minimum supported client: Windows XP [desktop apps only]
- Minimum supported server: Windows Server 2003 [desktop apps only]
- Header: Setupapi.h

### See Also
- Overview
- Notifications
- FILEPATHS
- SetupCommitFileQueue
- SetupDefaultQueueCallback
```

--------------------------------

### SetupQuerySourceList

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/using-the-mru-source-list

Queries the current source list to obtain an array of the source paths.

```APIDOC
## SetupQuerySourceList

### Description
Queries the current source list to obtain an array of the source paths.

### Method
Function

### Parameters
- **SourceListType** (enum) - Required - Specifies the type of source list to query.
- **SourceList** (array of strings) - Output - Receives the array of source paths.
- **SourceCount** (UINT) - Output - Receives the number of source paths.

### Remarks
When the source list array is no longer needed, you must call SetupFreeSourceList to free the resources allocated by SetupQuerySourceList.
```

--------------------------------

### SetupAddToSourceList

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/using-the-mru-source-list

Adds a path to a source list, either one that is resident on the user's system or a temporary list.

```APIDOC
## SetupAddToSourceList

### Description
Adds a path to a source list, either one that is resident on the user's system or a temporary list.

### Method
Function

### Parameters
- **SourceListType** (enum) - Required - Specifies the type of source list to add to.
- **SourcePath** (string) - Required - The path to add to the source list.

### Remarks
If the source list specified is not temporary, that source will remain on the user's system and is accessible to subsequent installations.
```

--------------------------------

### SetupOpenMasterInf

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Opens the INF file that contains file and layout information for files shipped with the system.

```APIDOC
## SetupOpenMasterInf

### Description
Opens the INF file that contains file and layout information for files shipped with the system.

### Function
SetupOpenMasterInf
```

--------------------------------

### SetupPromptReboot

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/file-queue-functions

Prompts the user to reboot his or her computer, if necessary.

```APIDOC
## SetupPromptReboot

### Description
Prompts the user to reboot his or her computer, if necessary.

### Function
SetupPromptReboot
```

--------------------------------

### SetupInitializeFileLog

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/using-the-file-log

Opens or creates a file log. You can specify flags to create or overwrite a file log, open the system log, or open a file log as read-only.

```APIDOC
## SetupInitializeFileLog

### Description
Opens or creates a file log. You can specify flags to create or overwrite a file log, open the system log, or open a file log as read-only.

### Method
Function

### Endpoint
SetupInitializeFileLog

### Parameters
#### Flags
- **Flags** (DWORD) - Required - Specifies the behavior: create or overwrite a file log, open the system log, or open as read-only.

### Return Value
Returns a handle to the file log.
```

--------------------------------

### SetupSetSourceList

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/using-the-mru-source-list

Opens or creates a source list on the user's system. You can specify to set the user list, the system list, a combination of the user and system lists, or a temporary list as the MRU source list.

```APIDOC
## SetupSetSourceList

### Description
Opens or creates a source list on the user's system. You can specify to set the user list, the system list, a combination of the user and system lists, or a temporary list as the MRU source list.

### Method
Function

### Parameters
- **SourceListType** (enum) - Required - Specifies the type of source list to set (user, system, combination, or temporary).
- **SourceList** (array of strings) - Required - Array of source paths to set.
- **Policy** (DWORD) - Optional - Policy flags for the source list.

### Remarks
If a temporary list is used, it will be the only list available to the setup application until SetupCancelTemporarySourceList is called, or SetupSetSourceList is called a second time.
```

--------------------------------

### SPFILENOTIFY_STARTQUEUE

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/spfilenotify-startqueue

Notification sent to the callback routine when the queue commitment process starts. The callback routine receives the owner window handle and should return zero on error or a nonzero value on success.

```APIDOC
## SPFILENOTIFY_STARTQUEUE

### Description
The SPFILENOTIFY_STARTQUEUE notification is sent to the callback routine when the queue commitment process starts.

### Parameters
- Param1: (UINT) OwnerWindow - Handle to the window that is to own the dialog boxes that the callback routine generates.
- Param2: (UINT) 0 - Unused.

### Return Value
If an error occurs, the callback routine should call SetLastError, specifying the error, and then return zero. The SetupCommitFileQueue function will return FALSE and a subsequent call to GetLastError will return the error code set by the callback routine. If no error occurs, the callback routine should return a nonzero value.

### Requirements
- Minimum supported client: Windows XP [desktop apps only]
- Minimum supported server: Windows Server 2003 [desktop apps only]
- Header: Setupapi.h
```

--------------------------------

### SetupInitDefaultQueueCallbackEx

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/committing-a-queue

Initializes the context for the default queue callback routine with additional options.

```APIDOC
## SetupInitDefaultQueueCallbackEx

### Description
Initializes the context for the default queue callback routine with additional options.

### Method
Not applicable (Windows Setup API function)

### Endpoint
Not applicable (Windows Setup API function)

### Parameters
- **Owner** (HWND) - Required - Handle to the window to use as the parent of any user interface elements.
- **AlternateProgressWindow** (HWND) - Optional - Handle to a window to use for progress messages.
- **ProgressMessage** (UINT) - Optional - Message to send to the alternate progress window.
- **UseSystemDialogBox** (BOOL) - Optional - Indicates whether to use a system dialog box for progress.

### Request Example
Not applicable (function call)

### Response
#### Success Response
Returns a context value to be used with the default queue callback routine.

#### Response Example
Not applicable (function return value)
```

--------------------------------

### SPFILENOTIFY_STARTSUBQUEUE

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/spfilenotify-startsubqueue

Notification sent to the callback function when the queue starts processing operations in the delete, rename, or copy subqueue. The callback should return zero on error after calling SetLastError, or a nonzero value on success.

```APIDOC
## SPFILENOTIFY_STARTSUBQUEUE

### Description
Notification sent to the callback function when the queue starts to process the operations in the delete, rename, or copy subqueue.

### Parameters
- **Param1** (UINT) - Required - Subqueue that has been started. Can be one of FILEOP_DELETE, FILEOP_RENAME, or FILEOP_COPY.
- **Param2** (UINT) - Required - Number of file copy, rename, or delete operations in the subqueue.

### Return Value
If an error occurs, the callback routine should call SetLastError, specifying the error, and then return zero. The SetupCommitFileQueue function will return FALSE and a subsequent call to GetLastError will return the error code set by the callback routine. If no error occurs, the callback routine should return a nonzero value.

### Requirements
- Minimum supported client: Windows XP [desktop apps only]
- Minimum supported server: Windows Server 2003 [desktop apps only]
- Header: Setupapi.h

### See Also
- Notifications
- SetupCommitFileQueue
- SetupDefaultQueueCallback
```

--------------------------------

### SetupQueryDrivesInDiskSpaceList

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/disk-space-list-functions

Fills a buffer with the drive specifications for all the drives listed in the disk-space list.

```APIDOC
## SetupQueryDrivesInDiskSpaceList

### Description
Fills a buffer with the drive specifications for all the drives listed in the disk-space list.

### Function
SetupQueryDrivesInDiskSpaceList

### Parameters
No parameters are documented in the source.

### Return Value
No return value is documented in the source.
```

--------------------------------

### SetupQueryFileLog

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/using-the-file-log

Retrieves information about a particular file in a file log.

```APIDOC
## SetupQueryFileLog

### Description
Retrieves information about a particular file in a file log.

### Method
Function

### Endpoint
SetupQueryFileLog

### Parameters
#### FileLogHandle
- **FileLogHandle** (HANDLE) - Required - Handle to the file log returned by SetupInitializeFileLog.

### Return Value
Returns information about the specified file.
```

--------------------------------

### SPFILENOTIFY_STARTCOPY notification

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/spfilenotify-startcopy

The SPFILENOTIFY_STARTCOPY notification is sent to the callback function when the queue starts a file copy operation. It provides a FILEPATHS structure and the operation type, and expects a return code indicating whether to abort, perform, or skip the operation.

```APIDOC
## SPFILENOTIFY_STARTCOPY

### Description
The SPFILENOTIFY_STARTCOPY notification is sent to the callback function when the queue starts a file copy operation.

### Parameters
- **Param1** (UINT) - Required - Pointer to a FILEPATHS structure.
- **Param2** (UINT) - Required - Always has the value FILEOP_COPY.

### Return Value
The callback routine should return one of the following values:
- **FILEOP_ABORT** - Abort the queue commit process. The callback routine should call SetLastError to indicate the reason for termination. The SetupCommitFileQueue function returns FALSE and a subsequent call to GetLastError returns the error code set by the callback routine during the call to SetLastError.
- **FILEOP_DOIT** - Perform the file copy operation.
- **FILEOP_SKIP** - Skip the current copy operation.

### Requirements
- Minimum supported client: Windows XP [desktop apps only]
- Minimum supported server: Windows Server 2003 [desktop apps only]
- Header: Setupapi.h

### See Also
- Overview
- Notifications
- FILEPATHS
- SetupCommitFileQueue
- SetupDefaultQueueCallback
```

--------------------------------

### SetupGetInfFileList

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/opening-and-closing-an-inf-file

Retrieves a list of INF files in a specified directory, useful when the exact INF file name is unknown.

```APIDOC
## SetupGetInfFileList

### Description
Obtains a list of INF files in a directory. This is useful when you do not know the name of the INF file you need to open.

### Method
Function

### Endpoint
SetupGetInfFileList

### Parameters
- **DirectoryPath** (string) - Required - The path to the directory to search for INF files.
- **InfStyle** (DWORD) - Optional - The style of the INF files to list.
- **ReturnBuffer** (BYTE*) - Optional - Buffer to receive the list of INF file names.
- **ReturnBufferSize** (DWORD) - Optional - Size of the return buffer.
- **RequiredSize** (DWORD*) - Optional - Pointer to a variable that receives the required buffer size.

### Response
Returns TRUE if successful, FALSE otherwise.
```

--------------------------------

### SetupGetFileCompressionInfo

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Retrieves file compression information from an INF file.

```APIDOC
## SetupGetFileCompressionInfo

### Description
Retrieves file compression information from an INF file.

### Function
SetupGetFileCompressionInfo
```

--------------------------------

### SetupFreeSourceList

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/using-the-mru-source-list

Frees the resources allocated by SetupQuerySourceList.

```APIDOC
## SetupFreeSourceList

### Description
Frees the resources allocated by SetupQuerySourceList.

### Method
Function

### Parameters
- **SourceList** (array of strings) - Required - The array of source paths to free.
- **SourceCount** (UINT) - Required - The number of source paths in the array.
```

--------------------------------

### SetupInitDefaultQueueCallback

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/committing-a-queue

Initializes the context for the default queue callback routine.

```APIDOC
## SetupInitDefaultQueueCallback

### Description
Initializes the context for the default queue callback routine.

### Method
Not applicable (Windows Setup API function)

### Endpoint
Not applicable (Windows Setup API function)

### Parameters
- **Owner** (HWND) - Required - Handle to the window to use as the parent of any user interface elements.

### Request Example
Not applicable (function call)

### Response
#### Success Response
Returns a context value to be used with the default queue callback routine.

#### Response Example
Not applicable (function return value)
```

--------------------------------

### SetupCreateDiskSpaceList

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/disk-space-list-functions

Creates a disk-space list and allocates resources to it.

```APIDOC
## SetupCreateDiskSpaceList

### Description
Creates a disk-space list and allocates resources to it.

### Function
SetupCreateDiskSpaceList

### Parameters
No parameters are documented in the source.

### Return Value
No return value is documented in the source.
```

--------------------------------

### SetupQueryInfVersionInformation

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Queries an INF information structure for version information on one of its constituent INF files.

```APIDOC
## SetupQueryInfVersionInformation

### Description
Queries an INF information structure for version information on one of its constituent INF files.

### Function
SetupQueryInfVersionInformation
```

--------------------------------

### SetupQueueRename

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/file-queue-functions

Queues a file rename operation.

```APIDOC
## SetupQueueRename

### Description
Queues a file rename operation.

### Function
SetupQueueRename
```

--------------------------------

### SetupQueryInfFileInformation

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Queries an INF information structure about its associated INF filenames.

```APIDOC
## SetupQueryInfFileInformation

### Description
Queries an INF information structure about its associated INF filenames.

### Function
SetupQueryInfFileInformation
```

--------------------------------

### SetupDecompressOrCopyFile

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Copies a file and, if necessary, decompresses it.

```APIDOC
## SetupDecompressOrCopyFile

### Description
Copies a file and, if necessary, decompresses it.

### Function
SetupDecompressOrCopyFile
```

--------------------------------

### SetupIterateCabinet

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/cabinet-file-functions

Returns a notification for each file stored in a cabinet file. This function is used to enumerate the contents of a cabinet file.

```APIDOC
## SetupIterateCabinet

### Description
Returns a notification for each file stored in a cabinet file.

### Function
SetupIterateCabinet

### Parameters
No parameters are documented in the source.

### Return Value
Returns a notification for each file stored in a cabinet file.

### Remarks
This function is used with cabinets.
```

--------------------------------

### SetupQuerySpaceRequiredOnDrive

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/disk-space-list-functions

Returns the total amount of disk space required to complete the file operations on a particular drive listed in the disk-space list.

```APIDOC
## SetupQuerySpaceRequiredOnDrive

### Description
Returns the total amount of disk space required to complete the file operations on a particular drive listed in the disk-space list.

### Function
SetupQuerySpaceRequiredOnDrive

### Parameters
No parameters are documented in the source.

### Return Value
No return value is documented in the source.
```

--------------------------------

### SetupTerminateFileLog

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/using-the-file-log

Releases resources allocated during the call to SetupInitializeFileLog.

```APIDOC
## SetupTerminateFileLog

### Description
Releases resources allocated during the call to SetupInitializeFileLog.

### Method
Function

### Endpoint
SetupTerminateFileLog

### Parameters
#### FileLogHandle
- **FileLogHandle** (HANDLE) - Required - Handle to the file log returned by SetupInitializeFileLog.

### Return Value
Returns a Boolean value indicating success or failure.
```

--------------------------------

### SetupFindNextLine

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Returns the next line in a section relative to the Line member of the specified INFCONTEXT structure.

```APIDOC
## SetupFindNextLine

### Description
Returns the next line in a section relative to the Line member of the specified INFCONTEXT structure.

### Function
SetupFindNextLine
```

--------------------------------

### SetupSetDirectoryId

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Associates a new directory identifier with a particular directory.

```APIDOC
## SetupSetDirectoryId

### Description
Associates a new directory identifier with a particular directory.

### Function
SetupSetDirectoryId
```

--------------------------------

### SetupSetPlatformPathOverride

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/file-queue-functions

Sets the platform path override.

```APIDOC
## SetupSetPlatformPathOverride

### Description
Sets the platform path override.

### Function
SetupSetPlatformPathOverride
```

--------------------------------

### SetupCloseInfFile

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/closing-the-file-queue-and-inf-file

Closes the INF file and frees system resources when access to the INF information is no longer needed.

```APIDOC
## SetupCloseInfFile

### Description
Closes the INF file and frees system resources when access to the INF information is no longer needed.

### Function
SetupCloseInfFile

### Parameters
- **InfHandle** (HANDLE) - Required - Handle to the INF file to close, created by SetupOpenFileQueue.

### Remarks
Call this function when access to the INF information is no longer needed.

### Return Value
Not specified in the source.
```

--------------------------------

### SetupQueueCopy

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/file-queue-functions

Queues a file copy operation.

```APIDOC
## SetupQueueCopy

### Description
Queues a file copy operation.

### Function
SetupQueueCopy
```

--------------------------------

### SetupQueueRenameSection

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/file-queue-functions

Queues the files in an INF Rename Files section.

```APIDOC
## SetupQueueRenameSection

### Description
Queues the files in an INF Rename Files section.

### Function
SetupQueueRenameSection
```

--------------------------------

### SetupQueueCopySection

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/file-queue-functions

Queues the files in an INF Copy Files section.

```APIDOC
## SetupQueueCopySection

### Description
Queues the files in an INF Copy Files section.

### Function
SetupQueueCopySection
```

--------------------------------

### SetupFindNextMatchLine

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Returns the next line in a section relative to the Line member of the specified INFCONTEXT that matches a specified key.

```APIDOC
## SetupFindNextMatchLine

### Description
Returns the next line in a section relative to the Line member of the specified INFCONTEXT that matches a specified key.

### Function
SetupFindNextMatchLine
```

--------------------------------

### SetupGetBinaryField

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Retrieves data from a line whose fields are in binary format.

```APIDOC
## SetupGetBinaryField

### Description
Retrieves data from a line whose fields are in binary format.

### Function
SetupGetBinaryField
```

--------------------------------

### SetupScanFileQueue

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/file-queue-functions

Scans the file queue for operations.

```APIDOC
## SetupScanFileQueue

### Description
Scans the file queue for operations.

### Function
SetupScanFileQueue
```

--------------------------------

### SetupOpenAppendInfFile

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/opening-the-inf-file

Appends an INF file to an already open INF file. If the filename is NULL, it searches for a LayoutFile key in the Version section and appends the specified file.

```APIDOC
## SetupOpenAppendInfFile

### Description
Appends an INF file to an already open INF file. If the filename is NULL, it searches for a LayoutFile key in the Version section and appends the specified file.

### Method
Function call

### Endpoint
SetupOpenAppendInfFile

### Parameters
- **Filename** (string) - Optional - The filename of the INF file to append. If NULL, the function searches for a LayoutFile key.

### Response
Returns a handle to the appended INF file.
```

--------------------------------

### SetupGetLineText

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Retrieves the content of a specified line from an INF file.

```APIDOC
## SetupGetLineText

### Description
Retrieves the content of a specified line from an INF file.

### Function
SetupGetLineText
```

--------------------------------

### SetupFindFirstLine

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/inf-file-setup-functions

Finds the first line in a section of an INF file or, if a key is specified, the first line that matches that key. It updates the Line member of an INFCONTEXT structure.

```APIDOC
## SetupFindFirstLine

### Description
Finds the first line in a section of an INF file or, if a key is specified, the first line that matches that key. It updates the Line member of an INFCONTEXT structure.

### Function
SetupFindFirstLine
```

--------------------------------

### SetupAddSectionToDiskSpaceList

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/disk-space-list-functions

Adds all the file operations in a Copy Files or Delete Files section of an INF file to a disk-space list.

```APIDOC
## SetupAddSectionToDiskSpaceList

### Description
Adds all the file operations in a Copy Files or Delete Files section of an INF file to a disk-space list.

### Function
SetupAddSectionToDiskSpaceList

### Parameters
No parameters are documented in the source.

### Return Value
No return value is documented in the source.
```

--------------------------------

### SetupDuplicateDiskSpaceList

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/disk-space-list-functions

Duplicates a disk-space list as a new independent disk-space list.

```APIDOC
## SetupDuplicateDiskSpaceList

### Description
Duplicates a disk-space list as a new independent disk-space list.

### Function
SetupDuplicateDiskSpaceList

### Parameters
No parameters are documented in the source.

### Return Value
No return value is documented in the source.
```

--------------------------------

### SetupQueueDefaultCopy

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/file-queue-functions

Queues the files in an INF Copy Files section using the default information specified in an INF file.

```APIDOC
## SetupQueueDefaultCopy

### Description
Queues the files in an INF Copy Files section using the default information specified in an INF file.

### Function
SetupQueueDefaultCopy
```

--------------------------------

### SetupCopyError

Source: https://learn.microsoft.com/en-us/windows/win32/setupapi/disk-prompting-and-error-handling-functions

Generates a dialog box that informs the user of a copy error.

```APIDOC
## SetupCopyError

### Description
Generates a dialog box that informs the user of a copy error.

### Function
SetupCopyError

### Parameters
None documented.

### Return Value
Not documented.

### Remarks
This function is part of the Windows Setup API and provides a user interface for error handling.
```
Tokens:
Raw