SetupPromptForDiskA, 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 SetupPromptForDisk affiche une boîte de dialogue qui invite l’utilisateur à entrer un disque.
Syntaxe
WINSETUPAPI UINT SetupPromptForDiskA(
[in] HWND hwndParent,
[in] PCSTR DialogTitle,
[in] PCSTR DiskName,
[in] PCSTR PathToSource,
[in] PCSTR FileSought,
[in] PCSTR TagFile,
[in] DWORD DiskPromptStyle,
[in, out] PSTR PathBuffer,
[in] DWORD PathBufferSize,
[in, out] PDWORD PathRequiredSize
);
Paramètres
[in] hwndParent
Gérez la fenêtre parente de cette boîte de dialogue.
[in] DialogTitle
Pointeur facultatif vers une chaîne null-terminated spécifiant le titre de la boîte de dialogue. Si ce paramètre est NULL, la valeur par défaut « »%s--Files Nécessaire » (localisée) est utilisée. Le «%s» est remplacé par le texte récupéré à partir de la fenêtre parente. Si aucun texte n’est récupéré à partir de la fenêtre parente, le titre est « Fichiers nécessaires ».
[in] DiskName
Pointeur facultatif vers une chaîne null-terminated spécifiant le nom du disque à insérer. Si ce paramètre est null, la valeur par défaut « (inconnu) » (localisée) est utilisée.
[in] PathToSource
Pointeur facultatif vers une chaîne null-terminated spécifiant la partie chemin d’accès de l’emplacement attendu du fichier, par exemple F :\x86. S’il n’est pas spécifié, le chemin d’accès où SetupPromptForDisk le plus récemment situé dans un fichier est utilisé. Si cette liste est vide, une valeur système par défaut est utilisée.
[in] FileSought
Pointeur vers une chaîne null-terminated spécifiant le nom du fichier nécessaire (partie nom de fichier uniquement). Le nom de fichier s’affiche si l’utilisateur clique sur le bouton Parcourir
[in] TagFile
Pointeur facultatif vers une chaîne null-terminated spécifiant un fichier de balise (partie nom de fichier uniquement) qui identifie la présence d’un volume de média amovible particulier. Si le chemin actuellement sélectionné place le fichier sur un média amovible et qu’un fichier de balise est spécifié, SetupPromptForDisk recherche le fichier de balise à la racine du lecteur pour déterminer s’il faut continuer.
Par exemple, si PathToSource est A :\x86, le tagfile est disk1.tag et l’utilisateur tape B :\x86 dans le contrôle de modification de la boîte de dialogue d’invite, la routine recherche B :\disk1.tag pour déterminer s’il faut continuer. Si le fichier de balise est introuvable, la fonction recherche le tagfile à l’aide de PathToSource.
Si aucun fichier d’étiquette n’est spécifié, le support amovible fonctionne comme un média non amovible et FileSought est recherché avant de continuer.
[in] DiskPromptStyle
Spécifie le comportement de la boîte de dialogue. Ce paramètre peut être une combinaison des indicateurs suivants.
IDF_CHECKFIRST
Vérifiez le fichier/disque avant d’afficher la boîte de dialogue d’invite et, le cas échéant, retournez DPROMPT_SUCCESS immédiatement.
IDF_NOBEEP
Empêchez la boîte de dialogue de pleurer pour attirer l’attention de l’utilisateur lors de sa première apparition.
IDF_NOBROWSE
N’affichez pas l’option Parcourir.
IDF_NOCOMPRESSED
Ne recherchez pas les versions compressées du fichier source.
IDF_NODETAILS
N’affichez pas d’informations détaillées.
IDF_NOFOREGROUND
Empêcher la boîte de dialogue de devenir la fenêtre de premier plan.
IDF_NOSKIP
N’affichez pas l’option Ignorer.
IDF_OEMDISK
Demander un disque fourni par un fabricant de matériel.
IDF_WARNIFSKIP
Avertir l’utilisateur qui ignore un fichier peut affecter l’installation.
[in, out] PathBuffer
Pointeur facultatif vers une mémoire tampon qui, lors du retour, reçoit le chemin d’accès (aucun nom de fichier) de l’emplacement spécifié par l’utilisateur via la boîte de dialogue. Vous devez utiliser une chaîne null-terminated. La chaîne null-terminated ne doit pas dépasser la taille de la mémoire tampon de destination. Vous pouvez appeler la fonction une fois pour obtenir la taille de mémoire tampon requise, allouer la mémoire nécessaire, puis appeler la fonction une deuxième fois pour récupérer les données. Cette technique vous permet d’éviter les erreurs en raison d’une taille de mémoire tampon insuffisante. Consultez la section Remarques.
[in] PathBufferSize
Taille de la mémoire tampon pointée par PathBuffer, en caractères. Il devrait être au moins MAX_PATH long. Cela inclut la la marque de fin de null.
[in, out] PathRequiredSize
Pointeur facultatif vers une variable qui reçoit la taille requise pour PathBuffer, en caractères. Cela inclut la la marque de fin de null.
Valeur de retour
La fonction retourne l’une des valeurs suivantes.
Pour obtenir des informations d’erreur étendues, appelez GetLastError.
Remarques
Si cette fonction est appelée avec un PathBuffer de NULL et un PathBufferSize de zéro, la fonction place la taille de mémoire tampon nécessaire pour contenir les données spécifiées dans la variable pointée par PathRequiredSize. Si la fonction réussit dans ce cas, la valeur de retour est NO_ERROR. Sinon, la valeur de retour est l’une des valeurs décrites dans la section Valeurs de retour.
Note
L’en-tête setupapi.h définit SetupPromptForDisk 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. 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 |