IMAPITable::GetCollapseState
Hace referencia a: Outlook 2013 | Outlook 2016
Devuelve los datos necesarios para volver a generar el estado actual contraído o expandido de una tabla categorizada.
HRESULT GetCollapseState(
ULONG ulFlags,
ULONG cbInstanceKey,
LPBYTE lpbInstanceKey,
ULONG FAR * lpcbCollapseState,
LPBYTE FAR * lppbCollapseState
);
Parameters
ulFlags
Reservados; debe ser cero.
cbInstanceKey
[in] Recuento de bytes en la clave de instancia a la que apunta el parámetro lpbInstanceKey .
lpbInstanceKey
[in] Puntero a la propiedad PR_INSTANCE_KEY (PidTagInstanceKey) de la fila en la que se debe volver a generar el estado actual contraído o expandido. El parámetro lpbInstanceKey no puede ser NULL.
lpcbCollapseState
[out] Puntero al recuento de estructuras a las que apunta el parámetro lppbCollapseState .
lppbCollapseState
[out] Puntero a un puntero a estructuras que contienen datos que describen la vista de tabla actual.
Valor devuelto
S_OK
El estado de la tabla categorizada se guardó correctamente.
MAPI_E_BUSY
Hay otra operación en curso que impide que se inicie la operación. Se debe permitir que se complete la operación en curso o se debe detener.
MAPI_E_NO_SUPPORT
La tabla no admite la categorización y las vistas expandidas y contraídas.
Comentarios
El método IMAPITable::GetCollapseState funciona con el método IMAPITable::SetCollapseState para cambiar la vista del usuario de una tabla categorizada. GetCollapseState guarda los datos necesarios para que SetCollapseState use para volver a generar las vistas adecuadas de las categorías de una tabla categorizada. Los proveedores de servicios determinan los datos que se van a guardar. Sin embargo, la mayoría de los proveedores de servicios que implementan GetCollapseState guardan lo siguiente:
Las claves de ordenación (columnas estándar y columnas de categoría).
Información sobre la fila que representa la clave de instancia.
Información para restaurar las categorías contraídas y expandidas de la tabla.
Para obtener más información sobre las tablas categorizadas, vea Ordenar y categorizar.
Notas a los implementadores
Almacene el estado actual de todos los nodos de una tabla en el parámetro lppbCollapseState .
Notas para los llamadores
Llame siempre a GetCollapseState antes de llamar a SetCollapseState.