SetupCommitFileQueueA, fonction (setupapi.h)
[Cette fonction est disponible pour une utilisation dans les systèmes d’exploitation indiqués dans la section Configuration requise. Il peut être modifié ou indisponible dans les versions ultérieures. SetupAPI ne doit plus être utilisé pour installer des applications. Utilisez plutôt Windows Installer pour développer des programmes d’installation d’applications. SetupAPI continue d’être utilisé pour installer des pilotes de périphérique.]
La fonction SetupCommitFileQueue effectue des opérations de fichier mises en file d’attente sur une file d’attente de fichiers d’installation.
La meilleure pratique consiste à collecter toutes les opérations de fichier requises pour la file d’attente de fichiers et à valider la file d’attente une seule fois, car une file d’attente de fichiers ne peut pas être réutilisée une fois qu’elle a été validée. Si un traitement supplémentaire de la file d’attente est nécessaire une fois qu’il a été validé, le handle de la file d’attente doit être fermé et une nouvelle file d’attente de fichiers créée. Pour plus d’informations, consultez Commiting a Queue.
Si un fichier est modifié, l’appelant de cette fonction doit disposer de privilèges d’écriture dans le répertoire cible.
Syntaxe
WINSETUPAPI BOOL SetupCommitFileQueueA(
[in] HWND Owner,
[in] HSPFILEQ QueueHandle,
[in] PSP_FILE_CALLBACK_A MsgHandler,
[in] PVOID Context
);
Paramètres
[in] Owner
Handle facultatif vers une fenêtre à utiliser comme parent de toutes les boîtes de dialogue de progression.
[in] QueueHandle
Gérez une file d’attente de fichiers d’installation, comme retourné par SetupOpenFileQueue.
[in] MsgHandler
Pointeur vers une routine de rappel facultative pour être averti de divers événements significatifs qui se trouvent dans le traitement de la file d’attente. Pour plus d’informations, consultez routine de rappel de file d’attente par défaut ou FileCallback Si la routine de rappel est null, SetupCommitFileQueue retourne TRUE et que l’erreur est 0 ou NO_ERROR.
[in] Context
Valeur transmise à la fonction de rappel fournie par le paramètre MsgHandler. Si la routine de rappel par défaut a été spécifiée comme MsgHandler, ce contexte doit être le contexte retourné par SetupInitDefaultQueueCallback ou SetupInitDefaultQueueCallbackEx.
Valeur de retour
Si la fonction réussit, la valeur de retour est une valeur différente de zéro.
Si la fonction échoue, la valeur de retour est égale à zéro. Pour obtenir des informations d’erreur étendues, appelez GetLastError.
Remarques
La routine de rappel spécifiée dans msgHandler doit être compatible avec les paramètres qui SetupCommitFileQueue transmises lors d’une validation de file d’attente.
Si Unicode est défini dans votre application de rappel et que vous spécifiez MsgHandler comme routine de rappel de file d’attente par défaut, la routine de rappel attend les paramètres Unicode. Sinon, la routine de rappel de file d’attente par défaut attend les paramètres ANSI.
Note
L’en-tête setupapi.h définit SetupCommitFileQueue en tant qu’alias qui sélectionne automatiquement la version ANSI ou Unicode de cette fonction en fonction de la définition de la constante de préprocesseur UNICODE. Le mélange de l’utilisation de l’alias neutre en encodage avec du code qui n’est pas neutre en encodage peut entraîner des incompatibilités qui entraînent des erreurs de compilation ou d’exécution. Pour plus d’informations, consultez Conventions pour les prototypes de fonction.
Exigences
| Exigence | Valeur |
|---|---|
| client minimum pris en charge | Windows XP [applications de bureau uniquement] |
| serveur minimum pris en charge | Windows Server 2003 [applications de bureau uniquement] |
| plateforme cible | Windows |
| d’en-tête | setupapi.h |
| bibliothèque | Setupapi.lib |
| DLL | Setupapi.dll |