Función GetEnvironmentVariableA (processenv.h)
Recupera el contenido de la variable especificada del bloque de entorno del proceso de llamada.
Sintaxis
DWORD GetEnvironmentVariableA(
[in, optional] LPCSTR lpName,
[out, optional] LPSTR 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. Una variable de entorno tiene un límite de tamaño máximo de 32 767 caracteres, incluido el carácter de terminación null.
[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, sin incluir 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á definido.
Si la función no se realiza correctamente, 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.
Comentarios
Esta función puede recuperar una variable de entorno del sistema o una variable de entorno de usuario.
Ejemplos
Para obtener un ejemplo, consulte Cambio de 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 neutro de codificación con código que no es neutral de codificación puede provocar discrepancias que dan lugar a errores de compilación o en tiempo de ejecución. Para obtener más información, vea Convenciones para prototipos de función.
Requisitos
| 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 (incluya Windows.h en Windows Server 2003, Windows Vista, Windows 7, Windows Server 2008 Windows Server 2008 R2) |
| Library | Kernel32.lib |
| Archivo DLL | Kernel32.dll |