Die Funktionsbeschreibungen folgen alle demselben Prinzip, das im Folgenden erläutert werden soll.
Die Beschreibung einer Funktion ist in folgende Informationsabschnitte aufgeteilt:
Funktionsname und deutsche Kurzbezeichnung in der Überschrift
Definition und allgemeine Funktionsbeschreibung
Parameter
Returnwert
Hinweise
Satz-E/A
Beispiel
Siehe auch
Einige der o.g. Abschnitte können fehlen, wenn sie für die Funktion ohne Bedeutung sind bzw. wenn die Information (wie z.B. Datentyp der Parameter) bereits aus der Syntax des Funktionsaufrufes hervorgeht.
Definition und allgemeine Funktionsbeschreibung
Die Funktionsdefinition enthält folgende Informationen:
den Namen der Include-Datei, die man für die Funktion benötigt,
den Funktionskopf (Datentyp und Name der Funktion, Liste der formalen Parameter).
Funktionsköpfe, die mit (C11) gekennzeichnet sind, sind in der Include-Datei nur für Übersetzungen mit C/C++ Version >= V4.0A und Sprachmodus C11 bzw. C++ 2017 definiert.
Funktionsköpfe, die mit (nicht C11) gekennzeichnet sind, sind in der Include-Datei für Übersetzungen mit C/C++ Version >= V4.0A und Sprachmodus C11 bzw. C++ 2017 nicht definiert.
Nach der Definition (Include-Dateien/Funktionskopf) finden Sie die allgemeine Beschreibung der Arbeitsweise einer Funktion.
Parameter
Im Anschluss an die Beschreibung finden Sie bei komplexeren Funktionen eine Beschreibung der Parameter: Bedeutung, mögliche Werte, davon abhängige Wirkungsweise etc.
Es wird unterschieden zwischen Eingabe- und Ergebnisparametern. Im Unterschied zu Eingabeparametern wird bei Ergebnisparametern der Inhalt der beim Aufruf übergebenen Variablen durch die Funktion verändert. Man spricht hier auch von „impliziten“ Funktionsergebnissen. Ergebnisparameter sind als Zeiger auf ein Objekt ohne den Zusatz „const“ definiert. Für Ergebnisparameter müssen Sie beim Funktionsaufruf stets die Variablenadresse, d.h. ein Zeigerargument, angeben. Für Vektoren, Zeichenkettenvariablen und Strukturen ist außerdem genügend Speicherplatz bereitzustellen.
Returnwert
Hier werden die möglichen Funktionsergebnisse aufgelistet. Zeigt der Returnwert einen Fehler an, finden Sie als zusätzlichen Hinweis, ob und ggf. welcher Fehlercode in der Variablen errno abgespeichert wird.
Hinweise
In diesem Informationsabschnitt finden Sie folgende Informationen:
mögliche Fehlerquellen (immer als erste Information),
Programmier- und Anwendungstips,
Zusammenhang mit anderen Funktionen,
technische Details zur Arbeitsweise der Funktion,
BS2000-Besonderheiten.
Satz-E/A
Diesen Informationsabschnitt finden Sie bei allen Ein-/Ausgabefunktionen, die auch auf Dateien mit satzorientierter Ein-/Ausgabe anwendbar sind. Er ergänzt die allgemeinen „Hinweise“ (vornehmlich für stromorientierte Ein-/Ausgabe formuliert) mit Besonderheiten, die bei Satz-E/A zu beachten sind.
Vgl. "Binärdatei", "Stromorientierte Ein-/Ausgabe" und "Satzorientierte-Ein-/Ausgabe" im Abschnitt "Grundbegriffe".
Beispiel
Kurzes Beispiel, das die Anwendung der beschriebenen Funktion illustriert.
Siehe auch
Verweise auf die Namen verwandter Funktionen.