|
|
|
|
type RelationLockType is (NoLockRelation,
ReadLockRelation,
WriteLockRelation,
ExclusiveReadLockRelation,
ExclusiveWriteLockRelation);
type RecordLockType is (NoLockRecord,
ReadLockRecord,
WriteLockRecord);
ShortLock : constant := 1;
MediumLock : constant := 5;
LongLock : constant := 15;
InfiniteLock : constant := 0;
ShortPreempt : constant := 60;
MediumPreempt : constant := 300;
LongPreempt : constant := 1_800;
InfinitePreempt : constant := 32_767;
procedure SetMultUserStatus
(MultUserEnabled : in 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
(MultUserEnabled : in out 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
(DataBase : in string;
Forms : in ModSys.S_Natural;
Screens : in ModSys.S_Natural;
BufSize : in ModSys.S_Natural);
--*
-- 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
(Relation : in string;
Modify : in 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
(Relation : in string);
--*
-- 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
(Relation : in string;
Lock : in RelationLockType;
lockTime : in ModSys.S_Natural;
PreemptTime : in ModSys.S_Natural;
Abortable : in boolean;
ShowMessages : in boolean;
Locked : in out 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
(Relation : in string;
Field : in string;
Operation : in Sage.SageOperations;
Lock : in RecordLockType;
lockTime : in ModSys.S_Natural;
PreemptTime : in ModSys.S_Natural;
Abortable : in boolean;
ShowMessages : in 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
(Relation : in string;
Field : in string;
Operation : in Sage.SageOperations;
Str : in string;
Lock : in RecordLockType;
lockTime : in ModSys.S_Natural;
PreemptTime : in ModSys.S_Natural;
Abortable : in boolean;
ShowMessages : in 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
(Relation : in string;
Field : in string;
Number : in ModSys.S_Natural;
Lock : in RecordLockType;
lockTime : in ModSys.S_Natural;
PreemptTime : in ModSys.S_Natural;
Abortable : in boolean;
ShowMessages : in 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
(Relation : in string;
Field : in string;
Position : in ModSys.S_Natural;
Lock : in RecordLockType;
lockTime : in ModSys.S_Natural;
PreemptTime : in ModSys.S_Natural;
Abortable : in boolean;
ShowMessages : in 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
(Relation : in string;
Field : in string;
Operation : in 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
(Relation : in string;
Field : in string;
Position : in out ModSys.S_Natural);
--*
-- 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
(Relation : in string;
Field : in string;
blockSize : in out ModSys.S_Natural);
--*
-- 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
(Relation : in string;
Field : in string;
BuffAddr : in System.Address;
numBytes : in out ModSys.S_Natural;
firstByte : in out ModSys.S_Natural);
--*
-- 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
(Relation : in string;
Field : in string;
BuffAddr : in System.Address;
numBytes : in ModSys.S_Natural;
firstByte : in out ModSys.S_Natural);
--*
-- 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
(Relation : in string;
Field : in string;
firstByte : in out ModSys.S_Natural);
--*
-- 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
(Relation : in string);
--*
-- 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
(Relation : in string);
--*
-- 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
(Relation : in string);
--*
-- 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
(Relation : in string);
--*
-- 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. --
function TotalRecords
(Relation : in string) return ModSys.S_Natural;
--*
-- 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
(Relation : in string);
--*
-- 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
(Relation : in string;
Lock : in RelationLockType;
ShowMessages : in 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.
--
function RelationIsOpen
(Relation : in string) return 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
(Relation : in string;
Field : in string;
keyNum : in out ModSys.S_Natural);
--*
-- 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