MAPILOGON-Rückruffunktion (mapi.h)

Artikel
08/24/2023

[Die Verwendung dieser Funktion wird abgeraten. Sie kann in nachfolgenden Versionen von Windows geändert oder nicht verfügbar sein.]

Die MAPILogon-Funktion startet eine einfache MAPI-Sitzung und lädt den Standardnachrichtenspeicher und die Adressbuchanbieter.

Syntax

MAPILOGON Mapilogon;

ULONG Mapilogon(
  [in]           ULONG_PTR ulUIParam,
  [in, optional] LPSTR lpszProfileName,
  [in, optional] LPSTR lpszPassword,
  [in]           FLAGS flFlags,
                 ULONG ulReserved,
  [out]          LPLHANDLE lplhSession
)
{...}

Parameter

[in] ulUIParam

Ziehpunkt des übergeordneten Fensters oder null, was angibt, dass es sich bei der Anzeige eines Dialogfelds um eine modale Anwendung handelt. Wenn der ulUIParam-Parameter ein übergeordnetes Fensterhandle enthält, ist er vom Typ HWND (in eine ULONG_PTR umgewandelt). Wenn während des Aufrufs kein Dialogfeld angezeigt wird, wird ulUIParam ignoriert.

[in, optional] lpszProfileName

Zeiger auf eine NULL-endende Profilnamenszeichenfolge, die auf maximal 256 Zeichen beschränkt ist. Dies ist das Profil, das bei der Anmeldung verwendet werden soll. Wenn der lpszProfileName-ParameterNULL ist oder auf eine leere Zeichenfolge zeigt und der flFlags-Parameter auf MAPI_LOGON_UI festgelegt ist, zeigt MAPILogon ein Anmeldedialogfeld mit einem leeren Namensfeld an.

[in, optional] lpszPassword

Zeiger auf eine null-endende Anmeldeinformationszeichenfolge, die auf maximal 256 Zeichen beschränkt ist. Wenn das Messagingsystem keine Kennwortanmeldeinformationen erfordert oder der Benutzer diese eingeben muss, sollte der lpszPassword-ParameterNULL sein oder auf eine leere Zeichenfolge zeigen. Wenn der Benutzer Anmeldeinformationen eingeben muss, muss der flFlags-Parameter auf MAPI_LOGON_UI festgelegt werden, damit ein Anmeldedialogfeld angezeigt werden kann.

[in] flFlags

Bitmaske von Optionsflags. Die folgenden Flags können festgelegt werden.

Wert	Bedeutung
MAPI_FORCE_DOWNLOAD	Es sollte versucht werden, alle Nachrichten des Benutzers herunterzuladen, bevor sie zurückgegeben werden. Wenn das MAPI_FORCE_DOWNLOAD-Flag nicht festgelegt ist, können Nachrichten im Hintergrund heruntergeladen werden, nachdem der Funktionsaufruf zurückgegeben wurde.
MAPI_NEW_SESSION	Es sollte versucht werden, eine neue Sitzung zu erstellen, anstatt die freigegebene Sitzung der Umgebung zu erhalten. Wenn das MAPI_NEW_SESSION-Flag nicht festgelegt ist, verwendet MAPILogon eine vorhandene freigegebene Sitzung.
MAPI_LOGON_UI	Es sollte ein Anmeldedialogfeld angezeigt werden, um den Benutzer zur Eingabe von Anmeldeinformationen aufzufordern. Wenn der Benutzer ein Kennwort und einen Profilnamen angeben muss, um eine erfolgreiche Anmeldung zu ermöglichen, muss MAPI_LOGON_UI festgelegt werden.
MAPI_PASSWORD_UI	MAPILogon sollte nur zur Eingabe eines Kennworts auffordern und dem Benutzer nicht erlauben, den Profilnamen zu ändern. Entweder MAPI_PASSWORD_UI oder MAPI_LOGON_UI sollte nicht festgelegt werden, da die Absicht darin besteht, zwischen zwei verschiedenen Dialogfeldern für die Anmeldung zu wählen.

ulReserved

Reserviert; muss null sein.

[out] lplhSession

Einfaches MAPI-Sitzungshandle.

Rückgabewert

Diese Funktion gibt einen der folgenden Werte zurück.

Rückgabecode	Beschreibung
MAPI_E_FAILURE	Mindestens ein nicht angegebener Fehler ist während der Anmeldung aufgetreten. Es wurde kein Sitzungshandle zurückgegeben.
MAPI_E_INSUFFICIENT_MEMORY	Es war nicht genügend Arbeitsspeicher vorhanden, um fortzufahren. Es wurde kein Sitzungshandle zurückgegeben.
MAPI_E_LOGIN_FAILURE	Es gab keine Standardanmeldung, und der Benutzer konnte sich nicht erfolgreich anmelden, wenn das Anmeldedialogfeld angezeigt wurde. Es wurde kein Sitzungshandle zurückgegeben.
MAPI_E_TOO_MANY_SESSIONS	Der Benutzer hatte zu viele Sitzungen gleichzeitig geöffnet. Es wurde kein Sitzungshandle zurückgegeben.
MAPI_E_USER_ABORT	Der Benutzer hat das Anmeldedialogfeld abgebrochen. Es wurde kein Sitzungshandle zurückgegeben.
SUCCESS_SUCCESS	Der Aufruf war erfolgreich, und eine einfache MAPI-Sitzung wurde eingerichtet.

Hinweise

Die MAPILogon-Funktion beginnt eine Sitzung mit dem Messagingsystem und gibt ein Handle zurück, das in nachfolgenden MAPI-Aufrufen verwendet werden kann, um dem Messagingsystem explizit Benutzeranmeldeinformationen bereitzustellen. Um die Anzeige eines Anmeldedialogfelds anzufordern, wenn die angezeigten Anmeldeinformationen die Sitzung nicht überprüfen können, legen Sie den parameter flFlags auf MAPI_LOGON_UI fest.

Die Clientanwendung testet eine vorhandene Sitzung, indem sie MAPILogon mit einem NULL-Wert für den lpszProfileName-Parameter , einem NULL-Wert für den lpszPassword-Parameter und nicht durch Festlegen des MAPI_LOGON_UI Flags in flFlags aufruft. Wenn eine Sitzung vorhanden ist, ist der Aufruf erfolgreich und gibt einen gültigen LHANDLE für die Sitzung zurück. Andernfalls tritt bei dem Aufruf ein Fehler auf.

Anforderungen

Anforderung	Wert
Zielplattform	Windows
Kopfzeile	mapi.h

Weitere Informationen

MAPILogoff

Einfache MAPI

Freigeben über