Método IKnownFolderManager::GetFolderByName (shobjidl_core.h)

Obtém um objeto que representa uma pasta conhecida identificada pelo nome canônico. O objeto permite consultar determinadas propriedades de pasta, obter o caminho atual da pasta, redirecionar a pasta para outro local e obter o caminho da pasta como ITEMIDLIST.

Sintaxe

HRESULT GetFolderByName(
  [in]  LPCWSTR      pszCanonicalName,
  [out] IKnownFolder **ppkf
);

Parâmetros

[in] pszCanonicalName

Tipo: LPCWSTR

Um ponteiro para o nome canônico não localizado para a pasta conhecida, armazenado como uma cadeia de caracteres Unicode terminada em nulo. Se essa pasta for uma pasta comum ou por usuário , esse valor também será usado como o nome do valor das configurações do registro "Pastas do Shell do Usuário". Esse valor é recuperado por meio do membro pszName da estrutura de KNOWNFOLDER_DEFINITION da pasta.

[out] ppkf

Tipo: IKnownFolder**

Quando esse método retorna, contém o endereço de um ponteiro para o objeto IKnownFolder que representa a pasta conhecida.

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.

Comentários

Quando usar

Requisitos

Confira também

IKnownFolderManager

Exemplo de pastas conhecidas