IMAPIProp::D eleteProps
適用於:Outlook 2013 |Outlook 2016
從物件中刪除一或多個屬性。
HRESULT DeleteProps(
LPSPropTagArray lpPropTagArray,
LPSPropProblemArray FAR * lppProblems
);
參數
lpPropTagArray
[in]屬性標記陣列的指標,指出要刪除的屬性。 lpPropTagArray 所指向之 SPropTagArray 結構的 cValues 成員不得為零,而且 lpPropTagArray 參數本身不得為 NULL。
lppProblems
[in, out]在輸入時, 指向 SPropProblemArray 結構指標的指標;否則為 NULL,表示不需要錯誤資訊。 如果 lppProblems 是輸入的有效指標, DeleteProps 會 傳回有關刪除一或多個屬性錯誤的詳細資訊。
傳回值
S_OK
已成功刪除屬性。
MAPI_E_NO_ACCESS
呼叫端沒有足夠的許可權可刪除屬性。
註解
IMAPIProp::D eleteProps 方法會從目前的 物件移除一或多個屬性。
實作者注意事項
您不需要允許從所有物件刪除屬性。 如果物件不可修改,請從 DeleteProps 方法傳回MAPI_E_NO_ACCESS。
呼叫者注意事項
您不需要在 lpPropTagArray 參數所指向的屬性標記陣列中,為每個屬性標記設定屬性類型。 忽略屬性類型;只會使用屬性識別碼。
請注意,有些對象不允許修改,而且這些物件會從 DeleteProps 方法傳回MAPI_E_NO_ACCESS。 其他物件允許刪除某些屬性,但不允許刪除其他屬性。 如果只刪除某些屬性時發生問題, DeleteProps 會傳回S_OK。 如果您已在 lppProblems 參數中傳遞有效的指標, DeleteProps 會將指標設定為 SPropProblemArray 結構,其中包含每個屬性問題的詳細資訊。 例如,如果您要刪除訊息的所有屬性,而且有一或多個附件的問題, 則 SPropProblemArray 結構會包含 PR_MESSAGE_ATTACHMENTS (PidTagMessageAttachments) 屬性的專案。
lppProblems 所指向的結構只有在 DeleteProps 傳回S_OK時才有效。 如果 DeleteProps 傳回錯誤,請勿嘗試使用 SPropProblemArray 結構。 請改為呼叫物件的 IMAPIProp::GetLastError 方法,以取得錯誤的詳細資訊。
藉由呼叫 MAPIFreeBuffer 函式,釋放傳回的 SPropProblemArray 結構。
MFCMAPI 參考
如需 MFCMAPI 範例程式代碼,請參閱下表。
檔案 | Function | Comment |
---|---|---|
MAPIFunctions.cpp |
DeleteProperty |
MFCMAPI 使用 IMAPIProp::D eleteProps 方法,從物件中刪除屬性。 |