SetupCommitFileQueueW-Funktion (setupapi.h)
[Diese Funktion steht für die Verwendung in den im Abschnitt "Anforderungen" angegebenen Betriebssystemen zur Verfügung. Sie kann in nachfolgenden Versionen geändert oder nicht verfügbar sein. 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 für die Installation von Gerätetreibern verwendet.]
Die SetupCommitFileQueue-Funktion führt Dateivorgänge in die Warteschlange einer Setupdateiwarteschlange aus.
Die bewährte Methode besteht darin, alle erforderlichen Dateivorgänge für die Dateiwarteschlange zu sammeln und die Warteschlange nur einmal zu übernehmen, 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 Commit für eine Warteschlange.
Wenn eine Datei geändert wird, ist der Aufrufer dieser Funktion erforderlich, um in das Zielverzeichnis zu schreiben.
Syntax
WINSETUPAPI BOOL SetupCommitFileQueueW(
[in] HWND Owner,
[in] HSPFILEQ QueueHandle,
[in] PSP_FILE_CALLBACK_W MsgHandler,
[in] PVOID Context
);
Parameter
[in] Owner
Optionales Handle für ein Fenster, das als übergeordnetes Element aller Statusdialogfelder verwendet werden soll.
[in] QueueHandle
Behandeln Sie eine Setupdateiwarteschlange, wie von SetupOpenFileQueuezurückgegeben.
[in] MsgHandler
Zeigen Sie auf eine optionale Rückrufroutine, um über verschiedene wichtige Ereignisse benachrichtigt zu werden, die sich in der Warteschlangenverarbeitung befinden. Weitere Informationen finden Sie unter Default Queue Callback Routine oder FileCallback If the callback routine is null, SetupCommitFileQueue returns TRUE and the error is 0 or NO_ERROR.
[in] Context
Wert, der an die rückruffunktion übergeben wird, die vom MsgHandler Parameter bereitgestellt wird. Wenn die Standardrückrufroutine als MsgHandlerangegeben wurde, muss dieser Kontext der kontext sein, der von SetupInitDefaultQueueCallback oder SetupInitDefaultQueueCallbackExzurückgegeben wird.
Rückgabewert
Wenn die Funktion erfolgreich ist, ist der Rückgabewert ein Wert ungleich Null.
Wenn die Funktion fehlschlägt, ist der Rückgabewert null. Rufen Sie GetLastErrorauf, um erweiterte Fehlerinformationen zu erhalten.
Bemerkungen
Die in MsgHandler- angegebene Rückrufroutine sollte mit den Parametern kompatibel sein, die SetupCommitFileQueue während eines Warteschlangen-Commits an sie übergeben werden.
Wenn Unicode in Ihrer Rückrufanwendung definiert ist und Sie MsgHandler als Standardrückrufroutine der Warteschlange angeben, erwartet die Rückrufroutine Unicode-Parameter. Andernfalls erwartet die Standardmäßige Warteschlangenrückrufroutine ANSI-Parameter.
Anmerkung
Der Header setupapi.h definiert SetupCommitFileQueue 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 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 |
|---|---|
| mindestens unterstützte Client- | Windows XP [nur Desktop-Apps] |
| mindestens unterstützte Server- | Windows Server 2003 [Nur Desktop-Apps] |
| Zielplattform- | Fenster |
| Header- | setupapi.h |
| Library | Setupapi.lib |
| DLL- | Setupapi.dll |