IMAPIFormMgr::LoadForm

Hace referencia a: Outlook 2013 | Outlook 2016

Inicia un formulario para abrir un mensaje existente.

HRESULT LoadForm(
  ULONG_PTR ulUIParam,
  ULONG ulFlags,
  LPCSTR lpszMessageClass,
  ULONG ulMessageStatus,
  ULONG ulMessageFlags,
  LPMAPIFOLDER pFolderFocus,
  LPMAPIMESSAGESITE pMessageSite,
  LPMESSAGE pmsg,
  LPMAPIVIEWCONTEXT pViewContext,
  REFIID riid,
  LPVOID FAR * ppvObj
);

Parameters

ulUIParam

[in] Identificador de la ventana primaria del indicador de progreso que se muestra mientras se abre el formulario. El parámetro ulUIParam se omite a menos que se establezca la marca de MAPI_DIALOG en el parámetro ulFlags .

ulFlags

[in] Máscara de bits de marcas que controla cómo se abre el formulario. Se pueden establecer las siguientes marcas:

MAPI_DIALOG

Muestra una interfaz de usuario para proporcionar el estado o pedir al usuario más información. Si no se establece esta marca, no se muestra ninguna interfaz de usuario.

MAPIFORM_EXACTMATCH

Solo se deben resolver las cadenas de clase de mensaje que son una coincidencia exacta.

lpszMessageClass

[in] Puntero a una cadena que asigna un nombre a la clase de mensaje del mensaje que se va a cargar. Si se pasa NULL en el parámetro lpszMessageClass , la clase de mensaje se determina a partir del mensaje al que apunta el parámetro pmsg .

ulMessageStatus

[in] Máscara de bits de marcas definidas por el cliente o definidas por el proveedor copiadas de la propiedad PR_MSG_STATUS (PidTagMessageStatus) del mensaje que proporciona información sobre el estado del mensaje. El parámetro ulMessageStatus debe establecerse si lpszMessageClass no es NULL; De lo contrario, se omite ulMessageStatus .

ulMessageFlags

[in] Puntero a una máscara de bits de marcas copiadas de la propiedad PR_MESSAGE_FLAGS (PidTagMessageFlags) del mensaje que indica el estado actual del mensaje. El parámetro ulMessageFlags debe establecerse si lpszMessageClass no es NULL; De lo contrario, se omite ulMessageFlags .

pFolderFocus

[in] Puntero a la carpeta que contiene directamente el mensaje. El parámetro pFolderFocus puede ser NULL si dicha carpeta no existe (por ejemplo, si el mensaje está incrustado en otro mensaje).

pMessageSite

[in] Puntero al sitio de mensaje del mensaje.

Pmsg

[in] Puntero al mensaje.

pViewContext

[in] Puntero al contexto de vista del mensaje. El parámetro pViewContext puede ser NULL.

riid

[in] Identificador de interfaz (IID) de la interfaz que se va a usar para el objeto de formulario devuelto. El parámetro riid no debe ser NULL.

ppvObj

[out] Puntero a un puntero a la interfaz devuelta.

Valor devuelto

S_OK

La llamada se ha realizado correctamente y devuelva el valor esperado o los valores.

MAPI_E_NO_INTERFACE

El formulario no admite la interfaz solicitada.

MAPI_E_NOT_FOUND

La clase de mensaje pasada en lpszMessageClass no coincide con la clase de mensaje de ningún formulario de la biblioteca de formularios.

Comentarios

Los visores de formularios llaman al método IMAPIFormMgr::LoadForm para abrir un formulario para un mensaje existente. LoadForm abre el objeto de formulario, carga el mensaje en el objeto de formulario, configura el contexto de vista adecuado, si es necesario, y devuelve la interfaz solicitada para el objeto de formulario.

El parámetro pFolderFocus apunta a la carpeta que contiene el mensaje. Si el mensaje está incrustado en otro mensaje, pFolderFocus debe ser NULL.

Notas a los implementadores

Si se pasa NULL en lpszMessageClass, la implementación obtiene la clase de mensaje, el estado y las marcas del mensaje de las propiedades PR_MESSAGE_CLASS (PidTagMessageClass), PR_MSG_STATUS y PR_MESSAGE_FLAGS del mensaje. Si se proporciona una cadena de clase de mensaje en lpszMessageClass, la implementación debe usar los valores de ulMessageStatus y ulMessageFlags.

Referencia de MFCMAPI

Para obtener un ejemplo de código de MFCMAPI, vea la siguiente tabla.

Archivo	Función	Comment
MAPIFormFunctions.cpp	OpenMessageNonModal	MFCMAPI usa el método IMAPIFormMgr::LoadForm para cargar un formulario antes de mostrarlo.

Vea también

Propiedad canónica PidTagMessageClass
Propiedad canónica PidTagMessageFlags
Propiedad canónica PidTagMessageStatus
IMAPIFormMgr: IUnknownMFCMAPI como ejemplo de código