Fonction de rappel MAPILOGON (mapi.h)

Article
08/24/2023

[L’utilisation de cette fonction est déconseillée. Il peut être modifié ou indisponible dans les versions ultérieures de Windows.]

La fonction MAPILogon démarre une session MAPI simple, chargeant les fournisseurs de magasins de messages et de carnet d’adresses par défaut.

Syntaxe

MAPILOGON Mapilogon;

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

Paramètres

[in] ulUIParam

Handle de fenêtre parente ou zéro, indiquant que si une boîte de dialogue est affichée, elle est modale de l’application. Si le paramètre ulUIParam contient un handle de fenêtre parent, il est de type HWND (cast en ULONG_PTR). Si aucune boîte de dialogue n’est affichée pendant l’appel, ulUIParam est ignoré.

[in, optional] lpszProfileName

Pointeur vers une chaîne de nom de profil terminée par null, limitée à 256 caractères ou moins. Il s’agit du profil à utiliser lors de la connexion. Si le paramètre lpszProfileName a la valeur NULL ou pointe vers une chaîne vide, et si le paramètre flFlags a la valeur MAPI_LOGON_UI, MAPILogon affiche une boîte de dialogue d’ouverture de session avec un champ de nom vide.

[in, optional] lpszPassword

Pointeur vers une chaîne d’informations d’identification terminée par null, limitée à 256 caractères ou moins. Si le système de messagerie ne nécessite pas d’informations d’identification de mot de passe, ou s’il nécessite que l’utilisateur les entre, le paramètre lpszPassword doit être NULL ou pointer vers une chaîne vide. Lorsque l’utilisateur doit entrer des informations d’identification, le paramètre flFlags doit être défini sur MAPI_LOGON_UI pour permettre l’affichage d’une boîte de dialogue d’ouverture de session.

[in] flFlags

Masque de bits des indicateurs d’option. Les indicateurs suivants peuvent être définis.

Valeur	Signification
MAPI_FORCE_DOWNLOAD	Une tentative doit être effectuée pour télécharger tous les messages de l’utilisateur avant de revenir. Si l’indicateur MAPI_FORCE_DOWNLOAD n’est pas défini, les messages peuvent être téléchargés en arrière-plan après le retour de l’appel de fonction.
MAPI_NEW_SESSION	Vous devez tenter de créer une session plutôt que d’acquérir la session partagée de l’environnement. Si l’indicateur MAPI_NEW_SESSION n’est pas défini, MAPILogon utilise une session partagée existante.
MAPI_LOGON_UI	Une boîte de dialogue d’ouverture de session doit s’afficher pour inviter l’utilisateur à entrer des informations de connexion. Si l’utilisateur doit fournir un mot de passe et un nom de profil pour permettre une ouverture de session réussie, MAPI_LOGON_UI doit être défini.
MAPI_PASSWORD_UI	MAPILogon doit uniquement demander un mot de passe et ne pas autoriser l’utilisateur à modifier le nom du profil. Vous ne devez pas définir MAPI_PASSWORD_UI ou MAPI_LOGON_UI, car l’intention est de choisir entre deux boîtes de dialogue différentes pour l’ouverture de session.

ulReserved

Réservés au; doit être égal à zéro.

[out] lplhSession

Handle de session MAPI simple.

Valeur retournée

Cette fonction retourne l’une des valeurs suivantes.

Code de retour	Description
MAPI_E_FAILURE	Une ou plusieurs erreurs non spécifiées se sont produites lors de l’ouverture de session. Aucun handle de session n’a été retourné.
MAPI_E_INSUFFICIENT_MEMORY	La mémoire était insuffisante pour continuer. Aucun handle de session n’a été retourné.
MAPI_E_LOGIN_FAILURE	Il n’y avait pas d’ouverture de session par défaut et l’utilisateur n’a pas pu se connecter correctement lorsque la boîte de dialogue d’ouverture de session s’est affichée. Aucun handle de session n’a été retourné.
MAPI_E_TOO_MANY_SESSIONS	L’utilisateur avait trop de sessions ouvertes simultanément. Aucun handle de session n’a été retourné.
MAPI_E_USER_ABORT	L’utilisateur a annulé la boîte de dialogue d’ouverture de session. Aucun handle de session n’a été retourné.
SUCCESS_SUCCESS	L’appel a réussi et une session MAPI simple a été établie.

Remarques

La fonction MAPILogon commence une session avec le système de messagerie, en retournant un handle qui peut être utilisé dans les appels MAPI suivants pour fournir explicitement des informations d’identification utilisateur au système de messagerie. Pour demander l’affichage d’une boîte de dialogue d’ouverture de session si les informations d’identification présentées ne parviennent pas à valider la session, définissez le paramètre flFlags sur MAPI_LOGON_UI.

L’application cliente teste une session existante en appelant MAPILogon avec une valeur NULL pour le paramètre lpszProfileName , une valeur NULL pour le paramètre lpszPassword et en ne définissant pas l’indicateur MAPI_LOGON_UI dans flFlags. S’il existe une session existante, l’appel réussit et retourne un LHANDLE valide pour la session. Dans le cas contraire, l’appel échoue.

Configuration requise

Condition requise	Valeur
Plateforme cible	Windows
En-tête	mapi.h

Voir aussi

MAPILogoff

Simple MAPI

Partager via