IMAPIProp::GetPropList

适用于:Outlook 2013 | Outlook 2016

返回所有属性的属性标记。

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

参数

ulFlags

[in]一个标志的位掩码,用于控制返回的属性标记中字符串的格式。 可以设置以下标志:

MAPI_UNICODE

返回的字符串采用 Unicode 格式。 如果未设置MAPI_UNICODE标志,则字符串采用 ANSI 格式。

lppPropTagArray

[out]指向属性标记数组的指针的指针,该数组包含对象的所有属性的标记。

返回值

S_OK

已成功返回所有属性标记。

MAPI_E_BAD_CHARWIDTH

已设置MAPI_UNICODE标志且实现不支持 Unicode,或者未设置MAPI_UNICODE且实现仅支持 Unicode。

备注

IMAPIProp::GetPropList 方法检索对象当前支持的每个属性的属性标记。 如果对象当前不支持任何属性, GetPropList 将返回一个将 cValues 成员设置为 0 的属性标记数组。

GetPropList 返回的属性范围因提供程序而异。 某些服务提供程序排除调用方无权访问的属性。 所有提供程序都返回 类型为 PT_OBJECT 的属性。

如果对象不支持 Unicode,则即使没有为对象定义字符串属性, GetPropList 也会返回MAPI_E_BAD_CHARWIDTH。

针对实现者的说明

远程传输提供程序完全按照此处指定的方式实现 GetPropList 。 没有特别的问题。 当然,实现应返回 IMAPIProp::GetProps 方法支持的属性列表。

给调用方的说明

调用 MAPIFreeBuffer 函数以释放 lppPropTagArray 指向的属性标记数组。

MFCMAPI 引用

有关 MFCMAPI 示例代码,请参阅下表。

文件 函数 Comment
MAPIFunctions.cpp
GetPropsNULL
MFCMAPI 使用 IMAPIProp::GetPropList 方法获取要传递给 GetProps 的属性列表。

另请参阅

IMAPIProp::GetProps
MAPIFreeBuffer
IMAPIProp:IUnknownMFCMAPI 作为代码示例