IMAPIMessageSite::GetSiteStatus
Hace referencia a: Outlook 2013 | Outlook 2016
Devuelve información de un objeto de sitio de mensaje sobre las funcionalidades del sitio de mensaje para el mensaje actual.
HRESULT GetSiteStatus(
ULONG FAR * lpulStatus
);
Parameters
lpulStatus
[out] Puntero a una máscara de bits de marcas que proporciona información sobre el estado del mensaje. Se pueden establecer las siguientes marcas:
VCSTATUS_COPY
El mensaje se puede copiar.
VCSTATUS_DELETE
El mensaje se puede eliminar.
VCSTATUS_DELETE_IS_MOVE
Cuando se elimina, un mensaje se mueve a una carpeta Elementos eliminados en su almacén de mensajes en lugar de quitarse inmediatamente de su almacén de mensajes.
VCSTATUS_MOVE
El mensaje se puede mover.
VCSTATUS_NEW_MESSAGE
Se puede crear un nuevo mensaje.
VCSTATUS_SAVE
El mensaje se puede guardar.
VCSTATUS_SUBMIT
El mensaje se puede enviar.
Valor devuelto
S_OK
La llamada se ha realizado correctamente y devuelva el valor esperado o los valores.
Comentarios
Los objetos Form llaman al método IMAPIMessageSite::GetSiteStatus para obtener las funcionalidades del objeto de sitio de mensaje para el mensaje actual. Las marcas devueltas en el parámetro lpulStatus proporcionan información sobre el sitio del mensaje. Normalmente, un formulario habilita o deshabilita los comandos de menú, en función de la información que proporcionen las marcas sobre las funcionalidades de la implementación del sitio de mensajes. Si el método IPersistMessage::SaveCompleted o el método IPersistMessage::Load cargan un nuevo mensaje, se deben comprobar las marcas de estado. Algunos objetos de sitio de mensaje, especialmente los objetos de solo lectura, no permiten guardar ni eliminar mensajes.
Notas a los implementadores
El método IMAPIMessageSite::GetSiteStatus puede requerir que la aplicación cliente realice algún cálculo para determinar qué operaciones se pueden o no realizar en el mensaje actual. Normalmente, esto implica examinar la fila de estado del proveedor de almacén de mensajes del mensaje actual o consultar al proveedor de almacén para determinar qué acciones puede realizar la aplicación cliente mediante el almacén de mensajes. Por ejemplo, para determinar si se devuelve la marca MAPI_DELETE_IS_MOVE, compruebe la propiedad PR_IPM_WASTEBASKET_ENTRYID del objeto de almacén de mensajes (PidTagIpmWastebasketEntryId) para ver si hay una carpeta Elementos eliminados en el almacén de mensajes.
Para obtener una lista de interfaces relacionadas con los servidores de formularios, vea Interfaces de formulario MAPI.
Referencia de MFCMAPI
Para obtener un ejemplo de código de MFCMAPI, vea la siguiente tabla.
| Archivo | Función | Comment |
|---|---|---|
| MyMAPIFormViewer.cpp |
CMyMAPIFormViewer::GetSiteStatus |
MFCMAPI usa el método IMAPIMessageSite::GetSiteStatus para obtener el estado del sitio especificado. Puede devolver VCSTATUS_NEW_MESSAGE, VCSTATUS_SAVE o VCSTATUS_SUBMIT. |
Vea también
IPersistMessage::SaveCompleted
Propiedad canónica PidTagIpmWastebasketEntryId