Chaque fiche de fonction commence par sa syntaxe : le nom de la fonction, ses paramètres entre parenthèses, puis la liste des paramètres avec leur explication.
Quelques symboles indiquent ce qu'il faut fournir, ce qui est facultatif et ce qui peut se répéter. Ils font partie de la notation de l'aide : on ne les recopie pas dans une formule.
| Notation | Signification |
|---|---|
| < Paramètre > | Une valeur à fournir. Le nom du paramètre dit ce qu'on attend (par exemple < Date >, < Texte >). On le remplace par une valeur, une colonne ou une formule, sans recopier les signes < et >. |
| < Actif ? > | Un nom de paramètre qui se termine par ? attend une valeur Vrai ou Faux. |
| [ … ] | Les crochets entourent ce qui est facultatif : on peut l'omettre. On ne recopie pas les crochets. |
| [, < B >] [, < C >] | Des crochets côte à côte sont des paramètres facultatifs indépendants. On peut donner B, C, les deux ou aucun. Si on donne C sans B, SIMAX reconnaît chaque paramètre à son type. |
| [, < B > [, < C >] ] | Des crochets imbriqués indiquent une dépendance : on ne peut donner C que si B est donné. |
| < Valeur 1 >, < Valeur 2 >, …, < Valeur n > | Les points de suspension indiquent qu'on peut répéter le paramètre autant de fois que nécessaire (la fiche précise le nombre maximum quand il y en a un). |
| Option : < Valeur > | Un paramètre nommé : on écrit le nom de l'option, le signe : puis la valeur (par exemple dans les fonctions Http ou EBICS). |
| - < Paramètre > : … | Sous la syntaxe, chaque paramètre est décrit sur une ligne : son nom, son rôle et, s'il y en a une, sa valeur par défaut. |
| Plusieurs syntaxes | Une même fonction peut avoir plusieurs syntaxes (par exemple une avec une date de fin et une avec une durée). L'aide donne alors une page par syntaxe. |
| Notation | Signification |
|---|---|
| ['Nom de colonne' de 'Formulaire' <XXXXXXXXXX>] | Dans les exemples, une colonne : son nom, son formulaire, puis son identifiant collé entre < >. |
| <%Nom%> | Un argument, qui peut être : un argument fourni par la fonction à sa formule (par exemple <%valeur%> dans la formule de MappeTableau), un argument défini dans la formule (par exemple avec Déclare ou une affectation), ou un paramètre d'une fonction externe. |
| Retourne … | Sous un exemple, la ligne « Retourne … » donne le résultat de la formule qui précède. |
| Syntaxe | Comment la lire |
|---|---|
| Abs(< Valeur >) | Un seul paramètre, obligatoire. |
| SINonVide(< Valeur 1 >, < Valeur 2 >, …, < Valeur n >) | Au moins deux valeurs, et autant d'autres que nécessaire. |
| TrouveRessourceLibre(< Liste Ressources >, < Date Heure Début >, < Date Heure Fin > [, < Ouvré ? >] [, < Liste à ignorer >]) | Trois paramètres obligatoires. Ouvré ? (Vrai ou Faux) et Liste à ignorer sont facultatifs et indépendants : on peut donner la liste à ignorer sans Ouvré ?. |
| Référence(< Référence > [, < Nb fixe au début > [, < Nb fixe à la fin > ] ]) | Nb fixe à la fin ne peut être donné qu'avec Nb fixe au début, car les crochets sont imbriqués. |
| AjouteDuréeOuvrée([< Date Heure > [, < Nombre Seconde >]] [,< Ressource / Pays >]) | Tout est facultatif. On peut donner la date seule ; le nombre de secondes n'existe qu'avec la date ; la ressource ou le pays est indépendant des deux autres. |
| HttpsGet(< URL > [, < Option > : < Valeur >] [, < Option > : < Valeur >] …) | L'URL est obligatoire. Les options sont facultatives et nommées : on écrit le nom de l'option, le signe : puis sa valeur. Les points de suspension indiquent qu'on peut donner autant d'options que nécessaire. |