|
|
|
|
TypeLen6_1 : constant := 30; TypeLen6_2 : constant := 257; subtype TokenType is string (1 .. 8); type tokenType_u_array is array (ModSys.S_Natural range <>) of TokenType;
procedure GetPath
(dflFile : in string;
keyName : in string;
Path : in out string);
--*
-- GetPath - Get a special path from the configuration file.
--
--
-- This procedure returns a path associated with a special key as
-- defined in the configuration file (.CFG) if it exists. This
-- procedure is similar to 'Sage.GetSpecialPath' except that
-- it does not require the database file (.DFL file) to be
-- opened first. This allows the creation of very small
-- executable programs since none of the database (Sage and/or
-- MultSage, etc.) nor user interface (Display) packages
-- need to be referenced nor loaded.
--
-- CALLING SEQUENCE -
--
-- GetPath (dflFile, keyName, path)
--
-- ENTRY -
--
-- dflFile : string
-- The name of the .DFL file of concern.
--
-- keyName : string
-- The name which identifies the required path.
--
-- EXIT -
--
-- path : string
-- The path associated with the given key name.
--
procedure ResetPath
(dflFile : in string;
keyName : in string;
Path : in string;
Error : in out boolean);
--*
-- ResetPath - Reset a special path for a configuration key.
--
--
-- This procedure resets a path associated with a special key as
-- defined in the configuration file (.CFG) if it exists.
--
-- CALLING SEQUENCE -
--
-- ResetPath (dflFile, keyName, path, error)
--
-- ENTRY -
--
-- dflFile : string
-- The name of the .DFL file of concern.
--
-- keyName : string
-- The name which identifies the required path.
--
-- path : string
-- The path to reset.
--
-- EXIT -
--
-- error : boolean
-- The result of the modification TRUE=Success, FALSE=No Success
--
procedure GetRelationPath
(dflFile : in string;
RelationName : in string;
Path : in out string);
--*
-- GetRelationPath - Get a relation path from the configuration file.
--
--
-- This procedure returns a path associated with a relation as
-- defined in the configuration file (.CFG) if it exists.
--
-- CALLING SEQUENCE -
--
-- GetRelationPath (dflFile, relationName, path)
--
-- ENTRY -
--
-- dflFile : string
-- The name of the .DFL file of concern.
--
-- relationName : string
-- The relation name which identifies the required path.
--
-- EXIT -
--
-- path : string
-- The path associated with the given relation name.
--
procedure ResetCFGRelationPath
(dflFile : in string;
RelationName : in string;
Path : in string;
Error : in out boolean);
--*
-- ResetCFGRelationPath - Reset saved relation path in config. file.
--
--
-- This procedure resets the path associated with the specified
-- relation as defined in the configuration file (.CFG) if it exists.
--
-- CALLING SEQUENCE -
--
-- ResetCFGRelationPath (dflFile, relationName, path, error)
--
-- ENTRY -
--
-- dflFile : string
-- The name of the .DFL file of concern.
--
-- relationName : string
-- The relation name which identifies the required path.
--
-- path : string
-- The new path.
--
-- EXIT -
--
-- error : boolean
-- The result of the modification TRUE=Success, FALSE=No Success
--
procedure GetDFLPath
(dflFile : in string;
Path : in out string);
--*
-- GetDFLPath - Get a dfl path from the configuration file.
--
--
-- This procedure returns a path associated with a dfl as
-- defined in the configuration file (.CFG) if it exists.
--
-- CALLING SEQUENCE -
--
-- GetDFLPath (dflFile, path)
--
-- ENTRY -
--
-- dflFile : string
-- The name of the .dfl file of concern.
--
-- EXIT -
--
-- path : string
-- The path associated with the given .dfl name.
--
procedure ResetDFLPath
(dflFile : in string;
Path : in string;
Error : in out boolean);
--*
-- ResetDFLPath - Reset the DFL path found in the configuration file.
--
--
-- This procedure resets the dfl path found in the configuration
-- defined in the configuration file (.CFG) if it exists.
--
-- CALLING SEQUENCE -
--
-- ResetDFLPath (dflFile, path, error)
--
-- ENTRY -
--
-- dflFile : string
-- The name of the .dfl file of concern.
--
-- path : string
-- The new dfl path.
--
-- EXIT -
--
-- error : boolean
-- The result of the modification TRUE=Success, FALSE=No Success
--
procedure GetLogPath
(dflFile : in string;
Path : in out string);
--*
-- GetLogPath - Get a Log path from the configuration file.
--
--
-- This procedure returns a path associated with a Log as
-- defined in the configuration file (.CFG) if it exists.
--
-- CALLING SEQUENCE -
--
-- GetLogPath (dflFile, path)
--
-- ENTRY -
--
-- dflFile : string
-- The name of the .dfl file of concern.
--
-- EXIT -
--
-- path : string
-- The path associated with the given Log name.
--
procedure ResetLogPath
(dflFile : in string;
Path : in string;
Error : in out boolean);
--*
-- ResetLOGPath - Reset log file path in configuration file.
--
--
-- This procedure resets the log file path found in the configuration
-- defined in the configuration file (.CFG) if it exists.
--
-- CALLING SEQUENCE -
--
-- ResetLogPath (dflFile, path, error)
--
-- ENTRY -
--
-- dflFile : string
-- The name of the .dfl file of concern.
--
-- path : string
-- The new log file path
--
-- EXIT -
--
-- error : boolean
-- The result of the modification TRUE=Success, FALSE=No Success
--
function TotalUsers
(dflFile : in string) return ModSys.S_Natural;
--*
-- TotalUsers - Return the total users in the security system.
--
--
-- This procedure returns the total number of users stored in
-- the security system.
--
-- CALLING SEQUENCE -
--
-- n := TotalUsers (dflFile);
--
-- ENTRY -
--
-- dflFile : string
-- The name of the database file (if a suffix is not given,
-- then ".DFL" is appended).
--
-- EXIT -
--
-- n : ModSys.S_natural
-- The total number of users referenced in the configuration.
--
procedure ReturnUserID
(dflFile : in string;
userNum : in ModSys.S_Natural;
userID : in out string);
--*
-- ReturnUserID - Return the user ID for a specified user number.
--
--
-- This procedure returns the user ID for a given user number.
--
-- CALLING SEQUENCE -
--
-- ReturnUserID (dflFile, userNum, userID)
--
-- ENTRY -
--
-- dflFile : string
-- The name of the database file (if a suffix is not given,
-- then ".DFL" is appended).
--
-- userNum : ModSys.S_natural
-- The number of the user for which the ID is required (1..n).
-- When the number exceedes the number of users, a null
-- string for the 'userID' will be returned.
--
-- EXIT -
--
-- userID : string
-- The user ID associated with the requested user number. If
-- there is no user ID then the indicated number is greater
-- than the number of users represented on the .CFG file.
--
procedure ReturnUserInfo
(dflFile : in string;
userID : in string;
lastName : in out string;
firstName : in out string;
middleI : in out character;
logging : in out character;
phone : in out string;
org : in out string;
address1 : in out string;
address2 : in out string;
city : in out string;
state : in out string;
country : in out string;
zip : in out string;
Des : in out string);
--*
-- ReturnUserInfo - Return information about the given user.
--
--
-- This procedure returns the basic user information
-- for the specified user.
--
procedure ChangeUserInfo
(dflFile : in string;
userID : in string;
lastName : in string;
firstName : in string;
middleI : in character;
phone : in string;
org : in string;
address1 : in string;
address2 : in string;
city : in string;
state : in string;
country : in string;
zip : in string;
good : in out boolean);
--*
-- ChangeUserInfo - Change user information.
--
--
-- This procedure allows changing of selected user information
-- items. Other items such as the description and passwords
-- are not changed by this procedure. The current user information
-- may be acquired using "CFGLib.ReturnUserInfo".
--
procedure ChangeUserPassword
(dflFile : in string;
userID : in string;
oldPW : in string;
NewPW : in string;
good : in out boolean);
--*
-- ChangeUserPassword - Change a current user password.
--
--
-- This procedure changes the selected current user password
-- from the previous value to the new value. A user may have
-- more than one password. This procedure only changes the
-- one specified. The new password should not be blank.
--
procedure SetUserPasswords
(dflFile : in string;
userID : in string;
userPassword : in string);
--*
-- SetUserPasswords - Submit passwords to the system.
--
--
-- This procedure submits passwords to SAGE based on the given
-- user ID and password. The associated system passwords are
-- set which allows the user permissions of data base access
-- as restricted by the normal SAGE password security system.
--
procedure SetForeignUserPasswords
(dflFile : in string;
userID : in string;
userPassword : in string);
--*
-- SetForeignUserPasswords - Submit passwords for external DFL's.
--
--
-- This procedure submits passwords to SAGE based on the given
-- user ID and password. The associated system passwords are
-- set which allows the user permissions of data base access
-- as restricted by the normal SAGE password security system
-- implemented in libraries such as "SageDyn". Each time a
-- Sagdyn procedure is called, the previously established foreign
-- passwords are released.
--
procedure ReleaseForeignUserPasswords; --* -- ReleaseForeignUserPasswords - Release list of foreign pw's. -- -- -- This procedure releases the list of passwords which were previously -- set by a call to "SetForeignUserPasswords. --
procedure ReturnUserPWData
(dflFile : in string;
userID : in string;
userPassword : in string;
accessMode : in out ModSys.S_Natural;
workAreaPath : in out string);
--*
-- ReturnUserPWData - Return info. associated with the user PW.
--
--
-- This procedure returns information associated with the
-- given user and password for the specified data base.
--
-- CALLING SEQUENCE -
--
-- ReturnUserPWData (dflFile, userID, userPassword, accessMode,
-- workAreaPath, totalProcesses)
--
-- ENTRY -
--
-- dflFile : string
-- Name of data base dictionary file. If given without
-- a suffix, then ".DFL" is appended.
--
-- userID : string
-- User ID of the user.
--
-- userPassword : string
-- Password for the specified user.
--
-- EXIT -
--
-- accessMode : ModSys.S_natural
-- The access mode associated with this password. These
-- may be determined by the program, but are commonly
-- defined as follows -
--
-- 0 - Single user normal access.
-- 1 - Single user with File.DenyNone set for the sharing mode
-- 2 - Copy required relation files to local space. Single
-- user access to those relations.
-- 3 - MultSage access with exclusive locks
-- 4 - Try for an exclusive lock. If unavailable, use normal
-- MultSage access
-- 5 - Normal MultSage access
--
-- workAreaPath : string
-- Path for the required local work area. This area may be
-- used for local file space if "accessMode" is set to 2.
--
-- totalProcesses : ModSys.S_natural
-- The total number of processes associated with the given
-- db name, user, and password. The actual process may
-- be retrieved using "CFGLib.ReturnUserProcesses".
-- This is the same number as returned from
-- "CFGLib.TotalProcesses".
--
function TotalProcesses
(dflFile : in string;
userID : in string;
userPassword : in string) return ModSys.S_Natural;
--*
-- TotalProcesses - Return the total processes available for the user.
--
--
-- This procedure returns the total number of passwords assigned
-- to the given user under the specified password. The names of
-- these processes may be retrieved using
-- "CFGLib.ReturnUserProcesses".
--
procedure ReturnUserProcesses
(dflFile : in string;
userID : in string;
userPassword : in string;
processes : in out tokenType_u_array;
maxProcesses : in ModSys.S_Natural;
totalReturned : in out ModSys.S_Natural);
--*
-- ReturnUserProcesses - Return the processes for the user.
--
--
-- This procedure returns the processes assigned to the given
-- user and associated given user password. It will return
-- no more than the 'maxProcesses' specified in the argument
-- list. To determine the total number of processes available
-- under the given user and password conditions, the
-- "CFGLib.TotalProcesses" procedure may be used.
--
procedure ConvertCFGToCurrent
(dflFile : in string;
CFGFound : out boolean;
Converted : out boolean);
--*
-- ReturnUserProcesses - Return the processes for the user.
--
--
-- This procedure converts the .CFG file of the given .DFL to
-- the latest format if possible. If the file is found the
-- CFGFound param is set appropriately whether the file gets
-- converted or not. The Converted parameter will give the
-- result of the attempt to convert.
--
-- CALLING SEQUENCE -
--
-- ConvertCFGToCurrent (dflFile, CFGFound, Converted)
--
-- ENTRY -
--
-- dflFile : string
-- Name of data base dictionary file. If given without a suffix,
-- then ".DFL" is appended.
--
-- EXIT -
--
-- CFGFound : boolean
-- True - The .CFG file was located whether conversion was successful
-- or not.
-- False - The .CFG file was NOT located whether conversion was successful
-- or not.
--
-- Converted : boolean
-- True - The .CFG file was converted to the current format.
-- False - The .CFG file was NOT converted to the current format.
--
Send mail to
warren.merrill@inl.gov
with questions or comments about this web site.
Copyright © 1989-2006 Battelle Energy Alliance