Sage-ST ä

Multuser

Documentation

Global Declarations (Constants, Types, Variables)
CloseAllSystems CloseRelation CloseSystem
DeleteRecord DeleteRelation FindRecord GenerateUniqueKey
GetBlock GetBlockSize GetKeyPosition GetMultUserStatus
LockRelation OpenRelation OpenSystem PutBlock
ReWriteRecord ReadRecord ReadRecordA ReadRecordN
ReadRecordP RelationIsOpen SetMultUserStatus TotalRecords
TruncateBlock UnlockRecord UnlockRelation WriteRecord





  TYPE
    RelationLockType = (NoLockRelation,
                        ReadLockRelation,
                        WriteLockRelation,
                        ExclusiveReadLockRelation,
                        ExclusiveWriteLockRelation);

    RecordLockType = (NoLockRecord,
                      ReadLockRecord,
                      WriteLockRecord);

  CONST
    ShortLock    = 1;
    MediumLock   = 5;
    LongLock     = 15;
    InfiniteLock = 0;

    ShortPreempt    = 60;
    MediumPreempt   = 300;
    LongPreempt     = 1800;
    InfinitePreempt = 32767;




  PROCEDURE SetMultUserStatus
             (CONST MultUserEnabled : BOOLEAN);

  (**
      SetMultUserStatus - Set use of Multi-User checking on or off.


      This turns on or off the use of multi-user calls when accessing
      the data.  If MultUserStatus is False then calls will be made
      use the Sage package.  If MultUserStatus is True then calls will
      be made using the MultSage package.

      CALLING SEQUENCE -

        SetMultUserStatus (MultUserStatus)

      ENTRY -

        MultUserStatus : BOOLEAN
          True - Use Mult-User calls to access data.
          False - Use single-user calls to access data.
  *)




  PROCEDURE GetMultUserStatus
             (VAR   MultUserEnabled : BOOLEAN);

  (**
      GetMultUserStatus - Get status of Multi-User checking.


      This procedure checks the current status of multi-user calls and
      returns a boolean flag indicating if it is current on or off.

      CALLING SEQUENCE -

        GetMultUserStatus (MultUserEnabled)

      EXIT -

        MultUserEnabled : BOOLEAN
          True - Mult-User calls will be used to access data.
          False - Single-user calls will be used to access data.
  *)




  PROCEDURE OpenSystem
             (CONST DataBase : ARRAY OF CHAR;
              CONST Forms    : CARDINAL;
              CONST Screens  : CARDINAL;
              CONST BufSize  : CARDINAL);

  (**
      OpenSystem - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        OpenSystem (DataBase, Forms, Screens, BufSize)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE OpenRelation
             (CONST Relation : ARRAY OF CHAR;
              CONST Modify   : BOOLEAN);

  (**
      OpenRelation - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        OpenRelation (Relation, Modify)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE CloseRelation
             (CONST Relation : ARRAY OF CHAR);

  (**
      CloseRelation - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        CloseRelation (Relation)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE LockRelation
             (CONST Relation     : ARRAY OF CHAR;
              CONST Lock         : RelationLockType;
              CONST lockTime     : ModSys.INT16;
              CONST PreemptTime  : ModSys.INT16;
              CONST Abortable    : BOOLEAN;
              CONST ShowMessages : BOOLEAN;
              VAR   Locked       : BOOLEAN);

  (**
      LockRelation - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        LockRelation (Relation, Lock, LockTime, PreemptTime, Abortable,
                      ShowMessages, Locked)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE ReadRecord
             (CONST Relation     : ARRAY OF CHAR;
              CONST Field        : ARRAY OF CHAR;
              CONST Operation    : Sage.SageOperations;
              CONST Lock         : RecordLockType;
              CONST lockTime     : ModSys.INT16;
              CONST PreemptTime  : ModSys.INT16;
              CONST Abortable    : BOOLEAN;
              CONST ShowMessages : BOOLEAN);

  (**
      ReadRecord - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        ReadRecord (Relation, Field, Operation, Lock, LockTime, PreemptTime,
                    Abortable, ShowMessages)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE ReadRecordA
             (CONST Relation     : ARRAY OF CHAR;
              CONST Field        : ARRAY OF CHAR;
              CONST Operation    : Sage.SageOperations;
              CONST Str          : ARRAY OF CHAR;
              CONST Lock         : RecordLockType;
              CONST lockTime     : ModSys.INT16;
              CONST PreemptTime  : ModSys.INT16;
              CONST Abortable    : BOOLEAN;
              CONST ShowMessages : BOOLEAN);

  (**
      ReadRecordA - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        ReadRecordA (Relation, Field, Operation, Str, Lock, LockTime,
                     PreemptTime, Abortable, ShowMessages)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE ReadRecordN
             (CONST Relation     : ARRAY OF CHAR;
              CONST Field        : ARRAY OF CHAR;
              CONST Number       : ModSys.INT32;
              CONST Lock         : RecordLockType;
              CONST lockTime     : ModSys.INT16;
              CONST PreemptTime  : ModSys.INT16;
              CONST Abortable    : BOOLEAN;
              CONST ShowMessages : BOOLEAN);

  (**
      ReadRecordN - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        ReadRecordN (Relation, Field, Operation, Number, Lock, LockTime,
                     PreemptTime, Abortable, ShowMessages)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE ReadRecordP
             (CONST Relation     : ARRAY OF CHAR;
              CONST Field        : ARRAY OF CHAR;
              CONST Position     : ModSys.INT32;
              CONST Lock         : RecordLockType;
              CONST lockTime     : ModSys.INT16;
              CONST PreemptTime  : ModSys.INT16;
              CONST Abortable    : BOOLEAN;
              CONST ShowMessages : BOOLEAN);

  (**
      ReadRecordP - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        ReadRecordP (Relation, Field, Operation, Position, Lock, LockTime,
                     PreemptTime, Abortable, ShowMessages)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE FindRecord
             (CONST Relation  : ARRAY OF CHAR;
              CONST Field     : ARRAY OF CHAR;
              CONST Operation : Sage.SageOperations);

  (**
      FindRecord - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        FindRecord (Relation, Field, Operation)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE GetKeyPosition
             (CONST Relation : ARRAY OF CHAR;
              CONST Field    : ARRAY OF CHAR;
              VAR   Position : ModSys.INT32);

  (**
      GetKeyPosition - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        GetKeyPosition (Relation, Field, Position)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE GetBlockSize
             (CONST Relation  : ARRAY OF CHAR;
              CONST Field     : ARRAY OF CHAR;
              VAR   blockSize : ModSys.INT32);

  (**
      GetBlockSize - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        GetBlockSize (Relation, Field, blockSize)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE GetBlock
             (CONST Relation  : ARRAY OF CHAR;
              CONST Field     : ARRAY OF CHAR;
              CONST BuffAddr  : SYSTEM.ADDRESS;
              VAR   numBytes  : CARDINAL;
              VAR   firstByte : ModSys.INT32);

  (**
      GetBlock - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        GetBlock (Relation, Field, BuffAddr, numBytes, firstByte)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE PutBlock
             (CONST Relation  : ARRAY OF CHAR;
              CONST Field     : ARRAY OF CHAR;
              CONST BuffAddr  : SYSTEM.ADDRESS;
              CONST numBytes  : CARDINAL;
              VAR   firstByte : ModSys.INT32);

  (**
      PutBlock - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        PutBlock (Relation, Field, BuffAddr, numBytes, firstByte)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE TruncateBlock
             (CONST Relation  : ARRAY OF CHAR;
              CONST Field     : ARRAY OF CHAR;
              VAR   firstByte : ModSys.INT32);

  (**
      TruncateBlock - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        TruncateBlock (Relation, Field, firstByte)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE DeleteRecord
             (CONST Relation : ARRAY OF CHAR);

  (**
      DeleteRecord - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        DeleteRecord (Relation)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE WriteRecord
             (CONST Relation : ARRAY OF CHAR);

  (**
      WriteRecord - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        WriteRecord (Relation)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE ReWriteRecord
             (CONST Relation : ARRAY OF CHAR);

  (**
      ReWriteRecord - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        ReWriteRecord (Relation)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE DeleteRelation
             (CONST Relation : ARRAY OF CHAR);

  (**
      DeleteRelation - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        DeleteRelation (Relation)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE CloseAllSystems;

  (**
      CloseAllSystems - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        CloseAllSystems

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE CloseSystem;

  (**
      CloseSystem - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        CloseSystem

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE TotalRecords
             (CONST Relation : ARRAY OF CHAR) : ModSys.INT32;

  (**
      TotalRecords - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        TotRec := TotalRecords (Relation)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE UnlockRecord
             (CONST Relation : ARRAY OF CHAR);

  (**
      UnlockRecord - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        UnlockRecord (Relation)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE UnlockRelation
             (CONST Relation     : ARRAY OF CHAR;
              CONST Lock         : RelationLockType;
              CONST ShowMessages : BOOLEAN);

  (**
      UnlockRelation - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        UnlockRelation (Relation, Lock, ShowMessages

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE RelationIsOpen
             (CONST Relation : ARRAY OF CHAR) : BOOLEAN;

  (**
      RelationIsOpen - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        RelOpen := RelationIsOpen (Relation)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




  PROCEDURE GenerateUniqueKey
             (CONST Relation : ARRAY OF CHAR;
              CONST Field    : ARRAY OF CHAR;
              VAR   keyNum   : ModSys.INT32);

  (**
      GenerateUniqueKey - See equivalent calls in Sage and MultSage packages.


      This procedure performs the same functionality as the equivalent
      call in the Sage and MultSage packages.  In the case of multi-user
      access this routine does added checking of the error coming
      back from the call and pops up error messages to the user.

      CALLING SEQUENCE -

        GenerateUniqueKey (Relation, Field, KeyNum)

      ENTRY -

        See equivalent calls in the packages :
          Sage and MultSage.

      EXIT -

        See equivalent calls in the packages :
          Sage and MultSage.
  *)




Send mail to   warren.merrill@inl.gov with questions or comments about this web site.
Copyright © 1989-2006 Battelle Energy Alliance