ERiC API-Referenz 43.3.2.0

Lade ...
Suche ...
Keine Treffer
Makrodefinitionen | Funktionen
erictoolkit.h-Dateireferenz

Bereitstellung von Prüffunktionen ohne Abhängigkeit zu anderen ERiC Bibliotheken. Mehr ...

gehe zum Quellcode dieser Datei

## Makrodefinitionen
#define | ETKAPI_DECL

## Funktionen
ETKAPI_DECL int | EtkPruefeBuFaNummer (const char *steuernummer)
| Die Bundesfinanzamtsnummer wird überprüft.
ETKAPI_DECL int | EtkPruefeBIC (const char *bic)
| Die `bic` wird auf Gültigkeit überprüft.
ETKAPI_DECL int | EtkPruefeEWAz (const char *einheitswertAz)
| Überprüft ein `Einheitswert-Aktenzeichen` im ELSTER-Format auf Gültigkeit.
ETKAPI_DECL int | EtkPruefeIBAN (const char *iban)
| Die `iban` wird auf Gültigkeit überprüft.
ETKAPI_DECL int | EtkPruefeIdentifikationsMerkmal (const char *steuerId)
| Die `steuerId` wird auf Gültigkeit überprüft. Formal korrekte Test Identifikationsnummern (beginnen mit der Ziffer 0) sind zulässig.
ETKAPI_DECL int | EtkPruefeSteuernummer (const char *steuernummer)
| Die `steuernummer` wird einschließlich Bundesfinanzamtsnummer auf formale Richtigkeit geprüft.
ETKAPI_DECL int | EtkPruefeWIdNr (const char *wIdNr)
| Die `Wirtschafts-Identifikationsnummer` (`W-IdNr`.) wird auf formale Gültigkeit geprüft.
ETKAPI_DECL const char * | EtkHoleProduktVersion ()
| Abfragen der Produktversion des ERiCToolKit.
ETKAPI_DECL const char * | EtkHoleDateiVersion ()
| Abfragen der Dateiversion des ERiCToolKit.

## Ausführliche Beschreibung

Bereitstellung von Prüffunktionen ohne Abhängigkeit zu anderen ERiC Bibliotheken.

Definiert in Datei erictoolkit.h.

## Makro-Dokumentation

## ◆ ETKAPI_DECL

#define ETKAPI_DECL

Dieses Makro ist nur für die Kompilierung unter Windows von Belang. Auf allen anderen Plattformen ist es leer definiert.

Unter Windows gibt es bei Einbindung der erictoolkit.h in fremden Code an, dass die deklarierten Funktionen zu importieren sind (dllimport).

Siehe auch
  - ERICAPI_IMPORT

Definiert in Zeile 150 der Datei erictoolkit.h.

## Dokumentation der Funktionen

## ◆ EtkHoleDateiVersion()

ETKAPI_DECL const char * EtkHoleDateiVersion | ( |  | ) |

Abfragen der Dateiversion des ERiCToolKit.

Die Dateiversion wird in den bereitgestellten Speicher als NULL-terminierte C Zeichenkette zurückgegeben. Der Speicher muss/darf von der Anwendung nicht freigegeben werden.

Rückgabe
  - NULL-terminierte C Zeichenkette.

## ◆ EtkHoleProduktVersion()

ETKAPI_DECL const char * EtkHoleProduktVersion | ( |  | ) |

Abfragen der Produktversion des ERiCToolKit.

Die Produktversion wird in den bereitgestellten Speicher als NULL-terminierte C Zeichenkette zurückgegeben. Der Speicher muss/darf von der Anwendung nicht freigegeben werden.

Rückgabe
  - NULL-terminierte C Zeichenkette.

## ◆ EtkPruefeBIC()

ETKAPI_DECL int EtkPruefeBIC | ( | const char * | bic | ) |

Die `bic` wird auf Gültigkeit überprüft.

Die Prüfung erfolgt in zwei Schritten:

1. Formale Prüfung auf gültige Zeichen und richtige Länge
2. Prüfung, ob das Länderkennzeichen für BIC gültig ist.

Parameter

  [in] | bic | Zeiger auf eine NULL-terminierte Zeichenkette.

Rückgabe
  - ERIC_OK
  - ERIC_GLOBAL_BIC_FORMALER_FEHLER: Ungültige Zeichen, falsche Länge.
  - ERIC_GLOBAL_BIC_LAENDERCODE_FEHLER
  - ERIC_GLOBAL_NULL_PARAMETER: Parameter `bic` ist NULL.

Siehe auch
  - ERiC-Entwicklerhandbuch.pdf, Kap. "BIC ISO-Ländercodes"
  - ERiC-Entwicklerhandbuch.pdf, Kap. "BIC-Prüfung"

## ◆ EtkPruefeBuFaNummer()

ETKAPI_DECL int EtkPruefeBuFaNummer | ( | const char * | steuernummer | ) |

Die Bundesfinanzamtsnummer wird überprüft.

Wird eine 13-stellige Steuernummer im ELSTER-Steuernummernformat angegeben, so wird nur die Bundesfinanzamtsnummer (= die ersten 4 Stellen der 13-stelligen Steuernummer) geprüft.

Eine Prüfung der Steuernummer selbst findet nicht statt (hierfür EtkPruefeSteuernummer() verwenden).

Parameter

  [in] | steuernummer | 13-stellige Steuernummer im ELSTER Steuernummernformat bzw. 4-stellige Bundesfinanzamtsnummer.

Rückgabe
  - ERIC_OK
  - ERIC_GLOBAL_BUFANR_UNBEKANNT: Die Bundesfinanzamtsnummer ist unbekannt oder ungültig.
  - ERIC_GLOBAL_NULL_PARAMETER: Es wurde keine Bundesfinanzamtsnummer übergeben (Parameter ist NULL).

Siehe auch
  - EtkPruefeSteuernummer()
  - Pruefung_der_Steuer_und_Steueridentifikatsnummer.pdf, siehe Entwicklerbereich bei ELSTER.

## ◆ EtkPruefeEWAz()

ETKAPI_DECL int EtkPruefeEWAz | ( | const char * | einheitswertAz | ) |

Überprüft ein `Einheitswert-Aktenzeichen` im ELSTER-Format auf Gültigkeit.

Parameter

  [in] | einheitswertAz | Zeiger auf ein Einheitswert-Aktenzeichen im ELSTER-Format

Rückgabe
  - ERIC_OK
  - ERIC_GLOBAL_EWAZ_UNGUELTIG
  - ERIC_GLOBAL_NULL_PARAMETER

## ◆ EtkPruefeIBAN()

ETKAPI_DECL int EtkPruefeIBAN | ( | const char * | iban | ) |

Die `iban` wird auf Gültigkeit überprüft.

Die Prüfung erfolgt in vier Schritten:

1. Formale Prüfung auf gültige Zeichen und richtige Länge.
2. Prüfung, ob das Länderkennzeichen für IBAN gültig ist.
3. Prüfung, ob das länderspezifische Format gültig ist.
4. Prüfung, ob die Prüfziffer der IBAN gültig ist.

Parameter

  [in] | iban | Zeiger auf eine NULL-terminierte Zeichenkette.

Rückgabe
  - ERIC_OK
  - ERIC_GLOBAL_IBAN_FORMALER_FEHLER: Ungültige Zeichen, falsche Länge.
  - ERIC_GLOBAL_IBAN_LAENDERCODE_FEHLER
  - ERIC_GLOBAL_IBAN_LANDESFORMAT_FEHLER
  - ERIC_GLOBAL_IBAN_PRUEFZIFFER_FEHLER
  - ERIC_GLOBAL_NULL_PARAMETER: Parameter `iban` ist NULL.

Siehe auch
  - ERiC-Entwicklerhandbuch.pdf, Kap. "IBAN - länderspezifische Formate"
  - ERiC-Entwicklerhandbuch.pdf, Kap. "IBAN-Prüfung"

## ◆ EtkPruefeIdentifikationsMerkmal()

ETKAPI_DECL int EtkPruefeIdentifikationsMerkmal | ( | const char * | steuerId | ) |

Die `steuerId` wird auf Gültigkeit überprüft. Formal korrekte Test Identifikationsnummern (beginnen mit der Ziffer 0) sind zulässig.

Parameter

  [in] | steuerId | Steuer-Identifikationsnummer (IdNr)

Rückgabe
  - ERIC_OK
  - ERIC_GLOBAL_IDNUMMER_UNGUELTIG
  - ERIC_GLOBAL_NULL_PARAMETER

Siehe auch
  - ERiC-Entwicklerhandbuch.pdf, Kap. "Prüfung der Steueridentifikationsnummer (IdNr)"
  - ERiC-Entwicklerhandbuch.pdf, Kap. "Test-Steueridentifikationsnummer"
  - EtkPruefeSteuernummer()

## ◆ EtkPruefeSteuernummer()

ETKAPI_DECL int EtkPruefeSteuernummer | ( | const char * | steuernummer | ) |

Die `steuernummer` wird einschließlich Bundesfinanzamtsnummer auf formale Richtigkeit geprüft.

Zur Prüfung der Bundesfinanzamtsnummer wird EtkPruefeBuFaNummer() verwendet.

Parameter

  [in] | steuernummer | NULL-terminierte 13-stellige Steuernummer im ELSTER-Steuernummernformat.

Rückgabe
  - ERIC_OK
  - ERIC_GLOBAL_STEUERNUMMER_UNGUELTIG
  - ERIC_GLOBAL_NULL_PARAMETER

Siehe auch
  - EtkPruefeBuFaNummer()
  - Pruefung_der_Steuer_und_Steueridentifikatsnummer.pdf, siehe Entwicklerbereich bei ELSTER.

## ◆ EtkPruefeWIdNr()

ETKAPI_DECL int EtkPruefeWIdNr | ( | const char * | wIdNr | ) |

Die `Wirtschafts-Identifikationsnummer` (`W-IdNr`.) wird auf formale Gültigkeit geprüft.

Parameter

  [in] | wIdNr | NULL-terminierte Wirtschafts-Identifikationsnummer mit oder ohne Unterscheidungsmerkmal.

Rückgabe
  - ERIC_OK
  - ERIC_GLOBAL_IDNUMMER_UNGUELTIG
  - ERIC_GLOBAL_NULL_PARAMETER

Siehe auch
  - ERiC-Entwicklerhandbuch.pdf, Kap. "Prüfung der Wirtschafts-Identifikationsnummer (W-IdNr.)"