11.45 setvalue()

Mit Hilfe dieser Funktion werden Sie in die Lage versetzt, Attribute von Objekten zu verändern.

Die dabei zulässigen Attribute für den jeweiligen Objekttyp entnehmen Sie bitte der „Objektreferenz“.

Mit setvalue() können Sie Werte ändern, ohne dass dadurch ein changed-Ereignis ausgelöst wird. Dies ist sinnvoll, wenn mit den Schleifenkonstrukten innerhalb einer Regel sehr viele Werte auf einmal abgeändert werden sollen. Es besteht sonst die Gefahr, dass die interne Setvalue-Ereignisqueue überläuft.

Definition

boolean setvalue
(
      object    Obj  input,
      attribute Attr input,
      anyvalue  NewVal input
  { , integer   IntIdx input | index IdxIdx input }
  { , boolean   SendEvent := true input }
)

Parameter

object Obj input
Dieser Parameter beschreibt das Objekt, dessen Attribut Sie ändern möchten.
attribute Attr input
Dieser Parameter beschreibt das Objektattribut, das Sie ändern möchten.
anyvalue NewVal input
In diesem Parameter wird der Wert übergeben, den das Attribut annehmen soll.
integer IntIdx input
index IdxIdx input
Dieser optionale Parameter kann entweder ein Integerwert oder ein Indexwert sein. Er muss gesetzt werden, wenn ein vektorielles Attribut gesetzt werden soll. Soll dabei ein eindimensionales Attribut gesetzt werden, so muss hier eine Zahl angegeben werden. Soll ein zweidimensionales Attribut gesetzt werden, so muss hier ein Index angegeben werden.
boolean SendEvent := true input
Über diesen optionalen Parameter wird gesteuert, ob der Dialog Manager durch das erfolgreiche Setzen des Attributes die Regelbearbeitung auslösen soll oder nicht. Der Parameter muss mit false belegt sein, wenn keine Events verschickt werden sollen. Sollen Events verschickt werden, muss dieser Parameter mit true belegt oder weggelassen sein.

Rückgabewert

true
Das Setzen des Attributes wurde erfolgreich ausgeführt.
false
Das Attribut konnte nicht gesetzt werden.

Beispiele

Siehe auch

Methode :set()

C-Funktion DM_SetValue im Handbuch „C-Schnittstelle - Funktionen“