IMGetSources

Autor: Alexander Berger
Headerdatei: ims.h

Prototyp
Retcode_t API_FUNCTION IMGetSources(
   UInt32_t    bufferSize,
   IMSource_s* sourceInfos,
   UInt32_t*   usedBufferSize );

Kurzbeschreibung
Diese Funktion ermittelt alle Nachrichtenquellen, die es im aktuellen IMS-System gibt.

Parameter
bufferSize - Gibt an, wieviele IMSource_s-Strukturen der Puffer aufnehmen kann.

sourceInfos - Zeiger auf einen Puffer, der die IMSource_s-Strukturen aufnehmen kann.

usedBufferSize - Zeiger auf eine 32-Bit Zahl. Diese Zahl enthält bei Erfolg die Anzahl der tatsächlich gelesenen IMSource_s-Strukturen bzw. beim Rückgabewert RC_MORE_DATA die benötigte Größe des Puffers (in Anzahl von IMSource_s-Strukturen).

Rückgabewert:
Sind alle Quellenmodule in den Puffer kopiert worden, RC_SUCCESS. Wenn der Puffer nicht groß genug war, dann RC_MORE_DATA. Bei anderen Fehlern wird ein in 'errdefs.h' definierter Fehlercode zurückgegeben.

Anmerkungen:
Keine