IMAPIProp::GetPropList

Hace referencia a: Outlook 2013 | Outlook 2016

Devuelve etiquetas de propiedad para todas las propiedades.

HRESULT GetPropList(
  ULONG ulFlags,
  LPSPropTagArray FAR * lppPropTagArray
);

Parameters

ulFlags

[in] Máscara de bits de marcas que controla el formato de las cadenas en las etiquetas de propiedad devueltas. Se puede establecer la marca siguiente:

MAPI_UNICODE

Las cadenas devueltas están en formato Unicode. Si no se establece la marca de MAPI_UNICODE, las cadenas están en formato ANSI.

lppPropTagArray

[out] Puntero a un puntero a la matriz de etiquetas de propiedad que contiene etiquetas para todas las propiedades del objeto.

Valor devuelto

S_OK

Todas las etiquetas de propiedad se devolvieron correctamente.

MAPI_E_BAD_CHARWIDTH

Se estableció la marca de MAPI_UNICODE y la implementación no admite Unicode, o MAPI_UNICODE no se estableció y la implementación solo admite Unicode.

Comentarios

El método IMAPIProp::GetPropList recupera la etiqueta de propiedad de cada propiedad admitida actualmente por un objeto. Si el objeto no admite actualmente ninguna propiedad, GetPropList devuelve una matriz de etiquetas de propiedad con el miembro cValues establecido en 0.

El ámbito de las propiedades devueltas por GetPropList varía de proveedor a proveedor. Algunos proveedores de servicios excluyen las propiedades para las que el autor de la llamada no tiene acceso. Todos los proveedores devuelven propiedades de tipo PT_OBJECT.

Si el objeto no admite Unicode, GetPropList devuelve MAPI_E_BAD_CHARWIDTH, incluso si no hay ninguna propiedad de cadena definida para el objeto.

Notas a los implementadores

Los proveedores de transporte remoto implementan GetPropList exactamente como se especifica aquí. No hay preocupaciones especiales. Por supuesto, la implementación debe devolver la misma lista de propiedades que admite el método IMAPIProp::GetProps .

Notas para los llamadores

Llame a la función MAPIFreeBuffer para liberar la matriz de etiquetas de propiedad a la que apunta lppPropTagArray.

Referencia de MFCMAPI

Para obtener un ejemplo de código de MFCMAPI, vea la siguiente tabla.

Archivo Función Comment
MAPIFunctions.cpp
GetPropsNULL
MFCMAPI usa el método IMAPIProp::GetPropList para obtener una lista de propiedades que se va a pasar a GetProps.

Vea también

IMAPIProp::GetProps
MAPIFreeBuffer
IMAPIProp: IUnknownMFCMAPI como ejemplo de código