Compartir a través de

Función SetEnvironmentVariableW (processenv.h)

  • Artículo

Establece el contenido de la variable de entorno especificada para el proceso actual.

Sintaxis

BOOL SetEnvironmentVariableW(
  [in]           LPCWSTR lpName,
  [in, optional] LPCWSTR lpValue
);

Parámetros

[in] lpName

Nombre de la variable de entorno. El sistema operativo crea la variable de entorno si no existe y lpValue no es NULL.

[in, optional] lpValue

Contenido de la variable de entorno.

El tamaño máximo de una variable de entorno definida por el usuario es de 32 767 caracteres. No hay ninguna limitación técnica en el tamaño del bloque de entorno. Sin embargo, existen límites prácticos en función del mecanismo utilizado para acceder al bloque. Por ejemplo, un archivo por lotes no puede establecer una variable que sea mayor que la longitud máxima de la línea de comandos. Para obtener más información, consulte Variables de entorno.

Windows Server 2003 y Windows XP: El tamaño total del bloque de entorno de un proceso puede no superar los 32 767 caracteres.

Si este parámetro es NULL, la variable se elimina del entorno del proceso actual.

Valor devuelto

Si la función se ejecuta correctamente, el valor devuelto es distinto de cero.

Si se produce un error en la función, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.

Observaciones

Esta función no tiene ningún efecto en las variables de entorno del sistema ni en las variables de entorno de otros procesos.

Ejemplos

Para obtener un ejemplo, vea Cambiar variables de entorno.

Nota

El encabezado processenv.h define SetEnvironmentVariable 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 XP [aplicaciones de escritorio | Aplicaciones para UWP]
servidor mínimo admitido Windows Server 2003 [aplicaciones de escritorio | Aplicaciones para UWP]
de la plataforma de destino de Windows
encabezado de processenv.h (incluya Windows.h en Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2)
biblioteca de Kernel32.lib
DLL de Kernel32.dll

Consulte también

variables de entorno de

GetEnvironmentVariable