| $$SETSTR |
* $$SETSTR^VALM1(STRING, DEST, COLUMN, LENGTH)
This extrinsic function will setup a string for display. Once the string has
been set up for display, it would be set in the local variable or global
specified in the list template. (e.g. S ^TMP("SDAM",$J,SDLN)=X)
INPUT: STRING := string to insert DEST := destination string COLUMN
:= insert @ col. X LENGTH := clear # of chars (length)
OUTPUT: [returned] := <string>
Example: >S X=$$SETSTR^VALM1("This","",10,4) W !,X
This >S X=$$SETSTR^VALM1("is",X,20,2) W !,X
This is >S X=$$SETSTR^VALM1("an",X,30,2) W !,X
This is an >S X=$$SETSTR^VALM1("example.",X,40,8) W !,X
This is an example.
|
INSTR |
* INSTR^VALM1(STRING, COLUMN, ROW, LENGTH,
ERASE) This sub-routine will insert text on display screen at the row and
column specified.
INPUT: STRING := string to insert COLUMN := X coordinate ROW
:= Y coordinate LENGTH := clear # of characters ERASE := erase chars first
|
FLDUPD |
* FLDUPD^VALM1(STRING, FIELD, ENTRY) This
sub-routine updates a specific field of a specified list entry on the display
screen. The field name must match a field defined in the CAPTION LINE COLUMNS
multiple of the LIST TEMPLATE file.
INPUT: STRING := string to insert FIELD := col. name ENTRY := line # in
list
|
$$SETFLD |
* $$SETFLD^VALM1(STRING, VARIABLE, FIELD) This
sub-routine inserts the STRING at the column where the specific field starts
in the VARIABLE string. The FIELD name must match a field defined in the
CAPTION LINE COLUMNS multiple of the LIST TEMPLATE file.
INPUT: STRING := string to insert VARIABLE := destination string FIELD :=
col. name
OUTPUT: [returned] := <string>
|
CLEAR |
* CLEAR^VALM1 This will change the screen from
screen mode to the full scrolling region and clear the screen.
This call will also turn off the following: * underline * high
intensity * reverse video * blinking
Use this call in programmers' mode during development to clean up the
screen after an error occurs.
|
FULL |
* FULL^VALM1 This sets the screen to the full
scrolling region.
|
PAUSE |
* PAUSE^VALM1 This will pause the screen. The
call uses a ^DIR call with DIR(0) set to "E" for end of page. The prompt will
look like: Type <Enter> to continue or '^' to exit:
WARNING: This API DOES NOT NEW any of the Reader variables (such as DIR),
which may lead to unexpected behavior. For a safer API, consider using
WAIT^VALM1.
|
$$UPPER |
* $$UPPER^VALM1(STRING) This will convert a
string from lower case to upper case.
INPUT: STRING := string to convert
OUTPUT: [returned] := <string>
|
$$LOWER |
* $$LOWER^VALM1(STRING) This extrinsic function
will convert a string from upper case to lower case. It parses the string,
using a space, comma and a '/', It starts with the second character after
each delimiter.
INPUT: STRING := string to convert
OUTPUT: [returned] := <string>
Example:
S X="PATIENT,ONE AND/OR PATIENT,TWO"
S X=$$LOWER^VALM1(X)
W X
Patient,One And/Or Patient,Two
If your line of text contains many consecutive spaces, it is
often faster to execute this function as you build each portion
the line, instead of after the line has been completely built.
|
RANGE |
* RANGE^VALM1 This sub-routine will allow the
user to change a date range.
INPUT: DATE RANGE LIMIT field List Template file. VALMB := default beginning
date {optional}
OUTPUT: VALMBEG := beginning date in FM date format VALMEND := ending date in
FM date format
|
$$FDATE |
* $$FDATE^VALM1(Y) This extrinsic function
returns a date in 'mm/dd/yy' format. (e.g. 12/12/92)
INPUT: Y := FM date/time format
OUTPUT: [returned] := formatted date only
|
$$FDTTM |
* $$FDTTM^VALM1(Y) This extrinsic function
returns a date/time in 'mm/dd/yy@hh:mm' format. (e.g. 12/12/92@09:00)
INPUT: Y := FM date/time format
OUTPUT: [returned] := formatted date and time
|
$$FTIME |
* $$FTIME^VALM1(Y) This extrinsic function
returns a date/time in the 'mmm dd, yyyy@hh:mm' format. (e.g. DEC 12,
1992@09:00)
INPUT: Y := FM date format OUTPUT: [returned] := formatted date only
|
$$NOW |
* $$NOW^VALM1 This extrinsic date/time function
returns the value of 'NOW' in external format.
INPUT: none OUTPUT: [returned] := value of 'now' in $$FTIME^VALM1 format (e.g.
Mar 06, 1993 11:15:29)
|
WAIT |
* WAIT^VALM1 This will pause the screen with an
end of page call to the FileMan Reader. The user is prompted with "Enter
RETURN to continue".
NOTE: This is a safer API than PAUSE^VALM1 as all Reader variables are NEWed.
|
