IMAPITable::GetCollapseState
Aplica-se a: Outlook 2013 | Outlook 2016
Retorna os dados necessários para recompilar o estado atual recolhido ou expandido de uma tabela categorizada.
HRESULT GetCollapseState(
ULONG ulFlags,
ULONG cbInstanceKey,
LPBYTE lpbInstanceKey,
ULONG FAR * lpcbCollapseState,
LPBYTE FAR * lppbCollapseState
);
Parâmetros
ulFlags
Reservados; deve ser zero.
cbInstanceKey
[in] A contagem de bytes na chave de instância apontada pelo parâmetro lpbInstanceKey .
lpbInstanceKey
[in] Um ponteiro para a propriedade PR_INSTANCE_KEY (PidTagInstanceKey) da linha na qual o estado atual recolhido ou expandido deve ser reconstruído. O parâmetro lpbInstanceKey não pode ser NULL.
lpcbCollapseState
[out] Um ponteiro para a contagem de estruturas apontadas pelo parâmetro lppbCollapseState .
lppbCollapseState
[out] Um ponteiro para um ponteiro para estruturas que contêm dados que descrevem a exibição da tabela atual.
Valor de retorno
S_OK
O estado da tabela categorizada foi salvo com êxito.
MAPI_E_BUSY
Outra operação está em andamento que impede o início da operação. A operação em andamento deve ser autorizada a ser concluída ou deve ser interrompida.
MAPI_E_NO_SUPPORT
A tabela não dá suporte à categorização e exibições expandidas e recolhidas.
Comentários
O método IMAPITable::GetCollapseState funciona com o método IMAPITable::SetCollapseState para alterar a exibição do usuário de uma tabela categorizada. GetCollapseState salva os dados necessários para setCollapseState para usar para recompilar as exibições apropriadas das categorias de uma tabela categorizada. Os provedores de serviços determinam os dados a serem salvos. No entanto, a maioria dos provedores de serviços que implementam GetCollapseState salva o seguinte:
As chaves de classificação (colunas padrão e colunas de categoria).
Informações sobre a linha que a chave da instância representa.
Informações para restaurar as categorias recolhidas e expandidas da tabela.
Para obter mais informações sobre tabelas categorizadas, consulte Classificação e Categorização.
Observações para implementadores
Armazene o estado atual de todos os nós de uma tabela no parâmetro lppbCollapseState .
Notas para chamadores
Sempre chame GetCollapseState antes de chamar SetCollapseState.