IMAPIProp::GetPropList

Artigo
04/04/2023

Aplica-se a: Outlook 2013 | Outlook 2016

Retorna marcas de propriedade para todas as propriedades.

HRESULT GetPropList(
  ULONG ulFlags,
  LPSPropTagArray FAR * lppPropTagArray
);

Parâmetros

ulFlags

[in] Um bitmask de sinalizadores que controla o formato das cadeias de caracteres nas marcas de propriedade retornadas. O seguinte sinalizador pode ser definido:

MAPI_UNICODE

As cadeias de caracteres retornadas estão no formato Unicode. Se o sinalizador MAPI_UNICODE não estiver definido, as cadeias de caracteres estarão no formato ANSI.

lppPropTagArray

[out] Um ponteiro para um ponteiro para a matriz de marcas de propriedade que contém marcas para todas as propriedades do objeto.

Valor de retorno

S_OK

Todas as marcas de propriedade foram retornadas com êxito.

MAPI_E_BAD_CHARWIDTH

O sinalizador MAPI_UNICODE foi definido e a implementação não dá suporte ao Unicode ou MAPI_UNICODE não foi definido e a implementação dá suporte apenas ao Unicode.

Comentários

O método IMAPIProp::GetPropList recupera a marca de propriedade de cada propriedade com suporte atualmente por um objeto. Se o objeto não for compatível com nenhuma propriedade no momento, GetPropList retornará uma matriz de marcas de propriedade com o membro cValues definido como 0.

O escopo das propriedades retornadas pelo GetPropList varia de provedor para provedor. Alguns provedores de serviços excluem essas propriedades para as quais o chamador não tem acesso. Todos os provedores retornam propriedades do tipo PT_OBJECT.

Se o objeto não der suporte ao Unicode, GetPropList retornará MAPI_E_BAD_CHARWIDTH, mesmo que não haja propriedades de cadeia de caracteres definidas para o objeto.

Observações para implementadores

Provedores de transporte remoto implementam GetPropList exatamente como especificado aqui. Não há preocupações especiais. Sua implementação deve, naturalmente, retornar a mesma lista de propriedades com suporte pelo método IMAPIProp::GetProps .

Notas para chamadores

Chame a função MAPIFreeBuffer para liberar a matriz de marcas de propriedade apontada por lppPropTagArray.

Referência do MFCMAPI

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

Arquivo	Função	Comentário
MAPIFunctions.cpp	GetPropsNULL	O MFCMAPI usa o método IMAPIProp::GetPropList para obter uma lista de propriedades para passar para GetProps.

Confira também

IMAPIProp::GetProps
MAPIFreeBuffer
IMAPIProp : IUnknown MFCMAPI como um exemplo de código

Compartilhar via