Método IKnownFolder::GetFolderDefinition (shobjidl_core.h)

Recupera uma estrutura que contém os elementos definidores de uma pasta conhecida, que inclui a categoria, o nome, o caminho, a descrição, a dica de ferramenta, o ícone e outras propriedades da pasta.

Sintaxe

HRESULT GetFolderDefinition(
  [out] KNOWNFOLDER_DEFINITION *pKFD
);

Parâmetros

[out] pKFD

Tipo: KNOWNFOLDER_DEFINITION*

Quando esse método retorna, contém um ponteiro para a estrutura KNOWNFOLDER_DEFINITION . Quando não for mais necessário, o aplicativo de chamada será responsável por chamar FreeKnownFolderDefinitionFields para liberar esse recurso.

Valor retornado

Tipo: HRESULT

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

Comentários

Quando um aplicativo de terceiros cria sua própria pasta conhecida, ele faz isso definindo-a com uma estrutura KNOWNFOLDER_DEFINITION e registrando-a no sistema. Qualquer informação de definição de pasta conhecida registrada — fornecida pelo sistema ou criada pelo aplicativo — pode ser recuperada por meio desse método.

Para chamar esse método, o chamador deve ter pelo menos privilégios de usuário.

Requisitos

Confira também

IKnownFolder

Exemplo de pastas conhecidas