IMAPISession::OpenAddressBook
S’applique à : Outlook 2013 | Outlook 2016
Ouvre le carnet d’adresses mapi intégré, renvoyant un pointeur IAddrBook pour un accès supplémentaire.
HRESULT OpenAddressBook(
ULONG_PTR ulUIParam,
LPCIID lpInterface,
ULONG ulFlags,
LPADRBOOK FAR * lppAdrBook
);
Paramètres
ulUIParam
[in] Handle de la fenêtre parente de la boîte de dialogue d’adresse commune et d’autres affichages associés.
lpInterface
[in] Pointeur vers l’identificateur d’interface (IID) qui représente l’interface à utiliser pour accéder au carnet d’adresses. La transmission de la valeur null renvoie un pointeur vers l’interface standard du carnet d’adresses, IAddrBook : IMAPIProp.
ulFlags
[in] Masque de bits d’indicateurs qui contrôle l’ouverture du carnet d’adresses. L’indicateur suivant peut être défini :
AB_NO_DIALOG
Supprime l’affichage des boîtes de dialogue. Si l’indicateur AB_NO_DIALOG n’est pas défini, les fournisseurs de carnet d’adresses qui contribuent au carnet d’adresses intégré peuvent inviter l’utilisateur à fournir toutes les informations nécessaires.
lppAdrBook
[out] Pointeur vers un pointeur vers le carnet d’adresses.
Valeur renvoyée
S_OK
Le carnet d’adresses a été ouvert avec succès.
MAPI_W_ERRORS_RETURNED
L’appel a réussi, mais les conteneurs d’un ou de plusieurs fournisseurs de carnets d’adresses n’ont pas pu être ouverts. Lorsque cet avertissement est retourné, l’appel doit être géré comme ayant réussi. Pour tester cet avertissement, utilisez la macro HR_FAILED . Pour plus d’informations, consultez Utilisation de macros pour la gestion des erreurs.
Remarques
La méthode IMAPISession ::OpenAddressBook ouvre le carnet d’adresses intégré MAPI, une collection des conteneurs de niveau supérieur de tous les fournisseurs de carnets d’adresses dans le profil. Le pointeur retourné dans le paramètre lppAdrBook fournit un accès supplémentaire au contenu du carnet d’adresses. Cela permet à l’appelant d’effectuer des tâches telles que l’ouverture de conteneurs individuels, la recherche d’utilisateurs de messagerie et l’affichage des boîtes de dialogue d’adresse courantes.
Remarques pour les appelants
OpenAddressBook retourne MAPI_W_ERRORS_RETURNED s’il ne peut pas charger un ou plusieurs fournisseurs de carnets d’adresses dans le profil. Cette valeur est un avertissement, et non une valeur d’erreur ; gérez-le comme vous le feriez S_OK. OpenAddressBook retourne toujours un pointeur valide dans le paramètre lppAdrBook , quel que soit le nombre de fournisseurs de carnets d’adresses qui n’ont pas pu être chargés. Par conséquent, vous devez toujours appeler la méthode IUnknown ::Release du carnet d’adresses à un moment donné avant de vous déconnecter.
Lorsque OpenAddressBook retourne MAPI_W_ERRORS_RETURNED, appelez IMAPISession ::GetLastError pour obtenir une structure MAPIERROR qui contient des informations sur les fournisseurs défaillants. Une structure MAPIERROR unique est retournée qui contient des informations fournies par tous les fournisseurs.
Référence MFCMAPI
Pour voir un exemple de code MFCMAPI, consultez le tableau suivant.
| Fichier | Fonction | Commentaire |
|---|---|---|
| MAPIObjects.cpp |
CMapiObjects ::GetAddrBook |
MFCMAPI utilise la méthode IMAPISession ::OpenAddressBook pour obtenir le carnet d’adresses intégré. |