SetupGetTargetPathA, 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 SetupGetTargetPath détermine le répertoire cible d’une section de liste de fichiers. La section de liste de fichiers peut être une section Copier des fichiers , une section Supprimer des fichiers ou une section Renommer des fichiers . Tous les fichiers de la section doivent se trouver dans un répertoire unique répertorié dans une section DestinationDirs du fichier INF.

Syntaxe

WINSETUPAPI BOOL SetupGetTargetPathA(
  [in]      HINF        InfHandle,
  [in]      PINFCONTEXT InfContext,
  [in]      PCSTR       Section,
  [in, out] PSTR        ReturnBuffer,
  [in]      DWORD       ReturnBufferSize,
  [in, out] PDWORD      RequiredSize
);

Paramètres

[in] InfHandle

Gérez le fichier INF de chargement qui contient une section DestinationDirs .

[in] InfContext

Pointeur facultatif vers un contexte INF qui spécifie une ligne dans une section de liste de fichiers dont le répertoire de destination doit être récupéré. Si InfContext a la valeur NULL, le paramètre Section est utilisé.

[in] Section

Paramètre facultatif qui spécifie le nom d’une section du fichier INF dont le handle est InfHandle. SetupGetTargetPath récupère le répertoire cible pour cette section. Le paramètre Section est ignoré si InfContext est spécifié. Si ni InfContext ni Section ne sont spécifiés, la fonction récupère le chemin d’accès cible par défaut à partir du fichier INF. Vous devez utiliser une chaîne terminée par null.

[in, out] ReturnBuffer

Pointeur facultatif vers la mémoire tampon pour recevoir le chemin d’accès cible complet. Le chemin d’accès ne se termine pas par . Vous devez utiliser une chaîne terminée par null. 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. À l’aide de cette technique, vous pouvez éviter les erreurs dues à une taille de mémoire tampon insuffisante. Consultez la section Notes. Ce paramètre peut être NULL.

[in] ReturnBufferSize

Taille de la mémoire tampon pointée par ReturnBuffer, en caractères. Cela inclut la marque de fin null .

[in, out] RequiredSize

Pointeur facultatif vers une variable qui reçoit la taille requise pour la mémoire tampon pointée par ReturnBuffer, en caractères. Cela inclut la marque de fin null . Si la taille réelle nécessaire est supérieure à la valeur spécifiée par ReturnBufferSize, la fonction échoue et un appel à GetLastError retourne ERROR_INSUFFICIENT_BUFFER.

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

Si cette fonction est appelée avec un ReturnBuffernull et un ReturnBufferSize 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 RequiredSize. Si la fonction réussit dans ce cas, la valeur de retour est une valeur différente de zéro. Sinon, la valeur de retour est zéro et des informations d’erreur étendues peuvent être obtenues en appelant GetLastError.

Notes

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

SetupGetSourceFileLocation

SetupGetSourceFileSize

SetupGetSourceInfo