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

  • Artigo

Atribui um novo caminho a uma pasta conhecida.

Sintaxe

HRESULT SetPath(
  [in] DWORD   dwFlags,
  [in] LPCWSTR pszPath
);

Parâmetros

[in] dwFlags

Tipo: DWORD

Zero ou o seguinte valor:

KF_FLAG_DONT_UNEXPAND

Defina o caminho completo sem cadeias de caracteres de ambiente. Se esse sinalizador não estiver definido, partes do caminho em pszPath poderão ser representadas por cadeias de caracteres de ambiente, como %USERPROFILE%.

[in] pszPath

Tipo: LPCWSTR

Ponteiro para o novo caminho da pasta. Essa é uma cadeia de caracteres Unicode terminada em nulo de comprimento MAX_PATH. Esse caminho não pode ter comprimento zero. Se esse valor for NULL, IKnownFolder::SetPath definirá o caminho como o valor padrão.

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

Esse método não pode ser chamado em pastas do tipo KF_CATEGORY_FIXED ou KF_CATEGORY_VIRTUAL.

Para chamar esse método em uma pasta do tipo KF_CATEGORY_COMMON, o aplicativo de chamada deve estar em execução com privilégios elevados.

Esse método é equivalente a SHSetKnownFolderPath.

Requisitos

Requisito Valor
Cliente mínimo com suporte Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte Windows Server 2008 [somente aplicativos da área de trabalho]
Plataforma de Destino Windows
Cabeçalho shobjidl_core.h (inclua Shobjidl.h)
DLL Shell32.dll

Confira também

IKnownFolder

Exemplo de pastas conhecidas

SHSetKnownFolderPath