dali/devel-api/adaptor-framework/environment-variable.h

   1 #ifndef DALI_ENVIRONMENT_VARIABLE_H
   2 #define DALI_ENVIRONMENT_VARIABLE_H
   3
   4 /*
   5  * Copyright (c) 2019 Samsung Electronics Co., Ltd.
   6  *
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  * http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  */
  19
  20 // INTERNAL INCLUDES
  21 #include <dali/public-api/dali-adaptor-common.h>
  22
  23 namespace Dali
  24 {
  25
  26 namespace EnvironmentVariable
  27 {
  28
  29 /**
  30  * @brief Search the environment list for the specified variable name and return a pointer to the C string that is associated with the matched environment list member.
  31  *
  32  * @param[in] variable Null-terminated character string identifying the name of the environmental variable to look for.
  33  * @return A C-string containing the value of the specified environment variable.
  34  */
  35 DALI_ADAPTOR_API const char * GetEnvironmentVariable( const char * variable );
  36
  37 /**
  38  * @brief Create or overwrite (when it does not exist) an environment variable.
  39  *
  40  * @param[in] variable Null-terminated character string identifying the name of the environmental variable.
  41  * @param[in] value Null-terminated character string to set as a value.
  42  * @return True on success, false on error.
  43  */
  44 DALI_ADAPTOR_API bool SetEnvironmentVariable( const char * variable, const char * value );
  45
  46 } // namespace EnvironmentVariable
  47
  48 } // namespace Dali
  49
  50 #endif /*DALI_ ENVIRONMENT_VARIABLE_H */