Compartilhar via

IMsgStore::GetReceiveFolder

  • Artigo

Aplica-se a: Outlook 2013 | Outlook 2016

Obtém a pasta que foi estabelecida como o destino para mensagens de entrada de uma classe de mensagem especificada ou como a pasta de recebimento padrão para o repositório de mensagens.

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

Parâmetros

lpszMessageClass

[in] Um ponteiro para uma classe de mensagem associada a uma pasta de recebimento. Se o parâmetro lpszMessageClass estiver definido como NULL ou uma cadeia de caracteres vazia, GetReceiveFolder retornará a pasta de recebimento padrão para o repositório de mensagens.

ulFlags

[in] Um bitmask de sinalizadores que controla o tipo das cadeias de caracteres passadas e retornadas. O seguinte sinalizador pode ser definido:

MAPI_UNICODE

A cadeia de caracteres de classe de mensagem está no formato Unicode. Se o sinalizador MAPI_UNICODE não estiver definido, a cadeia de caracteres da classe de mensagem estará no formato ANSI.

lpcbEntryID

[out] Um ponteiro para a contagem de bytes no identificador de entrada apontado pelo parâmetro lppEntryID .

lppEntryID

[out] Um ponteiro para um ponteiro para o identificador de entrada da pasta de recebimento solicitada.

lppszExplicitClass

[out] Um ponteiro para um ponteiro para a classe de mensagem que define explicitamente como sua pasta de recebimento a pasta apontada por lppEntryID. Essa classe de mensagem deve ser a mesma que a classe no parâmetro lpszMessageClass ou uma classe base dessa classe. Passar NULL indica que a pasta apontada por lppEntryID é a pasta de recebimento padrão para o repositório de mensagens.

Valor de retorno

S_OK

A pasta de recebimento foi retornada com êxito.

Comentários

O método IMsgStore::GetReceiveFolder obtém o identificador de entrada de uma pasta de recebimento, uma pasta designada para receber mensagens de entrada de uma classe de mensagem específica. Os chamadores podem especificar uma classe de mensagem ou NULL no parâmetro lpszMessageClass . Se lpszMessageClass for NULL, GetReceiveFolder retornará os seguintes valores:

  • Em lppszExplicitClass, o nome da primeira classe base da classe de mensagem apontada por lpszMessageClass que define explicitamente uma pasta de recebimento.

  • Em lppEntryID, o identificador de entrada da pasta de recebimento da classe base apontada pelo parâmetro lppszExplicitClass .

Por exemplo, suponha que a pasta de recebimento da classe de mensagem IPM. A observação foi definida como o identificador de entrada da Caixa de Entrada e GetReceiveFolder é chamado com o conteúdo de lpszMessageClass definido como IPM. Note.Phone. Se IPM. Note.Phone não tem um conjunto de pastas de recebimento explícito, GetReceiveFolder retorna o identificador de entrada da caixa de entrada em lppEntryID e IPM. Observação em lppszExplicitClass.

Se o cliente chamar GetReceiveFolder para uma classe de mensagem e não tiver definido uma pasta de recebimento para essa classe de mensagem, lppszExplicitClass será uma cadeia de caracteres de comprimento zero, uma cadeia de caracteres no formato Unicode ou uma cadeia de caracteres no formato ANSI, dependendo se o cliente definir o sinalizador MAPI_UNICODE no parâmetro ulFlags .

Uma pasta de recebimento padrão, obtida passando NULL no parâmetro lpszMessageClass , sempre existe para cada repositório de mensagens.

Um cliente deve chamar a função MAPIFreeBuffer quando for feita com o identificador de entrada retornado em lppEntryID para liberar a memória que contém esse identificador de entrada. Ele também deve chamar MAPIFreeBuffer quando for feito com a cadeia de caracteres de classe de mensagem retornada em lppszExplicitClass para liberar a memória que contém essa cadeia de caracteres.

Referência do MFCMAPI

Para ver códigos de exemplo do MFCMAPI, confira a tabela a seguir.

Arquivo Função Comentário
MAPIFunctions.cpp
 GetInbox
 O MFCMAPI usa o método IMsgStore::GetReceiveFolder para localizar a pasta Caixa de Entrada.

Confira também

MAPIFreeBuffer
IMsgStore : IMAPIPropMFCMAPI como exemplo de código