Changeset 8163 in vbox for trunk/include/iprt/env.h
- Timestamp:
- Apr 18, 2008 4:38:25 PM (17 years ago)
- File:
-
- 1 edited
-
trunk/include/iprt/env.h (modified) (13 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/include/iprt/env.h
r8155 r8163 1 1 /** @file 2 * innotekPortable Runtime - Process Environment Strings.2 * Incredibly Portable Runtime - Process Environment Strings. 3 3 */ 4 4 … … 48 48 /** 49 49 * Creates an empty environment block. 50 * 51 * @returns IPRT status code. Typical error is VERR_NO_MEMORY. 52 * 50 * 51 * @returns IPRT status code. Typical error is VERR_NO_MEMORY. 52 * 53 53 * @param pEnv Where to store the handle of the new environment block. 54 54 */ … … 78 78 /** 79 79 * Get the execve/spawnve/main envp. 80 * 80 * 81 81 * All returned strings are in the current process' codepage. 82 82 * This array is only valid until the next RTEnv call. 83 * 83 * 84 84 * @returns Pointer to the raw array of environment variables. 85 85 * @returns NULL if Env is NULL or invalid. 86 * 86 * 87 87 * @param Env Environment block handle. 88 88 */ … … 92 92 /** 93 93 * Checks if an environment variable exists in the default environment block. 94 * 95 * @returns IPRT status code. Typical error is VERR_NO_MEMORY. 96 * 97 * @param pszVar The environment variable name. 98 * @remark WARNING! The current implementation does not perform the appropriate 94 * 95 * @returns IPRT status code. Typical error is VERR_NO_MEMORY. 96 * 97 * @param pszVar The environment variable name. 98 * @remark WARNING! The current implementation does not perform the appropriate 99 99 * codeset conversion. We'll figure this out when it becomes necessary. 100 100 */ … … 103 103 /** 104 104 * Checks if an environment variable exists in a specific environment block. 105 * 106 * @returns IPRT status code. Typical error is VERR_NO_MEMORY. 107 * 105 * 106 * @returns IPRT status code. Typical error is VERR_NO_MEMORY. 107 * 108 108 * @param Env The environment handle. 109 109 * @param pszVar The environment variable name. … … 113 113 /** 114 114 * Gets an environment variable from the default environment block. (getenv). 115 * 116 * The caller is responsible for ensuring that nobody changes the environment 115 * 116 * The caller is responsible for ensuring that nobody changes the environment 117 117 * while it's using the returned string pointer! 118 * 118 * 119 119 * @returns Pointer to read only string on success, NULL if the variable wasn't found. 120 * 121 * @param pszVar The environment variable name. 122 * 123 * @remark WARNING! The current implementation does not perform the appropriate 120 * 121 * @param pszVar The environment variable name. 122 * 123 * @remark WARNING! The current implementation does not perform the appropriate 124 124 * codeset conversion. We'll figure this out when it becomes necessary. 125 125 */ … … 128 128 /** 129 129 * Gets an environment variable in a specific environment block. 130 * 131 * @returns IPRT status code. 132 * 130 * 131 * @returns IPRT status code. 132 * 133 133 * @param Env The environment handle. 134 134 * @param pszVar The environment variable name. … … 141 141 /** 142 142 * Puts an variable=value string into the environment (putenv). 143 * 144 * @returns IPRT status code. Typical error is VERR_NO_MEMORY. 145 * 146 * @param pszVarEqualValue The variable '=' value string. If the value and '=' is 143 * 144 * @returns IPRT status code. Typical error is VERR_NO_MEMORY. 145 * 146 * @param pszVarEqualValue The variable '=' value string. If the value and '=' is 147 147 * omitted, the variable is removed from the environment. 148 * 148 * 149 149 * @remark Don't assume the value is copied. 150 * @remark WARNING! The current implementation does not perform the appropriate 150 * @remark WARNING! The current implementation does not perform the appropriate 151 151 * codeset conversion. We'll figure this out when it becomes necessary. 152 152 */ … … 155 155 /** 156 156 * Puts a copy of the passed in 'variable=value' string into the environment block. 157 * 158 * @returns IPRT status code. Typical error is VERR_NO_MEMORY. 159 * 157 * 158 * @returns IPRT status code. Typical error is VERR_NO_MEMORY. 159 * 160 160 * @param Env Handle of the environment block. 161 * @param pszVarEqualValue The variable '=' value string. If the value and '=' is 161 * @param pszVarEqualValue The variable '=' value string. If the value and '=' is 162 162 * omitted, the variable is removed from the environment. 163 163 */ … … 166 166 /** 167 167 * Sets an environment variable (setenv(,,1)). 168 * 169 * @returns IPRT status code. Typical error is VERR_NO_MEMORY. 170 * 168 * 169 * @returns IPRT status code. Typical error is VERR_NO_MEMORY. 170 * 171 171 * @param pszVar The environment variable name. 172 172 * @param pszValue The environment variable value. 173 * 174 * @remark WARNING! The current implementation does not perform the appropriate 173 * 174 * @remark WARNING! The current implementation does not perform the appropriate 175 175 * codeset conversion. We'll figure this out when it becomes necessary. 176 176 */ … … 179 179 /** 180 180 * Sets an environment variable (setenv(,,1)). 181 * 182 * @returns IPRT status code. Typical error is VERR_NO_MEMORY. 183 * 181 * 182 * @returns IPRT status code. Typical error is VERR_NO_MEMORY. 183 * 184 184 * @param Env The environment handle. 185 185 * @param pszVar The environment variable name. … … 190 190 /** 191 191 * Removes an environment variable from the default environment block. 192 * 192 * 193 193 * @returns IPRT status code. 194 194 * @returns VINF_ENV_VAR_NOT_FOUND if the variable was not found. 195 * 196 * @param pszVar The environment variable name. 197 * 198 * @remark WARNING! The current implementation does not perform the appropriate 195 * 196 * @param pszVar The environment variable name. 197 * 198 * @remark WARNING! The current implementation does not perform the appropriate 199 199 * codeset conversion. We'll figure this out when it becomes necessary. 200 200 */ … … 203 203 /** 204 204 * Removes an environment variable from the specified environment block. 205 * 205 * 206 206 * @returns IPRT status code. 207 207 * @returns VINF_ENV_VAR_NOT_FOUND if the variable was not found. 208 * 208 * 209 209 * @param Env The environment handle. 210 210 * @param pszVar The environment variable name.
Note:
See TracChangeset
for help on using the changeset viewer.
