IKnownFolderManager ::Redirect, méthode (shobjidl_core.h)

Article
08/26/2023

Redirige les demandes de dossiers pour les dossiers courants et par utilisateur.

Syntaxe

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
);

Paramètres

[in] rfid

Type : REFKNOWNFOLDERID

Référence au KNOWNFOLDERID du dossier à rediriger.

[in, optional] hwnd

Type : HWND

Handle de la fenêtre parente utilisée pour afficher les boîtes de dialogue d’interface utilisateur de progression du moteur de copie lorsque KF_REDIRECT_WITH_UI est passé dans le paramètre flags . Si aucune boîte de dialogue de progression n’est nécessaire, cette valeur peut être NULL.

[in] flags

Type : KF_REDIRECT_FLAGS

Options KF_REDIRECT_FLAGS pour la redirection.

[in, optional] pszTargetPath

Type : LPCWSTR

Pointeur vers le nouveau chemin d’accès du dossier. Il s’agit d’une chaîne Unicode terminée par null. Cette valeur peut être NULL.

[in] cFolders

Type : UINT

Nombre de valeurs KNOWNFOLDERID dans le tableau à pExclusion.

[in] pExclusion

Type : KNOWNFOLDERID const*

Pointeur vers un tableau de valeurs KNOWNFOLDERID qui font référence à des sous-dossiers de rfid qui doivent être exclus de la redirection. Si aucun sous-dossier n’est exclu, cette valeur peut être NULL.

[out] ppszError

Type : LPWSTR*

Lorsque cette méthode retourne, contient l’adresse d’un pointeur vers une chaîne Unicode terminée par null qui contient un message d’erreur si une chaîne a été générée. Cette valeur peut être NULL.

Valeur retournée

Type : HRESULT

Retourne S_OK en cas de réussite, ou une valeur d’erreur dans le cas contraire, y compris les éléments suivants :

Code de retour	Description
E_INVALIDARG	Entre autres, cette valeur peut indiquer que le paramètre rfid fait référence à un KNOWNFOLDERID qui n’est pas présent sur le système. Toutes les valeurs KNOWNFOLDERID ne sont pas présentes sur tous les systèmes. Utilisez IKnownFolderManager ::GetFolderIds pour récupérer l’ensemble de valeurs KNOWNFOLDERID pour le système actuel.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	shobjidl_core.h (inclure Shobjidl.h)

Voir aussi

IKnownFolderManager

Dossiers connus, exemple