Méthode Session.FormatRecord

La méthode FormatRecord de l’objet Session renvoie une chaîne mise en forme à partir d’un modèle et de données d’enregistrement.

Syntaxe

Session.FormatRecord(
  record
)

Paramètres

enregistrement

Objet Record obligatoire 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, suivie de tous les paramètres de données référencés.

Valeur retournée

Cette méthode ne retourne pas de valeur.

Notes

La méthode FormatRecord utilise le processus de mise en forme suivant.

Les paramètres à mettre en forme sont placés entre crochets [..]. Les crochets peuvent être itérés, car les remplacements sont résolus de l’intérieur vers l’extérieur.

Si une partie de la chaîne est entourée d’accolades { } et ne contient pas de crochets, elle est laissée telle quelle, y compris les accolades.

Si une partie de la chaîne est entourée d’accolades et contient un ou plusieurs noms de propriété, et si toutes les propriétés sont trouvées, le texte (avec les remplacements résolus) s’affiche sans les accolades. Si 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 avec la méthode FormatRecord

1. Les paramètres numériques sont remplacés en remplaçant le marqueur par la valeur du champ d’enregistrement correspondant, les valeurs manquantes ou Null ne produisant aucun texte.
2. La chaîne qui en résulte est traitée en remplaçant les paramètres qui ne sont pas liés à l’enregistrement par les valeurs correspondantes, comme indiqué dans les descriptions suivantes.
   • Si une sous-chaîne de la forme « [propertyname] » est rencontrée, elle est remplacée par la valeur de la propriété .
   • Si une sous-chaîne de la forme « [%environmentvariable] » est trouvée, la valeur de la variable d’environnement est remplacée.
   • Si une sous-chaîne de la forme [#filekey] est trouvée, elle est remplacée par le chemin complet du fichier, avec la valeur filekey utilisée comme clé dans la table File. La valeur de [#filekey] reste vide et n’est pas remplacée par un chemin tant que le programme d’installation n’exécute pas l’action CostInitialize, l’action FileCost et l’action CostFinalize. La valeur de [#filekey] dépend de l’état d’installation du composant auquel appartient le fichier. Si le composant est exécuté à partir de la source, la valeur est le chemin de l’emplacement source du fichier. Si le composant est exécuté localement, la valeur est le chemin de l’emplacement cible du fichier après l’installation. Si le composant est absent, le chemin est vide. Pour plus d’informations sur la vérification de l’état d’installation des composants, consultez Vérification de l’installation des fonctionnalités, des composants, des fichiers.
   • Si une sous-chaîne de la forme [$componentkey] est trouvée, elle est remplacée par le répertoire d’installation du composant, par la valeur componentkey utilisée comme clé dans la table Component. La valeur de [#componentkey] reste vide et n’est pas remplacée par un répertoire tant que le programme d’installation n’exécute pas l’action CostInitialize, l’action FileCost et 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 des fonctionnalités, des composants, des fichiers.
   • Si une sous-chaîne de la forme « [\x] » 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é.

Configuration requise

Voir aussi

Mis en forme

Types de données de colonne