UpsMmr.LireParametre


Fonction Optimiser(Invariant, PasDEffetDeBord) LireParametre(M : Module, NomDuParametre : Caractere, NomDeLaSection : Caractere, Valeur : Booleen Sortie, Chaine : Nul Ou Caractere=Nul, Booleen PourInternet=Faux) Retourner Booleen;

Fonction Optimiser(Invariant, PasDEffetDeBord) LireParametre(M : Module, NomDuParametre : Caractere, NomDeLaSection : Caractere, Valeur : Entier Sortie, Chaine : Nul Ou Caractere=Nul, Booleen PourInternet=Faux) Retourner Booleen;

Fonction Optimiser(Invariant, PasDEffetDeBord) LireParametre(M : Module, NomDuParametre : Caractere, NomDeLaSection : Caractere, Valeur : Reel Sortie, Chaine : Nul Ou Caractere=Nul, Booleen PourInternet=Faux) Retourner Booleen;

Fonction Optimiser(Invariant, PasDEffetDeBord) LireParametre(M : Module, NomDuParametre : Caractere, NomDeLaSection : Caractere, Valeur : Caractere Sortie, Chaine : Nul Ou Caractere=Nul, Booleen PourInternet=Faux) Retourner Booleen;

Fonction Optimiser(Invariant, PasDEffetDeBord) LireParametre(M : Module, NomDuParametre : Caractere, NomDeLaSection : Caractere, Valeur : Date Sortie, Chaine : Nul Ou Caractere=Nul, Booleen PourInternet=Faux) Retourner Booleen;

Description

La fonction LireParametre permet de lire la valeur du paramètre NomDuParametre. Le paramètre est lu dans :

Les variables environnement.
Le fichier d'initialisation.
${UPS_HOME}/ini/${UPS_LANGUAGE}/upsaps.ini en mode mono-utilisateur ou ${UPS_HOME}/ini/${UPS_USER}/upsaps.ini en mode multi-utilisateur.
Si le programme comporte un profil d'exécution particulier, les options sont lues dans ce profil au lieu de upsaps.ini. La section est donnée par le paramètre NomDeLaSection.
Le fichier de paramètres.
S'il existe.
La ligne de commande.
Les valeurs des paramètres comportant des caractères espace doivent être mises entre caractères guillemet " ou entre caractères apostrophe ' .
La chaîne de paramètres Chaine.
Si elle est non Nul.
Les valeurs des paramètres comportant des caractères espace doivent être mises entre caractères guillemet " ou entre caractères apostrophe ' .
Si le paramètre PourInternet a pour valeur Vrai alors le séparateur de paramètres est alors le caractère ampersand & .

Le nom du paramètre est traduit selon le fichier Up ! Natural Language Support du module M.

Si le paramètre existe, la fonction LireParametre retourne Vrai et la valeur du paramètre Valeur est renseignée à la valeur lue. Si le paramètre n'existe pas, la fonction LireParametre retourne Faux et la valeur du paramètre Valeur est renseignée à la valeur par défaut standard.

Type de la valeur	Valeur par défaut
Booleen	Faux
Caractere	Chaine de caracteres vide.
Date	1er Janvier de l'an 1.
Entier	0
Reel	0.0

La fonction LireParametre permet de lire des paramètres dont le nom et la section sont calculés dynamiquement alors que l'instruction Parametre ne permet de lire que des paramètres dont le nom et la section sont fixés.

Si une erreur survient, alors l'exception OperationParametreImpossible est envoyée.

Exemple


Principal

/*******/

Variable

	A : Entier;



Debut

...

Si LireParametre(Global, "a", "masection", A) Alors

/* Le paramètre 'a' existe. */

	...

Fin Si

...

Fin Principal

Voir aussi

EcrireParametre pour écrire un paramètre persistant. ModifierParametre pour modifier un paramètre volatile. SupprimerParametre pour supprimer un paramètre persistant.

LireEnvironnement pour lire une variable environnement. L'instruction Parametre pour lire statiquement des paramètres.

Traduction


-	-	-	-	-	-	-	-	-