SetupCommitFileQueueA, fonction (setupapi.h)

[Cette fonction peut être utilisée dans les systèmes d’exploitation indiqués dans la section Configuration requise. Il sera 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 les pilotes de périphérique.]

La fonction SetupCommitFileQueue effectue des opérations de fichier mis en file d’attente dans une file d’attente de fichier 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 après sa validation, le handle de la file d’attente doit être fermé et une nouvelle file d’attente de fichiers doit être créée. Pour plus d’informations, consultez Validation d’une file d’attente.

Si un fichier est modifié, l’appelant de cette fonction doit disposer de privilèges pour écrire 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 pour une fenêtre à utiliser comme parent de toute boîte de dialogue de progression.

[in] QueueHandle

Gérez dans une file d’attente de fichier d’installation, comme retourné par SetupOpenFileQueue.

[in] MsgHandler

Pointeur vers une routine de rappel facultative pour être informé de divers événements importants qui se trouvent dans 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 a la valeur null, SetupCommitFileQueue retourne TRUE et l’erreur est 0 ou NO_ERROR.

[in] Context

Valeur passée à la fonction de rappel fournie par le paramètre MsgHandler . Si la routine de rappel par défaut a été spécifiée en tant que MsgHandler, ce contexte doit être le contexte retourné par SetupInitDefaultQueueCallback ou SetupInitDefaultQueueCallbackEx.

Valeur retournée

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étaillées sur l’erreur, appelez GetLastError.

Remarques

La routine de rappel spécifiée dans MsgHandler doit être compatible avec les paramètres que SetupCommitFileQueue lui a transmis 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 des paramètres Unicode. Sinon, la routine de rappel de file d’attente par défaut attend des paramètres ANSI.

Notes

L’en-tête setupapi.h définit SetupCommitFileQueue comme 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. La combinaison 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.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows XP [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	setupapi.h
Bibliothèque	Setupapi.lib
DLL	Setupapi.dll

Voir aussi

Fonctions

Vue d'ensemble

SetupCloseFileQueue