Inheritance diagram for Device:

Collaboration diagram for Device:

Static Public Member Functions
_.Library.Status	Broadcast (_.Library.String terminal, _.Library.String message, _.Library.Integer level)
	Description<br> More...

_.Library.Status	ChangePrincipal ()
	The ChangePrincipal() class method makes the current device (last. More...

	Get (_.Library.String Prompt, _.Library.String Value, _.Library.String Help, _.Library.Integer Flag, _.Library.Integer Timeout, _.Library.Integer IOFlag, _.Library.String IOSL, _.Library.Integer IOM, _.Library.String IOF, _.Library.String IOBS, _.Library.String IOPAR, _.Library.String IOT, _.Library.String IOST, _.Library.String ANS, _.Library.String RMSDF, _.Library.String IODOC, _.Library.String IODES)
	Get and open an INPUT or OUTPUT device. More...

_.Library.String	GetBackSpace ()
	Return the Back Space string for the process principal device. More...

_.Library.String	GetClearScreen ()
	Return the Clear Screen (Form Feed) string for the process principal device. More...

	GetCurrent (_.Library.String IO, _.Library.String SL, _.Library.String RM, _.Library.String FF, _.Library.String BS, _.Library.String SUB, _.Library.String XY)
	Get current device info from IS global. More...

_.Library.String	GetMnemonicDirectory ()
	Return the write mnemonic space routine directory for the current device. More...

_.Library.String	GetMnemonicRoutine ()
	Return the write mnemonic space routine name for the current device. More...

_.Library.String	GetNullDevice ()
	Return the name of the null device for the platform. More...

_.Library.List	GetPrinters ()
	Return a list of printers that the system recognizes. More...

_.Library.String	GetReadTerminators ()
	Return the read terminator string for the current device. More...

_.Library.Integer	GetRightMargin ()
	Return the right margin setting for the current device. More...

_.Library.Integer	GetType ()
	Returns an integer which specifies the type of device. More...

_.Library.DataType	InstalledPrinters (_.Library.Integer n)
	The InstalledPrinters() class method returns the number of printers. More...

_.Library.Boolean	ReDirectIO (_.Library.Boolean n)
	The ReDirectIO() class method returns the status of the I/O. More...

_.Library.Status	SetFFBS (_.Library.String ff, _.Library.String bs)
	The SetFFBS class method specifies the form feed or backspace. More...

Static Public Member Functions inherited from Help
_.Library.String	Help (_.Library.String method)
	This is a helper class that is used by the various SYSTEM classes to provide a Help method. More...

Member Function Documentation

◆ Broadcast()

_.Library.Status Broadcast	(	_.Library.String	terminal,
		_.Library.String	message,
		_.Library.Integer	level
	)

static

Description<br>

The Broadcast class method has two syntactic forms. The first sends a message to the specified terminal, and can optionally time out. The second sends a message to the operator console (specified by the null string), and also logs the message.

Broadcast(terminal,message) passes the message to the specified terminal. If you specify your own principal device, your message appears on your terminal screen.

Broadcast("",message) passes the message to the operator console, logging it in the console log file. By default, the console log file is messages.log, which can be accessed via the System Management Portal System Logs option. This default console log file location is configurable. Go to the Management Portal, select [Home] > [System Administration] > [Configuration] > [Additional Settings] > [Advanced Memory]. View and edit the current setting of ConsoleFile. By default this setting is blank, routing console messages to messages.log in the MGR directory. If you change this setting, you must restart the system for this change to take effect.
Broadcast does not add any carriage control to the message it sends. To include any carriage control (carriage returns or line feeds), you must include them in the message, using $CHAR(10) and $CHAR(13).

Broadcast returns 1 if successful; 0 if not successful.

Parameters<br>
terminal
The device name of the terminal to which you want to send a message, specified as a quoted string. Specify the null string ("") to send the message to the system console.

message
The message to send, specified as a quoted string.

level
Optional
when used with named terminal only ? A timeout in seconds. If Broadcast is not able to send the message during the period of the timeout, it ceases attempts to send the message after the timeout expires.
when used with operator console only ? The log level you want to assign to the message.

You can use the following values:
0 = Send the message to the following locations: Operator console log file, InterSystems IRIS console.
1 = Send the message to the following locations: Operator console log file, InterSystems IRIS console, System-wide operator console facility.

◆ ChangePrincipal()

_.Library.Status ChangePrincipal ( )

static

The ChangePrincipal() class method makes the current device (last.

device specified in a USE command) be the principal I/O device (referenceable by USE 0 or USE $PRINCIPAL.) This method makes the current device the principal I/O device, while leaving the former principal I/O device open, and thus capable of being used explicitly by name.

ChangePrincipal() takes no arguments. It returns 1 on success, 0 on failure.

◆ Get()

Get	(	_.Library.String	Prompt,
		_.Library.String	Value,
		_.Library.String	Help,
		_.Library.Integer	Flag,
		_.Library.Integer	Timeout,
		_.Library.Integer	IOFlag,
		_.Library.String	IOSL,
		_.Library.Integer	IOM,
		_.Library.String	IOF,
		_.Library.String	IOBS,
		_.Library.String	IOPAR,
		_.Library.String	IOT,
		_.Library.String	IOST,
		_.Library.String	ANS,
		_.Library.String	RMSDF,
		_.Library.String	IODOC,
		_.Library.String	IODES
	)

static

Get and open an INPUT or OUTPUT device.

Input Parameters:
Prompt - Prompt to be displayed
Value - Default value
Help - Array of help text
Flag - From syPrompt.inc

$$$DisableBackupCharMask - Disable entry of the backup character
$$$TrapCtrlCMask - Trap CTRL/C and return CTRL/C status
$$$EnableQuitCharMask - Enable quit and return Quit status
$$$DisableHelpCharMask - Disable entry of the help character
$$$TrapErrorMask - Trap errors and return error status
TimeOut - Timeout for prompt
IOFlag - Mask containing one of the following values
- 1= Get input or output device (Default)
- 2= Get input device
- 4= Get output device
  - 8= Open passed in Value without prompting
    
    Output parameters:
    Status - One of the following from syPrompt:
    $$$SuccessResponse - Successful entry, Value contains valid open device
    $$$BackupResponse - Backup character entered
    $$$QuitResponse - Quit character entered if $$$EnableQuitCharMask set
    $$$CtrlCResponse - CTRL/C entered if $$$TrapCtrlCMask set
    $$$ErrorResponse - Error during entry if $$$TrapErrorMask set
    $$$HelpResponse - Help character entered if $$$DisableHelpCharMask set
    
    Value - Open device name
    IOSL - Number of lines per screen
    IOM - Right margin
    IOBS - Backspace character
    IOPAR - IO parameters
    IOT - Device type
    IOST - Expanded device type
    ANS - Device typed in by user
    RMSDF - Default RMS parameters
    IODOC - Spool file name
    IODES - Spool file description
    
    Typical usage is as follows: s Status=##Class(Library.Device).Get("Device:",.Value,,$$$TrapCtrlCMask+$$$EnableQuitCharMask,,IOFlag,.IOSL,.IOM)
    i (Status=$$$CtrlCResponse)||(Status=$$$QuitResponse) q
    i (Status=$$$BackupResponse) g PreviousPrompt
    use Value
    w !,"Right margin is "_IOM
    w !,"Lines per page is "_IOSL
    close Value

◆ GetBackSpace()

_.Library.String GetBackSpace ( )

static

Return the Back Space string for the process principal device.

◆ GetClearScreen()

_.Library.String GetClearScreen ( )

static

Return the Clear Screen (Form Feed) string for the process principal device.

◆ GetCurrent()

GetCurrent	(	_.Library.String	IO,
		_.Library.String	SL,
		_.Library.String	RM,
		_.Library.String	FF,
		_.Library.String	BS,
		_.Library.String	SUB,
		_.Library.String	XY
	)

static

Get current device info from IS global.

Get current device info from IS global and set default FormFeed and Backspace strings for the process based on information in the IS global.
Return Values:
IO - Device name
SL - Number of screen lines of the device
RM - Right margin of the device
FF - Form feed character of the device
BS - Back space character of the device
SUB - Device subtype
XY - XY cursor positioning string

This method replaces the CURRENT^IS call.

◆ GetMnemonicDirectory()

_.Library.String GetMnemonicDirectory ( )

static

Return the write mnemonic space routine directory for the current device.

◆ GetMnemonicRoutine()

_.Library.String GetMnemonicRoutine ( )

static

Return the write mnemonic space routine name for the current device.

◆ GetNullDevice()

_.Library.String GetNullDevice ( )

static

Return the name of the null device for the platform.

◆ GetPrinters()

_.Library.List GetPrinters ( )

static

Return a list of printers that the system recognizes.

This method is supported only for Windows platform, for non Windows platform it always returns a null string.

It returns a null string when there is no printer recognized by the system.
Use $LISTLENGTH function to get number of printers in the returned list. Use $LIST function to get each printer name in the list. Note that you need to add "|PRN|" at beginning of each printer name in order to use OPEN command to open the printer device.

◆ GetReadTerminators()

_.Library.String GetReadTerminators ( )

static

Return the read terminator string for the current device.

Does not apply to some devices.

◆ GetRightMargin()

_.Library.Integer GetRightMargin ( )

static

Return the right margin setting for the current device.

This only applies to terminals.

◆ GetType()

_.Library.Integer GetType ( )

static

Returns an integer which specifies the type of device.

0 - sequential file
1 - terminal
2 - spool device (device #2)
3 - magnetic tape (device numbers 47-50)
4 - system operator's console (device 1)
5 - pseudo-device (device numbers 20-46)
6 - Null device
7 - spooled virtual console
8 - IJC device (devices 224-255)
9 - TCP device
11 - NetBIOS NTI device
12 - Named Pipe device
13 - Memory-mapped device
14 - XDEV extensible device

-1 - Unknown or no default device

◆ InstalledPrinters()

_.Library.DataType InstalledPrinters ( _.Library.Integer n )

static

The InstalledPrinters() class method returns the number of printers.

currently installed on your system, counting from 1.

The InstalledPrinters(n) method, where 1 <= n <= InstalledPrinters(), returns the pathname of the printer currently installed on your system that corresponds to n. The system counts printers from 1, and assigns a sequential integer to each. If n is a number that does not correspond to a printer, the system issues a <FUNCTION> error.

◆ ReDirectIO()

_.Library.Boolean ReDirectIO ( _.Library.Boolean n )

static

The ReDirectIO() class method returns the status of the I/O.

redirection switch for the current device.

The ReDirectIO(n) class method sets the I/O redirection switch for the current device according to the boolean value n. It returns the previous setting of this switch.

◆ SetFFBS()

_.Library.Status SetFFBS	(	_.Library.String	ff,
		_.Library.String	bs
	)

static

The SetFFBS class method specifies the form feed or backspace.

control code sequence used by printers.

Parameters
ff : The new value for the form feed control code sequence. If omitted, the system default, as defined for Device 0, is used. May not be omitted if the bs parameter is present.
bs : The new value for the backspace control code sequence. If omitted, the system default, as defined for Device 0, is used.

Description
This function is used to change the form feed and backspace control code sequences.
SetFFBS(ff,bs) sets form feed control sequence to ff and backspace control sequence to bs.
SetFFBS(ff) sets form feed control sequence to ff and backspace control sequence to system default.
SetFFBS() sets the printer form feed and backspace control sequences to system default.

Static Public Member Functions

Member Function Documentation

◆ Broadcast()

◆ ChangePrincipal()

◆ Get()

◆ GetBackSpace()

◆ GetClearScreen()

◆ GetCurrent()

◆ GetMnemonicDirectory()

◆ GetMnemonicRoutine()

◆ GetNullDevice()

◆ GetPrinters()

◆ GetReadTerminators()

◆ GetRightMargin()

◆ GetType()

◆ InstalledPrinters()

◆ ReDirectIO()

◆ SetFFBS()