SignedWrite()
- Last UpdatedApr 24, 2026
- 5 minute read
Fait une écriture dans un attribut d'objet Automation configuré en mode d'écriture sécurisée ou vérifiée.
Remarque : SignedWrite() est actuellement pris en charge uniquement pour les applications InTouch HMI.
Catégorie
Divers
Syntaxe
int SignedWrite(string unAttribut,
object laValeur,
string descriptionMotif,
Bool comment_Modifiable,
Enum comment_Modalité,
string[] liste_Comment_Predefinis
);
Des parenthèses droites [ ] indiquent une matrice.
Paramètres
|
Attribut |
Nom de l’attribut à mettre à jour et type de données de chaîne. Peut être une constante chaîne, une référence ou une expression. Prend en charge les références liées et à liaison imbriquées. Pour des exemples détaillés d'utilisation des paramètres Attribute, voir la rubrique Exemples d'utilisation du paramètre d'attribut dans la fonction SignedWrite() sous Guide de l'utilisateur de création et de gestion de graphiques industriels. Exemple 1 : « DefUtilisateur_001.temp » Exemple 2 : « Pompe15 » + « .vanne4 » Exemple 3 : Soit UDO_7 contenant deux attributs chaînes, nomChaineA et nomChaineA définis aux
valeurs « Cuve1 » et « Cuve5 » respectivement, le script suivant écrit dans Cuve1.Level
ou Cuve5.Level selon que selectionChaine vaut « A » ou « B »: Dim selectionChaine As String; Dim x As Indirect; { logique pour définir selectionChaine à « A » ou « B » } x.BindTo ("UDO_7.namestr" + selectionChaine); SignedWrite(x + ".Level", 243, "Définit le niveau " + x, true, 0, null); |
|
Valeur |
La valeur à écrire. Le type de données est un objet. La plage valide de la valeur doit coïncider avec le type de données de l’attribut à mettre à jour. La valeur peut être une valeur constante, une référence, une expression ou NULL si rien n’est à saisir. |
|
descriptionMotif |
Texte pour expliquer l’usage de l’attribut cible et l’impact de sa modification. Le type de données est une chaîne avec une longueur maximale de 256 caractères. Peut être une chaîne constante, une référence ou une expression. La valeur ReasonDescription est passée à l’attribut indiqué au moment de l’opération d’écriture. L'objet inclut également le commentaire utilisateur de l'écriture, si besoin. Une description du champ de l'attribut s'utilise pour le paramètre descriptionMotif si l'attribut est un champ et possède une description (non nulle). Autrement, la description courte dans l'objet Application est utilisée pour le paramètre descriptionMotif. |
|
comment_Modifiable |
Ce paramètre indique si l’utilisateur peut modifier le commentaire d’écriture. Le type de données est Boolean. Si défini sur True : la zone de texte du commentaire est activée avec des exceptions.
|
|
comment_Modalité |
Ce paramètre est de type de données Enum, avec les options de valeur suivantes : 0 = facultatif 1 = obligatoire 2 = prédéfini uniquement |
|
liste_Comment_Predefinis |
Une matrice de chaînes utilisée pour les commentaires prédéfinis. Les données sont de type String. Maximum de 20 commentaires, chacun avec un maximum de 200 caractères.
|
Valeurs retour
Les valeurs renvoyées indiquent l'état : succès ou défaillance. Une valeur différente de zéro indique le type de défaillance.
|
0 |
La fonction renvoie une valeur 0 (signifiant que l'opération a réussi) si les conditions suivantes sont toutes vraies :
|
|
1 |
La fonction a échoué pour une erreur quelconque non couverte par les autres valeurs d'erreur. Ceci inclut toutes les erreurs non associées aux autres valeurs de retour spécifiées. En cas de défaillance, un message spécifique est consigné dans le Logger. |
|
2 |
Un ou plusieurs paramètres n'étaient pas convertibles au type de données approprié en exploitation. Exemple : le paramètre est une référence et le type de données attendu est Boolean. En exploitation, une référence est un type de données chaîne qui n'est pas convertible à vrai ou faux. La fonction renvoie cette valeur et consigne un message dans le Logger. |
|
3 |
Le paramètre unAttribut n'était pas valide pendant l'exploitation.
|
|
4 |
La valeur du paramètre comment_Modalité n'était pas dans l'intervalle des énumerateurs valides. |
Remarques
La fonction SignedWrite() est prise en charge uniquement pour des scripts client, et non pour des scripts d'objet.
Une valeur retour de zéro n'indique pas si l'attribut était mis à jour, mais seulement que la fonction a placé une entrée dans la file d'attente pour écrire dans l'attribut. L'opérateur peut décider d'annuler l'opération après l'affichage de la boîte de dialogue d'écriture sécurisée ou vérifiée. Dans ce cas, l'attribut n'est pas mis à jour et un message d'information est consigné dans le Logger indiquant l'annulation par l'utilisateur. Même si l’utilisateur saisit des informations d’identification valides et clique sur OK, il est possible que l’attribut ne soit pas mis à jour à cause d’autorisations non adéquates ou de problèmes de conversion de données.
La fonction SignedWrite() prend en charge la propriété personnalisée passée comme premièr paramètre entre des guillemets
Si la propriété personnalisée CP est configurée comme dans le script suivant, la fonction tente de résoudre CP et de déterminer si elle possède une référence. Si elle possède une référence, celle-ci est récupérée et l'écriture appliquée à la référence.
SignedWrite("CP", laValeur, leMotif, siModifiable, modeSaisie, null);
Pour plus d'informations sur l'utilisation de la fonction SignedWrite(), voir la rubrique Travailler avec la fonction SignedWrite() pour les écritures sécurisées et vérifiées sous « Gestion des graphiques » dans le Guide de l'utilisateur de création et de gestion de graphiques industriels.
Exemples
SignedWrite ("DefUtilisateur_001.temp", 185, "Ceci change la température du four", true, 1, null);
L'exemple suivant présente à l'utilisateur une matrice de commentaire prédéfinis :
Dim n as Integer;
n = SignedWrite("DefUtilisateur_001.temp", 185, "Ceci change la température du four", true, 1, DefUtilisateur_001.OvenCommentArray[ ]);
où DefUtilisateur_001.OvenCommentArray est un attribut contenant une matrice de chaînes.