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

  • Artigo

Redireciona solicitações de pasta para pastas comuns e por usuário.

Sintaxe

HRESULT Redirect(
  [in]           REFKNOWNFOLDERID    rfid,
  [in, optional] HWND                hwnd,
  [in]           KF_REDIRECT_FLAGS   flags,
  [in, optional] LPCWSTR             pszTargetPath,
  [in]           UINT                cFolders,
  [in]           const KNOWNFOLDERID *pExclusion,
  [out]          LPWSTR              *ppszError
);

Parâmetros

[in] rfid

Tipo: REFKNOWNFOLDERID

Uma referência ao KNOWNFOLDERID da pasta a ser redirecionada.

[in, optional] hwnd

Digite: HWND

O identificador da janela pai usada para exibir caixas de diálogo de interface do usuário de progresso do mecanismo de cópia quando KF_REDIRECT_WITH_UI é passado no parâmetro flags . Se nenhuma caixa de diálogo de progresso for necessária, esse valor poderá ser NULL.

[in] flags

Tipo: KF_REDIRECT_FLAGS

As opções de KF_REDIRECT_FLAGS para redirecionamento.

[in, optional] pszTargetPath

Tipo: LPCWSTR

Um ponteiro para o novo caminho da pasta. Essa é uma cadeia de caracteres Unicode terminada em nulo. Esse valor pode ser NULL.

[in] cFolders

Tipo: UINT

O número de valores KNOWNFOLDERID na matriz em pExclusion.

[in] pExclusion

Tipo: KNOWNFOLDERID const*

Ponteiro para uma matriz de valores KNOWNFOLDERID que se referem a subpastas de rfid que devem ser excluídas do redirecionamento. Se nenhuma subpasta for excluída, esse valor poderá ser NULL.

[out] ppszError

Tipo: LPWSTR*

Quando esse método retorna, contém o endereço de um ponteiro para uma cadeia de caracteres Unicode terminada em nulo que contém uma mensagem de erro se uma foi gerada. Esse valor pode ser NULL.

Retornar valor

Tipo: HRESULT

Retorna S_OK se tiver êxito ou um valor de erro, incluindo o seguinte:

Código de retorno Descrição
E_INVALIDARG
 Entre outras coisas, esse valor pode indicar que o parâmetro rfid faz referência a um KNOWNFOLDERID que não está presente no sistema. Nem todos os valores KNOWNFOLDERID estão presentes em todos os sistemas. Use IKnownFolderManager::GetFolderIds para recuperar o conjunto de valores KNOWNFOLDERID para o sistema atual.

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)

Confira também

IKnownFolderManager

Exemplo de pastas conhecidas