summaryrefslogtreecommitdiff
path: root/inc/OSD_Environment.hxx
blob: e4a68acca754b4b80c6cbbefeb5a173f572d200f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
// This file is generated by WOK (CPPExt).
// Please do not edit this file; modify original file instead.
// The copyright and license terms as defined for the original file apply to 
// this header file considered to be the "object code" form of the original source.

#ifndef _OSD_Environment_HeaderFile
#define _OSD_Environment_HeaderFile

#ifndef _Standard_HeaderFile
#include <Standard.hxx>
#endif
#ifndef _Standard_Macro_HeaderFile
#include <Standard_Macro.hxx>
#endif

#ifndef _TCollection_AsciiString_HeaderFile
#include <TCollection_AsciiString.hxx>
#endif
#ifndef _OSD_Error_HeaderFile
#include <OSD_Error.hxx>
#endif
#ifndef _Standard_Boolean_HeaderFile
#include <Standard_Boolean.hxx>
#endif
#ifndef _Standard_Integer_HeaderFile
#include <Standard_Integer.hxx>
#endif
class Standard_ConstructionError;
class Standard_NullObject;
class OSD_OSDError;
class TCollection_AsciiString;


//! Management of system environment variables <br>
//!          An environment variable is composed of a variable name <br>
//!          and its value. <br>
class OSD_Environment  {
public:

  void* operator new(size_t,void* anAddress) 
  {
    return anAddress;
  }
  void* operator new(size_t size) 
  {
    return Standard::Allocate(size); 
  }
  void  operator delete(void *anAddress) 
  {
    if (anAddress) Standard::Free((Standard_Address&)anAddress); 
  }

  //! Creates the object Environment. <br>
  Standard_EXPORT   OSD_Environment();
  //! Creates an Environment variable initialized with value <br>
//!          set to an empty AsciiString. <br>
  Standard_EXPORT   OSD_Environment(const TCollection_AsciiString& Name);
  //! Creates an Environment variable initialized with Value. <br>
  Standard_EXPORT   OSD_Environment(const TCollection_AsciiString& Name,const TCollection_AsciiString& Value);
  //! Changes environment variable value. <br>
//!          Raises ConstructionError either if the string contains <br>
//!          characters not in range of ' '...'~' or if the string <br>
//!          contains the character '$' which is forbiden. <br>
  Standard_EXPORT     void SetValue(const TCollection_AsciiString& Value) ;
  //! Gets the value of an environment variable <br>
  Standard_EXPORT     TCollection_AsciiString Value() ;
  //! Changes environment variable name. <br>
//!          Raises ConstructionError either if the string contains <br>
//!          characters not in range of ' '...'~' or if the string <br>
//!          contains the character '$' which is forbiden. <br>
  Standard_EXPORT     void SetName(const TCollection_AsciiString& name) ;
  //! Gets the name of <me>. <br>
  Standard_EXPORT     TCollection_AsciiString Name() const;
  //! Sets the value of an environment variable <br>
//!          into system (physically). <br>
  Standard_EXPORT     void Build() ;
  //! Removes (physically) an environment variable <br>
  Standard_EXPORT     void Remove() ;
  //! Returns TRUE if an error occurs <br>
  Standard_EXPORT     Standard_Boolean Failed() const;
  //! Resets error counter to zero <br>
  Standard_EXPORT     void Reset() ;
  //! Raises OSD_Error <br>
  Standard_EXPORT     void Perror() ;
  //! Returns error number if 'Failed' is TRUE. <br>
  Standard_EXPORT     Standard_Integer Error() const;





protected:





private:



TCollection_AsciiString myName;
TCollection_AsciiString myValue;
OSD_Error myError;


};





// other Inline functions and methods (like "C++: function call" methods)


#endif