IMAPIProp::DeleteProps
Hace referencia a: Outlook 2013 | Outlook 2016
Elimina una o varias propiedades de un objeto.
HRESULT DeleteProps(
LPSPropTagArray lpPropTagArray,
LPSPropProblemArray FAR * lppProblems
);
Parameters
lpPropTagArray
[in] Puntero a una matriz de etiquetas de propiedad que indican las propiedades que se van a eliminar. El miembro cValues de la estructura SPropTagArray a la que apunta lpPropTagArray no debe ser cero y el propio parámetro lpPropTagArray no debe ser NULL.
lppProblems
[entrada, salida] En la entrada, un puntero a un puntero a una estructura SPropProblemArray ; de lo contrario, NULL, que indica que no hay necesidad de información de error. Si lppProblems es un puntero válido en la entrada, DeleteProps devuelve información detallada sobre los errores al eliminar una o varias propiedades.
Valor devuelto
S_OK
Las propiedades se eliminaron correctamente.
MAPI_E_NO_ACCESS
El autor de la llamada no tiene permisos suficientes para eliminar propiedades.
Comentarios
El método IMAPIProp::D eleteProps quita una o varias propiedades del objeto actual.
Notas a los implementadores
No es necesario permitir que las propiedades se eliminen de todos los objetos. Si el objeto no es modificable, devuelva MAPI_E_NO_ACCESS del método DeleteProps .
Notas para los llamadores
No es necesario establecer el tipo de propiedad para cada etiqueta de propiedad de la matriz de etiquetas de propiedad a la que apunta el parámetro lpPropTagArray . Los tipos de propiedad se omiten; solo se usan los identificadores de propiedad.
Tenga en cuenta que algunos objetos no permiten la modificación y que estos objetos devuelven MAPI_E_NO_ACCESS del método DeleteProps . Otros objetos permiten eliminar algunas propiedades, pero no otras. Cuando hay un problema al eliminar solo algunas de las propiedades, DeleteProps devuelve S_OK. Si ha pasado un puntero válido en el parámetro lppProblems , DeleteProps establecerá el puntero en una estructura SPropProblemArray que contiene información detallada sobre los problemas con cada propiedad. Por ejemplo, si va a eliminar todas las propiedades de un mensaje y hay un problema con uno o varios de sus datos adjuntos, la estructura SPropProblemArray contendrá una entrada para la propiedad PR_MESSAGE_ATTACHMENTS (PidTagMessageAttachments).
La estructura a la que apunta lppProblems solo es válida si DeleteProps devuelve S_OK. Si DeleteProps devuelve un error, no intente usar la estructura SPropProblemArray . En su lugar, llame al método IMAPIProp::GetLastError del objeto para obtener más información sobre el error.
Libere la estructura SPropProblemArray devuelta llamando a la función MAPIFreeBuffer .
Referencia de MFCMAPI
Para obtener un ejemplo de código de MFCMAPI, vea la siguiente tabla.
| Archivo | Función | Comment |
|---|---|---|
| MAPIFunctions.cpp |
DeleteProperty |
MFCMAPI usa el método IMAPIProp::D eleteProps para eliminar una propiedad de un objeto . |