Aller au contenu principal
Version: Next

ST GET OPTIONS

ST GET OPTIONS ( {* ;} objet ; option ; valeur {; option2 ; valeur2 ; ... ; optionN ; valeurN} )

ParamètreTypeDescription
*OpérateurSi spécifié, objet est un nom d'objet (chaîne)
Si omis, objet est un champ ou une variable
objetanyNom d'objet (si * est spécifié) ou
Champ ou variable (si * est omis)
optionIntegerOption à lire
valeurIntegerValeur courante de l’option

Cette commande n'est pas thread-safe, elle ne peut pas être utilisée dans du code préemptif.

Description

La commande ST GET OPTIONS permet d’obtenir la valeur courante d’une ou plusieurs options de fonctionnement du champ ou de la variable de texte multistyle désigné(e) par le paramètre objet.

Si vous passez le paramètre optionnel *, vous indiquez que le paramètre objet est un nom d’objet (une chaîne). A l’exécution, si l’objet a le focus, la commande retourne les informations de l’objet en cours d'édition ; si l’objet n’a pas le focus, la commande retourne les informations de la source de données de l’objet (variable ou champ).
Si vous omettez le paramètre *, vous indiquez que le paramètre objet est un champ ou une variable. Dans ce cas, vous ne passez pas une chaîne mais une référence de champ ou de variable. A l’exécution, la commande retourne les informations de la variable ou du champ.

Passez dans option le code de l’option à lire. La commande retourne dans valeur la valeur courante de l’option. Pour ces deux paramètres, vous pouvez utiliser les constantes suivantes du thème "Texte multistyle" :

ConstanteTypeValeurComment
ST Expressions display modeEntier long1Le paramètre valeur peut contenir ST Values or ST References
ST ReferencesEntier long1Affichage des chaînes source des expressions
ST ValuesEntier long0Affichage des valeurs calculées des expressions

Voir aussi

ST SET OPTIONS