IServer

Beschreibung:

IServer ist der zentrale Einstiegspunkt der Bibliothek. Es ist das einzige, erstellbare Objekt in der Hierarchie für den Zugriff auf den Server.

import "OxSvrSpt.idl"

Öffentliche Methoden:

HRESULT Login ([in, defaultvalue("")] BSTR User, [in, defaultvalue("")]
BSTR Password, [in, defaultvalue("")] BSTR Server, [in, defaultvalue("")]
BSTR Port, [in, defaultvalue(pwNotEncrypted)] PasswortTypeEnum
PasswortType, [in, defaultvalue()] VARIANT_BOOL DefaultSession, [out,
retval] ISession ** ppSession)
HRESULT Connect ([in, defaultvalue("localhost")] BSTR Server, [in,
defaultvalue("4000")] BSTR Port)
HRESULT OpenSession ([in, defaultvalue("")] BSTR SessionGUID, [in,
defaultvalue("")] BSTR Alias, [out, retval] ISession ** ppSession)
HRESULT LoginBalanced ([in, defaultvalue("")] BSTR User, [in,
defaultvalue("")] BSTR Password, [in, defaultvalue("")] BSTR ServerList,
[in, defaultvalue(pwNotEncrypted)] PasswortTypeEnum PasswortType, [in,
defaultvalue()] VARIANT_BOOL DefaultSession, [out, retval] ISession **
ppSession)
HRESULT LoginGUID ([in, defaultvalue("")] BSTR GUID, [in,
defaultvalue("")] BSTR Server, [in, defaultvalue("")] BSTR Port, [in,
defaultvalue()] VARIANT_BOOL DefaultSession, [out, retval] ISession **
ppSession)

Properties:

IProperties Properties [get]
IErrors Errors [get]

Dokumentation der Elementfunktionen:

HRESULT Connect ([in, defaultvalue("localhost")] BSTR Server, [in,

  defaultvalue("4000")] BSTR Port)

Connect stellt eine Verbindung zu dem angegebenen Servern her.

Diese Methode liefert zurzeit den Fehler E_NOTIMPL zurück!

Der Aufbau einer Verbindung zu einem Server ohne eine Anmeldung ist notwendig, wenn die Eigenschaften des Servers benötigt werden. Diese werden nach einem Connect in den Properties zur Verfügung gestellt. Werden keine dieser Daten benötigt, ist es nicht notwendig erst ein Connect zum Server aufzubauen bevor man sich einloggt. Die Serverdaten können in diesem Fall direkt beim Login mit angegeben werden.

Parameter:

[in]: Server (Standardwert ist localhost ) IP-Adresse oder Name des Servers, zu dem die Verbindung aufgebaut werden soll

[in]: Port (Standardwert ist 4000 ) Port des Servers

HRESULT Login ([in, defaultvalue("")] BSTR User, [in,

  defaultvalue("")] BSTR Password, [in, defaultvalue("")] BSTR Server,
  [in, defaultvalue("")] BSTR Port, [in, defaultvalue(pwNotEncrypted)]
  PasswortTypeEnum PasswortType, [in, defaultvalue()] VARIANT_BOOL
  DefaultSession, [out, retval] ISession ** ppSession)

Login führt eine Anmeldung am Server durch und liefert die betreffende Session zurück.

Wurde vor dem Aufruf von Login bereits eine Verbindung zu einem Server über die Methode Connect hergestellt, werden diese Verbindungsdaten für das Login verwendet, falls keine angegeben wurden.

Werden sowohl der User-, als auch der Password-Parameter leer oder mit einer leeren Zeichenkette übergeben, wird versucht die Anmeldung über das automatische Login durchzuführen. Dieses muss im enaio® administrator aktiviert sein und ist nicht mit NTLMAuthentifikation gleichzusetzen.

Parameter:

[in]: User Nutzer-Account

[in]: Password Passwort des zu verwendenden Nutzer-Accounts

[in]: Server IP-Adresse oder Name des Servers, zu dem die Verbindung aufgebaut werden soll

[in]: Port Port des Servers

[in]: PasswortType gibt an, ob das übergebene Passwort bereits verschüsselt wurde. Wird dieser Parameter nicht angegeben, wird davon ausgegangen, dass das Passwort unverschüsselt übergeben wurde.

[in]: DefaultSession (Standardwert ist VARIANT_FALSE) gibt an, ob es sich um die Session handelt, an der sich der Benutzer später mit Hilfe von OpenSession anhängen kann.

[out]: ppSession (VB-Rückgabeparameter) erstellte Session für den Account.

Ausnahmebehandlung:

errLoginUnknownUser (602) Der angegebene Benutzer existiert nicht.

errLogin3TimesWrong (603) Der dritte Login-Versuch schlug fehl.

errLoginInvalidPassword (604) Das angegebene Passwort ist falsch.

errLoginLocked (605) Der Benutzeraccount ist gesperrt.

HRESULT LoginBalanced ([in, defaultvalue("")] BSTR User, [in,

  defaultvalue("")] BSTR Password, [in, defaultvalue("")] BSTR
  ServerList, [in, defaultvalue(pwNotEncrypted)] PasswortTypeEnum
  PasswortType, [in, defaultvalue()] VARIANT_BOOL DefaultSession, [out,
  retval] ISession ** ppSession)

LoginBalanced führt eine Anmeldung am Server durch und liefert die betreffende Session zurück.

Werden sowohl der User-, als auch der Password-Parameter leer oder mit einer leeren Zeichenkette übergeben, wird versucht die Anmeldung über das automatische Login durchzuführen.

Parameter:

[in]: User Nutzer-Account

[in]: Password Passwort des zu verwendenden Nutzer-Accounts

[in]: ServerList Liste mit den Servern, auf die sich die Bibliothekt verbinden soll. Diese Liste hat folgenden Aufbau: Server1#Port1#Wichtung1;Server2#Port2#Wichtung2#;

Server3#Port3#Wichtung3

[in]: DefaultSession (Standardwert ist VARIANT_FALSE) gibt an, ob es sich um die Session handelt, an der sich der Benutzer später mit Hilfe von OpenSession anhängen kann.

[out]: ppSession (VB-Rückgabeparameter) erstellte Session für den Account.

Ausnahmebehandlung:

errLoginUnknownUser (602) Der angegebene Benutzer existiert nicht.

errLogin3TimesWrong (603) Der dritte Login-Versuch schlug fehl.

errLoginInvalidPassword (604) Das angegebene Passwort ist falsch.

errLoginLocked (605) Der Benutzeraccount ist gesperrt.

HRESULT LoginGUID ([in, defaultvalue("")] BSTR GUID, [in,

  defaultvalue("")] BSTR Server, [in, defaultvalue("")] BSTR Port, [in,
  defaultvalue()] VARIANT_BOOL DefaultSession, [out, retval] ISession **
  ppSession)

LoginGUID führt eine Anmeldung mit der übergebenen SessionGUID am Server aus und liefert die betreffende Session zurück

Mittels der SessionGUID wird eine Verbindung mit einer bestehenden Session auf dem Server aufgebaut.

Parameter:

[in]: GUID GUID der Server-Session, mit der das Session -Objekt arbeiten soll

[in]: Server IP-Adresse oder Name des Servers, zu dem die Verbindung aufgebaut werden soll

[in]: Port Port des Servers

[in]: DefaultSession (Standardwert ist VARIANT_FALSE) gibt an, ob es sich um die Session handelt, an der sich der Benutzer später mit Hilfe von OpenSession anhängen kann

[out]: ppSession (VB-Rückgabeparameter) erstellte Session für den Account

Ausnahmebehandlung:

errLoginLocked (605) Der Benutzeraccount ist gesperrt.

HRESULT OpenSession ([in, defaultvalue("")] BSTR SessionGUID, [in,

  defaultvalue("")] BSTR Alias, [out, retval] ISession ** ppSession)

OpenSession erstellt ein neues Session -Objekt und verbindet dies mit der DefaultSession .

Parameter:

[in]: SessionGUID GUID der bestehenden Session, mit der die Verbindung aufgebaut werden soll

[in]: Alias beliebiger Name für den Aufruf, um Fehler oder Zustand zuzuordnen

[out]: ppSession (VB-Rückgabeparameter) erstellte Session für den Account

Dokumentation der Properties:

IErrors Errors [get]

Errors liefert die Fehler-Collection mit den Fehlern des Serverzugriffs zurück.

Parameter:

[out]: pVal (VB-Rückgabewert) Fehler-Collection

IProperties Properties [get]

Properties liefert die Collection mit den Eigenschaften des Servers zurück

Derzeit werden bei der Erstellung des Serverobjektes folgende Eigenschaften durch die OxSvrSpt-Bibliothek gesetzt:

TempDir:

Beinhaltet das temporäre Verzeichnis, in dem die Dateien der Fileparameter abgelegt werden sollen. Dieses wird mit dem temporären Verzeichnis des Benutzers initialisiert.

NotifyNeeded:

wird mit 0 initialisiert.

Wird der Wert auf einen Wert ungleich 0 (oder VARIANT_FALSE) gesetzt, wird die Unterstützung für die Notifications aktiviert. Es besteht dann die Möglichkeit über die EventSchnittstelle des Server- und des Session-Objekts Notifications zu verarbeiten.

Die angegebenen Bezeichner entsprechen den Namen der Parameter.

Parameter:

[out]: pVal (VB-Rückgabeparameter) IProperties -Schnittstelle