Fonction de rappel MAPISENDDOCUMENTS (mapi.h)

Article
03/02/2024

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

La fonction MAPISendDocuments envoie un message standard avec un ou plusieurs fichiers joints et une note de couverture. La note de couverture est une boîte de dialogue qui permet à l’utilisateur d’entrer une liste de destinataires et un message facultatif. MAPISendDocuments diffère de la fonction MAPISendMail en ce qu’elle offre moins de flexibilité dans la génération de messages.

Syntaxe

MAPISENDDOCUMENTS Mapisenddocuments;

ULONG Mapisenddocuments(
  [in] ULONG_PTR ulUIParam,
  [in] LPSTR lpszDelimChar,
  [in] LPSTR lpszFilePaths,
  [in] LPSTR lpszFileNames,
       ULONG ulReserved
)
{...}

Paramètres

[in] ulUIParam

Poignée de fenêtre parente ou zéro, indiquant que si une boîte de dialogue s’affiche, il s’agit d’une application modale. 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] lpszDelimChar

Pointeur vers un caractère que l’appelant utilise pour délimiter les noms pointés par les paramètres lpszFullPaths et lpszFileNames . L’appelant doit sélectionner un caractère pour le délimiteur qui n’est pas utilisé dans les noms de fichiers de système d’exploitation.

[in] lpszFilePaths

Pointeur vers une chaîne contenant une liste de chemins complets (y compris des lettres de lecteur) vers les fichiers joints. Cette liste est formée par concaténation des chemins d’accès de fichiers correctement formés, séparés par le caractère spécifié dans le paramètre lpszDelimChar et suivis d’une terminaison null . Voici un exemple de liste valide :

C:\TMP\TEMP1.DOC ;C:\TMP\TEMP2.DOC

Les fichiers spécifiés dans ce paramètre sont ajoutés au message sous forme de pièces jointes. Si ce paramètre a la valeur NULL ou contient une chaîne vide, la boîte de dialogue Envoyer une note s’affiche sans fichier attaché.

[in] lpszFileNames

Pointeur vers une liste null des noms de fichiers d’origine tels qu’ils doivent apparaître dans le message. Lorsque plusieurs noms sont spécifiés, la liste est formée en concaténant les noms de fichiers séparés par le caractère spécifié dans le paramètre lpszDelimChar et suivis d’une terminaison null . Voici un exemple :

TEMP3.DOC ;TEMP4.DOC

S’il n’existe aucune valeur pour le paramètre lpszFileNames ou s’il est vide, MAPISendDocuments définit les noms de fichiers sur les valeurs de nom de fichier indiquées par le paramètre lpszFullPaths .

ulReserved

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

Valeur retournée

Cette fonction retourne l’une des valeurs suivantes.

Code de retour	Description
MAPI_E_ATTACHMENT_OPEN_FAILURE	Impossible de trouver un ou plusieurs fichiers dans le paramètre lpszFilePaths . Aucun message n’a été envoyé.
MAPI_E_ATTACHMENT_WRITE_FAILURE	Une pièce jointe n’a pas pu être écrite dans un fichier temporaire. Vérifiez les autorisations de répertoire.
MAPI_E_FAILURE	Une ou plusieurs erreurs non spécifiées se sont produites lors de l’envoi du message. On ne sait pas si le message a été envoyé.
MAPI_E_INSUFFICIENT_MEMORY	La mémoire était insuffisante pour continuer.
MAPI_E_LOGIN_FAILURE	Il n’y avait pas d’ouverture de session par défaut et l’utilisateur n’a pas réussi à se connecter lorsque la boîte de dialogue d’ouverture de session s’affichait. Aucun message n’a été envoyé.
MAPI_E_USER_ABORT	L’utilisateur a annulé l’une des boîtes de dialogue. Aucun message n’a été envoyé.
SUCCESS_SUCCESS	L’appel a réussi et le message a été envoyé.

Remarques

La fonction MAPISendDocuments envoie un message standard, affichant toujours une boîte de dialogue de note de couverture afin que l’utilisateur puisse fournir des destinataires et d’autres options d’envoi. Cette fonction tente d’établir une session à l’aide de la session partagée du système de messagerie. S’il n’existe aucune session partagée, il invite l’utilisateur à fournir des informations de connexion pour établir une session. Avant que MAPISendDocuments ne retourne, il met fin à la session.

Les pièces jointes de message peuvent inclure le document actif ou tous les documents actuellement ouverts dans l’application cliente appelée MAPISendDocuments. Cette fonction est principalement utilisée pour les appels à partir d’une macro ou d’un langage de script, souvent présent dans des applications telles que des feuilles de calcul ou des programmes de traitement de texte.

MAPISendDocuments crée autant de pièces jointes de fichiers que de chemins d’accès spécifiés par le paramètre lpszFullPaths , en dépit du fait qu’il peut y avoir différents nombres de chemins d’accès et de noms de fichiers. L’appelant est responsable de la suppression des fichiers temporaires créés lors de l’utilisation de MAPISendDocuments.

Configuration requise

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

Voir aussi

MAPISendMail

Simple MAPI

Partager via