SetupCommitFileQueueA-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 SetupCommitFileQueue-Funktion führt Dateivorgänge aus, die in einer Setupdateiwarteschlange in die Warteschlange eingereiht werden.
Die bewährte Methode besteht darin, alle erforderlichen Dateivorgänge für die Dateiwarteschlange zu sammeln und die Warteschlange nur einmal zu committen, da eine Dateiwarteschlange nach dem Commit nicht wiederverwendet werden kann. Wenn nach dem Commit eine zusätzliche Verarbeitung der Warteschlange erforderlich ist, sollte das Handle für die Warteschlange geschlossen und eine neue Dateiwarteschlange erstellt werden. Weitere Informationen finden Sie unter Committen einer Warteschlange.
Wenn eine Datei geändert wird, muss der Aufrufer dieser Funktion über Berechtigungen zum Schreiben in das Zielverzeichnis verfügen.
Syntax
WINSETUPAPI BOOL SetupCommitFileQueueA(
[in] HWND Owner,
[in] HSPFILEQ QueueHandle,
[in] PSP_FILE_CALLBACK_A MsgHandler,
[in] PVOID Context
);
Parameter
[in] Owner
Optionales Handle für ein Fenster, das als übergeordnetes Element aller Statusdialogfelder verwendet werden soll.
[in] QueueHandle
Handle für eine Setupdateiwarteschlange, wie von SetupOpenFileQueue zurückgegeben.
[in] MsgHandler
Zeiger auf eine optionale Rückrufroutine, um über verschiedene wichtige Ereignisse benachrichtigt zu werden, die sich in der Warteschlangenverarbeitung befinden. Weitere Informationen finden Sie unter Standardwarteschlangenrückrufroutine oder FileCallback Wenn die Rückrufroutine NULL ist, gibt SetupCommitFileQueueTRUE zurück, und der Fehler ist 0 oder NO_ERROR.
[in] Context
Wert, der an die vom MsgHandler-Parameter bereitgestellte Rückruffunktion übergeben wird. Wenn die Standardrückrufroutine als MsgHandler angegeben wurde, muss dieser Kontext der Kontext sein, der von SetupInitDefaultQueueCallback oder SetupInitDefaultQueueCallbackEx zurückgegeben wird.
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
Die in MsgHandler angegebene Rückrufroutine sollte mit den Parametern kompatibel sein, die SetupCommitFileQueue während eines Warteschlangencommit-Commits an sie übergeben hat.
Wenn Unicode in Ihrer Rückrufanwendung definiert ist und Sie MsgHandler als Standard-Warteschlangenrückrufroutine angeben, erwartet die Rückrufroutine Unicode-Parameter. Andernfalls erwartet die Standardmäßige Warteschlangenrückrufroutine ANSI-Parameter.
Hinweis
Der Setupapi.h-Header definiert SetupCommitFileQueue 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 |