Variable_set - Programmschnittstelle (API)

Variable_set – Variablenmenge zur Übergabe von Parametern

int	variable_set.count	Anzahl der Variablen

	variable_set.merge( Variable_set )	Mischt eine andere Variablenmenge ein

String	variable_set.names	Alle Variablennamen durch Semikolon getrennt

	variable_set.set_var( name, value )	Setzt eine Variable

String	variable_set.substitute( String )	Ersetzt $-Variablen in einem String

	variable_set.value( name ) = value	Eine Variable
Variant	variable_set.value( name )

	variable_set.xml = String	`Variable_set` als XML-Dokument
String	variable_set.xml

Variablenmengen werden gebraucht für die Scheduler-weiten Variablen und Task-Parameter. Eine neue Variablenmenge wird mit Spooler.create_variable_set() angelegt.

Die Großschreibung der Variablennamen ist nicht relevant.

In COM (JavaScript, VBScript, Perl) ist ein Variablenwert ein Variant. Weil die Variablen in der Regel in die Scheduler-Datenbank geschrieben werden, sollten nur nach String konvertierbare Variant-Werte verwendet werden (d.h. es sollten keine Objekte verwendet werden).

In Java ist ein Variablenwert ein String. Wenn die Variable mit COM als Variant gesetzt worden ist, wird beim Lesen der nach String konvertierte Wert zurückgegeben. Null und Empty werden als null zurückgeliefert. Wenn ein Variant-Wert nicht konvertierbar ist, wird eine Exception ausgelöst.

Siehe auch <params> und <sos.spooler.variable_set>.

count

Anzahl der Variablen

int	variable_set.count

merge

Mischt eine andere Variablenmenge ein

variable_set.merge( Variable_set )

Gleichnamige Variablen werden überschrieben.

Parameter

Variable_set

names

Alle Variablennamen durch Semikolon getrennt

String

variable_set.names

Beispiel

var variable_set = spooler.create_variable_set();
spooler_log.info( '"' + variable_set.names + '"' );        // ==> ""

variable_set( "variable_1" ) = "edno";
variable_set( "variable_2" ) = "dwa";

spooler_log.info( '"' + variable_set.names + '"' );        // ==> "variable_1;variable_2"

var names = variable_set.names.split( ";" );
for( var i in names )  spooler_log.info( names[i] + "=" + variable_set( names[i] ) );

Rückgabe

String

Die Namen aller Variablen durch Semikolon getrennt.

set_var

Setzt eine Variable

variable_set.set_var( String name, Variant value )

Parameter

name
value

substitute

Ersetzt $-Variablen in einem String

String

variable_set.substitute( String )

Beispiel

subprocess.start( subprocess.env.substitute( "${MY_HOME}/my_program" ) );

Im Beispiel wird Subprocess.env verwendet.

Referenzen der Form $name und ${name} im String werden durch Variablenwerte ersetzt, siehe auch »Einstellungen, die den Abruf von Umgebungsvariablen mit ${…} erlauben«.

Parameter

String

Rückgabe

String

Die Zeichenkette mit den ersetzten $-Variablen

value

Eine Variable

	variable_set.value( String name ) = Variant value
Variant	variable_set.value( String name )

Parameter

name
value	`empty`, wenn die Variable nicht vorhanden ist.

Rückgabe

Variant

empty, wenn die Variable nicht vorhanden ist.

xml

Variable_set als XML-Dokument

	variable_set.xml = String
String	variable_set.xml

Beispiel

var variable_set = spooler.create_variable_set();
spooler_log.info( variable_set.xml );   // Liefert <?xml version='1.0'?><sos.spooler.variable_set/>

variable_set.xml= "<?xml version='1.0'?>" +
                  "<params>" +
                      "<param name='nachname' value='Meier'/>" +
                      "<param name='vorname' value='Hans'/>" + 
                  "</params>";
spooler_log.info( variable_set.xml );
spooler_log.info( "nachname=" + variable_set.value( "nachname" ) );
spooler_log.info( "vorname =" + variable_set.value( "vorname" ) );

Siehe <sos.spooler.variable_set>, <params>.

Parameter

String

XML-Dokument als String. Liefert <sos.spooler.variable_set>. Beim Setzen wird der Name des Wurzelelements nicht beachtet, <params> oder <sos.spooler.variable_set> kann übergeben werden.

Rückgabe

String

XML-Dokument als String. Liefert <sos.spooler.variable_set>. Beim Setzen wird der Name des Wurzelelements nicht beachtet, <params> oder <sos.spooler.variable_set> kann übergeben werden.

Software- und Organisations-Service GmbH

Zuletzt geändert von Joacim Zschimmer, 2008-06-03