| Contents: | Main | Chapter | See Also: | Getting Started Manual | Advanced User Manual | |||
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. For example, use it to extract a single word or short phrase to use as a text parameter to embed into another DIALOG file entry. If the DIALOG entry has POST MESSAGE ACTION code, this code is executed after the message has been built but before quitting.
$$EZBLD^DIALOG(DIALOG#,[.]TEXT_PARAM)
| DIALOG# |
(Required) Record number from the DIALOG File for the text to be returned. |
| [.]TEXT_PARAM |
(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. |
This extrinsic function returns the first line of text from a DIALOG file entry. No output variables are returned.
NOTE: If you wish to add entries to the DIALOG file, you must use a numberspace assigned by the Database Administrator. See the Developer Tools, Dialog File section in this manual for more information.
Example 1
To write a single line of text with no parameters, do the following:
>W $$EZBLD^DIALOG(110)
The record is currently locked.
Example 2
To write a single line of text with a single parameter passed as a literal, do the following:
>W $$EZBLD^DIALOG(201,"PARAM")
The input variable PARAM is missing or invalid.
Example 3
To write a single line of text with parameters in an input array, do the following:
>S TESTPAR(1)="PAR2"
>W $$EZBLD^DIALOG(201,.TESTPAR)
The input variable PAR2 is missing or invalid.
None
Reviewed/Updated: March 14, 2007