Función GetEnvironmentVariableW (processenv.h)
Recupera el contenido de la variable especificada del bloque de entorno del proceso de llamada.
Sintaxis
DWORD GetEnvironmentVariableW(
[in, optional] LPCWSTR lpName,
[out, optional] LPWSTR lpBuffer,
[in] DWORD nSize
);
Parámetros
[in, optional] lpName
Nombre de la variable de entorno.
[out, optional] lpBuffer
Puntero a un búfer que recibe el contenido de la variable de entorno especificada como una cadena terminada en null.
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.
[in] nSize
Tamaño del búfer al que apunta el parámetro lpBuffer, incluido el carácter de terminación null, en caracteres.
Valor devuelto
Si la función se ejecuta correctamente, el valor devuelto es el número de caracteres almacenados en el búfer al que apunta lpBuffer, no incluido el carácter nulo de terminación.
Si lpBuffer no es lo suficientemente grande como para contener los datos, el valor devuelto es el tamaño del búfer, en caracteres, necesario para contener la cadena y su carácter nulo de terminación y el contenido de lpBuffer no están definidos.
Si se produce un error en la función, el valor devuelto es cero. Si no se encontró la variable de entorno especificada en el bloque de entorno, GetLastError devuelve ERROR_ENVVAR_NOT_FOUND.
Observaciones
Esta función puede recuperar una variable de entorno del sistema o una variable de entorno de usuario.
Ejemplos
Para obtener un ejemplo, vea Cambiar variables de entorno.
Nota
El encabezado processenv.h define GetEnvironmentVariable 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