IMAPIProp::DeleteProps
Область применения: Outlook 2013 | Outlook 2016
Удаляет одно или несколько свойств из объекта .
HRESULT DeleteProps(
LPSPropTagArray lpPropTagArray,
LPSPropProblemArray FAR * lppProblems
);
Параметры
lpPropTagArray
[в] Указатель на массив тегов свойств, указывающих удаляемые свойства. Элемент cValues структуры SPropTagArray , на который указывает lpPropTagArray , не должен быть равным нулю, а сам параметр lpPropTagArray не должен иметь значение NULL.
lppProblems
[вход, выход] На входных данных — указатель на указатель на структуру SPropProblemArray ; в противном случае значение NULL, указывающее, что нет необходимости в информации об ошибке. Если lppProblems является допустимым указателем на входные данные, deleteProps возвращает подробные сведения об ошибках при удалении одного или нескольких свойств.
Возвращаемое значение
S_OK
Свойства успешно удалены.
MAPI_E_NO_ACCESS
У вызывающего объекта недостаточно разрешений на удаление свойств.
Замечания
Метод IMAPIProp::D eleteProps удаляет одно или несколько свойств из текущего объекта.
Примечания для исполнителей
Не нужно разрешать удаление свойств из всех объектов. Если объект не является изменяемым, верните MAPI_E_NO_ACCESS из метода DeleteProps .
Примечания для вызывающих методов
Вам не нужно задавать тип свойства для каждого тега свойства в массиве тегов свойств, на который указывает параметр lpPropTagArray . Типы свойств игнорируются; Используются только идентификаторы свойств.
Имейте в виду, что некоторые объекты не допускают изменения и что эти объекты возвращают MAPI_E_NO_ACCESS из метода DeleteProps . Другие объекты позволяют удалять некоторые свойства, но не другие. Если возникает проблема при удалении только некоторых свойств, функция DeleteProps возвращает S_OK. Если вы передали допустимый указатель в параметре lppProblems , DeleteProps установит указатель на структуру SPropProblemArray , содержащую подробные сведения о проблемах с каждым свойством. Например, если вы удаляете все свойства сообщения и возникла проблема с одним или несколькими его вложениями, структура SPropProblemArray будет содержать запись для свойства PR_MESSAGE_ATTACHMENTS (PidTagMessageAttachments).
Структура, на которую указывает lppProblems , допустима только в том случае, если DeleteProps возвращает S_OK. Если DeleteProps возвращает ошибку, не пытайтесь использовать структуру SPropProblemArray . Вместо этого вызовите метод IMAPIProp::GetLastError объекта, чтобы получить дополнительные сведения об ошибке.
Освободите возвращаемую структуру SPropProblemArray , вызвав функцию MAPIFreeBuffer .
Справочные материалы по MFCMAPI
Пример кода MFCMAPI указан в приведенной ниже таблице.
| Файл | Функция | Comment |
|---|---|---|
| MAPIFunctions.cpp |
DeleteProperty |
MFCMAPI использует метод IMAPIProp::D eleteProps для удаления свойства из объекта. |