IMAPIProp::DeleteProps
Aplica-se a: Outlook 2013 | Outlook 2016
Exclui uma ou mais propriedades de um objeto.
HRESULT DeleteProps(
LPSPropTagArray lpPropTagArray,
LPSPropProblemArray FAR * lppProblems
);
Parâmetros
Lpproptagarray
[in] Um ponteiro para uma matriz de marcas de propriedade que indicam as propriedades a serem excluídas. O membro cValues da estrutura SPropTagArray apontada por lpPropTagArray não deve ser zero e o parâmetro lpPropTagArray em si não deve ser NULL.
lppProblems
[in, out] Na entrada, um ponteiro para um ponteiro para uma estrutura SPropProblemArray ; caso contrário, NULL, que indica que não há necessidade de informações de erro. Se lppProblems for um ponteiro válido na entrada, DeleteProps retornará informações detalhadas sobre erros na exclusão de uma ou mais propriedades.
Valor de retorno
S_OK
As propriedades foram excluídas com êxito.
MAPI_E_NO_ACCESS
O chamador tem permissões insuficientes para excluir propriedades.
Comentários
O método IMAPIProp::D eleteProps remove uma ou mais propriedades do objeto atual.
Observações para implementadores
Você não precisa permitir que as propriedades sejam excluídas de todos os objetos. Se o objeto não for modificável, retorne MAPI_E_NO_ACCESS do método DeleteProps .
Notas para chamadores
Você não precisa definir o tipo de propriedade para cada marca de propriedade na matriz de marcas de propriedade apontada pelo parâmetro lpPropTagArray . Os tipos de propriedade são ignorados; somente os identificadores de propriedade são usados.
Lembre-se de que alguns objetos não permitem modificação e que esses objetos retornam MAPI_E_NO_ACCESS do método DeleteProps . Outros objetos permitem que algumas propriedades sejam excluídas, mas não outras. Quando há um problema em excluir apenas algumas das propriedades, DeleteProps retorna S_OK. Se você tiver passado um ponteiro válido no parâmetro lppProblems , DeleteProps definirá o ponteiro como uma estrutura SPropProblemArray que contém informações detalhadas sobre os problemas com cada propriedade. Por exemplo, se você estiver excluindo todas as propriedades de uma mensagem e houver um problema com um ou mais de seus anexos, a estrutura SPropProblemArray conterá uma entrada para a propriedade PR_MESSAGE_ATTACHMENTS (PidTagMessageAttachments).
A estrutura apontada por lppProblems só será válida se DeleteProps retornar S_OK. Se DeleteProps retornar um erro, não tente usar a estrutura SPropProblemArray . Em vez disso, chame o método IMAPIProp::GetLastError do objeto para obter mais informações sobre o erro.
Libere a estrutura SPropProblemArray retornada chamando a função MAPIFreeBuffer .
Referência do MFCMAPI
Para ver códigos de exemplo do MFCMAPI, confira a tabela a seguir.
| Arquivo | Função | Comentário |
|---|---|---|
| MAPIFunctions.cpp |
DeleteProperty |
O MFCMAPI usa o método IMAPIProp::D eleteProps para excluir uma propriedade de um objeto. |