MsiGetSourcePathA, fonction (msiquery.h)

Article
03/04/2024

La fonction MsiGetSourcePath retourne le chemin d’accès source complet d’un dossier dans la table Directory.

Syntaxe

UINT MsiGetSourcePathA(
  [in]      MSIHANDLE hInstall,
  [in]      LPCSTR    szFolder,
  [out]     LPSTR     szPathBuf,
  [in, out] LPDWORD   pcchPathBuf
);

Paramètres

[in] hInstall

Gérez l’installation fournie à une action personnalisée DLL ou obtenue via MsiOpenPackage, MsiOpenPackageEx ou MsiOpenProduct.

[in] szFolder

Chaîne terminée par null qui spécifie un enregistrement de la table Directory. Si le répertoire est un répertoire racine, il peut s’agir d’une valeur de la colonne DefaultDir. Sinon, il doit s’agir d’une valeur de la colonne Répertoire.

[out] szPathBuf

Pointeur vers la mémoire tampon qui reçoit le chemin de la source complète terminée null. N’essayez pas de déterminer la taille de la mémoire tampon en transmettant une valeur null (valeur=0) pour szPathBuf. Vous pouvez obtenir la taille de la mémoire tampon en transmettant une chaîne vide (par exemple « »). La fonction retourne ensuite ERROR_MORE_DATA et pcchPathBuf contient la taille de mémoire tampon requise dans les TCHAR, sans inclure le caractère null de fin. Au retour de ERROR_SUCCESS, pcchPathBuf contient le nombre de TCHAR écrits dans la mémoire tampon, sans inclure le caractère null de fin.

[in, out] pcchPathBuf

Pointeur vers la variable qui spécifie la taille, en TCHAR, de la mémoire tampon pointée par la variable szPathBuf. Lorsque la fonction retourne ERROR_SUCCESS, cette variable contient la taille des données copiées dans szPathBuf, sans inclure le caractère null de fin. Si szPathBuf n’est pas assez grand, la fonction retourne ERROR_MORE_DATA et stocke la taille requise, sans inclure le caractère null de fin, dans la variable pointée par pcchPathBuf.

Valeur retournée

La fonction MsiGetSourcePath retourne les valeurs suivantes :

Remarques

Avant d’appeler cette fonction, le programme d’installation doit d’abord exécuter l’action CostInitialize, l’action FileCost et l’action CostFinalize. Pour plus d’informations, consultez Appel de fonctions de base de données à partir de programmes.

Si ERROR_MORE_DATA est retourné, le paramètre qui est un pointeur donne la taille de la mémoire tampon requise pour contenir la chaîne. Si ERROR_SUCCESS est retourné, il indique le nombre de caractères écrits dans la mémoire tampon de chaîne. Par conséquent, vous pouvez obtenir la taille de la mémoire tampon en transmettant une chaîne vide (par exemple « ») pour le paramètre qui spécifie la mémoire tampon. N’essayez pas de déterminer la taille de la mémoire tampon en transmettant une valeur Null (valeur=0).

Si la fonction échoue, vous pouvez obtenir des informations d’erreur étendues à l’aide de MsiGetLastErrorRecord.

Notes

L’en-tête msiquery.h définit MsiGetSourcePath comme un 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.

Configuration requise

Condition requise	Valeur
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 sur Windows Server 2003 ou Windows XP
Plateforme cible	Windows
En-tête	msiquery.h
Bibliothèque	Msi.lib
DLL	Msi.dll

Voir aussi

Fonctions d’emplacement du programme d’installation

Passage de la valeur Null en tant qu’argument des fonctions Windows Installer

Partager via