Befehle der Schnittstellen

Befehle der Schnittstellen
Darstellung der Informationen zu einzelnen Befehlen

Alle Befehle werden in der gleichen Weise beschrieben.

• Syntaxdiagramm

  Hier wird in aller Kürze die Syntax des Befehls dargestellt. D. h. die Anzahl, die Reihenfolge und der Typ der Übergabeparameter und der Typ des Rückgabewertes werden angezeigt. Parameter, die weggelassen werden können, werden in eckigen Klammern [] gefasst.

• Ausführbarkeit des Befehls

  Die Symbole hinter dem Syntaxdiagramm geben Auskunft darüber, unter welchen Umständen der Befehl aufgerufen werden kann (oder nicht):

  		API
  		DLL
  		Application Remote Control
  		Script-API
  		ArcFlow.Next

• Kurzbeschreibung des Befehls

  Es folgt eine kurze Beschreibung des Befehls. Die Beschreibung ist dabei auf wenige Worte beschränkt.

• Parameterliste

  In diesem Bereich werden die Übergabeparameter mit einem Stichwort erläutert. Können Konstanten übergeben werden und die Liste der Konstanten ist nicht zu lang, werden hier bereits die möglichen Übergabeparameter angegeben.

  Werden durch den Befehl Datenbankfelder gesetzt oder müssen bestimmte Datenbankfelder vor der Durchführung des Befehls gesetzt sein, befinden sich eine Liste der Felder ebenfalls in der Parameterliste.

• Resultat

  Hier wird der Typ des Rückgabewertes (falls vorhanden) und eine kurze Beschreibung der Bedeutung angegeben.

• Links zu anderen Hilfethemen

  In diesem Bereich sind Verknüpfungen mit anderen Themen innerhalb der Hilfe aufgelistet. In der Regel befindet sich hier ein Link zu einer Liste mit Befehlen, die in der gleichen Kategorie angesiedelt sind.

• Beschreibung

  In dem Beschreibungstext wird der Befehl ausführlich erläutert. Die zu übergebenen Parameter und deren Bedeutung bzw. Herkunft (zum Beispiel als Rückgabewerte von anderen Befehlen, werden beschrieben. Am Ende stehen verschiedene Beispiele und die möglichen Rückgabewerte des Befehls.

Der Aufruf der Befehle kann entweder von einem CONZEPT 16-Client erfolgen, der die entsprechenden Prozeduren der API verwendet, oder von einer beliebigen Anwendung, die die Befehle über die Application Remote Control-Schnittstelle übermittelt. Die Aufrufe der Befehle sind unterschiedlich. Der Aufruf von der API folgt dem Syntaxdiagramm der Befehle. Der Aufruf über die ARC-Schnittstelle ist in dem entsprechenden Abschnitt der Hilfe beschrieben.