Fonction SetupCopyErrorA (setupapi.h)

Article
08/26/2023

[Cette fonction est disponible pour une utilisation 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 l’installation d’applications. Utilisez plutôt Windows Installer pour développer des programmes d’installation d’applications. SetupAPI continue d’être utilisé pour l’installation des pilotes de périphérique.]

La fonction SetupCopyError génère une boîte de dialogue pour notifier un utilisateur d’une erreur de fichier de copie.

Syntaxe

WINSETUPAPI UINT SetupCopyErrorA(
  [in]      HWND   hwndParent,
  [in]      PCSTR  DialogTitle,
  [in]      PCSTR  DiskName,
  [in]      PCSTR  PathToSource,
  [in]      PCSTR  SourceFile,
  [in]      PCSTR  TargetPathFile,
  [out]     UINT   Win32ErrorCode,
  [in]      DWORD  Style,
  [in, out] PSTR   PathBuffer,
  [in]      DWORD  PathBufferSize,
  [in, out] PDWORD PathRequiredSize
);

Paramètres

[in] hwndParent

Handle de la fenêtre parente de cette boîte de dialogue.

[in] DialogTitle

Pointeur facultatif vers une chaîne terminée par null qui spécifie le titre de la boîte de dialogue.

Ce paramètre peut être NULL. Si ce paramètre a la valeur NULL, le titre par défaut « Erreur de copie » (localisé dans la langue système) est utilisé.

[in] DiskName

Pointeur facultatif vers une chaîne terminée par null qui spécifie le nom du disque à insérer.

Ce paramètre peut être NULL. Si ce paramètre a la valeur NULL, le nom par défaut « (Inconnu) » (localisé dans la langue système) est utilisé.

[in] PathToSource

Pointeur vers le composant de chemin d’accès du fichier source où une opération échoue, par exemple F :\x86.

Utilisez une chaîne terminée par null.

[in] SourceFile

Pointeur vers une chaîne terminée par null qui spécifie la partie de nom de fichier du fichier où une opération échoue.

Utilisez une chaîne terminée par null. Ce nom de fichier s’affiche si l’utilisateur clique sur les boutons Détails ou Parcourir . La fonction SetupCopyError recherche le fichier qui utilise ses noms de formulaire compressé. Par conséquent, vous pouvez passer cmd.exe et ne pas vous soucier que le fichier existe réellement en tant que cmd.ex_ sur le média source.

[in] TargetPathFile

Pointeur facultatif vers une chaîne terminée par null qui spécifie le chemin d’accès complet du fichier cible pour les opérations de renommage et de copie.

Utilisez une chaîne terminée par null. Ce paramètre peut être NULL. Si TargetPathFile n’est pas spécifié, « (Inconnu) » (localisé dans la langue système) est utilisé.

[out] Win32ErrorCode

Si une erreur se produit, ce membre est le code d’erreur système.

Si aucune erreur ne se produit, elle est NO_ERROR.

[in] Style

Les indicateurs qui contrôlent affichent la mise en forme et le comportement d’une boîte de dialogue.

Ce paramètre peut être l’un des indicateurs suivants.

IDF_NOBROWSE

N’affichez pas l’option parcourir.

IDF_NOSKIP

N’affichez pas l’option ignorer le fichier.

IDF_NODETAILS

N’affichez pas l’option détails.

Si cet indicateur est défini, les paramètres TargetPathFile et Win32ErrorCode peuvent être omis.

IDF_NOCOMPRESSED

Ne case activée pas pour les versions compressées du fichier source.

IDF_OEMDISK

La source d’opération est un disque fourni par un fabricant de matériel.

IDF_NOBEEP

Empêche la boîte de dialogue de biper pour attirer l’attention de l’utilisateur lorsqu’elle s’affiche pour la première fois.

IDF_NOFOREGROUND

Empêche la boîte de dialogue de devenir la fenêtre de premier plan.

IDF_WARNIFSKIP

Avertit l’utilisateur que le fait d’ignorer un fichier peut affecter l’installation.

[in, out] PathBuffer

Pointeur facultatif vers une variable dans laquelle cette fonction retourne le chemin d’accès (sans le nom de fichier) de l’emplacement spécifié par un utilisateur dans la boîte de dialogue. Vous devez utiliser une chaîne terminée par null.

La chaîne terminée par null ne doit pas dépasser la taille de la mémoire tampon de destination. Pour éviter des erreurs de mémoire tampon insuffisantes, PathBuffer doit être au moins MAX_PATH. Pour plus d’informations, consultez la section Remarques de cette rubrique.

[in] PathBufferSize

Taille de la mémoire tampon vers laquelle PathBuffer pointe, en caractères.

La taille de la mémoire tampon doit être d’au moins MAX_PATH caractères, y compris la fin null .

[in, out] PathRequiredSize

Pointeur facultatif vers une variable dans laquelle cette fonction retourne la taille de mémoire tampon requise, en caractères, y compris la terminaison null .

Valeur retournée

La fonction retourne l’une des valeurs suivantes.

Pour obtenir des informations détaillées sur l’erreur, appelez GetLastError.

Remarques

Si cette fonction est appelée avec un PathBuffernull et un PathBufferSize de 0 (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, la valeur de retour est NO_ERROR. Sinon, la valeur de retour est l’une des valeurs spécifiées.

Pour éviter des erreurs de mémoire tampon insuffisantes, ReturnBuffer doit être au moins MAX_PATH.

Notes

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

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