VA FileMan V. 22.2 Programmer Manual Banner


 

Main Chapter Getting Started Manual Advanced User Manual

Database Server (DBS) API


$$EZBLD^DIALOG(): DIALOG Extractor (Single Line)

Reference Type Category ICR #
Supported Database Server (DBS) 2050
Description

The $$EZBLD^DIALOG extrinsic function returns the first line of text from an entry in the DIALOG (#.84) 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 (#.84) file entry. If the DIALOG (#.84) file entry has a POST MESSAGE ACTION code, this code is executed after the message has been built but before quitting.

Format
$$EZBLD^DIALOG(dialog#[,[.]text_param])
Input Parameters
DIALOG#

(Required) Record number from the DIALOG (#.84) 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.

Output

This extrinsic function returns the first line of text from a DIALOG (#.84) file entry. No output variables are returned.

NOTE: To add entries to the DIALOG (#.84) file, you must use a numberspace assigned by the database administrator (DBA).

REF: For more information on the DIALOG (#.84) file, see the “DIALOG File” section.

Examples

Example 1

To write a single line of text with no parameters, do the following:

Figure 134: $$EZBLD^DIALOG API—Example 1: Input and Output

    >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:

Figure 135: $$EZBLD^DIALOG API—Example 2: Input and Output

    >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:

Figure 136: $$EZBLD^DIALOG API—Example 3: Input and Output

    >S TESTPAR(1)="PAR2"
    >W $$EZBLD^DIALOG(201,.TESTPAR)
    The input variable PAR2 is missing or invalid.
Error Codes Returned

None.

 


Reviewed/Updated: May 2026