Método IShellFolderView::GetArrangeParam (shlobj_core.h)

Obtém o parâmetro de arranjo da exibição, que é como a exibição foi classificada.

Nota Esse método foi preterido a partir do Windows Vista. Ele pode estar alterado ou indisponível em versões subsequentes do Windows. Recomendamos que você use IFolderView2::GetSortColumns .

 

Sintaxe

HRESULT GetArrangeParam(
  [out] LPARAM *plParamSort
);

Parâmetros

[out] plParamSort

Tipo: LPARAM*

Os dezesseis bits inferiores de plParamSort definem a regra de classificação. A maioria dos aplicativos define a regra de classificação como o valor padrão de zero, indicando que os itens devem ser classificados por nome. O sistema não define nenhuma outra regra de classificação. Alguns objetos de pasta podem permitir que aplicativos de chamada usem os dezesseis bits inferiores de plParamSort para especificar regras de classificação específicas de pasta. As regras e seus valores plParamSort associados são definidos pela pasta .

Quando o objeto de exibição de pasta do sistema chama IShellFolderView::GetArrangeParam, os dezesseis bits inferiores de plParamSort são usados para especificar a coluna a ser usada para a organização.

Os 16 bits superiores de plParamSort são usados para sinalizadores que modificam a regra de classificação. No momento, o sistema define os seguintes sinalizadores modificador.

SHCIDS_ALLFIELDS

Versão 5.0. Organize todas as informações contidas na estrutura ITEMIDLIST , não apenas nos nomes de exibição. Esse sinalizador é válido apenas para objetos de pasta que dão suporte à interface IShellFolder2 . Por exemplo, se os dois itens forem arquivos, a pasta organizará seus nomes, tamanhos, tempos de arquivo, atributos e quaisquer outras informações nas estruturas. Se esse sinalizador estiver definido, os dezesseis bits inferiores de plParamSort deverão ser zero.

SHCIDS_CANONICALONLY

Versão 5.0. Ao organizar por nome, organize os nomes do sistema, mas não os nomes de exibição. Quando esse sinalizador é passado, os dois itens são organizados por qualquer critério que a pasta Shell determine mais eficiente, desde que implemente uma função de classificação consistente. Esse sinalizador não pode ser combinado com outros sinalizadores.

Retornar valor

Tipo: HRESULT

Se o método for bem-sucedido, ele retornará S_OK. Caso contrário, ele retornará um código de erro HRESULT.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows XP [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	shlobj_core.h