src/OSD/OSD_EnvironmentIterator.cdl

   1 -- Created on: 1992-09-11
   2 -- Created by: Stephan GARNAUD
   3 -- Copyright (c) 1992-1999 Matra Datavision
   4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
   5 --
   6 -- The content of this file is subject to the Open CASCADE Technology Public
   7 -- License Version 6.5 (the "License"). You may not use the content of this file
   8 -- except in compliance with the License. Please obtain a copy of the License
   9 -- at http://www.opencascade.org and read it completely before using this file.
  10 --
  11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  13 --
  14 -- The Original Code and all software distributed under the License is
  15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  16 -- Initial Developer hereby disclaims all such warranties, including without
  17 -- limitation, any warranties of merchantability, fitness for a particular
  18 -- purpose or non-infringement. Please see the License for the specific terms
  19 -- and conditions governing the rights and limitations under the License.
  20
  21
  22
  23
  24
  25 class EnvironmentIterator from OSD
  26
  27  ---Purpose: This allows consultation of every environment variable.
  28  --          There is no specific order of results.
  29
  30 uses Environment, Error, AsciiString from TCollection
  31 raises OSDError
  32
  33 is
  34  Create returns EnvironmentIterator;
  35     ---Purpose: Instantiates Object as Iterator;
  36     ---Level: Public
  37
  38  Destroy ( me : out );
  39         ---C++: alias ~
  40         -- Only implemented on Windows NT system
  41
  42  More (me : in out) returns Boolean  is static;
  43     ---Purpose: Returns TRUE if there are other environment variables.
  44     ---Level: Public
  45
  46  Next (me : in out)  is static;
  47     ---Purpose: Sets the iterator to the next item.
  48     --          Returns the item value corresponding to the current
  49     --          position of the iterator.
  50     ---Level: Public
  51
  52  Values (me : in out) returns Environment is static;
  53     ---Purpose: Returns the next environment variable found.
  54     ---Level: Public
  55
  56  Failed (me) returns Boolean is static;
  57    ---Purpose: Returns TRUE if an error occurs
  58     ---Level: Public
  59
  60  Reset (me : in out) is static;
  61    ---Purpose: Resets error counter to zero
  62     ---Level: Public
  63
  64  Perror (me : in out)
  65    ---Purpose: Raises OSD_Error
  66     ---Level: Public
  67    raises OSDError is static ;
  68
  69  Error (me) returns Integer is static ;
  70    ---Purpose: Returns error number if 'Failed' is TRUE.
  71     ---Level: Public
  72
  73  fields
  74       myEnv        : Address;         -- Windows NT specific
  75       myCount      : Integer;         -- Count in list of variables
  76       myError      : Error;
  77 end EnvironmentIterator from OSD;
  78