Función SetEnvironmentVariableA (processenv.h)
Establece el contenido de la variable de entorno especificada para el proceso actual.
Sintaxis
BOOL SetEnvironmentVariableA(
[in] LPCSTR lpName,
[in, optional] LPCSTR 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. Para obtener más información, vea 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 realiza correctamente, el valor devuelto es distinto de cero.
Si la función no se realiza correctamente, el valor devuelto es cero. Para obtener información de error extendida, llame a GetLastError.
Comentarios
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, consulte Cambio de 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 Convenciones para prototipos de función.
Requisitos
| Requisito | Value |
|---|---|
| Cliente mínimo compatible | Windows XP [aplicaciones de escritorio | aplicaciones para UWP] |
| Servidor mínimo compatible | Windows Server 2003 [aplicaciones de escritorio | aplicaciones para UWP] |
| Plataforma de destino | Windows |
| Encabezado | processenv.h (incluye Windows.h en Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2) |
| Library | Kernel32.lib |
| Archivo DLL | Kernel32.dll |