SetupQueueRenameA-Funktion (setupapi.h)
[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 zum Installieren von Anwendungen verwendet werden. Verwenden Sie stattdessen den Windows Installer zum Entwickeln von Installationsprogrammen für Anwendungen. SetupAPI wird weiterhin zum Installieren von Gerätetreibern verwendet.]
Die SetupQueueRename-Funktion platziert einen einzelnen Dateibenennungsvorgang in einer Setupdateiwarteschlange.
Syntax
WINSETUPAPI BOOL SetupQueueRenameA(
[in] HSPFILEQ QueueHandle,
[in] PCSTR SourcePath,
[in] PCSTR SourceFilename,
[in] PCSTR TargetPath,
[in] PCSTR TargetFilename
);
Parameter
[in] QueueHandle
Handle für eine Setupdateiwarteschlange, wie von SetupOpenFileQueue zurückgegeben.
[in] SourcePath
Zeiger auf eine NULL-endende Zeichenfolge, die den Quellpfad der datei angibt, die umbenannt werden soll. Wenn SourceFileName nicht angegeben ist, wird davon ausgegangen, dass SourcePath der vollständige Pfad ist.
[in] SourceFilename
Zeiger auf eine NULL-endende Zeichenfolge, die den Dateinamenteil der datei angibt, die umbenannt werden soll. Wenn nicht angegeben, ist SourcePath der vollständige Pfad.
[in] TargetPath
Zeiger auf eine NULL-endende 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, verbleibt aber am aktuellen Speicherort.
[in] TargetFilename
Zeiger auf eine NULL-endende Zeichenfolge, die den neuen Namen für die Quelldatei angibt.
Rückgabewert
Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein Wert ungleich null.
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 die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante automatisch auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit Code, der nicht Codierungsneutral ist, 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 |