| BLD() |
This entry point performs the following functions:
Extracts a dialog from a FileMan DIALOG file entry Substitutes dialog
parameters into the text if requested Returns the text in an array
Format: BLD^DIALOG(DIALOG#,[.]TEXT_PARAM,[.]OUTPUT_PARAM,OUTPUT_ARRAY,FLAGS)
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
DIALOG# |
Input |
(Required) Record number from the DIALOG file for the
text to be returned.
|
[.]TEXT_PARAM |
Input |
(Optional) Local array containing the dialog
parameters to substitute into the resulting text. Set the subscript of each
node in this array to a dialog parameter that's in a |window| in the
referenced Dialog entry's text. The value of each node should be in external,
printable format, and will be substituted in the Dialog text for that dialog
parameter.
|
[.]OUTPUT_PARAM |
Both |
(Optional) This is useful mainly if you are returning
error messages as part of an API for other programmers to use. Use it to pass
dialog parameters back to the user of your API, such that they can be accessed
individually instead of just being embedded in the error text.
|
OUTPUT_ARRAY |
Both |
(Optional) If provided, the text will be output in
the local or global array named by this parameter.
|
FLAGS |
Input |
(Optional) Flags to control processing. The possible
values are:
S Suppresses the blank line that is normally inserted between discrete blocks
of text that are built by separate calls to this routine.
F Formats the local array similar to the default output format of the ^TMP
global, so that MSG^DIALOG can be called to either write the array to the
current device or to a simple local array.
|
|
$$EZBLD() |
This extrinsic function returns the first line of
text from an entry in the DIALOG File. It can be used when the text entry is
only one line and when the output does not need to be put into an array.
Format $$EZBLD^DIALOG(DIALOG#,[.]TEXT_PARAM)
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
DIALOG# |
Input |
(Required) Record number from the DIALOG File for the
text to be returned.
|
[.]TEXT_PARAM |
Input |
(Optional) Name of local array containing the
parameter list for those parameters that are to be incorporated into the
resulting text. These parameters should be in external, printable format. If
there is only one parameter in the list, it can be passed in a local variable
or as a literal.
|
|
MSG() |
This procedure takes text from one of the FileMan
dialogue arrays (for errors, help text, or other text) or from a similarly
structured local array writes it and/or moves it into a simple local array.
Format: MSG^DIALOG(FLAGS,.OUTPUT_ARRAY,TEXT_WIDTH,LEFT_MARGIN,INPUT_ROOT)
|
| VARIABLES |
TYPE |
VARIABLES DESCRIPTION |
FLAGS |
Input |
(Optional) Flags to control processing. If none of
the text type flags (E, H or M) is entered, the routine behaves as if "E" were
entered. If no flags are entered, it behaves as if FLAGS contained "WE". The
possible values are:
A Local Array specified by the second parameter receives the text. W Writes
the text to the current device. S Saves the ^TMP or other designated input
array (does not kill the array). E Error array text is processed. H Help
array text is processed. M Message array text (other text) is processed. B
Blank lines are suppressed between error messages. T Return Total number of
lines in the top level node of the local array specified by the second
parameter.
|
|
|
|
.OUTPUT_ARRAY |
Both |
(Optional) This parameter contains the name of the
local array to which the text is to be written. If FLAGS contains an A, this
parameter must be sent. Otherwise, the parameter is ignored.
|
TEXT_WIDTH |
Input |
(Optional) Maximum line length for formatting text.
|
LEFT_MARGIN |
Input |
(Optional) Left margin for writing text. If sent, the
text is lined up in a column starting at this column number.
|
INPUT_ROOT |
Input |
(Optional) Closed root of local input array in which
text resides. If the text resides in a local array, this parameter must be
sent.
|
ARRAY |
Output |
Total number of lines (only returned if FLAGS
contains "T").
|
ARRAY(n) |
Output |
A line of formatted text (n=sequential integer
starting with 1).
|
|