Retour à la page principale
Cette instruction permet d'insérer le caractère '.
FUNCTION $Quote: '''';
Vérifie et modifie le format d'affichage des valeurs booléennes.
FUNCTION BooleanFormat [ ( VAL format: INTEGER ) ] : INTEGER;
Nom de l'argument | Description |
format | S'il y en a un, cet argument remplace le format par défaut |
Cette fonction permet de vérifier ou de modifier le format utilisé par défaut lorsqu'une valeur de ce type est convertie en format texte.
Si elle est utilisée sans argument, BooleanFormat retourne le format d'affichage booléen existant par défaut. Si un argument est fourni, la valeur remplace la valeur par défaut et l'ancien format est retourné.
Reportez-vous à la rubrique Remarque de l'instruction WinWrite pour avoir des explications sur les formats d'affichage.
VARIABLES
oldFormat: INTEGER; ACTIONS oldFormat:= BooleanFormat(BitOr($FmtBoolYesNo, $FmtLeftJustify));
...
BooleanFormat(oldFormat); END;
Convertit un code de caractère ASCII (valeur de point de code) en une chaîne d'un caractère. L'apparence de cette chaîne peut varier selon la page de code active. Pour avoir des informations sur les pages de code, reportez-vous à la documentation concernant votre système d'exploitation.
FUNCTION Char (VAL code: INTEGER): STRING;
Nom de l'argument | Description |
code | Entier représentant la valeur ASCII |
VARIABLES s : STRING; ACTIONS s:=Char(255);
CharCode
Retourne le code de caractère ASCII (valeur de point de code) du premier caractère de la chaîne. La valeur numérique du point de code qui est retournée pour une représentation du caractère peut varier selon la page de codes sélectionné. Pour avoir des informations sur les pages de codes, reportez-vous à la documentation concernant votre système d'exploitation.
FUNCTION CharCode (VAL str: STRING): INTEGER;
Nom de l'argument | Description |
str | N'importe quelle chaîne |
L'argument str est considéré comme une chaîne à un caractère. Si vous insérez une chaîne à plusieurs caractères, le code ASCII du premier caractère de la chaîne est retourné.
i := CharCode('A'); (* i = 65 *)
Char
Vérifie et modifie le format texte pour les entiers.
FUNCTION IntegerFormat [ ( VAL format: INTEGER ) ] : INTEGER;
Nom de l'argument | Description |
format | S'il y en a un, cet argument remplace le format par défaut |
Cette fonction permet de vérifier ou de modifier le format utilisé par défaut lorsqu'une valeur de ce type est convertie en format texte.
Si elle est utilisée sans argument, IntegerFormat retourne la valeur par défaut. Si un argument est fourni, la valeur remplace la valeur par défaut et la valeur précédente est retournée.
VARIABLES oldFormat: INTEGER; ACTIONS oldFormat := IntegerFormat(BitOr(IntegerFormat, $FmtIntSigned)); -- Prepend the sign to all integers.
...
IntegerFormat(oldFormat); END;
IntegerFormat ne renvoie aucun code. Tout comme la valeur retournée par StringFormat, IntegerFormat renvoie la valeur précédente correspondant à la séquence de bits de l'indicateur de format. Cette valeur peut être traitée comme un entier étant donné que TSD ne dispose pas de ce type de séquence de bits. Le signe de la valeur n'a pas de signification.
Pour avoir plus d'informations sur les formats d'affichage, reportez-vous à la section Indicateurs de format de types de données.
Permet de vérifier ou de modifier le format texte par défaut des valeurs réelles.
FUNCTION RealFormat [ ( VAL format: INTEGER ) ] : INTEGER;
Nom de l'argument | Description |
format | S'il y en a un, cet argument remplace le format par défaut |
Cette fonction permet de vérifier ou de modifier le format utilisé par défaut lorsqu'une valeur de ce type est convertie en format texte. Si elle est utilisée sans argument, elle renvoie la valeur par défaut. Si un argument est fourni, la valeur devient la valeur par défaut. La valeur par défaut d'origine est renvoyée.
CONSTANTS sigDigits IS 2; -- Two digits to the right of the decimal. VARIABLES oldFormat: INTEGER; ACTIONS oldFormat := RealFormat(BitOr($FmtRealGroupedWithComma, sigDigits));
...
RealFormat(oldFormat); END;
Code retour | Description |
Tous | Format réel courant si aucun argument n'est spécifié; format réel précédent si aucun argument n'est fourni. |
Pour plus d'informations, reportez-vous à la rubrique Indicateurs de format de types de données.
Renvoie la sous-chaîne d'une expression de chaîne.
FUNCTION StrCopy (VAL source: STRING, VAL start [, length]: INTEGER): STRING;
Nom de l'argument | Description |
source | Expression de chaîne à partir de laquelle la sous-chaîne est copiée. |
start | Indice du premier caractère à copier ; l'indice du premier caractère de la chaîne est 1. Si la valeur de départ est inférieure à 1, StrCopy échoue et renvoie une valeur inconnue. Si la valeur de départ est supérieure à la longueur de la chaîne, StrCopy renvoie une chaîne vide. |
length | Nombre de caractères à copier dans la nouvelle chaîne. Si length est inférieur à 0, StrCopy renvoie la valeur $Unknown. Si length est supérieur au nombre de caractères disponibles, tous les caractères disponibles sont copiés. |
StrCopy copie la longueur des caractères dans la chaîne source puis les retourne. Elle commence par copier le caractère trouvant en position de départ. Si la position de départ dépasse le nombre de caractères dans la chaîne, une chaîne vide est renvoyée.
VARIABLES drive,path,fileName: STRING; ACTIONS drive:=StrCopy('F:\ADVISOR\DATA\LOCATION.FLD',1,2); (* drive = 'F:'); path:=StrCopy('F:\ADVISOR\DATA\LOCATION.FLD',3,13); (* path = '\ADVISOR\DATA'): fileName:=StrCopy('F:\ADVISOR\DATA\LOCATION.FLD',17,12); (* fileName = 'LOCATION.FLD' *)
Déchiffre une chaîne codée par StrEncrypt avec la valeur de clé donnée.
FUNCTION StrDecrypt (VAL Source: STRING, VAL Key: INTEGER): STRING;
Attention : Une expression incorrecte est renvoyée lorsque la clé transmise à StrDecrypt n'est pas valide.
Nom de l'argument | Description |
Source | Chaîne précédemment codée avec StrEncrypt |
Key | Valeur de l'entier à utiliser comme clé secrète lors de déchiffrage de la chaîne. |
L'algorithme de chiffrement de StrDecrypt et StrEncrypt n'est pas vraiment fiable, mais peut-être utilisé pour les cryptages peu importants.
(* Function FCryptReadIn: This funciton reads an encrypted string from a file and decrypts it.
*)
FUNCTION FCryptReadIn(VAL Key:Integer, VAL fhdl:FILE):STRING IS
VARIABLES TmpStr: STRING;
ACTIONS FReadLn(fhdl, TmpStr); $Result:=StrDecrypt(TmpStr,Key);
END;
Code retour | Description |
Chaîne décryptée | Opération exécutée avec succès. |
$Unknown | L'utilisation de StrDecrypt a échoué. |
StrEncrypt
Supprime une sous-chaîne dans une chaîne de caractère.
FUNCTION StrDelete (VAL source:string, VAL start: Integer, VAL length: Integer):string
Nom de l'argument | Description |
source | Chaîne dans laquelle la sous-chaîne est supprimée. |
start | Emplacement où la suppression des caractères commence. Si la valeur de départ est inférieure à 0, la suppression échoue et $Unknown est renvoyé. Si la valeur de départ est supérieure à la longueur, aucun caractères n'est supprimé et la chaîne d'origine est renvoyée. |
length | Nombre de caractères à supprimer. Si length est inférieur à 0, StrDelete échoue et $Unknown est renvoyé. |
StrDelete renvoie une copie de la chaîne source et avec une série de caractères supprimés. La chaîne source n'est pas affectée.
VARIABLES s : STRING; ACTIONS s:=StrDelete('F:\ADVISOR\DATA.DAT',1,11); (* s = 'DATA.DAT' *)
StrDelete renvoie une copie de la chaîne d'entrée avec une série des caractères supprimée. S'il y a la moindre erreur dans les arguments d'entrée, la valeur $Unknown est renvoyée.
Chiffre une chaîne en format illisible avec une clé d'entier.
FUNCTION StrEncrypt (VAL Source: STRING, VAL Key: INTEGER): STRING;
Nom de l'argument | Description |
Source | Chaîne devant être chiffrée |
Key | Valeur de l'entier utilisé comme clé secrète lors du chiffrage de la chaîne |
L'algorithme de chiffrement de StrDecrypt et StrEncrypt n'est pas vraiment fiable, mais peut-être utilisé pour les cryptages peu importants.
(* Function FCryptWriteIn: This funciton writes a string to a file in an encrypted form.*)
FUNCTION FCryptWriteIn(VAL Str:String, VAL Key:Integer, VAL fhdl:FILE):INTEGER IS
ACTIONS $Result:=FWriteLn(fhdl, StrEncrypt(Str,Key));
END;
Code retour | Description |
$Unknown | L'utilisation de StrEncrypt a échoué |
StrDecrypt
Permet de vérifier ou de modifier les options de formatage par défaut d'une chaîne de caractères.
FUNCTION StringFormat [ ( VAL format: INTEGER ) ] : INTEGER;
Nom de l'argument | Description |
format | S'il y en a un, cet argument remplace le format par défaut |
Cette fonction est utilisée pour vérifier ou modifier le format par défaut lorsque la valeur de ce type est convertie en format texte.
Si elle est utilisée sans argument, elle renvoie la valeur par défaut. Si un argument est fourni, la valeur devient la nouvelle valeur par défaut. La valeur précédente par défaut est renvoyée.
VARIABLES oldFormat: INTEGER; ACTIONS oldFormat := StringFormat($FmtLeftJustify); ... StringFormat(oldFormat); END;
StringFormat renvoie la valeur précédente de la séquence de bits du format de la chaîne. Cette valeur renvoyée peut être transmise à StringFormat ultérieurement. Par exemple :
oldFormat :=StringFormat (newFormat); ... --output some strings ... StringFormat (oldFormat) ;
Pour plus d'informations sur les formats d'affichage, reportez-vous au manuel Tivoli Service Desk 6.0 Developer's Toolkit Script - Guide de programmation.
Insert une sous-chaîne dans une chaîne.
FUNCTION StrInsert (VAL source, substring: STRING, VAL start: INTEGER): STRING;
Nom de l'argument | Description |
source | Chaîne dans laquelle la sous-chaîne est insérée. |
substring | Chaîne à insérer dans la chaîne source. |
start | Emplacement où la sous-chaîne est insérée dans la chaîne cible. Si l'emplacement de départ est inférieure à 1, StrInsert échoue et $Unknown est renvoyé. Si l'emplacement de départ dépasse la longueur de la chaîne cible, la sous-chaîne est ajoutée à la fin de cette chaîne. |
StrInsert insère une sous-chaîne dans la chaîne source à une position donnée. L'insertion se fait de manière que le premier caractère de la sous-chaîne insérée se trouve à l'indice indiqué par la position.
Remarque : StrInsert construit et renvoie la nouvelle chaîne alors que les chaînes d'entrée ne sont pas modifiées.
VARIABLES s : STRING; ACTIONS s:=StrInsert('F:\DATA.TXT','\ADVISOR',3); (* s = 'F:\ADVISOR\DATA.TXT' *)
StrInsert renvoie une copie de la chaîne cible avec la sous-chaîne qui est inséré en commençant à l'index donné. Si une erreur se produit dans les arguments, l'instruction renvoie $Unknown.
Renvoie la longueur de la chaîne.
FUNCTION StrLength (VAL str: STRING): INTEGER;
Nom de l'argument | Description |
string | Expression de chaîne dont la longueur doit être calculée |
StrLength renvoie un nombre entier égal au nombre de caractères de l'expression. Si la chaîne est $Unknown, la fonction renvoie $Unknow.
VARIABLES i: INTEGER; path,fileName: STRING; ACTIONS path:='F:\EADVISOR'; fileName:='KMLRUN.EXE'; i:=StrLength(path & '\' & fileName); (* i = 22 *)
Code retour | Description |
> = 0 | Entier indiquant le nombre de caractères de l'expression |
$Unknown | Si la chaîne est $Unknown, la valeur renvoyée l'est également. |
Charge une chaîne à partir du tableau de chaîne dans un fichier .df créé par le concepteur d'interface.
FUNCTION StrLoad (VAL formspec: STRING): STRING;
Nom de l'argument | Description |
formspec | Spécification d'un formulaire au format 'file[res_name]' où file correspond au nom d'un fichier .dfc file et res_name correspond à la ressource de la chaîne dans le tableau de chaîne. |
Si la chaîne ou le fichier est introuvable, $Unknown est renvoyé lors de l'utilisation de la fonction.
KNOWLEDGEBASE test;
ROUTINES PROCEDURE Main;
PRIVATE
ROUTINES
PROCEDURE Main IS VARIABLES x: STRING; ACTIONS x := StrLoad('test[test_string]'); WinMessageBox($Desktop, 'Information', $MBOK, 'The string is ' & x); END;
Met une chaîne en minuscules.
FUNCTION StrLower (VAL str: STRING): STRING;
Nom de l'argument | Description |
str | Expression de chaîne |
VARIABLES s : STRING; ACTIONS s:=StrLower('F:\MYFILE.TXT'); (* s = 'f:\myfile.txt' *)
StrLower renvoie une copie de la chaîne dans laquelle tous les caractères en majuscules sont convertis en minuscules. La chaîne n'est pas modifiée.
StrUpper
Supprime les espaces de gauche, les tabulations et les caractères de retour à la ligne dans une chaîne.
FUNCTION StrLTrim (VAL str: STRING): STRING;
Nom de l'argument | Description |
str | Expression de chaîne |
VARIABLES s : STRING; ACTIONS s:=StrLTrim('F:\DATA.TXT'); (* s = 'F:\DATA.TXT' *)
Renvoie une copie de la chaîne sans les espaces de gauche, les tabulations et les caractères de retour à la ligne. La chaîne n'est pas modifiée.
StrTrim
Recherche une sous-chaîne dans une chaîne.
FUNCTION StrMatch (VAL source, VAL pattern: STRING): BOOLEAN;
Attention : La recherche ne tient pas compte des minuscules et majuscules.
Nom de l'argument | Description |
source | Expression de chaîne à rechercher. |
pattern | Expression de chaîne contenant parfois des caractères génériques comme ? ou *. |
StrMatch compare la chaîne source avec le modèle. Le modèle peut contenir des caractères génériques :
La recherche ne prend pas en compte les majuscules et minuscules.
VARIABLES f: FILE; l: LIST OF STRING; match: LIST OF STRING; ACTIONS FOpen(f,'MYFILE.TXT',$Read); FReadText(f,l); FClose(f); FOR l DO IF StrMatch(l[$Current],'*printer*') THEN ListInsert(match,l[$Current]); END;
StrMatch renvoie la valeur TRUE si le modèle et la chaîne source correspondent et la valeur FALSE dans le cas contraire.
Trouve la position de la sous-chaîne dans la chaîne.
FUNCTION StrPos (VAL source, VAL substring: STRING): INTEGER;
Nom de l'argument | Description |
source | Chaîne contenant la sous-chaîne |
Substring | Chaîne de caractères dans la chaîne source |
StrPos fait une recherche sans tenir compte des minuscules et majuscules depuis le début de la chaîne jusqu'à ce que la chaîne cible soit trouvée. Si la sous-chaîne est trouvée, StrPos renvoie l'indice de sa position dans la chaîne source. Dans le cas contraire, il renvoie un résultat égal à zéro.
VARIABLES i: INTEGER; ACTIONS i:=StrPos(F:\DATA\MYFILE.DAT','\'); (* i = 3 *)
Code retour | Description |
0 | La sous-chaîne est introuvable |
-1 | La chaîne source est inconnue |
-2 | La sous-chaîne est inconnue |
StrToken
Remplace les désignations utilisées dans la chaîne source par les valeurs terminologiques appropriées.
FUNCTION StrReplaceTerms (VAL source: STRING): STRING;
Attention : Si la variable n'existe pas ou si sa valeur ne peut pas être convertie en chaîne, un message d'avertissement s'affiche et la désignation n'est pas remplacée dans la chaîne cible.
Nom de l'argument | Description |
source | Chaîne contenant zéro ou plusieurs désignations de termes. |
La désignation est une sous-chaîne dont la forme est la suivante :
{{KNOWLEDGEBASE:VARIABLE}}
où KNOWLEDGEBASE est le nom de la base de connaissance et VARIABLE est le nom d'une variable déclarée avec la portée la plus vaste pour cette base de connaissances. Il est inutile de déclarer la variable dans la partie publique de la base de connaissances.
Toutes les formes de ce type ajoutées à la chaîne source sont remplacées par la valeur de la variable. La chaîne source n'est pas modifiée par cette fonction.
msg := StrReplaceTerms( 'The {{GLOBALS:T_CALLER}} has no open {{GLOBALS:T_PROBLEMS}}.'); -- T_CALLER and T_PROBLEMS from GLOBALS.KB contain 'caller' -- and 'problems' respectively, or synonyms such as 'customer' -- and 'inquires'.
StrReplaceTerms renvoie la chaîne modifiée. Si la chaîne source est inconnue StrReplaceTerms renvoie la valeur $Unknown.
Segmente une chaîne de façon destructive.
FUNCTION StrToken (REF source: STRING, VAL delimiters: STRING): STRING;
Nom de l'argument | Description |
source | Variable de chaîne destinée à recevoir un marquage sémantique |
delimiters | Chaîne contenant un ou plusieurs caractères de délimitation |
La fonction StrToken permet de diviser l'ensemble des caractères en deux sous-ensembles : les caractères faisant partie des token (ensemble des token) et ceux n'en faisant pas partie (ensemble des délimiteurs). Lorsque vous utilisez StrToken avec une chaîne source connue, l'instruction effectue les opérations suivantes :
Lorsque ces opérations sont terminées, la chaîne source est raccourcie chaque fois que cette fonction est utilisée, jusqu'à devenir une chaîne vide. Lorsqu'il n'y a plus de token dans la chaîne source, StrToken renvoie une chaîne vide.
WHILE NOT FEnd (inputFile) DO FReadLn (inputFile, inputLine); column := 0; WHILE (token := StrToken (inputLine,'')) <> ''DO ProcessEntry (token, column :=column +1); END; END;
Cette fonction renvoie la valeur $Unknown si la chaîne source ou la chaîne des séparateurs est inconnue.
StrPos
Supprime l'espace à la fin de la chaîne.
FUNCTION StrTrim (VAL str: STRING): STRING;
Nom de l'argument | Description |
str | Expression de chaîne |
StrTrim prend une chaîne et en renvoie une copie avec tous les espaces en fin de chaîne (espaces, tabulations, caractères d'interligne) supprimés. La chaîne elle-même n'est pas affectée.
VARIABLES f: FILE; l: LIST OF STRING; ACTIONS FOpen(f,'DATA.TXT',$Read); FReadText(f,l); FClose(f); FOR l DO l[$Current]:=StrTrim(l[$Current]);
StrTrim renvoie une copie de cette chaîne avec tous les espaces (espacements, tabulations, caractères d'interligne) supprimés.
StrLTrim
Renvoie une copie de la chaîne en majuscules.
FUNCTION StrUpper (VAL str: STRING): STRING;
Nom de l'argument | Description |
str | Expression de chaîne |
StrUpper renvoie une copie de la chaîne avec tous les caractères en minuscules convertis en majuscules. La chaîne n'est pas modifiée.
VARIABLES s : STRING; ACTIONS s:=StrUpper('f:\data\myfile.txt'); (* s = 'F:\DATA\MYFILE.TXT' *)
StrUpper renvoie une copie de la chaîne avec tous les caractères en minuscules convertis en majuscules.
StrLower
Tivoli Service Desk 6.0 Developer's Toolkit - Manuel de référence du langage TSD Script