IMSMGetFirstReceiverAddress

Autor: Alexander Berger
Headerdatei: imsm.h

Prototyp
Retcode_t MODULE_FUNCTION IMSMGetFirstReceiverAddress(
   PHEnum_t             iterator,
   IMReceiverAddress_s* receiverAddress );

Kurzbeschreibung
Das IMS System ruft diese Funktion auf, wenn es alle Kanäle eines Moduls ermittelt will. Mit dieser Funktion wird eine Iteration gestartet. Auf diesen Aufruf folgt jeweils IMSMGetNextReceiverAddress, um die weiteren Kanäle zu ermitteln. Das Modul erhält mit dieser Funktion die Möglichkeit, interne iterationsspezifische Daten zu initialisieren und diese im Parameter 'iterator' zu speichern. Der 'iterator'-Parameter wird vom IMS bei allen weiteren Aufrufen der Funktion IMSMGetNextReceiverAddress übergeben.

Parameter
iterator - Zeiger auf eine Variable vom Typ HEnum_t. Das Modul kann diese Variable als 'Merker' für die Iterationsdaten verwendet, indem es z.B. einen Zeiger auf bestimmte, iterationsspezifische Daten in diese Variable schreibt. ACHTUNG: HEnum_t ist ein 32-Bit-Wert und kann daher entweder als 32-Bit Zahl oder als Zeiger verwendet werden. Auf keinen Fall dürfen längere Daten in diese Variable geschrieben werden.

receiverAddress - Zeiger auf eine IMReceiverAddress_s - Struktur. Bei Erfolg muß diese Struktur die kompletten Daten zu einem Kanal (Empfänger) enthalten.

Rückgabewert:
Wenn ein Kanal eingetragen wurde, muß RC_SUCCESS zurückgegeben werden. Wenn keine Kanäle vorhanden sind (z.B. bei Modulen mit einer dynamischen Anzahl von Kanälen), muß RC_NO_DATA zurückgegeben werden. Ansonsten wird einer der definierten Fehlercodes erwartet.

Anmerkungen:
Keine