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

ProductCode ou GUID de correctif du produit ou du correctif. Utilisez une chaîne terminée par null. Si la chaîne contient plus de 39 caractères, la fonction échoue et retourne ERROR_INVALID_PARAMETER. Ce paramètre ne peut pas avoir la valeur 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 avoir la valeur NULL et dwContext doit être MSIINSTALLCONTEXT_MACHINE.

Type de SID Signification
NULL
NULL désigne l’utilisateur actuellement connecté. Lors du référencement du compte d’utilisateur actuel, szUserSID peut avoir la valeur NULL et dwContext peut être MSIINSTALLCONTEXT_USERMANAGED ou MSIINSTALLCONTEXT_USERUNMANAGED.
SID de l’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-1358098788-3127455600-2561 ».
 
Note La chaîne SID spéciale s-1-5-18 (système) ne peut pas être utilisée pour énumérer les produits ou les correctifs installés en tant que machine. La définition de la valeur SID sur s-1-5-18 renvoie ERROR_INVALID_PARAMETER.
 
Note 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 du produit ou du correctif instance. Ce paramètre peut contenir l’une des valeurs suivantes.

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

[in] dwOptions

La valeur dwOptions spécifie la signification de szProductCodeOrPatchCode.

Indicateur Signification
MSICODE_PRODUCT
szProductCodeOrPatchCode est un GUID de code produit.
MSICODE_PATCH
szProductCodeOrPatchCode est un GUID de code 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 prendre les valeurs suivantes.

Nom Signification
INSTALLPROPERTY_MEDIAPACKAGEPATH
« MediaPackagePath »
Chemin d’accès relatif à la racine du support d’installation.
INSTALLPROPERTY_DISKPROMPT
« DiskPrompt »
Modèle d’invite utilisé lors de l’invite à l’utilisateur pour le support d’installation.
INSTALLPROPERTY_LASTUSEDSOURCE
« LastUsedSource »
Emplacement source le plus récemment utilisé pour le produit.
INSTALLPROPERTY_LASTUSEDTYPE
« LastUsedType »
« n » si la dernière source utilisée est un emplacement réseau. « u » si la dernière source utilisée est un emplacement d’URL. « m » si la dernière source utilisée est un média. Chaîne vide («  ») s’il n’y a pas de dernière source utilisée.
INSTALLPROPERTY_PACKAGENAME
« PackageName »
Nom du package Windows Installer ou du package de correctifs de 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 sur le nombre de TCHAR dans la valeur, sans inclure le caractère NULL de fin.

Si szValue a la valeur NULL et que pcchValue est défini sur un pointeur valide, la fonction retourne ERROR_SUCCESS et définit *pcchValue sur 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 la mémoire tampon szValue 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 retourne, ce paramètre est défini sur la taille de la valeur demandée, que la fonction copie ou non la valeur dans la mémoire tampon spécifiée. La taille est retournée sous la forme du nombre de TCHAR dans la valeur demandée, sans inclure le caractère null de fin.

Ce paramètre ne peut être défini sur NULL que si szValue a également la valeur NULL, sinon la fonction retourne ERROR_INVALID_PARAMETER.

Valeur retournée

La fonction MsiSourceListGetInfo retourne les valeurs suivantes.

Valeur Signification
ERROR_ACCESS_DENIED
L’utilisateur n’a pas la possibilité de lire la liste des sources 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
Défaillance interne inattendue.

Notes

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

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

Notes

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

Spécifications

   
Client minimal 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. Pour plus d’informations sur le Service Pack Windows requis par une version de Windows Installer, consultez Configuration requise pour le runtime Windows.
Plateforme cible Windows
En-tête msi.h
Bibliothèque Msi.lib
DLL Msi.dll

Voir aussi

MsiSourceListSetInfo

Non pris en charge par Windows Installer 2.0 et antérieur

ProductCode