MsiSourceListGetInfoA, fonction (msi.h)

La fonction MsiSourceListGetInfo récupère des informations sur la liste source d’un produit ou d’un correctif dans un contexte spécifique.

Syntaxe

UINT MsiSourceListGetInfoA(
  [in]                LPCSTR            szProductCodeOrPatchCode,
  [in, optional]      LPCSTR            szUserSid,
  [in]                MSIINSTALLCONTEXT dwContext,
  [in]                DWORD             dwOptions,
  [in]                LPCSTR            szProperty,
  [out, optional]     LPSTR             szValue,
  [in, out, optional] LPDWORD           pcchValue
);

Paramètres

[in] szProductCodeOrPatchCode

L'ProductCode ou le GUID du correctif du produit ou du correctif. Utilisez une chaîne terminée par null. Si la chaîne dépasse 39 caractères, la fonction échoue et retourne ERROR_INVALID_PARAMETER. Ce paramètre ne peut pas être NULL.

[in, optional] szUserSid

Ce paramètre peut être un identificateur de sécurité de chaîne (SID) qui spécifie le compte d’utilisateur qui contient le produit ou le correctif. Le SID n’est pas validé ou résolu. Un SID incorrect peut retourner ERROR_UNKNOWN_PRODUCT ou ERROR_UNKNOWN_PATCH. Lors du référencement d’un contexte d’ordinateur, szUserSID doit être NULL et dwContext doit être MSIINSTALLCONTEXT_MACHINE.

Type de SID Signification
NULL
NULL indique l’utilisateur actuellement connecté. Lorsque vous référencez le compte d’utilisateur actuel, szUserSID peut être NULL et dwContext peut être MSIINSTALLCONTEXT_USERMANAGED ou MSIINSTALLCONTEXT_USERUNMANAGED.
SID utilisateur
Spécifie l’énumération d’un utilisateur spécifique dans le système. Un exemple de SID utilisateur est « S-1-3-64-2415071341-135809878-3127455600-2561 ».
 
Remarque La chaîne SID spéciale s-1-5-18 (système) ne peut pas être utilisée pour énumérer les produits ou correctifs installés en tant que machine. La définition de la valeur SID sur s-1-5-18 retourne ERROR_INVALID_PARAMETER.
 
Remarque La chaîne SID spéciale s-1-1-0 (tout le monde) ne doit pas être utilisée. La définition de la valeur SID sur s-1-1-0 échoue et retourne ERROR_INVALID_PARAM.
 

[in] dwContext

Ce paramètre spécifie le contexte de l’instance de produit ou de correctif. Ce paramètre peut contenir l’une des valeurs suivantes.

Type de contexte Signification
MSIINSTALLCONTEXT_USERMANAGED
L’instance de produit ou de correctif existe dans le contexte géré par l’utilisateur.
MSIINSTALLCONTEXT_USERUNMANAGED
L’instance de produit ou de correctif existe dans le contexte non managé par utilisateur.
MSIINSTALLCONTEXT_MACHINE
L’instance de produit ou de correctif existe dans le contexte par machine.

[in] dwOptions

La valeur dwOptions spécifie la signification de szProductCodeOrPatchCode.

Drapeau Signification
MSICODE_PRODUCT
szProductCodeOrPatchCode est un GUID de code de produit.
MSICODE_PATCH
szProductCodeOrPatchCode est un GUID de code de correctif.

[in] szProperty

Chaîne terminée par null qui spécifie la valeur de propriété à récupérer. Le paramètre szProperty peut être l’une des valeurs suivantes.

Nom Signification
INSTALLPROPERTY_MEDIAPACKAGEPATH
« MediaPackagePath »
Chemin relatif à la racine du support d’installation.
INSTALLPROPERTY_DISKPROMPT
« DiskPrompt »
Modèle d’invite utilisé lors de l’invite de l’utilisateur pour le support d’installation.
INSTALLPROPERTY_LASTUSEDSOURCE
« LastUsedSource »
Emplacement source le plus récent utilisé pour le produit.
INSTALLPROPERTY_LASTUSEDTYPE
« LastUsedType »
Un « n » si la dernière source utilisée est un emplacement réseau. Un « u » si la dernière source utilisée est un emplacement d’URL. Un « m » si la dernière source utilisée est un média. Chaîne vide («  ») si aucune source n’est utilisée pour la dernière fois.
INSTALLPROPERTY_PACKAGENAME
« PackageName »
Nom du package Windows Installer ou du package de correctifs sur la source.

[out, optional] szValue

Mémoire tampon de sortie qui reçoit les informations. Cette mémoire tampon doit être suffisamment grande pour contenir les informations. Si la mémoire tampon est trop petite, la fonction retourne ERROR_MORE_DATA et définit *pcchValue le nombre d'TCHAR dans la valeur, sans inclure le caractère NULL de fin.

Si le szValue est défini sur NULL et pcchValue est défini sur un pointeur valide, la fonction retourne ERROR_SUCCESS et définit *pcchValue le nombre de TCHAR dans la valeur, sans inclure le caractère NULL de fin. La fonction peut ensuite être appelée à nouveau pour récupérer la valeur, avec szValue mémoire tampon suffisamment grande pour contenir *pcchValue + 1 caractères.

Si szValue et pcchValue sont tous deux définis sur NULL, la fonction retourne ERROR_SUCCESS si la valeur existe, sans récupérer la valeur.

[in, out, optional] pcchValue

Pointeur vers une variable qui spécifie le nombre de TCHAR dans la mémoire tampon szValue. Lorsque la fonction est retournée, ce paramètre est défini sur la taille de la valeur demandée si la fonction copie la valeur dans la mémoire tampon spécifiée. La taille est retournée en tant que nombre de TCHAR dans la valeur demandée, sans inclure le caractère null de fin.

Ce paramètre peut être défini sur NULL uniquement si szValue est également NULL , sinon la fonction retourne ERROR_INVALID_PARAMETER.

Valeur de retour

La fonction msiSourceListGetInfo retourne les valeurs suivantes.

Valeur Signification
ERROR_ACCESS_DENIED
L’utilisateur n’a pas la possibilité de lire la liste source spécifiée. Cela n’indique pas si un produit ou un correctif est trouvé.
ERROR_BAD_CONFIGURATION
Les données de configuration sont endommagées.
ERROR_INVALID_PARAMETER
Un paramètre non valide est passé à la fonction.
ERROR_MORE_DATA
La mémoire tampon fournie n’est pas suffisante pour contenir les données demandées.
ERROR_SUCCESS
La propriété est récupérée avec succès.
ERROR_UNKNOWN_PATCH
Le correctif est introuvable.
ERROR_UNKNOWN_PRODUCT
Le produit est introuvable.
ERROR_UNKNOWN_PROPERTY
La propriété source est introuvable.
ERROR_FUNCTION_FAILED
Une défaillance interne inattendue.

Remarques

Les administrateurs peuvent modifier l’installation d’une instance de produit ou de correctif qui existe sous le contexte de l’ordinateur ou sous leur propre contexte par utilisateur (géré ou non managé.) Ils peuvent modifier l’installation d’une instance de produit ou de correctif qui existe sous le contexte géré par l’utilisateur. Les administrateurs ne peuvent pas modifier l’installation d’un autre utilisateur d’une instance de produit ou de correctif qui existe sous ce contexte non managé par utilisateur.

Les non-administrateurs ne peuvent pas modifier l’installation d’une instance de produit ou de correctif qui existe sous le contexte par utilisateur d’un autre utilisateur (géré ou non managé.) Ils peuvent modifier l’installation d’une instance de produit ou de correctif qui existe sous leur propre contexte non managé par utilisateur. Ils peuvent modifier l’installation d’une instance de produit ou de correctif sous le contexte de l’ordinateur ou leur propre contexte géré par l’utilisateur uniquement s’ils sont activés pour rechercher une source de produit ou de correctif. Les utilisateurs peuvent être activés pour rechercher des sources en définissant une stratégie. Pour plus d’informations, consultez DisableBrowse, AllowLockdownBrowseet stratégies de AlwaysInstallElevated.

Note

L’en-tête msi.h définit MsiSourceListGetInfo 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 Installer 5.0 sur Windows Server 2012, Windows 8, Windows Server 2008 R2 ou Windows 7. Windows Installer 4.0 ou Windows Installer 4.5 sur Windows Server 2008 ou Windows Vista. Windows Installer 3.0 ou version ultérieure sur Windows Server 2003 ou Windows XP. Consultez la configuration requise de Windows Installer Run-Time pour plus d’informations sur le service pack Windows minimal requis par une version de Windows Installer.
plateforme cible Windows
d’en-tête msi.h
bibliothèque Msi.lib
DLL Msi.dll

Voir aussi

MsiSourceListSetInfo

non pris en charge dans Windows Installer 2.0 et versions antérieures

ProductCode