SetupQueueRenameW-Funktion (setupapi.h)

Artikel
03/01/2024

[Diese Funktion ist für die Verwendung in den Betriebssystemen verfügbar, die im Abschnitt "Anforderungen" angegeben sind. Es kann in nachfolgenden Versionen geändert oder entfernt werden. SetupAPI sollte nicht mehr für die Installation von Anwendungen verwendet werden. Verwenden Sie stattdessen den Windows Installer zum Entwickeln von Anwendungsinstallationsprogrammen. SetupAPI wird weiterhin zum Installieren von Gerätetreibern verwendet.]

Die SetupQueueRename-Funktion platziert einen einzelnen Dateibenennungsvorgang in einer Setupdateiwarteschlange.

Syntax

WINSETUPAPI BOOL SetupQueueRenameW(
  [in] HSPFILEQ QueueHandle,
  [in] PCWSTR   SourcePath,
  [in] PCWSTR   SourceFilename,
  [in] PCWSTR   TargetPath,
  [in] PCWSTR   TargetFilename
);

Parameter

[in] QueueHandle

Behandeln Sie eine Setupdateiwarteschlange, wie sie von SetupOpenFileQueue zurückgegeben wird.

[in] SourcePath

Zeiger auf eine NULL-Zeichenfolge, die den Quellpfad der umzubenennten Datei angibt. Wenn SourceFileName nicht angegeben ist, wird davon ausgegangen, dass SourcePath der vollständige Pfad ist.

[in] SourceFilename

Zeiger auf eine null-beendete Zeichenfolge, die den Dateinamenteil der datei angibt, der umbenannt werden soll. Wenn nicht angegeben, ist SourcePath der vollständige Pfad.

[in] TargetPath

Zeiger auf eine NULL-beendete Zeichenfolge, die das Zielverzeichnis angibt. Wenn dieser Parameter angegeben wird, ist der Umbenennungsvorgang tatsächlich ein Verschiebungsvorgang. Wenn TargetPath nicht angegeben ist, wird die Datei umbenannt, bleibt aber an ihrem aktuellen Speicherort.

[in] TargetFilename

Zeiger auf eine NULL-Zeichenfolge, die den neuen Namen für die Quelldatei angibt.

Rückgabewert

Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein Nichtzero-Wert.

Wenn die Funktion fehlerhaft ist, ist der Rückgabewert null. Um erweiterte Fehlerinformationen zu erhalten, rufen Sie GetLastError auf.

Hinweise

Da von Umbenennungsvorgängen auf festen Medien ausgegangen wird, wird der Benutzer beim Commit für die Warteschlange nicht aufgefordert.

Hinweis

Der setupapi.h-Header definiert SetupQueueRename als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit nicht codierungsneutralem Code kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	setupapi.h
Bibliothek	Setupapi.lib
DLL	Setupapi.dll