_putenv_s, _wputenv_s
Crea, modifica o quita variables de entorno. Éstas son versiones de _putenv, _wputenv pero tienen mejoras de seguridad, como se describe en Características de seguridad de CRT.
Importante
Esta API no se puede usar en aplicaciones que se ejecutan en Windows en tiempo de ejecución.Para obtener más información, vea Funciones de CRT no admitidas con /ZW.
errno_t _putenv_s(
const char *name,
const char *value
);
errno_t _wputenv_s(
const wchar_t *name,
const wchar_t *value
);
Parámetros
name
El nombre de la variable de entorno.value
El valor para establecer la variable de entorno.
Valor devuelto
Devuelve 0 si es correcto, o un código de error.
Condiciones de error
name |
value |
Valor devuelto |
|---|---|---|
NULL |
any |
EINVAL |
any |
NULL |
EINVAL |
Si una de las condiciones de error, estas funciones se invoca un controlador no válido de parámetro, tal y como se describe en Validación de parámetros. Si la ejecución puede continuar, estas funciones devuelven EINVAL y establecen errno en EINVAL.
Comentarios
La función _putenv_s agrega nuevas variables de entorno o modifica los valores de las existentes. Las variables de entorno definen el entorno en el que se ejecuta un proceso (por ejemplo, la ruta de búsqueda predeterminada para vincular bibliotecas a un programa). _wputenv_s es una versión con caracteres anchos de _putenv_s; el argumento envstring para _wputenv_s es una cadena de caracteres anchos.
Asignaciones de rutina de texto genérico
Rutina TCHAR.H |
_UNICODE y _MBCS no definidos |
_MBCS definido |
_UNICODE definido |
|---|---|---|---|
_tputenv_s |
_putenv_s |
_putenv_s |
_wputenv_s |
name es el nombre de la variable de entorno que se agregue o modificado y value es el valor de la variable. Si name ya es parte del entorno, su valor es reemplazado por value; si no, la nueva variable de name y su value se agregan al entorno. Puede quitar una variable de entorno especificando una cadena vacía (es decir, "") para value.
_putenv_s y _wputenv_s solo afectan al entorno que es local en el proceso actual. No se pueden usar para modificar el entorno del nivel de comandos. Estas funciones solo funcionan en estructuras de datos que son accesibles a la biblioteca en tiempo de ejecución y no en el entorno “segmento” que el sistema operativo crea para un proceso. Cuando el proceso actual finaliza, el entorno vuelve a nivel del proceso de llamada, que en la mayoría de los casos es el nivel del sistema operativo. Sin embargo, el entorno modificado se puede pasar a cualquier nuevo proceso creado por _spawn, _exec, o system, y estos nuevos procesos obtienen los elementos nuevos que agreguen por _putenv_s y _wputenv_s.
No cambie una entrada de entorno directamente; en su lugar, utilice _putenv_s o _wputenv_s para cambiarlo. En particular, directamente liberar los elementos de la matriz global de _environ[] podría producir memoria no válida se envíen.
getenv y _putenv_s usan la variable global _environ para obtener acceso a la tabla de entorno. _wgetenv y _wputenv_s usan _wenviron. _putenv_s y _wputenv_s pueden cambiar el valor de _environ y de _wenviron, y por tanto reemplazan el argumento de envp a main y el argumento de _wenvp a wmain. Por ello, es más seguro usar _environ o _wenviron para obtener acceso a la información del entorno. Para obtener más información sobre la relación de _putenv_s y de _wputenv_s a las variables globales, vea _environ, _wenviron.
Nota
Los grupos de funciones de _putenv_s y _getenv_s no son seguros para subprocesos._getenv_s podría devolver un puntero de cadena mientras _putenv_s modifica la cadena, y por tanto los errores aleatorios de la causa.Asegúrese de que las llamadas a estas funciones están sincronizadas.
Requisitos
Rutina |
Encabezado necesario |
|---|---|
_putenv_s |
<stdlib.h> |
_wputenv_s |
<stdlib.h> o <wchar.h> |
Para obtener información adicional de compatibilidad, vea Compatibilidad.
Ejemplo
Para obtener un ejemplo que muestra cómo utilizar _putenv_s, consulta getenv_s, _wgetenv_s.
Equivalente en .NET Framework
No es aplicable Para llamar a la función estándar de C, use PInvoke. Para obtener más información, vea Ejemplos de invocación de plataforma.