IMGetReceiverList

Autor: Alexander Berger
Headerdatei: ims.h

Prototyp
Retcode_t API_FUNCTION IMGetReceiverList(
   Char_t*       computerName,
   Char_t*       phoneBookEntry,
   Char_t*       userName,
   Char_t*       password,
   Char_t*       domain,
   UInt32_t      bufferSize,
   IMReceiver_s* receiverInfos,
   UInt32_t*     usedBufferSize );

Kurzbeschreibung
Diese Funktion ermittelt alle Weiterleitungsmodule, die auf einem Rechner installiert sind. Dieser Rechner muß sich nicht im lokalen IMS-System befinden, sondern kann auch beispielsweise nur über RAS zu erreichen sein.

Parameter
computerName - Der Name der Rechners, von dem die installierten Weiterleitungsmodule ermittelt werden sollen.

phoneBookEntry - Sollte der Rechner nur über RAS zu erreichen sein, muß hier der entsprechende Telefonbucheintrag angegeben werden, damit über RAS die Verbindung hergestellt werden kann. Sollte der Rechner über eine Festleitung zu erreichen sein, muß hier eine leere Zeichenkette übergeben werden.

userName - Benutzername für RAS-Anmeldung. Wird RAS nicht verwendet, muß eine leere Zeichenkette übergeben werden.

password - Passwort für RAS-Anmeldung. Wird RAS nicht verwendet, muß eine leere Zeichenkette übergeben werden.

domain - Domäne für RAS-Anmeldung. Wird RAS nicht verwendet, muß eine leere Zeichenkette übergeben werden.

bufferSize - Anzahl der IMReceiver_s-Strukturen, die der 'receiverInfos'-Puffer aufnehmen kann.

receiverInfos - Zeiger auf einen Puffer für die IMReceiver_s-Strukturen.

usedBufferSize - Zeiger auf eine 32-Bit Variable, die bei Erfolg die tatsächlich kopierten IMReceiver_s-Strukturen enthält. Schlägt die Funktion mit dem Fehlercode RC_MORE_DATA fehl, enthält diese Variable die benötigte Puffergröße, um alle IMReceiver_s-Strukturen aufzunehmen.

Rückgabewert:
Sind alle Weiterleitungsmodule dieses Rechners 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