|
|
|
|
| ClearFormOnAdd | DefineCommandLine | DefineCursorPosition | Dumb1 |
| Dumb2 | Dumb3 | RecordEd | RecordEdH |
| RecordEdit | RecordEditH |
PROCEDURE Dumb1
(VAR TheChar : FullCharacter);
(**
Dumb1 - Do nothing default PreCommandProcType procedure.
This procedure is a null procedure which can be used as a parameter
to other editor calls where the PreCommand function is not needed.
*)
PROCEDURE Dumb2
(CONST PVal : CHAR;
CONST eVal : CARDINAL;
VAR oVal : CHAR);
(**
Dumb2 - Default PreModifyProcType procedure.
This procedure is a default procedure which can be used as a parameter
to other editor calls where the PreModify function is not needed. The
procdure will check the exitNo and return a continue for normal exits
(exitNo = 10) and an end for any other.
*)
PROCEDURE Dumb3
();
(**
Dumb3 - Do nothing default PostLocateProcType procedure.
This procedure is a null procedure which can be used as a parameter
to other editor calls where the PostLocate function is not needed.
*)
PROCEDURE RecordEdit
(CONST FormName : ARRAY OF CHAR;
CONST RelationName : ARRAY OF CHAR;
CONST KeyFieldName : ARRAY OF CHAR);
(**
RecordEdit - Edit a relation's records.
This procedure allows editing of a relations records. Functions
include locating, finding the next record, finding the previous
record, adding a record, modifying an existing record, and
deleting a record.
CALLING SEQUENCE -
RecordEdit (FormName, RelationName, KeyFieldName);
ENTRY -
FormName : ARRAY OF CHAR
Name of form used for editing
RelationName : ARRAY OF CHAR
Name of record to be edited
KeyFieldName : ARRAY OF CHAR
Name of primary keyed field within the relation to be
edited that uniquely identifies a record. An entry
field in the form must exist for this field. If the
primary field is concatenated, the fields which are
components of that field must have entry fields
on the form.
*)
PROCEDURE RecordEd
(CONST FormName : ARRAY OF CHAR;
CONST RelationName : ARRAY OF CHAR;
CONST KeyFieldName : ARRAY OF CHAR;
CONST PreCommand : PreCommandProcType;
CONST PreModify : PreModifyProcType;
CONST PostLocate : PostLocateProcType);
(**
RecordEd - Edit a relation's records.
This procedure allows editing of a relations records. Functions
include locating, finding the next record, finding the previous
record, adding a record, modifying an existing record, and
deleting a record.
This procedure allows the programmer to execute two variable
procedures which are passed in the argument list. The first,
or 'PreModify' procedure is executed after each form is sent
with a modify type option such as 'add', 'delete', 'modify',
or any command that is not a locate type command.
The second procedure, 'PostLocate', is executed after each
locate type command is performed and before the form is again
displayed. Locate type commands are 'locate', 'next', and
'previous'. This is only executed if the 'SageError' is
returns as 0 after a locate operation.
CALLING SEQUENCE -
RecordEd (FormName, RelationName, KeyFieldName,
PreCommand, PreModify, PostLocate)
ENTRY -
FormName : ARRAY OF CHAR
Name of form used for editing
RelationName : ARRAY OF CHAR
Name of record to be edited
KeyFieldName : ARRAY OF CHAR
Name of primary keyed field within the relation to be
edited that uniquely identifies a record. An entry
field in the form must exist for this field. If the
primary field is concatenated, the fields which are
components of that field must have entry fields
on the form.
PreCommand : PreCommandProcType
The name of a procedure to be executed after a command
has been entered and before any default command execution.
The command is a two character entry to span the complete
range of the keyboard.
PreModify : PreModifyProcType
The name of a procedure to be executed after a form has
been sent by the user and before any non-exit request is
performed. The argument is the 1 letter command
indicating the operation that called this procedure. The
valid commands are L, A, M, D for Locate, Add, Modify or
Delete. The exitNo is the last exit function number. The
user returns an option of 'C' to continue process, 'R' to
redisplay the form, 'E' to exit process, or 'T' to terminate
RecordEd routine.
PostLocate : PostLocateProcType
The name of a procedure to be executed after the actual
locate type command is successfully executed. The
locate commands are "L", "P", or "N" (locate, next, or
previous). If a Sage.SageError is returned as non-zero
after execution of a locate type command, this
procedure is not executed.
*)
PROCEDURE RecordEditH
(CONST FormName : ARRAY OF CHAR;
CONST RelationName : ARRAY OF CHAR;
CONST KeyFieldName : ARRAY OF CHAR;
CONST JoinFieldName : ARRAY OF CHAR;
CONST FatherRelation : ARRAY OF CHAR;
CONST FatherJoinField : ARRAY OF CHAR);
(**
RecordEditH - Edit a relation's records using hierarchical restrictions.
This procedure allows editing of a relations records. Functions
include locating, finding the next record, finding the previous
record, adding a record, modifying an existing record, and
deleting a record.
The records available for editing may be restricted by
a joined field from another existing record. Only those records
whose "join" field is equal to the "join" field of the defined
"father" relaion may be accessed.
CALLING SEQUENCE -
RecordEditH (FormName, RelationName, KeyFieldName,
JoinFieldName, FatherRelation, FatherJoinField);
ENTRY -
FormName : ARRAY OF CHAR
Name of form used for editing
RelationName : ARRAY OF CHAR
Name of record to be edited
KeyFieldName : ARRAY OF CHAR
Name of primary keyed field within the relation to be
edited that uniquely identifies a record. An entry
field in the form must exist for this field. If the
primary field is concatenated, the fields which are
components of that field must have entry fields
on the form.
JoinFieldName : ARRAY OF CHAR
Name of field in relation being edited to restrict by.
FatherRelation : ARRAY OF CHAR
Name of other relation that contains a field to restrict
the editing of the fields in 'RelationName'.
FatherJoinField : ARRAY OF CHAR
Name of field withing 'FatherRelation' to restrict
access to the relation being edited. The current
contents are compared against 'JoinFieldName' for
equality.
*)
PROCEDURE RecordEdH
(CONST FormName : ARRAY OF CHAR;
CONST RelationName : ARRAY OF CHAR;
CONST KeyFieldName : ARRAY OF CHAR;
CONST JoinFieldName : ARRAY OF CHAR;
CONST FatherRelation : ARRAY OF CHAR;
CONST FatherJoinField : ARRAY OF CHAR;
CONST PreCommand : PreCommandProcType;
CONST PreModify : PreModifyProcType;
CONST PostLocate : PostLocateProcType);
(**
RecordEdH - Edit a relation's records using hierarchical restrictions.
This procedure allows editing of a relations records. Functions
include locating, finding the next record, finding the previous
record, adding a record, modifying an existing record, and
deleting a record.
This procedure allows the programmer to execute two variable
procedures which are passed in the argument list. The first,
or 'PreModify' procedure is executed after each form is sent
with a modify type option such as 'add', 'delete', 'modify',
or any command that is not a locate type command.
The second procedure, 'PostLocate', is executed after each
locate type command is performed and before the form is again
displayed. Locate type commands are 'locate', 'next', and
'previous'. This is only executed if the 'SageError' is
returns as 0 after a locate operation.
The records available for editing may be restricted by
a joined field from another existing record. Only those records
whose "join" field is equal to the "join" field of the defined
"father" relaion may be accessed.
CALLING SEQUENCE -
RecordEdH (FormName, RelationName, KeyFieldName,
JoinFieldName, FatherRelation, FatherJoinField,
PreCommand, PreModify, PostLocate)
ENTRY -
FormName : ARRAY OF CHAR
Name of form used for editing
RelationName : ARRAY OF CHAR
Name of record to be edited
KeyFieldName : ARRAY OF CHAR
Name of primary keyed field within the relation to be
edited that uniquely identifies a record. An entry
field in the form must exist for this field. If the
primary field is concatenated, the fields which are
components of that field must have entry fields
on the form.
JoinFieldName : ARRAY OF CHAR
Name of field in relation being edited to restrict by.
FatherRelation : ARRAY OF CHAR
Name of other relation that contains a field to restrict
the editing of the fields in 'RelationName'.
FatherJoinField : ARRAY OF CHAR
Name of field withing 'FatherRelation' to restrict
access to the relation being edited. The current
contents are compared against 'JoinFieldName' for
equality.
PreCommand : PreCommandProcType
The name of a procedure to be executed after a command
has been entered and before any default command execution.
The command is a two character entry to span the complete
range of the keyboard.
PreModify : PreModifyProcType
The name of a procedure to be executed after a form has
been sent by the user and before any non-exit request is
performed. The argument is the 1 letter command
indicating the operation that called this procedure. The
valid commands are L, A, M, D for Locate, Add, Modify or
Delete. The exitNo is the last exit function number. The
user returns an option of 'C' to continue process, 'R' to
redisplay the form, 'E' to exit process, or 'T' to terminate
the RecordEdH routine.
PostLocate : PostLocateProcType
The name of a procedure to be executed after the actual
locate type command is successfully executed. The
locate commands are "L", "P", or "N" (locate, next, or
previous). If a Sage.SageError is returned as non-zero
after execution of a locate type command, this
procedure is not executed.
*)
PROCEDURE DefineCursorPosition
(CONST row : CARDINAL;
CONST col : CARDINAL);
(**
DefineCursorPosition - Row and col where cursor will wait for command.
CALLING SEQUENCE -
DefineCursorPosition (row, col);
ENTRY -
row : CARDINAL
row number (1 .. 25) default = 24.
col : CARDINAL
column number (1 .. 80) default = 80.
EXIT -
None
N/A
*)
PROCEDURE DefineCommandLine
(CONST validkeys : ARRAY OF FullCharacter;
CONST validNumber : CARDINAL;
CONST validStringI : ARRAY OF CHAR;
CONST Form : ARRAY OF CHAR;
CONST promptline : ARRAY OF CHAR;
CONST promptRow : CARDINAL);
(**
DefineCommandLine - Define command line and valid keystrokes.
This procedure establishes the command line or form to display and
the valid keys that can be entered.
CALLING SEQUENCE -
DefineCommandLine (validkeys, validNumber, validStringI,
form, promptline, promptRow);
ENTRY -
validkeys : ARRAY OF FullCharacter
An array of valid keystrokes that the user can enter. The
first nine are order dependent on action and default as follows -
1 - ('E', nul) Exit
2 - (esc, nul) Exit
3 - ('L', nul) Locate
4 - ('N', nul) Next
5 - ('P', nul) Previous
6 - ('A', nul) Add
7 - ('M', nul) Modify
8 - ('D', nul) Delete
9 - (' ', nul) do nothing
Up to 11 other keystrokes can be defined. To invalidate a
standare function enter a (nul, nul) in the proper position.
validNumber : CARDINAL
Number of commands in the validKey array.
validStringI : ARRAY OF CHAR
Up to a 20 character string displayed when an invalid key
is pressed. default "ELNPAMD".
form : ARRAY OF STRING
Form name to display for command prompt. If null string
prompt line will be used.
promptline : ARRAY OF STRING
Up to an 80 character string written on line 24 for command
prompt. Only used in form is not defined. If null string
and no form then no prompt is given.
promptRow : CARDINAL
Row to place the prompt line on. (1 .. 25);
EXIT -
None
N/A
*)
PROCEDURE ClearFormOnAdd
(CONST flag : BOOLEAN);
(**
ClearFormOnAdd - Clear the form when add requested.
CALLING SEQUENCE -
ClearFormOnAdd (flag);
ENTRY -
flag : BOOLEAN
TRUE - Clear relation fields before reqested data entry.
Default is TRUE;
*)
Send mail to
warren.merrill@inl.gov
with questions or comments about this web site.
Copyright © 1989-2006 Battelle Energy Alliance