DBL$ subroutines

WTSupported in traditional Synergy on Windows

 

USupported on UNIX
VSupported on OpenVMS

The majority of the DBL$ subroutines are syntactically and functionally identical to subroutines with the same name but without the “DBL$” prefix, with a few exceptions noted below. Refer to the specified pages for the correct syntax for each. We recommend you use the identical routine instead of the DBL$ one.

DBL$ Subroutines

Routine

Description

Identical routine

DBL$ASCII

Convert a decimal value into an ASCII character

ASCII

DBL$ASTRST

Restore the contents of work areas used as the result of an AST

ASTRST

DBL$ASTSAV

Save the contents of work areas used as the result of an AST

ASTSAV

DBL$BEGFL

Position to first record

BEGFL

DBL$BKSTR

Reverse search a string for a target value

%RVSTR

DBL$CHOPEN

Check whether a channel is in use

CHNOPN

DBL$CPUTM

Return accumulated CPU time

CPUTM

DBL$CREMBX

Create a mailbox

CREMBX

DBL$CVTIIV

Pass an integer value to a field

CVTIIV

DBL$CVTINT

Convert decimal data to binary values

DTOB

DBL$CVTIZ

Convert binary values to decimal data

BTOD

DBL$CVTIZV

Pass an integer value to a zoned numeric value

CVTIZV

DBL$CVTZI

Convert decimal data to binary values

DTOB

DBL$DATE

Return a date string

%DATE

DBL$DECML

Convert an ASCII character to its decimal value

%DECML

DBL$DELET

Delete the specified file

DELET

DBL$DELMBX

Mark a permanent mailbox for deletion

DELMBX

DBL$DEVCLT

Return the class and type of a device

None. See DBL$DEVCLT

DBL$ENDFL

Position the file pointer after the last record of a file

ENDFL

DBL$ERRMOD

Return the module in which the most recent error occurred

ERRMOD

DBL$ERROR

Return an error code number

%ERROR

DBL$ERRTXT

Return an error message

ERTXT

DBL$EXECUTE_
IMAGE_ROUTINE

Execute a routine in a shared image

None. See %DBL$EXECUTE_IMAGE_ROUTINE

DBL$EXITERROR

Exit the routine with a specific error

EXITE

DBL$FATAL

Chain to another program if a fatal error occurs

FATAL

DBL$FLAGS

Set runtime option flags

FLAGS

DBL$GETCM

Load the contents of a common area into a variable

GETCM

DBL$GETDFN

Return the default file specification

GETDFN

DBL$GETFA

Return file attributes

GETFA

DBL$GETFNM

Return the file specification of the open channel

GETFNM

DBL$GLINE

Get a line of input

GLINE

DBL$INSTR

Search a string for a target value

%INSTR

DBL$INTCVT

Convert binary values to decimal data

BTOD

DBL$JBNO

Provide the job number for the current process

%JBNO

DBL$KILL

Terminate the calling program

KILL

DBL$MONEY

Specify the currency symbol

MONEY

DBL$PAK

Compress numeric data

PAK

DBL$PARSE

Extract components of a file specification

PARSE

DBL$PURGE

Delete previous versions of a file

PURGE

DBL$PUTCM

Put the contents of a variable into a common area

PUTCM

DBL$RENAM

Rename a file

RENAM

DBL$RSTAT

Return information about the last record read

RSTAT

DBL$RSTATD

Return numeric information about the last record read

RSTATD

DBL$SETCTL

Modify the operation of control characters

SETCTL

DBL$SETDFN

Set the default file specification

SETDFN

DBL$SETKRF

Set the key of reference for the next operation of an ISAM file

None. See DBL$SETKRF

DBL$SIZE

Return the length of the data area

^SIZE

DBL$SNDOPR

Send a message to the system operator

None. See DBL$SNDOPR

DBL$TIME

Return the current system time

TIME

DBL$TNMBR

Return the terminal number

%TNMBR

DBL$TRACEBACK

Print the current traceback

TRACEBACK

DBL$TT_NAME_
TO_NUMBER

Convert a terminal name to its ­number

TT_NAME_TO_NUMBER

DBL$TT_NUMBER_
TO_NAME

Convert a terminal number to its name

TT_NUMBER_TO_NAME

DBL$TTBRDCST

Enable a program to trap broadcast messages

TTBRDCST

DBL$TTCHAR

Return type, lines, and width of a file

TTCHAR

DBL$TTFLGS

Set terminal‑oriented flags

TTFLGS

DBL$TTNAME

Return name of the terminal running the program

%TTNAME

DBL$TTSTS

Determine whether input is pending

%TTSTS

DBL$UNPAK

Decompress numeric data

UNPAK

DBL$VERSN

Identify the current operating system

%VERSN

DBL$VMCMD

Execute a DCL command

VMCMD

DBL$VMMSG

Get the text of an OpenVMS system message

VMMSG

DBL$WKDAY

Return the day of the week

%WKDAY

DBL$XARGS

Return information about arguments passed to external routine

XARGS

DBL$XSTAT

Get return value from last routine called

XSTAT