Funktionen zur Verwaltung von Werte-Paaren (KeyValues)

Funktionen zur Verwaltung von Werte-Paaren (KeyValues)

static KeyValues keyvalues::alloc()

Erzeuge ein KeyValues Listen-Objekt

Name Typ Default Beschreibung
Return KeyValues   neues KeyValues Objekt. Dieses Objekt muss mit keyvalues::release wieder freigegeben werden!
... String oder char* - optionale Liste von Wertepaaren, die direkt an die Liste angefügt werden 
// Anlegen einer leeren KeyValues Liste:
KeyValues values = keyvalues::alloc ();
 
// Anlegen einer KeyValues Liste mit Initial-Werten:
KeyValues values2 = keyvalues::alloc ("key1", "value1", "key2", "value2");

Version 4.1 R21349

priint:comet InDesign® Plug-Ins, comet_pdf, Illustrator

static KeyValues keyvalues::release(KeyValues list)

Lösche eine mit keyvalues::alloc erzeugte Liste und alle ihre Einträge wieder aus dem Speicher.

Name Typ Default Beschreibung
Return int   0
list KeyValues - Zu löschende Liste

Version 4.1 R21349

priint:comet InDesign® Plug-Ins, comet_pdf, Illustrator

clear

static int keyvalues::clear(KeyValues list)

Gibt eine KeyValues Liste frei

Name Typ Default Beschreibung
Return int   0 oder Fehlercode
list KeyValues - KeyValues Objekt

Version 4.1 R21349

priint:comet InDesign® Plug-Ins, comet_pdf, Illustrator

release

static int keyvalues::put(
  KeyValues list,
  char* key,
  char* value)

Füge einen Eintrag einer Liste hinzu bzw. ersetze einen vorhandenen Eintrag

Name Typ Default Beschreibung
Return int   0 oder Fehlercode
list KeyValues - KeyValues Objekt
key String oder char* - Schlüssel des Eintrags
value String oder char* - Wert des Eintrags

Version 4.1 R21349

priint:comet InDesign® Plug-Ins, comet_pdf, Illustrator

static char* keyvalues::get(KeyValues list, char* key)

Ermittle den Wert eines Eintrags in der KeyValues Liste

Name Typ Default Beschreibung
Return char *   Wert des Eintrags oder 0, sofern der Eintrag nicht existiert. Der Ergebnis-String darf nicht verändert werden!
list KeyValues - KeyValues Objekt
key String oder char* - Schlüssel des Eintrags

Version 4.1 R21349

priint:comet InDesign® Plug-Ins, comet_pdf, Illustrator

static char* keyvalues::remove(KeyValues list, char* key)

Lösche einen Eintrag aus einer KeyValues Liste

Name Typ Default Beschreibung
Return char *   Wert des gelöschten Eintrags oder 0, sofern der Eintrag nicht existiert. Der Ergebnis-String darf nicht verändert werden!
list KeyValues - KeyValues Objekt
key String oder char* - Schlüssel des Eintrags

Version 4.1 R21349

priint:comet InDesign® Plug-Ins, comet_pdf, Illustrator

static int keyvalues::contains(KeyValues list, char* key)

Prüfe, ob eine KeyValues Liste einen Eintrag enthält

Name Typ Default Beschreibung
Return int   1, sofern der gesuchte Eintrag existiert, andernfalls 0
list KeyValues - KeyValues Objekt
key String oder char* - Schlüssel des Eintrags

Version 4.1 R21349

priint:comet InDesign® Plug-Ins, comet_pdf, Illustrator

static int keyvalues::length(KeyValues list)

Ermittle die Länge (Anzahl Einträge) einer KeyValues Liste

Name Typ Default Beschreibung
Return int   Anzahl der Einträge in der Liste
list KeyValues - KeyValues Objekt

Version 4.1 R21349

priint:comet InDesign® Plug-Ins, comet_pdf, Illustrator

static char* keyvalues::to_xml(KeyValues list, char* rootElementName = "keyvalues")

Generiere die XML Struktur eines KeyValues-Objekts.

Wenn Sie über die Verwendung dieser Funktion nachdenken, sind Sie möglicherweise an näheren Informationen zur Interaktion von cscript mit auf dem PubServer als PlugIn bereitgestellten Java-Methoden interessiert. Mehr Informationen dazu finden Sie hier.

Name Typ Default Beschreibung
Return char*   xml string oder 0 bei Fehlern. Der Ergebnisstring ist nur bis zum nächsten Aufruf einer to_xml-Funktion gültig und darf nicht verändert oder freigegeben werden.
list KeyValues - Object
rootElementName String oder char* keyvalues Name des Root-Elements

Version 4.1 R21349

priint:comet InDesign® Plug-Ins, comet_pdf, Illustrator

comet.publication.toXMLKeyValueList

static KeyValues keyvalues::from_xml(char* xml)

Generiere eine KeyValues-Objekt aus einer XML Struktur.

Wenn Sie über die Verwendung dieser Funktion nachdenken, sind Sie möglicherweise an näheren Informationen zur Interaktion von cscript mit auf dem PubServer als PlugIn bereitgestellten Java-Methoden interessiert. Mehr Informationen dazu finden Sie hier.

Name Typ Default Beschreibung
Return KeyValues   Objekt vom Typ KeyValues. Dieses Objekt muss mit keyvalues::release wieder freigegeben werden.
xml String oder char* - xml string

Version 4.1 R21349

priint:comet InDesign® Plug-Ins, comet_pdf, Illustrator

comet.publication.fromXMLKeyValueList

static int keyvalues::add_all(
  KeyValues target,
  KeyValues src,
  int deleteFromSource = 0)

Füge alle Elemente der Liste src in die Liste target ein. Bei deleteFromSource != 0 werden die Elemente aus der Quellliste entfernt (aber nicht freigegeben)

Name Typ Default Beschreibung
Return int   0 oder Fehlercode.
target KeyValues - Zielliste
src KeyValues - Quellliste
deleteFromSource int 0 Elemente aus der Quelliste entfernen

Version 4.1 R21349

priint:comet InDesign® Plug-Ins, comet_pdf, Illustrator

static StringList keyvalues::get_keys(KeyValues list)

Hole alle in der KeyValues Liste enthaltenen Schlüssel. Die Einträge in der Ergebnisliste folgen keiner bestimmten Reihenfolge.

Name Typ Default Beschreibung
Return StringList   StringList Objekt. Diese Liste muss mit keyvalues::release() wieder freigegeben werden.
list KeyValues - gültiges KeyValues Objekt  

Version 4.1 R21349

priint:comet InDesign® Plug-Ins, comet_pdf, Illustrator

static StringList keyvalues::get_values(KeyValues list)

Hole alle in der KeyValues Liste enthaltenen Werte. Die Einträge in der Ergebnisliste folgen keiner bestimmten Reihenfolge.

Name Typ Default Beschreibung
Return StringList   StringList Objekt. Diese Liste muss mit keyvalues::release() wieder freigegeben werden.
list KeyValues - gültiges KeyValues Objekt  

Version 4.1 R21349

priint:comet InDesign® Plug-Ins, comet_pdf, Illustrator

Alphabetic index HTML hierarchy of classes or Java