ObjectGetInteger

Gibt den Wert der entsprechenden Eigenschaft des Objekts zurück. Eigenschaft des Objekts muss der Typen datetime, int, color, bool oder char sein. Es gibt  2 Varianten der Funktion.

1. Gibt den Wert der Eigenschaft direkt zurück.

long  ObjectGetInteger(
   long    chart_id,          // Identifikator des Charts
   string  name,              // Objektname
   int     prop_id,           // Identifikator der Eigenschaft
   int     prop_modifier=0    // Modifikator der Eigenschaft wenn erforderlich 
   );

2. Gibt true oder false zurück abhängig davon, ob die Funktion erfolgreich durchgeführt wird. Im Erfolgsfall wird der Wert der Eigenschaft in die Empfangsvariable gesetzt, die durch Referenz vom letzten Parameter übertragen wird.  

bool  ObjectGetInteger(
   long    chart_id,          // Identifikator des Charts 
   string  name,              // Objektname
   int     prop_id,           // Identifikator der Eifgenschaft
   int     prop_modifier,     // Modifikator der Eigenschaft
   long&   long_var           // hier erhalten wir den Wert der Eigenschaft 
   );

Parameter

chart_id

[in]  Identifikator des Charts. 0 bedeutet den laufenden Chart.

name

[in]  Objektname.

prop_id

[in]  Identifikator der Eigenschaft des Objekts. Wert kann einer der Enumerationswerte ENUM_OBJECT_PROPERTY_INTEGER sein.

prop_modifier

[in]  Modifikator der angegebenen Eigenschaft. Für die erste Variante ist der Default-Wert des Modifikators 0. Die meisten Eigenschaften erfordern keinen Modifikator. Bedeutet die Standnummer in Fibonacci Werkzeuge und in Andrew's Pitchfork. Nummerierung beginnt bei Null.

long_var

[out]  Variable des Typs long, die den Wert der angeforderten Eigenschaft annimmt.

Rückgabewert

Wert des Typs long für die erste Variante des Aufrufs.

für die zweite Variante des Aufrufs gibt true zurück, wenn diese Eigenschaft unterstuetzt wird und der Wert in die Variable long_var gesetzt wurde, anderenfalls gibt false zurück. Für Erhaltung der weiteren Information über den Fehler, muss die Funktion GetLastError() aufgerufen werden.

Hinweis

Die Funktion verwendet einen synchronen Aufruf, d.h. dass die Funktion auf die Ausführung aller Befehle wartet, die vor deren Aufruf zur Warteschlange des Charts hinzugefügt wurden, deswegen kann die Funktion viel Zeit in Anspruch nehmen. Dies muss man beachten, wenn man mit vielen Objekten im Chart arbeitet.