IMAPIProp::GetPropList

Статья
04/04/2023

Область применения: Outlook 2013 | Outlook 2016

Возвращает теги свойств для всех свойств.

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

Параметры

ulFlags

[в] Битовая маска флагов, управляющая форматом строк в возвращаемых тегах свойств. Можно задать следующий флаг:

MAPI_UNICODE

Возвращаемые строки имеют формат Юникода. Если флаг MAPI_UNICODE не задан, строки имеют формат ANSI.

lppPropTagArray

[out] Указатель на указатель на массив тегов свойств, содержащий теги для всех свойств объекта.

Возвращаемое значение

S_OK

Все теги свойств были успешно возвращены.

MAPI_E_BAD_CHARWIDTH

Либо был установлен флаг MAPI_UNICODE и реализация не поддерживает Юникод, либо MAPI_UNICODE не задан и реализация поддерживает только Юникод.

Замечания

Метод IMAPIProp::GetPropList извлекает тег свойства для каждого свойства, поддерживаемого объектом . Если объект в настоящее время не поддерживает какие-либо свойства, GetPropList возвращает массив тегов свойств с элементом cValues , равным 0.

Область свойств, возвращаемых GetPropList, зависит от поставщика. Некоторые поставщики услуг исключают те свойства, к которым у вызывающего объекта нет доступа. Все поставщики возвращают свойства типа PT_OBJECT.

Если объект не поддерживает Юникод, GetPropList возвращает MAPI_E_BAD_CHARWIDTH, даже если для объекта не определены строковые свойства.

Примечания для исполнителей

Поставщики удаленного транспорта реализуют GetPropList точно так, как указано здесь. Никаких особых опасений нет. Реализация должна, конечно, возвращать тот же список свойств, что и в методе IMAPIProp::GetProps .

Примечания для вызывающих методов

Вызовите функцию MAPIFreeBuffer , чтобы освободить массив тегов свойств, на который указывает lppPropTagArray.

Справочные материалы по MFCMAPI

Пример кода MFCMAPI указан в приведенной ниже таблице.

Файл	Функция	Comment
MAPIFunctions.cpp	GetPropsNULL	MFCMAPI использует метод IMAPIProp::GetPropList для получения списка свойств для передачи в GetProps.

См. также

IMAPIProp::GetProps
MAPIFreeBuffer
IMAPIProp: IUnknown MFCMAPI как пример кода

Поделиться через