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 範例程式代碼,請參閱下表。
檔案 | Function | Comment |
---|---|---|
MAPIFunctions.cpp |
GetPropsNULL |
MFCMAPI 使用 IMAPIProp::GetPropList 方法來取得要傳遞至 GetProps 的屬性清單。 |
另請參閱
IMAPIProp::GetProps
MAPIFreeBuffer
IMAPIProp:IUnknownMFCMAPI 作為程式碼範例