Función SHSetKnownFolderPath (shlobj_core.h)

Artículo
08/26/2023

Redirige una carpeta conocida a una nueva ubicación.

Sintaxis

HRESULT SHSetKnownFolderPath(
  [in] REFKNOWNFOLDERID rfid,
  [in] DWORD            dwFlags,
  [in] HANDLE           hToken,
  [in] PCWSTR           pszPath
);

Parámetros

[in] rfid

Tipo: REFKNOWNFOLDERID

GUID que identifica la carpeta conocida.

[in] dwFlags

Tipo: DWORD

0 o el valor siguiente.

KF_FLAG_DONT_UNEXPAND

Si se establece esta marca, las partes de la ruta de acceso a la que hace referencia pszPath se pueden representar mediante cadenas de entorno como %USERPROFILE%.

[in] hToken

Tipo: HANDLE

Un token de acceso que se usa para representar a un usuario determinado. Este parámetro normalmente se establece en NULL, en cuyo caso la función intenta acceder a la instancia del usuario actual de la carpeta. Sin embargo, es posible que tenga que asignar un valor a hToken para esas carpetas que pueden tener varios usuarios, pero que se tratan como pertenecientes a un solo usuario. La carpeta más usada de este tipo es Documentos.

La aplicación que realiza la llamada es responsable de la suplantación correcta cuando hToken no es NULL. Debe tener privilegios de seguridad adecuados para el usuario concreto, incluidos TOKEN_QUERY y TOKEN_IMPERSONATE, y el subárbol del registro del usuario debe estar montado actualmente. Consulte Access Control para obtener más información sobre los problemas de control de acceso.

Al asignar el parámetro hToken un valor de -1, se indica el usuario predeterminado. Esto permite a los clientes de SHSetKnownFolderPath establecer ubicaciones de carpetas (como la carpeta Escritorio ) para el usuario predeterminado. El perfil de usuario predeterminado se duplica cuando se crea una nueva cuenta de usuario e incluye carpetas especiales como Documentos y Escritorio. Los elementos agregados a la carpeta Usuario predeterminado también aparecen en cualquier nueva cuenta de usuario. Tenga en cuenta que el acceso a las carpetas de usuario predeterminado requiere privilegios de administrador.

[in] pszPath

Tipo: PCWSTR

Puntero a la nueva ruta de acceso de la carpeta. Se trata de una cadena Unicode terminada en null de longitud MAX_PATH. Esta ruta de acceso no puede tener una longitud cero.

Valor devuelto

Tipo: HRESULT

Devuelve S_OK si se ejecuta correctamente o un valor de error, incluido lo siguiente:

Código devuelto	Descripción
E_INVALIDARG	Entre otras cosas, este valor puede indicar que el parámetro rfid hace referencia a un KNOWNFOLDERID que no está presente en el sistema. No todos los valores KNOWNFOLDERID están presentes en todos los sistemas. Use IKnownFolderManager::GetFolderIds para recuperar el conjunto de valores KNOWNFOLDERID para el sistema actual.

Comentarios

Esta función reemplaza SHSetFolderPath. Esa función anterior ahora es simplemente un contenedor para SHSetKnownFolderPath.

El autor de la llamada de esta función debe tener privilegios de administrador. Para llamar a esta función en carpetas conocidas públicas, el autor de la llamada debe tener privilegios de administrador. Para las carpetas conocidas por usuario, el autor de la llamada solo requiere privilegios de usuario.

Algunas de las carpetas conocidas, por ejemplo, la carpeta Documentos , son por usuario. Cada usuario tiene una ruta de acceso diferente para su carpeta Documentos . Si hToken es NULL, la API intenta acceder a la instancia de la aplicación que realiza la llamada de la carpeta , que es la del usuario actual. Si hToken es un token de usuario válido, la API intenta suplantar al usuario mediante este token e intenta acceder a la instancia de ese usuario.

No se puede llamar a esta función en carpetas de tipo KF_CATEGORY_FIXED y KF_CATEGORY_VIRTUAL.

Para llamar a esta función en una carpeta de tipo KF_CATEGORY_COMMON, la aplicación que realiza la llamada debe ejecutarse con privilegios elevados.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2008 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	shlobj_core.h (incluya Shlobj.h)
Archivo DLL	Shell32.dll (versión 6.0.6000 o posterior)