Library Routines

isCOBOL supports the following Library Routines:

$WINHELP

A$CURRENT_USER

A$DECRYPT

A$ENCRYPT

A$GET_DIGEST

A$GET_USER

A$GETTHREAD

A$GET_DIGEST

A$LIST_USERS

A$USERINFO

AS$COPY

ASCII2HEX

ASCII2OCTAL

C$ASYNCPOLL

C$ASYNCRUN

C$CALLEDBY

C$CALLERR

C$CHDIR

C$CODESET

C$COPY

C$CREATE_TMP_FILE

C$DELETE

C$DELTREE

C$DESKTOP

C$EASYOPEN

C$ENVMAP

C$FILEINFO

C$FSCOPY

C$FSFULLNAME

C$FULLNAME

C$GETCGI

C$GETENV

C$GETLASTFILENAME

C$GETLASTFILEOP

C$GETPID

C$GUICFG

C$JUSTIFY

C$KEYMAP

C$KEYSTROKE

C$LIST_DIRECTORY

C$LIST_ENVIRONMENT

C$LOCKPID

C$MAKEDIR

C$MYFILE

C$NARG

C$OPENSAVEBOX

C$PARAMSIZE

C$PRELOAD

C$PROGINMEM

C$REPLACE_ALL

C$RERR

C$RERRNAME

C$RUN

C$SETDEVELOPMENTMODE

C$SETENV

C$SLEEP

C$SOCKET

C$SORT

C$SYSINFO

C$SYSTEM

C$TOLOWER

C$TOUPPER

C$TRIM

C$UNSET

C$VERSION

C$WRITELOG

C$XML

CBL_AND

CBL_CHANGE_DIR

CBL_CHECK_FILE_EXIST

CBL_CLEAR_SCR

CBL_COPY_FILE

CBL_CREATE_DIR

CBL_DELETE_DIR

CBL_DELETE_FILE

CBL_DIR_SCAN_END

CBL_DIR_SCAN_READ

CBL_DIR_SCAN_START

CBL_EQ

CBL_ERROR_PROC

CBL_EXIT_PROC

CBL_GET_SCR_SIZE

CBL_IMP

CBL_JOIN_FILENAME

CBL_NOT

CBL_OR

CBL_READ_SCR_CHARS

CBL_READ_SCR_CHATTRS

CBL_RENAME_FILE

CBL_SPLIT_FILENAME

CBL_WRITE_SCR_CHARS

CBL_WRITE_SCR_CHATTRS

CBL_WRITE_SCR_N_CHAR

CBL_WRITE_SCR_N_CHATTR

CBL_XOR

EDBI_DISCONNECT

ESQL$BLOB

HEX2ASCII

I$IO

J$GETFROMLAF

J$NETADDRESS

KEISEN

KEISEN1

KEISEN2

KEISEN_SELECT

M$ALLOC

M$COPY

M$FILL

M$FREE

M$GET

M$PUT

M$SIZE

OCTAL2ASCII

P$

R$IO

REG_CLOSE_KEY, DISPLAY_REG_CLOSE_KEY

REG_CREATE_KEY, DISPLAY_REG_CREATE_KEY

REG_CREATE_KEY_EX, DISPLAY_REG_CREATE_KEY_EX

REG_DELETE_KEY, DISPLAY_REG_DELETE_KEY

REG_DELETE_VALUE, DISPLAY_REG_DELETE_VALUE

REG_ENUM_KEY, DISPLAY_REG_ENUM_KEY

REG_ENUM_VALUE, DISPLAY_REG_ENUM_VALUE

REG_OPEN_KEY, DISPLAY_REG_OPEN_KEY

REG_OPEN_KEY_EX, DISPLAY_REG_OPEN_KEY_EX

REG_QUERY_VALUE, DISPLAY_REG_QUERY_VALUE

REG_QUERY_VALUE_EX, DISPLAY_REG_QUERY_VALUE_EX

REG_SET_VALUE, DISPLAY_REG_SET_VALUE

REG_SET_VALUE_EX, DISPLAY_REG_SET_VALUE_EX

RENAME

S$IO

SYSTEM

W$BITMAP

W$CAPTURE

W$CENTER_WINDOW

W$CREATEFONT

W$FONT

W$HINT

W$IMAGESIZE

W$KEYBUF

W$MENU

W$MOUSE

W$PALETTE

W$PROGRESSDIALOG

W$ROTATE

W$SAVE_IMAGE

W$SCALE

W$TEXTSIZE

WD2$CLIENT_INFO

WD2$EXECJS

WD2$REDIRECT

WD2$RUN_JS

WD2$SESSION

WIN$PLAYSOUND

WIN$PRINTER

WIN$VERSION

To override one of these library routines you can compile with the -sysc option.

Sample programs for each library routine are available among the isCOBOL Samples.

The table below lists the library routines along with their usability in the various scenarios. For each routine it’s specified if it can be used in stand-alone, thin client and web, with some advice where applicable.

 

Library Routine / op-code	Kind of execution						Notes
	Stand-Alone	Thin Client default on		Thin Client	WD2	EIS
		Server	Client	CALL CLIENT
$WINHELP	YES	X		YES	NO	NO	In thin client, if CALL CLIENT is not used, then the help is opened on the server machine.
A$CURRENT_USER	NO	X		NO	NO	NO
A$DECRYPT	YES	X		NO	YES	YES
A$ENCRYPT	YES	X		NO	YES	YES
A$GETTHREAD	NO	X		NO	NO	NO
A$GET_DIGEST	YES	X		NO	YES	YES
A$GET_USER	NO	X		NO	NO	NO
A$LIST_LOCKS	NO	X		NO	NO	NO
A$LIST_USERS	NO	X		NO	NO	NO
A$USERINFO	NO	X		NO	NO	NO
ASCII2HEX	YES	X		NO	YES	YES
ASCII2OCTAL	YES	X		NO	YES	YES
C$ASYNCHPOLL	YES	X		NO	YES	YES
C$ASYNCRUN	YES	X		NO	YES	YES
C$CALLEDBY	YES	X		NO	YES	YES
C$CALLERR	YES	X		NO	YES	YES
C$CHDIR	YES	X		YES	YES	YES
C$CODESET	YES	X		NO	YES	YES
C$COPY	YES	X		YES[1]	YES	YES	[1]For the copy client to client there’s no difference between using the @[display]: prefix before file names or calling the routine via CALL CLIENT.
C$CREATE_TMP_FILE	YES	X		YES	YES	YES
C$DELETE	YES	X		YES[1]	YES	YES	[1]For the deletion of a file on the client machine there’s no difference between using the @[display]: prefix before the file name or calling the routine via CALL CLIENT.
C$DELTREE	YES	X		YES	YES	YES
C$DESKTOP	YES	X		YES[1]	NO	NO	[1]To run the utility client-side is better to rely on the client-server flag parameter instead of using CALL CLIENT.
C$EASYOPEN	YES	X		YES	NO[1]	NO[1]	[1]In WD2 environment you can call the WD2$REDIRECT routine, in EIS environment you can use the displayBinaryFile method of the HttpHandler class (for example comm-Area:>displayBinaryFile(tmp-file-name "application/pdf").
C$ENVMAP	YES	X		NO	YES	YES
C$FILEINFO	YES	X		YES	YES	YES
C$FSCOPY	YES	X		YES	YES	YES
C$FSFULLNAME	YES	X		NO	YES	YES
C$FULLNAME	YES	X		NO	YES	YES
C$GETENV	YES	X		YES	YES	YES
C$GETLASTFILEOP	YES	X		NO	YES	YES
C$GETLASTFILENAME	YES	X		NO	YES	YES
C$GETPID	YES	X		YES	YES	YES
C$GUICFG	YES		X	NO	YES[1]	YES[1]	By default print jobs are executed client side. [1] The WD2 environment and the EIS environment don't support the print preview.
C$JUSTIFY	YES	X		NO	YES	YES
C$KEYMAP	YES	X		NO	YES	NO
C$KEYSTROKE	YES	X		NO	YES	NO
C$LIST_DIRECTORY	YES	X		YES	YES	YES
C$LIST_ENVIRONMENT	YES	X		YES	YES	YES
C$MAKEDIR	YES	X		YES	YES	YES
C$MYFILE	YES	X		NO	YES	YES
C$NARG	YES	X		NO	YES	YES
C$OPENSAVEBOX	YES		X	NO	NO	NO
C$PARAMSIZE	YES	X		NO	YES	YES
C$PRELOAD	YES	X		NO	YES	YES
C$PROGINMEM	YES	X		NO	YES	YES
C$REPLACE_ALL	YES	X		NO	YES	YES
C$RERR	YES	X		NO	YES	YES
C$RERRNAME	YES	X		NO	YES	YES
C$RUN	YES	X		YES	YES	YES
C$SETDEVELOPMENTMODE	YES	X		NO	YES	YES
C$SETENV	YES	X		YES	YES	YES
C$SLEEP	YES	X		NO	YES	YES
C$SOCKET	YES	X		NO	YES	YES
C$SORT	YES	X		YES	YES	YES
C$SYSINFO	YES	X		YES	YES	YES
C$SYSTEM	YES	X		YES[1	YES	YES	[1]To run a command client-side is better to rely on the CSYS-DESKTOP flag parameter instead of using CALL CLIENT.
C$TOLOWER	YES	X		NO	YES	YES
C$TOUPPER	YES	X		NO	YES	YES
C$TRIM	YES	X		NO	YES	YES
C$UNSET	YES	X		YES	YES	YES
C$VERSION	YES	X		YES	YES	YES
C$WRITELOG	YES	X		YES	YES	YES
C$XML	YES	X		YES	YES	YES
CBL_AND	YES	X		NO	YES	YES
CBL_CHANGE_DIR	YES	X		YES	YES	YES
CBL_CHECK_FILE_EXIST	YES	X		YES	YES	YES
CBL_CLEAR_SCR	YES	X		NO	NO	NO
CBL_COPY_FILE	YES	X		YES	YES	YES
CBL_CREATE_DIR	YES	X		YES	YES	YES
CBL_DELETE_DIR	YES	X		YES	YES	YES
CBL_DELETE_FILE	YES	X		YES	YES	YES
CBL_DIR_SCAN_START	YES	X		YES	YES	YES
CBL_DIR_SCAN_READ	YES	X		YES	YES	YES
CBL_DIR_SCAN_END	YES	X		YES	YES	YES
CBL_EQ	YES	X		NO	YES	YES
CBL_ERROR_PROC	YES	X		NO	YES	YES
CBL_EXIT_PROC	YES	X		NO	YES	YES
CBL_GET_SCR_SIZE	YES	X		NO	NO	NO
CBL_IMP	YES	X		NO	YES	YES
CBL_JOIN_FILENAME	YES	X		NO	YES	YES
CBL_NOT	YES	X		NO	YES	YES
CBL_OR	YES	X		NO	YES	YES
CBL_RENAME_FILE	YES	X		YES	YES	YES
CBL_READ_SCR_CHARS	YES	X		NO	NO	NO
CBL_READ_SCR_CHATTRS	YES	X		NO	NO	NO
CBL_SPLIT_FILENAME	YES	X		NO	YES	YES
CBL_WRITE_SCR_CHARS	YES	X		NO	NO	NO
CBL_WRITE_SCR_CHATTRS	YES	X		NO	NO	NO
CBL_WRITE_SCR_N_CHAR	YES	X		NO	NO	NO
CBL_WRITE_SCR_N_CHATTR	YES	X		NO	NO	NO
CBL_XOR	YES	X		NO	YES	YES
DISPLAY_REG_*	YES		X	NO	NO	NO
EDBI_DISCONNECT	YES	X		NO	YES	YES
ESQL$BLOB	YES	X		NO	YES	YES
HEX2ASCII	YES	X		NO	YES	YES
I$IO	YES	X		YES	YES	YES
J$GETFROMLAF	YES		X	NO	NO	NO
J$NETADDRESS	YES	X		YES	YES	YES
KEISEN	YES	X		NO	NO	NO
KEISEN1	YES	X		NO	NO	NO
KEISEN2	YES	X		NO	NO	NO
KEISEN_SELECT	YES	X		NO	NO	NO
M$ALLOC	YES	X		NO	YES	YES
M$COPY	YES	X		NO	YES	YES
M$FILL	YES	X		NO	YES	YES
M$FREE	YES	X		NO	YES	YES
M$GET	YES	X		NO	YES	YES
M$PUT	YES	X		NO	YES	YES
M$SIZE	YES	X		NO	YES	YES
OCTAL2ASCII	YES	X		NO	YES	YES
P$DISPLAYDIALOG	YES		X	NO	NO	NO
P$*	YES		X	NO	YES	YES
R$IO	YES	X		YES	YES	YES
REG_*	YES	X		YES[1]	YES	YES	[1]Instead of calling REG routines via CALL CLIENT it’s better to call DISPLAY_REG routines.
RENAME	YES	X		YES	YES	YES
S$IO	YES	X		YES	YES	YES
SYSTEM	YES	X		YES	YES	YES
W$BITMAP - WBITMAP-LOAD	YES	X		NO	YES	NO
W$BITMAP - WBITMAP-LOAD-FROM-CLIENT	YES		X	NO	NO	NO
W$BITMAP - other	YES	X		NO	YES	NO
W$CAPTURE	YES		X	NO	NO	NO
W$CENTER_WINDOW	YES		X	NO	NO	NO
W$CREATEFONT	YES	X		NO	YES	YES
W$FLUSH	YES		X	NO	YES	NO
W$FONT - WFONT-CHOOSE-FONT	YES		X	NO	NO	NO
W$FONT - other	YES	X		NO	YES	YES[1]	[1]Only to manage printer fonts.
W$HINT	YES		X	NO	NO	NO
W$IMAGESIZE	YES	X		NO	YES	NO
W$KEYBUF	YES	X		NO	NO	NO
W$MENU - WMENU-NEW	YES		X	NO	YES	NO
W$MENU - WMENU-NEW-POPUP	YES		X	NO	YES	NO
W$MENU - WMENU-SHOW	YES		X	NO	YES[1]	NO	[1]In WD2 it’s not possible to display a menu on the try icon.
W$MENU - other	YES		X	NO	YES	NO
W$MOUSE - TEST-MOUSE-PRESENCE	YES		X	NO	YES	NO
W$MOUSE - GET-MOUSE-STATUS	YES		X	NO	NO	NO
W$MOUSE - SET-MOUSE-SHAPE	YES		X	NO	YES	NO	[1]In WD2 it’s not possible to set a custom mouse shape
W$PALETTE - WPALETTE-SUPPORTED	YES		X	NO	YES	NO
W$PALETTE - WPALETTE-GET-COLOR	YES		X	NO	YES	NO
W$PALETTE - WPALETTE-NUM-COLORS	YES		X	NO	YES	NO
W$PALETTE - WPALETTE-SET-COLOR	YES		X	NO	YES	NO
W$PALETTE - WPALETTE-CHOOSE-COLOR	YES		X	NO	NO	NO
W$PROGRESSDIALOG	YES	X		NO	NO	NO
W$ROTATE	YES	X		NO	YES	YES
W$SAVE_IMAGE	YES	X		NO	YES	YES
W$SCALE	YES	X		NO	YES	YES
W$TEXTSIZE	YES		X	NO	YES	NO
WD2$CLIENT_INFO	NO			NO	YES	NO
WD2$EXECJS	NO			NO	YES	NO
WD2$REDIRECT	NO			NO	YES	NO
WD2$RUN_JS	NO			NO	YES	NO
WD2$SESSION	NO			NO	YES	NO
WIN$PLAYSOUND	YES		X	NO	NO	NO
WIN$PRINTER	YES		X	NO	YES	YES
WIN$VERSION	YES	X		YES	YES	YES