Function eric_bindings::EricGetErrormessagesFromXMLAnswer

source · 
pub unsafe extern "C" fn EricGetErrormessagesFromXMLAnswer(
    xml: *const c_char,
    transferticketPuffer: EricRueckgabepufferHandle,
    returncodeTHPuffer: EricRueckgabepufferHandle,
    fehlertextTHPuffer: EricRueckgabepufferHandle,
    returncodesUndFehlertexteNDHXmlPuffer: EricRueckgabepufferHandle,
) -> c_int
Expand description

@brief Aus dem Antwort-XML des Finanzamtservers wird das Transferticket und Returncodes/Fehlermeldungen zurückgegeben.

Die Funktion liefert bei erfolgreicher Ausführung:

  • Das Transferticket aus dem Antwort-XML in dem Parameter @c transferticketPuffer.
  • Den Returncode und die Fehlermeldung aus dem Transferheader in den Parametern \c returncodeTHPuffer und \c fehlertextTHPuffer.
  • Für jeden Nutzdatenheader dessen Returncode und Fehlermeldung als XML-Daten im Parameter @c returncodesUndFehlertexteNDHXmlPuffer nach XML Schema Definition Dokumentation\API-Rueckgabe-Schemata\EricGetErrormessagesFromXMLAnswer.xsd. Enthält das Antwort-XML keine Nutzdaten, wird kein <Fehler> Element zurückgegeben.

Zur Erzeugung, Verwendung und Freigabe von Rückgabepuffern siehe Dokumentation zu ::EricRueckgabepufferHandle.

@param[in] xml Antwort-XML des ELSTER-Servers, das ausgewertet werden soll. Der originale XML-Server-Datenstrom sollte unverändert übergeben werden und darf insbesondere keine Zeilenumbruchzeichen enthalten. @param[out] transferticketPuffer Handle auf einen Rückgabepuffer, in den das Transferticket geschrieben wird, siehe ::EricRueckgabepufferHandle. @param[out] returncodeTHPuffer Handle auf einen Rückgabepuffer, in den der Returncode aus dem Transferheader geschrieben wird. Siehe ::EricRueckgabepufferHandle. @param[out] fehlertextTHPuffer Handle auf einen Rückgabepuffer, in den die Fehlermeldung aus dem Transferheader geschrieben wird, siehe ::EricRueckgabepufferHandle. @param[out] returncodesUndFehlertexteNDHXmlPuffer Handle auf einen Rückgabepuffer, in den die Liste der Returncodes nach XML-Schema Dokumentation\API-Rueckgabe-Schemata\EricGetErrormessagesFromXMLAnswer.xsd geschrieben werden, siehe ::EricRueckgabepufferHandle.

\b Beispiel: \code

1 Fehlermeldung 1 2 Fehlermeldung 2 (...) \endcode

@return - ::ERIC_OK - ::ERIC_IO_PARSE_FEHLER - ::ERIC_GLOBAL_NULL_PARAMETER - ::ERIC_GLOBAL_PUFFER_ZUGRIFFSKONFLIKT - ::ERIC_GLOBAL_NICHT_GENUEGEND_ARBEITSSPEICHER - ::ERIC_GLOBAL_UNKNOWN

@note

  • Diese Funktion kann nicht dafür verwendet werden, die Antwort im Datenteil aus einer dekodierten Serverantwort für Lohnsteuerbescheinigungen auszuwerten.

@see - XML-Schema des Transferheaders: Dokumentation\Schnittstellenbeschreibungen\ElsterBasisSchema\Schema\th000011_extern.xsd - XML-Schema des Nutzdatenheaders: Dokumentation\Schnittstellenbeschreibungen\ElsterBasisSchema\Schema\ndh000011.xsd - ERiC-Entwicklerhandbuch.pdf, Kap. “Schnittstellenbeschreibungen”, Tabelle “Ergänzende Softwarepakete und Dateien – Schnittstellenbeschreibungen”