Funktion

Funktions-AEs werden von skalaren oder Tabellen-SQL-Funktionen aufgerufen.

Datenstrukturierer

struct NZAE_HANDLE: Die Funktion Handle. Ein undurchsichtiger Griff, der mit Function AE-Funktionen verwendet wird.

Funktionen

void nzaeClose(NZAE_HANDLE handle): Schließt den Griff, wenn er fertig ist.
NzaeRcCode nzaeDone(NZAE_HANDLE handle): Zeigt an, dass die AE beendet ist und keine weiteren Zeilen abruft und keine weiteren Ergebnisse ausgibt.
NzaeRcCode nzaeGetEnv(NZAE_HANDLE handle, const char *name, const char **result: Ruft eine AE- oder Systemumgebungsvariable ab. Die Agrarumweltmaßnahmen haben Vorrang.
void nzaeGetFirstEnvironmentEntry(NZAE_HANDLE handle, NzaeEnvironmentEntry *entry): Gibt den ersten Umgebungseintrag zurück.
NzaeRcCode nzaeGetInputColumn(NZAE_HANDLE handle, int index, NzudsData **data): Ruft die Daten der Eingabespalten ab. Der Index ist nullbasiert.
AeUserCode nzaeGetLastErrorCode(NZAE_HANDLE handle): Ruft den Code für den zuletzt aufgetretenen Fehler ab.
const char* nzaeGetLastErrorText(NZAE_HANDLE handle): Abrufen des Nachrichtentextes für den zuletzt aufgetretenen Fehler.
const char* nzaeGetLibraryFullPath(NZAE_HANDLE h, const char *libraryName, bool caseSens-itive): Ruft den Dateipfad für einen Bibliotheksnamen ab.
NzaeSharedLibraryInfo* nzaeGetLibraryInfo(NZAE_HANDLE h): Gibt NzaeSharedLibraryInfo der gemeinsam genutzten Bibliothek für die Anfrage zurück.

NzaeSharedLibraryInfo* nzaeGetLibraryProcessInfo(NZAE_HANDLE h): Gibt NzaeSharedLibraryInfo der gemeinsam genutzten Bibliothek für den Prozess zurück.

NzaeRcCode nzaeGetMetadata(NZAE_HANDLE handle, NzaeMetadata *arg): Ruft Metadaten über die AE ab.
NzaeRcCode nzaeGetNext(NZAE_HANDLE handle): Ruft die nächste Eingabezeile ab; gibt NZAE_RC_END am Ende der Datei zurück.
bool nzaeGetNextEnvironmentEntry(NZAE_HANDLE handle, NzaeEnvironmentEntry *entry): Gibt den nächsten Umgebungseintrag zurück.
NzaeRcCode nzaeGetNextPartition(NZAE_HANDLE handle): Ruft die nächste Partition ab; gibt NZAE_RC_END bei Ende der Partition zurück.

int nzaeGetNumberOfParameters(NZAE_HANDLE h): Gibt die Anzahl der Parameter zurück.
const char* nzaeGetParameter(NZAE_HANDLE h, int: Gibt einen Parameter zurück.
NzaeRcCode nzaeGetRuntime(NZAE_HANDLE handle, NzaeRuntime *arg): Ruft Laufzeitinformationen über die AE ab.
NzaeRcCode nzaeLog(NZAE_HANDLE handle, NzaeLogLevel level, const char *message): Protokolliert die angegebene Nachricht.
NzaeRcCode nzaeOutputResult(NZAE_HANDLE handle): Gibt eine Ergebniszeile aus, die die aktuellen Spaltenwerte enthält.
NzaeRcCode nzaePing(NZAE_HANDLE handle): Zeigt an, dass die AE noch aktiv ist und nicht hängt.
NzaeRcCode nzaeUserError(NZAE_HANDLE handle, const char *_template,...): Zeigt an, dass bei dieser AE ein Fehler aufgetreten ist.

Auflistung

enum NzaeCorrelationType { NzaeUnknownCorrelationType= 0, NzaeUncorrelated= 1, NzaeInnerCorrelation= 2, NzaeLeftCorrelation= 3 }: Spezialisierte Informationen darüber, wie diese AE aufgerufen wird.
enum NzaeRcCode { NZAE_RC_ERROR= -1, NZAE_RC_NORMAL= 0, NZAE_RC_END= 1 }: Rückgabecodes von nzae-Funktionen.

Detaillierte Beschreibung

Funktions-AEs werden von skalaren oder Tabellen-SQL-Funktionen aufgerufen.

Dokumentation der Funktion

void nzaeClose(NZAE_HANDLE handle)

Schließt den Griff, wenn er fertig ist.

Parameter:

handle
Der Funktionsgriff.

NzaeRcCode nzaeDone(NZAE_HANDLE handle)

Zeigt an, dass die AE beendet ist und keine weiteren Zeilen abruft und keine weiteren Ergebnisse ausgibt.

Parameter:

handle
Der Funktionsgriff.

Rückgabe

NzaeRcCode

Der Rückgabecode der Funktion.

NzaeRcCode nzaeGetEnv(NZAE_HANDLE handle, const char *name, const char **result)

Zeigt an, dass die AE beendet ist und keine weiteren Zeilen abruft und keine weiteren Ergebnisse ausgibt.

Parameter:

handle
Der Funktionsgriff.

Rückgabe

NzaeRcCode

Der Rückgabecode der Funktion.

void nzaeGetFirstEnvironmentEntry(NZAE_HANDLE handle, NzaeEnvironmentEntry *entry)

Gibt den ersten Umgebungseintrag zurück.

Parameter:

handle
Der Funktionsgriff.

Rückgabe

NzaeEnvironmentEntry entry

Erster Eintrag.

Auf diesen Funktionsaufruf folgen wiederholte Aufrufe von nzaeGetNextEnvironmentEntry. Das AE-System ist Eigentümer des Speichers für diesen Anruf.

NzaeRcCode nzaeGetInputColumn(NZAE_HANDLE handle, int index, NzudsData **data)

Ruft die Daten der Eingabespalten ab. Der Index ist nullbasiert.

Parameter:

handle
Der Funktionsgriff.

index

Der Eingangsindex.
NzudsData data
Die UDS-Daten.

Rückgabe

NzaeRcCode

Der Rückgabecode der Funktion.

NzudsData ist in nzuds.h definiert. Die Daten gehören zum Framework und sollten nicht freigegeben werden. Wird aufgerufen, nachdem nzaeGetNext verwendet wurde, um die nächste Zeile zurückzugeben.

AeUserCode nzaeGetLastErrorCode(NZAE_HANDLE handle)

Ruft den Code für den zuletzt aufgetretenen Fehler ab.

Parameter:

handle
Der Funktionsgriff.

Rückgabe

AeUserCode

Der Funktionsfehlercode für den zuletzt aufgetretenen Fehler.

const char* nzaeGetLastErrorText(NZAE_HANDLE handle)

Abrufen des Nachrichtentextes für den zuletzt aufgetretenen Fehler.

Parameter:

handle
Der Funktionsgriff.

Rückgabe

Der Meldungstext des zuletzt aufgetretenen Fehlers.

const char* nzaeGetLibraryFullPath(NZAE_HANDLE h, const char *libraryName, bool caseSensitive)

Ruft den Dateipfad für einen Bibliotheksnamen ab.

Parameter:

h
Der Funktionsgriff.
libraryName
Gibt den Bibliotheksnamen an.
caseSensitive
Wenn TRUE, wird bei der Suche die Groß- und Kleinschreibung beachtet.

Rückgabe

Dateipfad, wenn gefunden; sonst NULL

Gibt NULL zurück, wenn die Bibliothek nicht gefunden wird. Das AE-System ist Eigentümer des Speichers aus diesem Aufruf.

NzaeSharedLibraryInfo* nzaeGetLibraryInfo(NZAE_HANDLE h)

Gibt NzaeSharedLibraryInfo der gemeinsam genutzten Bibliothek für die Anfrage zurück.

Parameter:

h
Der Funktionsgriff.

Rückgabe

NzaeSharedLibraryInfo

Die Informationen der Gemeinsamen Bibliothek.

Das AE-System ist Eigentümer des Speichers aus diesem Aufruf.

NzaeSharedLibraryInfo* nzaeGetLibraryProcessInfo(NZAE_HANDLE h)

Gibt NzaeSharedLibraryInfo der gemeinsam genutzten Bibliothek für den Prozess zurück.

Parameter:

h
Der Funktionsgriff.

Rückgabe

NzaeSharedLibraryInfo

Die Informationen der Gemeinsamen Bibliothek.

Gibt NULL zurück, wenn es sich nicht um eine entfernte AE handelt. Das AE-System ist Eigentümer des Speichers aus diesem Aufruf.

NzaeRcCode nzaeGetMetadata(NZAE_HANDLE handle, NzaeMetadata *arg)

Ruft Metadaten über die AE ab.

Parameter:

handle
Der Funktionsgriff.
NzaeMetadata arg
Metadaten, die ausgefüllt werden müssen. Vom Anrufer erstellt.

Rückgabe

NzaeRcCode

Der Rückgabecode der Funktion.

NzaeRcCode nzaeGetNext(NZAE_HANDLE handle)

Ruft die nächste Eingabezeile ab; gibt NZAE_RC_END am Ende der Datei zurück.

Parameter:

handle
Der Funktionsgriff.

Rückgabe

NzaeRcCode

Der Rückgabecode der Funktion.

Invalidiert vorherige Daten, die von nzaeGetInputColumn zurückgegeben wurden.

bool nzaeGetNextEnvironmentEntry(NZAE_HANDLE handle, NzaeEnvironmentEntry *entry)

Gibt den nächsten Umgebungseintrag zurück.

Parameter:

handle
Der Funktionsgriff.
NzaeEnvironmentEntry entry
Der nächste Eintrag.

Rückgabe

FALSE am Ende.

Der erste nzaeGetNextEnvironmentEntry muss auf einen Aufruf von nzaeGetFirstEnvironmentEntry folgen. Gibt am Ende FALSE zurück. Schlüsselnamen können sich wiederholen, aber die aktuelle Version eines Schlüsselnamens kommt zuletzt. Das AE-System ist Eigentümer des Speichers aus diesem Aufruf.

NzaeRcCode nzaeGetNextPartition(NZAE_HANDLE handle)

Ruft die nächste Partition ab; gibt NZAE_RC_END bei Ende der Partition zurück.

Parameter:

handle
Der Funktionsgriff.

Rückgabe

NzaeRcCode

Der Rückgabecode der Funktion.

Invalidiert vorherige Daten, die durch nzaeGetInputColumn gewonnen wurden.

int nzaeGetNumberOfParameters(NZAE_HANDLE h)

Gibt die Anzahl der Parameter zurück.

Parameter:

h
Der Funktionsgriff.

Rückgabe

Die Anzahl der Parameter.

const char* nzaeGetParameter(NZAE_HANDLE h, int index)

Gibt einen Parameter zurück.

Parameter:

h
Der Funktionsgriff.
index
Der Parameterindex.

Rückgabe

Der Wert des Parameters.

Der Index ist nullbasiert.

NzaeRcCode nzaeGetRuntime(NZAE_HANDLE handle, NzaeRuntime *arg)

Ruft Laufzeitinformationen über die AE ab.

Parameter:

handle
Der Funktionsgriff.
NzaeRuntime arg
Die Laufzeit muss ausgefüllt werden. Vom Anrufer erstellt.

Rückgabe

NzaeRcCode

Der Rückgabecode der Funktion.

NzaeRcCode nzaeLog(NZAE_HANDLE handle, NzaeLogLevel level, const char *message)

Protokolliert die angegebene Nachricht.

Parameter:

handle
Der Funktionsgriff.
NzaeLogLevel level
Die Protokollebene.
message
Die Logmeldung.

Rückgabe

NzaeRcCode

Der Rückgabecode der Funktion.

NzaeRcCode nzaeOutputResult(NZAE_HANDLE handle)

Gibt eine Ergebniszeile aus, die die aktuellen Spaltenwerte enthält.

Parameter:

handle
Der Funktionsgriff.

Rückgabe

NzaeRcCode

Der Rückgabecode der Funktion.

NzaeRcCode nzaePing(NZAE_HANDLE handle)

Zeigt an, dass die AE noch aktiv ist und nicht hängt.

Parameter:

handle
Der Funktionsgriff.

Rückgabe

NzaeRcCode

Der Rückgabecode der Funktion.

NzaeRcCode nzaeUserError(NZAE_HANDLE handle, const char *_template,...)

Zeigt an, dass bei dieser AE ein Fehler aufgetreten ist.

Parameter:

handle
Der Funktionsgriff.
_template
Die Vorlage im Stil von printf.

Rückgabe

NzaeRcCode

Der Rückgabecode der Funktion.

Impliziert nzaeDone. Message ist wie printf aufgebaut.

Dokumentation der Aufzählungstypen

enum NzaeCorrelationType

Spezialisierte Informationen darüber, wie diese AE aufgerufen wird.

NzaeUnknownCorrelationType

NzaeUncorrelated

NzaeInnerCorrelation

NzaeLeftCorrelation

enum NzaeRcCode

Rückgabecodes von nzae-Funktionen.

NZAE_RC_ERROR

NZAE_RC_NORMAL

NZAE_RC_END