MsiSourceListEnumSourcesA, fonction (msi.h)

La fonction MsiSourceListEnumSources énumère les sources dans la liste source d’un correctif ou d’un produit spécifié.

Syntaxe

UINT MsiSourceListEnumSourcesA(
  [in]                LPCSTR            szProductCodeOrPatchCode,
  [in, optional]      LPCSTR            szUserSid,
  [in]                MSIINSTALLCONTEXT dwContext,
  [in]                DWORD             dwOptions,
  [in]                DWORD             dwIndex,
  [in, optional]      LPSTR             szSource,
  [in, out, optional] LPDWORD           pcchSource
);

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

SID de chaîne 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.

[in] dwContext

Contexte de l’instance de produit ou de correctif. Ce paramètre peut contenir l’une des valeurs suivantes.

[in] dwOptions

La valeur dwOptions détermine l’interprétation de la valeur szProductCodeOrPatchCode et le type de sources à effacer. Ce paramètre doit être une combinaison de l’une des constantes MSISOURCETYPE_* suivantes et de l’une des constantes MSICODE_* suivantes.

[in] dwIndex

Index de la source à récupérer. Ce paramètre doit être égal à 0 (zéro) pour le premier appel à la fonction MsiSourceListEnumSources, puis incrémenté pour les appels suivants jusqu’à ce que la fonction retourne ERROR_NO_MORE_ITEMS. L’index doit être incrémenté uniquement si l’appel précédent a retourné ERROR_SUCCESS.

[in, optional] szSource

Pointeur vers une mémoire tampon qui reçoit le chemin d’accès à la source énumérée. Cette mémoire tampon doit être suffisamment grande pour contenir la valeur reçue. Si la mémoire tampon est trop petite, la fonction retourne ERROR_MORE_DATA et définit *pcchSource au nombre d'TCHAR dans la valeur, sans inclure le caractère NULL de fin.

Si szSource est défini sur NULL et pcchSource est défini sur un pointeur valide, la fonction retourne ERROR_SUCCESS et définit *pcchSource 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 mémoire tampon suffisamment grande pour contenir *pcchSource + 1 caractères.

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

[in, out, optional] pcchSource

Pointeur vers une variable qui spécifie le nombre de TCHAR dans la mémoire tampon szSource . 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 szSource est également NULL , sinon la fonction retourne ERROR_INVALID_PARAMETER.

Valeur de retour

La fonction MsiSourceListEnumSources retourne les valeurs suivantes.

Remarques

Lorsque vous effectuez plusieurs appels à MsiSourceListEnumSources pour énumérer toutes les sources d’une instance de produit unique, chaque appel doit être effectué à partir du même thread.

Un administrateur peut énumérer les installations non managées et gérées par utilisateur pour eux-mêmes, les installations par ordinateur et les installations gérées par utilisateur pour n’importe quel utilisateur. Un administrateur ne peut pas énumérer les installations non managées par utilisateur pour d’autres utilisateurs. Les non-administrateurs ne peuvent énumérer leurs propres installations non managées et gérées par utilisateur que les installations par ordinateur.

Exigences

Voir aussi

contexte d’installation

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

ProductCode