IMsgServiceAdmin::ConfigureMsgService
S’applique à : Outlook 2013 | Outlook 2016
Reconfigure un service de message.
HRESULT ConfigureMsgService(
LPMAPIUID lpUID,
ULONG_PTR ulUIParam,
ULONG ulFlags,
ULONG cValues,
LPSPropValue lpProps
);
Paramètres
lpUID
[in] Pointeur vers la structure MAPIUID qui contient l’identificateur unique que le service de messagerie doit configurer.
ulUIParam
[in] Handle de la fenêtre parente de la feuille de propriétés de configuration.
ulFlags
[in] Masque de bits d’indicateurs qui contrôle l’affichage de la feuille de propriétés. Les indicateurs suivants peuvent être définis :
MAPI_UNICODE
Les chaînes transmises sont au format Unicode. Si l’indicateur MAPI_UNICODE n’est pas défini, les chaînes sont au format ANSI.
MSG_SERVICE_UI_READ_ONLY
Le service de message doit afficher sa feuille de propriétés de configuration, mais pas permettre à l’utilisateur de la modifier. La plupart des services de message ignorent cet indicateur.
SERVICE_UI_ALLOWED
Le service de message doit afficher sa feuille de propriétés de configuration uniquement si le service n’est pas complètement configuré.
SERVICE_UI_ALWAYS
Le service de message doit toujours afficher sa feuille de propriétés de configuration. Si SERVICE_UI_ALWAYS n’est pas défini, une feuille de propriétés de configuration peut toujours s’afficher si SERVICE_UI_ALLOWED est défini et que des informations de configuration valides ne sont pas disponibles à partir du tableau de valeurs de propriété dans le paramètre lpProps . Vous devez définir SERVICE_UI_ALLOWED ou SERVICE_UI_ALWAYS pour qu’une feuille de propriétés s’affiche.
cValues
[in] Nombre de valeurs de propriété dans la structure SPropValue pointée par lpProps.
lpProps
[in] Pointeur vers un tableau de valeurs de propriétés qui décrivent les propriétés à afficher dans la feuille des propriétés. Le paramètre lpProps ne doit pas avoir la valeur NULL si le service de message doit être configuré sans interface utilisateur.
Valeur renvoyée
S_OK
Le service de message a été correctement configuré.
MAPI_E_EXTENDED_ERROR
Erreur spécifique à un service de message. Pour obtenir la structure MAPIERROR qui décrit l’erreur, l’application cliente doit appeler la méthode IMsgServiceAdmin ::GetLastError .
MAPI_E_NOT_FOUND
Le MAPIUID pointé par lpUID ne correspond pas à celui d’un service de message existant.
MAPI_E_NOT_INITIALIZED
Le service de message n’a pas de fonction de point d’entrée.
MAPI_E_USER_CANCEL
L’utilisateur a annulé l’opération, généralement en cliquant sur le bouton Annuler dans la feuille de propriétés.
Remarques
La méthode IMsgServiceAdmin ::ConfigureMsgService permet de configurer un service de message, avec ou sans feuille de propriétés de configuration.
Pour autoriser la configuration sans affichage de feuille de propriétés, les services de message préparent généralement un fichier d’en-tête qui inclut des constantes pour toutes les propriétés requises et facultatives et leurs valeurs.
Remarques pour les appelants
Pour récupérer la structure MAPIUID pour le service de message à configurer, récupérez la colonne PR_SERVICE_UID (PidTagServiceUid) à partir de la ligne du service de message dans la table du service de message. Pour plus d’informations, consultez la procédure décrite dans la méthode IMsgServiceAdmin ::CreateMsgService .
Vous pouvez configurer un service de message sans afficher de feuille de propriétés à un utilisateur uniquement si vous disposez d’informations préalables sur les valeurs de propriété à définir. Si vous configurez un service de message sans afficher de feuille de propriétés, transmettez des valeurs de propriété valides dans le paramètre lpProps et ne définissez pas les indicateurs MSG_SERVICE_UI_READ_ONLY, SERVICE_UI_ALLOWED ou SERVICE_UI_ALWAYS.
Si vous recevez tout ou partie des informations de configuration de l’utilisateur par le biais d’une feuille de propriétés, définissez SERVICE_UI_ALLOWED dans ulFlags. Si vous utilisez les informations de propriété existantes uniquement pour établir les paramètres par défaut et que l’utilisateur est en mesure de modifier les paramètres, définissez SERVICE_UI_ALWAYS dans ulFlags.
Référence MFCMAPI
Pour voir un exemple de code MFCMAPI, consultez le tableau suivant.
| Fichier | Fonction | Commentaire |
|---|---|---|
| MAPIProfileFunctions.cpp |
HrAddServiceToProfile |
MFCMAPI utilise la méthode IMsgServiceAdmin ::ConfigureMsgService pour configurer un service qui a été ajouté à un profil. |