Session. FormatRecord, méthode
La méthode FormatRecord de l’objet session retourne une chaîne mise en forme à partir d’un modèle et des données d’enregistrement.
Syntaxe
Session.FormatRecord(
record
)
Paramètres
-
enregistrement
-
Objet Record requis contenant un modèle et des données à mettre en forme. La chaîne de modèle doit être définie dans le champ 0, suivi de tous les paramètres de données référencés.
Valeur de retour
Cette méthode ne retourne pas de valeur.
Notes
La méthode FormatRecord utilise le processus de format suivant.
Les paramètres à mettre en forme sont placés entre crochets [ .. ] . Les crochets peuvent être itérés, car les substitutions sont résolues de l’intérieur vers l’extérieur.
Si une partie de la chaîne est entourée d’accolades {} et ne contient aucun crochet, la partie reste inchangée, y compris les accolades.
Si une partie de la chaîne est placée entre accolades et contient un ou plusieurs noms de propriété, et si toutes les propriétés sont trouvées, le texte (avec les substitutions résolues) s’affiche sans les accolades. Si l’une des propriétés est introuvable, tout le texte entre les accolades et les accolades elles-mêmes sont supprimés.
Pour mettre en forme des chaînes à l’aide de la méthode FormatRecord
- Les paramètres numériques sont remplacés en remplaçant le marqueur par la valeur du champ d’enregistrement correspondant, avec des valeurs manquantes ou null qui ne génèrent pas de texte.
- La chaîne résultante est traitée en remplaçant les paramètres non-enregistrement par les valeurs correspondantes, comme indiqué dans les descriptions suivantes.
- Si une sous-chaîne se présentant sous la forme « [ PropertyName ] » est rencontrée, elle est remplacée par la valeur de la propriété.
- Si une sous-chaîne du formulaire « [ % EnvironmentVariable ] » est trouvée, la valeur de la variable d’environnement est remplacée.
- Si une sous-chaîne du formulaire [ # filekey ] est trouvée, elle est remplacée par le chemin d’accès complet du fichier, avec la valeur filekey utilisée comme clé dans la table de fichiers. La valeur de [ # filekey ] reste vide et n’est pas remplacée par un chemin d’accès jusqu’à ce que le programme d’installation exécute l’action CostInitialize, l’action FileCostet l' action CostFinalize. La valeur de [ # filekey ] dépend de l’état d’installation du composant auquel le fichier appartient. Si le composant est exécuté à partir de la source, la valeur est le chemin d’accès à l’emplacement source du fichier. Si le composant est exécuté localement, la valeur est le chemin d’accès à l’emplacement cible du fichier après l’installation. Si le composant est absent, le chemin d’accès est vide. Pour plus d’informations sur la vérification de l’état d’installation des composants, consultez vérification de l’installation de fonctionnalités, de composants et de fichiers.
- Si une sous-chaîne du formulaire [ $componentkey ] est trouvée, elle est remplacée par le répertoire d’installation du composant, avec la valeur componentkey utilisée comme clé dans la table des composants. La valeur de [ $ componentkey ] reste vide et n’est pas remplacée par un répertoire tant que le programme d’installation n’a pas exécuté l’action CostInitialize, l’action FileCostet l' action CostFinalize. La valeur de [ $ componentkey ] dépend de l’état d’installation du composant. Si le composant est exécuté à partir de la source, la valeur est le répertoire source du fichier. Si le composant est exécuté localement, la valeur est le répertoire cible après l’installation. Si le composant est absent, la valeur est laissée vide. Pour plus d’informations sur la vérification de l’état d’installation des composants, consultez vérification de l’installation de fonctionnalités, de composants et de fichiers.
- Si une sous-chaîne du formulaire « [ \ c ] » est trouvée, elle est remplacée par le caractère sans traitement supplémentaire. Seul le premier caractère après la barre oblique inverse est conservé ; tout le reste est supprimé.
Spécifications
| Condition requise | Valeur |
|---|---|
| Version |
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 |
| DLL |
|
| IID |
IID _ ISession est défini en tant que 000C109E-0000-0000-C000-000000000046 |