| 1 | /** @file
|
|---|
| 2 | * innotek Portable Runtime - Process Environment Strings.
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2006-2007 innotek GmbH
|
|---|
| 7 | *
|
|---|
| 8 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 9 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 10 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 11 | * General Public License as published by the Free Software Foundation,
|
|---|
| 12 | * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
|
|---|
| 13 | * distribution. VirtualBox OSE is distributed in the hope that it will
|
|---|
| 14 | * be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 15 | *
|
|---|
| 16 | * If you received this file as part of a commercial VirtualBox
|
|---|
| 17 | * distribution, then only the terms of your commercial VirtualBox
|
|---|
| 18 | * license agreement apply instead of the previous paragraph.
|
|---|
| 19 | */
|
|---|
| 20 |
|
|---|
| 21 | #ifndef __iprt_env_h__
|
|---|
| 22 | #define __iprt_env_h__
|
|---|
| 23 |
|
|---|
| 24 | #include <iprt/cdefs.h>
|
|---|
| 25 | #include <iprt/types.h>
|
|---|
| 26 |
|
|---|
| 27 | __BEGIN_DECLS
|
|---|
| 28 |
|
|---|
| 29 | /** @defgroup grp_rt_env RTProc - Process Environment Strings
|
|---|
| 30 | * @ingroup grp_rt
|
|---|
| 31 | * @{
|
|---|
| 32 | */
|
|---|
| 33 |
|
|---|
| 34 | #ifdef IN_RING3
|
|---|
| 35 |
|
|---|
| 36 |
|
|---|
| 37 | /**
|
|---|
| 38 | * Checks if an environment variable exists.
|
|---|
| 39 | *
|
|---|
| 40 | * @returns IPRT status code. Typical error is VERR_NO_MEMORY.
|
|---|
| 41 | *
|
|---|
| 42 | * @param pszVar The environment variable name.
|
|---|
| 43 | */
|
|---|
| 44 | RTDECL(bool) RTEnvExist(const char *pszVar);
|
|---|
| 45 |
|
|---|
| 46 | /**
|
|---|
| 47 | * Gets an environment variable (getenv).
|
|---|
| 48 | *
|
|---|
| 49 | * The caller is responsible for ensuring that nobody changes the environment
|
|---|
| 50 | * while it's using the returned string pointer!
|
|---|
| 51 | *
|
|---|
| 52 | * @returns Pointer to read only string on success, NULL if the variable wasn't found.
|
|---|
| 53 | *
|
|---|
| 54 | * @param pszVar The environment variable name.
|
|---|
| 55 | */
|
|---|
| 56 | RTDECL(const char *) RTEnvGet(const char *pszVar);
|
|---|
| 57 |
|
|---|
| 58 | /**
|
|---|
| 59 | * Puts an variable=value string into the environment (putenv).
|
|---|
| 60 | *
|
|---|
| 61 | * @returns IPRT status code. Typical error is VERR_NO_MEMORY.
|
|---|
| 62 | *
|
|---|
| 63 | * @param pszVarEqualValue The variable '=' value string. If the value and '=' is
|
|---|
| 64 | * omitted, the variable is removed from the environment.
|
|---|
| 65 | */
|
|---|
| 66 | RTDECL(int) RTEnvPut(const char *pszVarEqualValue);
|
|---|
| 67 |
|
|---|
| 68 | /**
|
|---|
| 69 | * Sets an environment variable (setenv(,,1)).
|
|---|
| 70 | *
|
|---|
| 71 | * @returns IPRT status code. Typical error is VERR_NO_MEMORY.
|
|---|
| 72 | *
|
|---|
| 73 | * @param pszVar The environment variable name.
|
|---|
| 74 | * @param pszValue The environment variable value.
|
|---|
| 75 | */
|
|---|
| 76 | RTDECL(int) RTEnvSet(const char *pszVar, const char *pszValue);
|
|---|
| 77 |
|
|---|
| 78 | /** @todo Add the missing environment APIs: safe, printf like, and various modifications. */
|
|---|
| 79 |
|
|---|
| 80 | #endif /* IN_RING3 */
|
|---|
| 81 |
|
|---|
| 82 | /** @} */
|
|---|
| 83 |
|
|---|
| 84 | __END_DECLS
|
|---|
| 85 |
|
|---|
| 86 | #endif
|
|---|
| 87 |
|
|---|
