SetupQueueRenameSectionA function (setupapi.h)

Article
02/09/2023

[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 SetupQueueRenameSection function queues a section in an INF file for renaming. The section must be in the correct rename list section format and the INF file must contain a DestinationDirs section.

Syntax

WINSETUPAPI BOOL SetupQueueRenameSectionA(
  [in] HSPFILEQ QueueHandle,
  [in] HINF     InfHandle,
  [in] HINF     ListInfHandle,
  [in] PCSTR    Section
);

Parameters

[in] QueueHandle

Handle to a setup file queue, as returned by SetupOpenFileQueue.

[in] InfHandle

Handle to the INF file that contains the DestinationDirs section. If ListInfHandle is not specified, InfHandle contains the section name.

[in] ListInfHandle

Optional handle to an INF file that contains the section to queue for renaming. If ListInfHandle is not specified, InfHandle is assumed to contain the section name.

[in] Section

Name of the section to be queued for renaming.

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.

Remarks

You cannot queue file moves with SetupQueueRenameSection because the form of a rename list section limits section renaming to within the same directory.

This function requires a Windows INF file. Some older INF file formats may not be supported.

Note

The setupapi.h header defines SetupQueueRenameSection as an alias which 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 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]
Target Platform	Windows
Header	setupapi.h
Library	Setupapi.lib
DLL	Setupapi.dll