IMsgStore::GetReceiveFolder

Hace referencia a: Outlook 2013 | Outlook 2016

Obtiene la carpeta que se estableció como destino para los mensajes entrantes de una clase de mensaje especificada o como la carpeta de recepción predeterminada para el almacén de mensajes.

HRESULT GetReceiveFolder(
  LPSTR lpszMessageClass,
  ULONG ulFlags,
  ULONG FAR * lpcbEntryID,
  LPENTRYID FAR * lppEntryID,
  LPSTR FAR * lppszExplicitClass
);

Parameters

lpszMessageClass

[in] Puntero a una clase de mensaje asociada a una carpeta de recepción. Si el parámetro lpszMessageClass se establece en NULL o en una cadena vacía, GetReceiveFolder devuelve la carpeta de recepción predeterminada para el almacén de mensajes.

ulFlags

[in] Máscara de bits de marcas que controla el tipo de las cadenas pasadas y devueltas. Se puede establecer la marca siguiente:

MAPI_UNICODE

La cadena de clase de mensaje está en formato Unicode. Si no se establece la marca de MAPI_UNICODE, la cadena de clase de mensaje está en formato ANSI.

lpcbEntryID

[out] Puntero al recuento de bytes en el identificador de entrada al que apunta el parámetro lppEntryID .

lppEntryID

[out] Puntero a un puntero al identificador de entrada de la carpeta de recepción solicitada.

lppszExplicitClass

[out] Puntero a un puntero a la clase de mensaje que establece explícitamente como su carpeta de recepción la carpeta a la que apunta lppEntryID. Esta clase de mensaje debe ser la misma que la clase del parámetro lpszMessageClass o una clase base de esa clase. Pasar NULL indica que la carpeta a la que apunta lppEntryID es la carpeta de recepción predeterminada para el almacén de mensajes.

Valor devuelto

S_OK

La carpeta de recepción se devolvió correctamente.

Comentarios

El método IMsgStore::GetReceiveFolder obtiene el identificador de entrada de una carpeta de recepción, una carpeta designada para recibir mensajes entrantes de una clase de mensaje determinada. Los autores de la llamada pueden especificar una clase de mensaje o NULL en el parámetro lpszMessageClass . Si lpszMessageClass es NULL, GetReceiveFolder devuelve los valores siguientes:

• En lppszExplicitClass, el nombre de la primera clase base de la clase de mensaje a la que apunta lpszMessageClass que establece explícitamente una carpeta de recepción.

• En lppEntryID, el identificador de entrada de la carpeta de recepción para la clase base a la que apunta el parámetro lppszExplicitClass .

Por ejemplo, supongamos que la carpeta de recepción de la clase de mensaje IPM. La nota se ha establecido en el identificador de entrada de la Bandeja de entrada y se llama a GetReceiveFolder con el contenido de lpszMessageClass establecido en IPM. Note.Phone. Si ES IPM. Note.Phone no tiene una carpeta de recepción explícita establecida, GetReceiveFolder devuelve el identificador de entrada de la Bandeja de entrada en lppEntryID e IPM. Tenga en cuenta en lppszExplicitClass.

Si el cliente llama a GetReceiveFolder para una clase de mensaje y no ha establecido una carpeta de recepción para esa clase de mensaje, lppszExplicitClass es una cadena de longitud cero, una cadena en formato Unicode o una cadena en formato ANSI en función de si el cliente establece la marca de MAPI_UNICODE en el parámetro ulFlags .

Una carpeta de recepción predeterminada, obtenida pasando NULL en el parámetro lpszMessageClass , siempre existe para cada almacén de mensajes.

Un cliente debe llamar a la función MAPIFreeBuffer cuando se realiza con el identificador de entrada devuelto en lppEntryID para liberar la memoria que contiene ese identificador de entrada. También debe llamar a MAPIFreeBuffer cuando se realiza con la cadena de clase de mensaje devuelta en lppszExplicitClass para liberar la memoria que contiene esa cadena.

Referencia de MFCMAPI

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

Archivo	Función	Comment
MAPIFunctions.cpp	GetInbox	MFCMAPI usa el método IMsgStore::GetReceiveFolder para buscar la carpeta Bandeja de entrada.

Vea también

MAPIFreeBuffer
IMsgStore: IMAPIPropMFCMAPI como ejemplo de código