Files > DIALOG

name
DIALOG
number
.84
location
^DI(.84,
description
This file stores the dialog used to 'talk' to a user (error messages, help text, and other prompts.) Entry points in the ^DIALOG routine retrieve text from this file. Variable parameters can be passed to these calls. The parameters are inserted into windows within the text as it is built. The text is returned in an array. This file and associated calls can be used by any package to pass information in arrays rather than writing to the current device. Record numbers 1 through 10000 are reserved for VA FileMan.
Fields
#NameLocationTypeDetailsIndexDescription
.01dialog number(+)0;1NUMERICBThe dialogue number is used to uniquely identify a message.
1type(+)0;2SET OF CODES1:ERROR
2:GENERAL MESSAGE
3:HELP
This code is used to group the entries in the FileMan DIALOG file, according to how they are used when interacting with the user.
1.2package(+)0;4POINTER9.4CThis is a pointer to the Package file. Each entry in this file belongs to, and is distributed by, a certain package. The Package field should be filled in for each entry on this file.
1.3short description0;5FREE TEXTDShort description is used to identify an entry on lookup. The "WRITE" identifier will display this description if it is not null.
2description1;0WORD-PROCESSING Used for internal documentation purposes.
3internal parameters needed0;3BOOLEANy:YES
Some dialogue is built by inserting variable text (internal parameters) into windows in the word-processing TEXT field. The insertable text might be, for example, File or Field names. This field should be set to YES if any internal parameters need to be inserted into the TEXT. If the field is not set to YES, the DIALOG routine will not go through the part of the code that stuffs the internal parameters into the text.
4text2;0WORD-PROCESSINGActual text of the message. If parameters (variable pieces of text) are to be inserted into the dialogue when the message is built, the parameter will appear as a 'window' in this TEXT field, surrounded by vertical bars. The data within the 'window' will represent a subscript of the input parameter list that is passed to BLD^DIALOG or $$EZBLD^DIALOG when building the message. This same subscript should be used as the .01 of the PARAMETER field in this file to document the parameter.
5parameter3;0MULTIPLE.845
6post message action6;E1,245FREE TEXTIf some special action should be taken whenever this message is built, MUMPS code can be entered here. This code will be executed by the BLD^DIALOG or $$EZBLD^DIALOG routines, immediately after the message text has been built in the output array. For example, the code could set a special flag into a global or local variable to notify the calling routine that some extra action needed to be taken.
7translation4;0MULTIPLE.847
8called from entry points5;0MULTIPLE.841

Referenced by 1 types

  1. SQLI_ERROR_LOG (1.52192) -- fileman_error