Compartir a través de

Función SHRegSetPathA (shlwapi.h)

  • Artículo

Toma una ruta de acceso de archivo, reemplaza los nombres de carpeta por cadenas de entorno y coloca la cadena resultante en el registro.

Sintaxis

LSTATUS SHRegSetPathA(
  [in] HKEY   hKey,
  [in] LPCSTR pcszSubKey,
  [in] LPCSTR pcszValue,
  [in] LPCSTR pcszPath,
       DWORD  dwFlags
);

Parámetros

[in] hKey

Tipo: HKEY de

Identificador de una clave que está abierta actualmente o una clave raíz del Registro.

[in] pcszSubKey

Tipo: LPCTSTR de

Puntero a una cadena terminada en null que contiene el nombre de una subclave existente. Si la subclave no existe, SHRegSetPath producirá un error.

[in] pcszValue

Tipo: LPCTSTR de

Puntero a una cadena terminada en null con el nombre del valor que contendrá la cadena de ruta de acceso.

[in] pcszPath

Tipo: LPCTSTR de

Puntero a una cadena terminada en null con una ruta de acceso de archivo completa.

dwFlags

Tipo: DWORD de

Reservado.

Valor devuelto

Tipo: LSTATUS de

Devuelve ERROR_SUCCESS si se ejecuta correctamente o un código de error de Windows de lo contrario.

Observaciones

Para Windows 2000, SHRegSetPath usa PathUnExpandEnvStrings convertir nombres de carpeta en su cadena de entorno correspondiente. Si se sustituyeron variables de entorno, el valor del Registro se establecerá con el tipo de datos REG_EXPAND_SZ. De lo contrario, se establecerá con el tipo de datos REG_SZ.

Las siguientes rutas de acceso de carpeta se reemplazarán por su cadena de entorno equivalente.

Carpeta Cadena de entorno
Carpeta de perfil del usuario actual %USERPROFILE%
La carpeta de perfil Todos los usuarios %ALLUSERSPROFILE%
Carpeta Archivos de programa %ProgramFiles%
Carpeta raíz del sistema %SystemRoot%
Letra de unidad del sistema %SystemDrive%
 
Nota %USERPROFILE% es relativa al usuario que realiza la llamada. Esta función no funciona si el usuario se suplanta desde un servicio.
 
Es posible que las variables de entorno enumeradas en la tabla anterior no se establezcan en ningún sistema determinado. Si no se establece una variable de entorno, no se incluirá. En concreto, ninguna de estas variables se establece para el entorno predeterminado de Windows 95 o Windows 98. La variable %ProgramFiles% es nueva para Windows 2000 y normalmente no se establecerá en los sistemas Microsoft Windows NT 4.0.

Nota

El encabezado shlwapi.h define SHRegSetPath como alias que selecciona automáticamente la versión ANSI o Unicode de esta función en función de la definición de la constante de preprocesador UNICODE. La combinación del uso del alias neutral de codificación con código que no es neutral de codificación puede dar lugar a errores de coincidencia que dan lugar a errores de compilación o tiempo de ejecución. Para obtener más información, vea Conventions for Function Prototypes.

Requisitos

Requisito Valor
cliente mínimo admitido Windows 2000 Professional, Windows XP [solo aplicaciones de escritorio]
servidor mínimo admitido Windows 2000 Server [solo aplicaciones de escritorio]
de la plataforma de destino de Windows
encabezado de shlwapi.h
biblioteca de Shlwapi.lib
DLL de Shlwapi.dll (versión 5.0 o posterior)