IMAPIMessageSite::GetSiteStatus

Article
03/15/2024

S’applique à : Outlook 2013 | Outlook 2016

Retourne des informations à partir d’un objet de site de message sur les fonctionnalités du site de message pour le message actuel.

HRESULT GetSiteStatus(
  ULONG FAR * lpulStatus
);

Paramètres

lpulStatus

[out] Pointeur vers un masque de bits d’indicateurs qui fournit des informations sur les status de messages. Les indicateurs suivants peuvent être définis :

VCSTATUS_COPY

Le message peut être copié.

VCSTATUS_DELETE

Le message peut être supprimé.

VCSTATUS_DELETE_IS_MOVE

En cas de suppression, un message est déplacé vers un dossier Éléments supprimés dans sa banque de messages au lieu d’être immédiatement supprimé de sa banque de messages.

VCSTATUS_MOVE

Le message peut être déplacé.

VCSTATUS_NEW_MESSAGE

Un nouveau message peut être créé.

VCSTATUS_SAVE

Le message peut être enregistré.

VCSTATUS_SUBMIT

Le message peut être envoyé.

Valeur renvoyée

S_OK

L'appel a r�ussi et a renvoy� la valeur attendue ou les valeurs.

Remarques

Les objets de formulaire appellent la méthode IMAPIMessageSite ::GetSiteStatus pour obtenir les fonctionnalités de l’objet de site de message pour le message actuel. Les indicateurs retournés dans le paramètre lpulStatus fournissent des informations sur le site de message. En règle générale, un formulaire active ou désactive les commandes de menu, en fonction des informations fournies par les indicateurs sur les fonctionnalités de l’implémentation du site de message. Si un nouveau message est chargé dans un formulaire par la méthode IPersistMessage ::SaveCompleted ou IPersistMessage ::Load, les indicateurs status doivent être vérifiés. Certains objets de site de message, en particulier les objets en lecture seule, n’autorisent pas l’enregistrement ou la suppression des messages.

Remarques pour les responsables de l’implémentation

La méthode IMAPIMessageSite ::GetSiteStatus peut nécessiter que l’application cliente effectue un calcul pour déterminer quelles opérations peuvent ou ne peuvent pas être effectuées sur le message actuel. En règle générale, cela implique d’examiner la ligne status du fournisseur de magasin de messages du message actuel ou d’interroger le fournisseur de magasin pour déterminer les actions que l’application cliente peut effectuer à l’aide de la banque de messages. Par exemple, pour déterminer s’il faut renvoyer l’indicateur MAPI_DELETE_IS_MOVE, case activée la propriété PR_IPM_WASTEBASKET_ENTRYID de l’objet de la banque de messages (PidTagIpmWastebasketEntryId) pour voir s’il existe un dossier Éléments supprimés dans la banque de messages.

Pour obtenir la liste des interfaces liées aux serveurs de formulaires, consultez Interfaces de formulaire MAPI.

Référence MFCMAPI

Pour voir un exemple de code MFCMAPI, consultez le tableau suivant.

Fichier	Fonction	Commentaire
MyMAPIFormViewer.cpp	CMyMAPIFormViewer ::GetSiteStatus	MFCMAPI utilise la méthode IMAPIMessageSite ::GetSiteStatus pour obtenir les status du site spécifié. Elle peut retourner VCSTATUS_NEW_MESSAGE, VCSTATUS_SAVE ou VCSTATUS_SUBMIT.