:orphan: .. index:: pair: group; Environment variables configuration .. _doxid-group__tapi__conf__sh__env: Environment variables configuration =================================== .. toctree:: :hidden: Overview ~~~~~~~~ Definition of API to deal with thread-safe stack of jumps. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // global functions static :ref:`te_errno` :ref:`tapi_sh_env_set`(:ref:`rcf_rpc_server`* pco, const char* env_name, const char* env_value, bool force, bool restart); static :ref:`te_errno` :ref:`tapi_sh_env_get`(:ref:`rcf_rpc_server`* pco, const char* env_name, char** val); static :ref:`te_errno` :ref:`tapi_sh_env_get_int`(:ref:`rcf_rpc_server`* pco, const char* env_name, int* val); static :ref:`te_errno` :ref:`tapi_sh_env_set_int`(:ref:`rcf_rpc_server`* pco, const char* env_name, int env_value, bool force, bool restart); static :ref:`te_errno` :ref:`tapi_sh_env_save_set`(:ref:`rcf_rpc_server`* pco, const char* env_name, bool* existed, char** old_value, const char* new_value, bool restart); static :ref:`te_errno` :ref:`tapi_sh_env_unset`(:ref:`rcf_rpc_server`* pco, const char* env_name, bool force, bool restart); static :ref:`te_errno` :ref:`tapi_sh_env_save_set_int`(:ref:`rcf_rpc_server`* pco, const char* env_name, int env_value, bool restart, bool* existed, int* old_value); static :ref:`te_errno` :ref:`tapi_sh_env_rollback_int`(:ref:`rcf_rpc_server`* pco, const char* env_name, bool existed, int env_value, bool restart); static :ref:`te_errno` :ref:`tapi_sh_env_rollback`(:ref:`rcf_rpc_server`* pco, const char* env_name, bool existed, const char* env_value, bool restart); static bool :ref:`tapi_getenv_bool`(const char* var_name); static :ref:`te_errno` :ref:`tapi_sh_env_ta_path_append`(const char* ta, const char* dir); int :ref:`tapi_expand_path_all_ta`(const char** dirs); .. _details-group__tapi__conf__sh__env: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Definition of API to deal with thread-safe stack of jumps. Copyright (C) 2004-2022 OKTET Labs Ltd. All rights reserved. Global Functions ---------------- .. index:: pair: function; tapi_sh_env_set .. _doxid-group__tapi__conf__sh__env_1gad58529012ec7649528a63d04bebcf1a3: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_sh_env_set(:ref:`rcf_rpc_server`* pco, const char* env_name, const char* env_value, bool force, bool restart) Set shell environment for the given agent and may be restart a PCO so it's aware. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pco - PCO handle * - env_name - Name of the environment variable * - env_value - New value * - force - Should we only add or overwrite? * - restart - Should the PCO be restarted .. rubric:: Returns: errno .. index:: pair: function; tapi_sh_env_get .. _doxid-group__tapi__conf__sh__env_1ga471acb98ce07499779da73f02e7a0f7e: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_sh_env_get(:ref:`rcf_rpc_server`* pco, const char* env_name, char** val) Get shell environment for the given agent. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pco - PCO handle * - env_name - Name of the environment variable * - val - Location for value, memory is allocated with malloc, so the obtained string must be freed after using .. rubric:: Returns: errno .. index:: pair: function; tapi_sh_env_get_int .. _doxid-group__tapi__conf__sh__env_1ga5108ae51f2a802db507a99cab13023b7: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_sh_env_get_int(:ref:`rcf_rpc_server`* pco, const char* env_name, int* val) Get int shell environment for the given agent. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pco - PCO handle * - env_name - Name of the environment variable * - val - Location for value .. rubric:: Returns: errno .. index:: pair: function; tapi_sh_env_set_int .. _doxid-group__tapi__conf__sh__env_1ga20acb489b2befce68e98fb1525c95e4e: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_sh_env_set_int(:ref:`rcf_rpc_server`* pco, const char* env_name, int env_value, bool force, bool restart) Set integer shell environment for the given agent and may be restart a PCO so it's aware. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pco - PCO handle * - env_name - Name of the environment variable * - env_value - New value * - force - Should we only add or overwrite? * - restart - Should the PCO be restarted .. rubric:: Returns: errno .. index:: pair: function; tapi_sh_env_save_set .. _doxid-group__tapi__conf__sh__env_1ga687be2cc11cb384fd7e742fcd39d2c88: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_sh_env_save_set(:ref:`rcf_rpc_server`* pco, const char* env_name, bool* existed, char** old_value, const char* new_value, bool restart) Check whether environment variable exists, save its current value if it does, then set a new value. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pco - PCO handle * - env_name - Name of the environment variable * - existed - [out] Whether this variable already existed in an environment or not * - old_value - [out] Where to save existing value * - new_value - New value * - restart - Should the PCO be restarted .. rubric:: Returns: errno .. index:: pair: function; tapi_sh_env_unset .. _doxid-group__tapi__conf__sh__env_1ga1c0564ddc6c0d14eeffb7e44f6c39b12: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_sh_env_unset(:ref:`rcf_rpc_server`* pco, const char* env_name, bool force, bool restart) Unset environment for the agent and may be restart given PCO. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pco - PCO handle * - env_name - Name of the environment variable * - force - Ignore if the variable was not set * - restart - Should the PCO be restarted? .. index:: pair: function; tapi_sh_env_save_set_int .. _doxid-group__tapi__conf__sh__env_1ga4696ab08c4ef8621eff7aeb0c6dca060: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_sh_env_save_set_int(:ref:`rcf_rpc_server`* pco, const char* env_name, int env_value, bool restart, bool* existed, int* old_value) Set integer shell environment and save previous value if it is necessary. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pco - PCO handle * - env_name - Name of the environment variable * - env_value - New value * - force - Should we only add or overwrite? * - restart - Should the PCO be restarted * - existed - [out] Whether this variable already existed in an environment or not * - old_value - [out] Where to save existing value .. rubric:: Returns: Status code .. index:: pair: function; tapi_sh_env_rollback_int .. _doxid-group__tapi__conf__sh__env_1ga5cf3e937debc92693b8a668c581154cb: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_sh_env_rollback_int(:ref:`rcf_rpc_server`* pco, const char* env_name, bool existed, int env_value, bool restart) Rollback integer shell environment variable .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pco - PCO handle * - env_name - The environment variable name * - existed - Did this variable exist in an environment or not * - env_value - Integer value to set if the env existed * - restart - Should the PCO be restarted .. rubric:: Returns: Status code .. index:: pair: function; tapi_sh_env_rollback .. _doxid-group__tapi__conf__sh__env_1ga2ddfbedab88675ae1d04af5798c06ea7: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_sh_env_rollback(:ref:`rcf_rpc_server`* pco, const char* env_name, bool existed, const char* env_value, bool restart) Rollback environment variable .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - pco - PCO handle * - env_name - The environment variable name * - existed - Did this variable exist in an environment or not * - env_value - Value to set if the env existed * - restart - Should the PCO be restarted .. rubric:: Returns: Status code .. index:: pair: function; tapi_getenv_bool .. _doxid-group__tapi__conf__sh__env_1ga5f78845f188036e8fb5a7f5377af91e7: .. ref-code-block:: cpp :class: doxyrest-title-code-block static bool tapi_getenv_bool(const char* var_name) Get boolean environment variable on engine. The function stops the test if the variable keeps unexpected value. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - var_name - The variable name .. rubric:: Returns: Boolean value .. index:: pair: function; tapi_sh_env_ta_path_append .. _doxid-group__tapi__conf__sh__env_1ga07d8a76927a8fa663eee795432bf4181: .. ref-code-block:: cpp :class: doxyrest-title-code-block static :ref:`te_errno` tapi_sh_env_ta_path_append(const char* ta, const char* dir) Append a location to the PATH on the agent. No restart of the PCOs is done. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - ta - Name of the test agent * - dir - Directory to be added into the PATH. .. rubric:: Returns: Status code .. index:: pair: function; tapi_expand_path_all_ta .. _doxid-group__tapi__conf__sh__env_1ga9c583960be1c7f23ca302d031a061ad8: .. ref-code-block:: cpp :class: doxyrest-title-code-block int tapi_expand_path_all_ta(const char** dirs) Add directories to every test agent's PATH environment variable. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - dirs - Array of pointers to directory names terminated by ``NULL``. If ``dirs`` itself is ``NULL``, add most commonly required directories (e.g. 'sbin' directories). .. rubric:: Returns: Status code.