SetupQueueRenameA, fonction (setupapi.h)

Article
08/26/2023

[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 SetupQueueRename place une opération de renommage de fichier individuel dans une file d’attente de fichier d’installation.

Syntaxe

WINSETUPAPI BOOL SetupQueueRenameA(
  [in] HSPFILEQ QueueHandle,
  [in] PCSTR    SourcePath,
  [in] PCSTR    SourceFilename,
  [in] PCSTR    TargetPath,
  [in] PCSTR    TargetFilename
);

Paramètres

[in] QueueHandle

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

[in] SourcePath

Pointeur vers une chaîne terminée par null qui spécifie le chemin d’accès source du fichier à renommer. Si SourceFileName n’est pas spécifié, SourcePath est supposé être le chemin d’accès complet.

[in] SourceFilename

Pointeur vers une chaîne terminée par null qui spécifie la partie du nom de fichier à renommer. S’il n’est pas spécifié, SourcePath est le chemin d’accès complet.

[in] TargetPath

Pointeur vers une chaîne terminée par null qui spécifie le répertoire cible. Lorsque ce paramètre est spécifié, l’opération de renommage est en fait une opération de déplacement. Si TargetPath n’est pas spécifié, le fichier est renommé mais reste à son emplacement actuel.

[in] TargetFilename

Pointeur vers une chaîne terminée par null qui spécifie le nouveau nom du fichier source.

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

Étant donné que les opérations de renommage sont supposées avoir lieu sur un support fixe, l’utilisateur ne sera pas invité à le faire lorsque la file d’attente est validée.

Notes

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

SetupQueueRenameSection