IMGetNextMessageSource

Autor: Alexander Berger
Headerdatei:
imsourcemodule.h

Prototyp
Retcode_t MODULE_FUNCTION IMGetNextMessageSource(
   HEnum_t iterator,
   Char_t* sourceName,
   Char_t* subAddress );

Kurzbeschreibung
Das IMS System ruft diese Funktion auf, um eine mit
IMGetFirstMessageSource gestartete Iteration fortzusetzen. Erst wenn das Modul einen Fehler meldet oder keine Quellen mehr vorhanden sind, wird die Iteration gestoppt.

Parameter
iterator
- Variable vom Typ HEnum_t. Diese Variable enthält iterationsspezifische Daten des Moduls und wurde von diesem bei Aufruf der Funktion
IMGetFirstMessageSource gesetzt.

sourceName - Puffer, der eine Zeichenkette von maximal STRING_NAME_LENGTH Zeichen aufnehmen kann. In diesen Puffer muß das Modul einen für den Benutzer lesbaren Bezeichner für die aktuelle Quelle kopieren.

subAddress - Puffer, der eine Zeichenkette von maximal STRING_NAME_LENGTH-Zeichen aufnehmen kann. In diesen Puffer muß das Modul eine interne Adresse für die aktuelle Quelle kopieren. Falls die Anwendung eine Nachricht weiterleitet, wird diese interne Adresse verwendet, um die Quelle zu bezeichnen.

Rückgabewert:
Wenn eine Quelle eingetragen wurde, muß RC_SUCCESS zurückgegeben werden. Wenn keine Quellen mehr verfügbar sind, muß RC_NO_MORE_DATA zurückgegeben werden. Ansonsten wird einer der definierten Fehlercodes erwartet.

Anmerkungen:
Keine