env.h revision 7757e065b2ef522ec99a434fbeeae8665a36543a
/** @file
* IPRT - Process Environment Strings.
*/
/*
* Copyright (C) 2006-2012 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
* VirtualBox OSE distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*/
#ifndef ___iprt_env_h
#define ___iprt_env_h
/** @defgroup grp_rt_env RTEnv - Process Environment Strings
* @ingroup grp_rt
* @{
*/
#ifdef IN_RING3
/** Special handle that indicates the default process environment. */
/**
* Creates an empty environment block.
*
* @returns IPRT status code. Typical error is VERR_NO_MEMORY.
*
* @param pEnv Where to store the handle of the new environment block.
*/
/**
* Creates an environment block and fill it with variables from the given
* environment array.
*
* @returns IPRT status code.
* @retval VWRN_ENV_NOT_FULLY_TRANSLATED may be returned when passing
* RTENV_DEFAULT and one or more of the environment variables have
* codeset incompatibilities. The problematic variables will be
* ignored and not included in the clone, thus the clone will have
* fewer variables.
* @retval VERR_NO_MEMORY
* @retval VERR_NO_STR_MEMORY
* @retval VERR_INVALID_HANDLE
*
* @param pEnv Where to store the handle of the new environment block.
* @param EnvToClone The environment to clone.
*/
/**
* Destroys an environment block.
*
* @returns IPRT status code.
*
* @param Env Environment block handle.
* Both RTENV_DEFAULT and NIL_RTENV are silently ignored.
*/
/**
*
* All returned strings are in the current process' codepage.
* This array is only valid until the next RTEnv call.
*
* @returns Pointer to the raw array of environment variables.
* @returns NULL if Env is NULL or invalid.
*
* @param Env Environment block handle.
* @todo This needs to change to return a copy of the env vars like
* RTEnvQueryUtf16Block does!
*/
/**
* Get a sorted, UTF-16 environment block for CreateProcess.
*
* @returns IPRT status code.
*
* @param hEnv Environment block handle.
* @param ppwszzBlock Where to return the environment block. This must be
* freed by calling RTEnvFreeUtf16Block.
*/
/**
* Frees an environment block returned by RTEnvGetUtf16Block().
*
* @param pwszzBlock What RTEnvGetUtf16Block returned. NULL is ignored.
*/
/**
* Checks if an environment variable exists in the default environment block.
*
* @returns IPRT status code. Typical error is VERR_NO_MEMORY.
*
* @param pszVar The environment variable name.
* @remark WARNING! The current implementation does not perform the appropriate
* codeset conversion. We'll figure this out when it becomes necessary.
*/
/**
* Checks if an environment variable exists in a specific environment block.
*
* @returns IPRT status code. Typical error is VERR_NO_MEMORY.
*
* @param Env The environment handle.
* @param pszVar The environment variable name.
*/
/**
* Gets an environment variable from the default environment block. (getenv).
*
* The caller is responsible for ensuring that nobody changes the environment
* while it's using the returned string pointer!
*
* @returns Pointer to read only string on success, NULL if the variable wasn't found.
*
* @param pszVar The environment variable name.
*
* @remark WARNING! The current implementation does not perform the appropriate
* codeset conversion. We'll figure this out when it becomes necessary.
*/
/**
* Gets an environment variable in a specific environment block.
*
* @returns IPRT status code.
* @retval VERR_ENV_VAR_NOT_FOUND if the variable was not found.
*
* @param Env The environment handle.
* @param pszVar The environment variable name.
* @param pszValue Where to put the buffer.
* @param cbValue The size of the value buffer.
* @param pcchActual Returns the actual value string length. Optional.
*/
RTDECL(int) RTEnvGetEx(RTENV Env, const char *pszVar, char *pszValue, size_t cbValue, size_t *pcchActual);
/**
* Puts an variable=value string into the environment (putenv).
*
* @returns IPRT status code. Typical error is VERR_NO_MEMORY.
*
* @param pszVarEqualValue The variable '=' value string. If the value and '=' is
* omitted, the variable is removed from the environment.
*
* @remark Don't assume the value is copied.
* @remark WARNING! The current implementation does not perform the appropriate
* codeset conversion. We'll figure this out when it becomes necessary.
*/
/**
* Puts a copy of the passed in 'variable=value' string into the environment block.
*
* @returns IPRT status code. Typical error is VERR_NO_MEMORY.
*
* @param Env Handle of the environment block.
* @param pszVarEqualValue The variable '=' value string. If the value and '=' is
* omitted, the variable is removed from the environment.
*/
/**
* Sets an environment variable (setenv(,,1)).
*
* @returns IPRT status code. Typical error is VERR_NO_MEMORY.
*
* @param pszVar The environment variable name.
* @param pszValue The environment variable value.
*
* @remark WARNING! The current implementation does not perform the appropriate
* codeset conversion. We'll figure this out when it becomes necessary.
*/
/**
* Sets an environment variable (setenv(,,1)).
*
* @returns IPRT status code. Typical error is VERR_NO_MEMORY.
*
* @param Env The environment handle.
* @param pszVar The environment variable name.
* @param pszValue The environment variable value.
*/
/**
* Removes an environment variable from the default environment block.
*
* @returns IPRT status code.
* @returns VINF_ENV_VAR_NOT_FOUND if the variable was not found.
*
* @param pszVar The environment variable name.
*
* @remark WARNING! The current implementation does not perform the appropriate
* codeset conversion. We'll figure this out when it becomes necessary.
*/
/**
* Removes an environment variable from the specified environment block.
*
* @returns IPRT status code.
* @returns VINF_ENV_VAR_NOT_FOUND if the variable was not found.
*
* @param Env The environment handle.
* @param pszVar The environment variable name.
*/
/**
* Duplicates the value of a environment variable if it exists.
*
* @returns Pointer to a string containing the value, free it using RTStrFree.
* NULL if the variable was not found or we're out of memory.
*
* @param Env The environment handle.
* @param pszVar The environment variable name.
*/
/**
* Counts the variables in the environment.
*
* @returns Number of variables in the environment. UINT32_MAX on error.
* @param hEnv The environment handle.
* RTENV_DEFAULT is currently not accepted.
*/
/**
* Queries an environment variable by it's index.
*
* This can be used together with RTEnvCount to enumerate the environment block.
*
* @returns IPRT status code.
* @retval VERR_ENV_VAR_NOT_FOUND if the index is out of bounds, output buffers
* untouched.
* @retval VERR_BUFFER_OVERFLOW if one of the buffers are too small. We'll
* fill it with as much we can in RTStrCopy fashion.
*
* @param hEnv The environment handle.
* RTENV_DEFAULT is currently not accepted.
* @param iVar The variable index.
* @param pszVar Variable name buffer.
* @param cbVar The size of the variable name buffer.
* @param pszValue Value buffer.
* @param cbValue The size of the value buffer.
*/
RTDECL(uint32_t) RTEnvGetByIndexEx(RTENV hEnv, uint32_t iVar, char *pszVar, size_t cbVar, char *pszValue, size_t cbValue);
#endif /* IN_RING3 */
/** @} */
#endif