BROADCAST command: Sending a file message

From m204wiki
Jump to navigation Jump to search

Summary

Privileges
File manager
Function
Adds, changes, or removes the message associated with a Model 204 file

Syntax

BROADCAST FILE [URGENT][text]

Where: text is the new file message; if text is not specified in the command, the current file message is removed. The maximum length of the file message is 255 characters (247 if URGENT is specified).

Syntax notes

Multiple lines of text are specified in the form:

line1/line2.../

where the slash character (/) indicates a new line or a carriage return/line feed sequence.

A line is continued by specifying any nonblank character in the continuation column specified by the INCCC parameter.

Example

BROADCAST FILE URGENT NO FURTHER UPDATES ALLOWED TODAY

The following command prints one blank line, followed by the specified text, followed by one more blank line:

BROADCAST FILE /FILE IS BACKED UP EVERY DAY AT 6.00 P.M./

Usage notes

The file message for a Model 204 file is normally displayed when users open the file. The BROADCAST command adds a new file message or changes an existing file message. If the file message is changed after a user has opened the file, the message is displayed the next time that the user is at command level outside a procedure. If URGENT is specified in the command, the message is displayed almost immediately on the terminals of users who have opened the file. (See the discussion of message timing below.)

BROADCAST can delete the existing file message. If no text is specified in the command, as in the example below, then the file message is removed from the file:

BROADCAST FILE

Note:
The file message automatically is deleted when a file is recreated or reinitialized.
Whenever a file is displayed, it is preceded by the header:

MESSAGE FROM FILE filename


If insufficient storage (specified in the SPCORE parameter) is available to hold a copy of the file's BROADCAST message during the process of opening the file, the file message is not printed and open processing continues.

Message timing

The exact time at which an URGENT message is displayed on a user's terminal depends upon two factors:

  • What the receiver of the message is doing at the time (for example, waiting for input or running a request)

  • The type of Model 204 terminal handler used by the user

The most common situations are summarized below:

  • If the receiver is currently executing a command, such as a DISPLAY, the message is displayed when the command completes.

  • If the receiver is running a request, the message is displayed at certain points during loop processing.

  • If Model 204 is waiting for input, the message is displayed immediately on the devices shown below:

    IODEV Device type and access method
    7 SNA Communications Server (formerly VTAM) 3270
    37 SNA Communications Server 3767 and NTO
    45 CMS line-at-a-time console
    47 CMS full screen

For other terminal types, the message is displayed when Model 204 has received the input.

Update units

When it processes BROADCAST FILE, Model 204 ends any current User Language update unit and begins a non-backoutable update unit. If a Model 204 command non-backoutable update unit is in progress, BROADCAST FILE is included in that update unit. For more information about Model 204 update units, see the Model 204 File Manager's Guide.

Interrupting end-users

See "Evaluating whether to issue a BROADCAST URGENT command" in BROADCAST: Sending a login message.

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=BROADCAST_command:_Sending_a_file_message&oldid=60947"