Partager via


IMAPITable::GetCollapseState

S’applique à : Outlook 2013 | Outlook 2016

Retourne les données nécessaires pour reconstruire l’état réduit ou développé actuel d’une table catégorisée.

HRESULT GetCollapseState(
ULONG ulFlags,
ULONG cbInstanceKey,
LPBYTE lpbInstanceKey,
ULONG FAR * lpcbCollapseState,
LPBYTE FAR * lppbCollapseState
);

Paramètres

ulFlags

Réservés au; doit être égal à zéro.

cbInstanceKey

[in] Nombre d’octets dans la clé instance pointée par le paramètre lpbInstanceKey.

lpbInstanceKey

[in] Pointeur vers la propriété PR_INSTANCE_KEY (PidTagInstanceKey) de la ligne à laquelle l’état actuel réduit ou développé doit être reconstruit. Le paramètre lpbInstanceKey ne peut pas être NULL.

lpcbCollapseState

[out] Pointeur vers le nombre de structures vers lesquelles pointe le paramètre lppbCollapseState .

lppbCollapseState

[out] Pointeur vers un pointeur vers des structures qui contiennent des données qui décrivent la vue de table actuelle.

Valeur renvoyée

S_OK

L’état de la table catégorisée a été correctement enregistré.

MAPI_E_BUSY

Une autre opération en cours empêche le démarrage de l’opération. Soit l’opération en cours doit être autorisée à se terminer, soit elle doit être arrêtée.

MAPI_E_NO_SUPPORT

La table ne prend pas en charge la catégorisation et les vues développées et réduites.

Remarques

La méthode IMAPITable ::GetCollapseState fonctionne avec la méthode IMAPITable ::SetCollapseState pour modifier l’affichage d’une table catégorisée par l’utilisateur. GetCollapseState enregistre les données nécessaires à l’utilisation de SetCollapseState pour recréer les vues appropriées des catégories d’une table classée. Les fournisseurs de services déterminent les données à enregistrer. Toutefois, la plupart des fournisseurs de services implémentant GetCollapseState enregistrent les éléments suivants :

  • Les clés de tri (colonnes standard et colonnes de catégorie).

  • Informations sur la ligne que représente la clé instance.

  • Informations permettant de restaurer les catégories réduites et développées de la table.

Pour plus d’informations sur les tables classées, consultez Tri et catégorisation.

Remarques pour les responsables de l’implémentation

Stockez l’état actuel de tous les nœuds d’une table dans le paramètre lppbCollapseState .

Remarques pour les appelants

Appelez toujours GetCollapseState avant d’appeler SetCollapseState.

Voir aussi

IMAPITable::SetCollapseState

IMAPITable : IUnknown