SetupGetSourceInfoA, 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 SetupGetSourceInfo récupère le chemin d’accès, le fichier d’étiquette ou la description du média d’une source répertoriée dans un fichier INF.
Syntaxe
WINSETUPAPI BOOL SetupGetSourceInfoA(
[in] HINF InfHandle,
[in] UINT SourceId,
[in] UINT InfoDesired,
[in, out] PSTR ReturnBuffer,
[in] DWORD ReturnBufferSize,
[in, out] PDWORD RequiredSize
);
Paramètres
[in] InfHandle
Gérez vers un fichier INF ouvert qui contient une section SourceDisksNames . Si des sections spécifiques à la plateforme existent pour le système de l’utilisateur (par exemple, SourceDisksNames.x86), la section spécifique à la plateforme est utilisée.
[in] SourceId
Identificateur d’un média source. Cette valeur est utilisée pour effectuer une recherche par clé dans la section SourceDisksNames .
[in] InfoDesired
Indique les informations souhaitées. Une seule valeur peut être spécifiée par appel de fonction, et elles ne peuvent pas être combinées. Les types d’informations suivants peuvent être récupérés à partir d’une section SourceDisksNames .
SRCINFO_PATH
Chemin d’accès spécifié pour la source. Il ne s’agit pas d’un chemin complet, mais du chemin d’accès relatif à la racine d’installation.
SRCINFO_TAGFILE
Fichier d’étiquette qui identifie le média source, ou si des armoires sont utilisées, le nom du fichier d’armoire.
SRCINFO_DESCRIPTION
Description du média.
[in, out] ReturnBuffer
Pointeur facultatif vers une mémoire tampon pour recevoir les informations récupérées. Les retours de chemin d’accès ne se terminent pas par . Vous devez utiliser une chaîne terminée par null. La chaîne terminée par un caractère Null 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. Consultez la section Notes. À l’aide de cette technique, vous pouvez éviter les erreurs dues à une taille de mémoire tampon insuffisante. 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 spécifiée par ReturnBuffer, en caractères. Cela inclut la marque de fin null . Si ReturnBuffer est spécifié et que 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 SetupGetSourceInfo 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 |