IMDBGetFirstMessage

Autor: Alexander Berger
Headerdatei: ims.h

Prototyp
Retcode_t API_FUNCTION IMDBGetFirstMessage(
   Char_t*      appType,
   PHEnum_t     iteratorHandle,
   IMMessage_s* messageInfo );

Kurzbeschreibung
Diese Funktion startet eine Iteration über alle Nachrichten eines bestimmten Anwendungstyps.

Parameter
appType - Typ der Anwendungen, dessen Nachrichten ermittelt werden sollen.

iteratorHandle - Zeiger auf einen HEnum_t-Typ. Diese Funktion füllt diesen Parameter mit Kontextinformationen, die der Aufrufer bei der Fortsetzung der Iteration mittels IMDBGetNextMessage übergeben muß.

messageInfo - Zeiger auf eine IMMessage_s-Struktur, welche bei Erfolg die Daten der ersten Nachricht erhält.

Rückgabewert:
Bei Erfolg RC_SUCCESS, ansonsten einer der in 'errdefs.h' definierten Fehlercodes.

Anmerkungen:
Keine