Built-In Subroutines Syntax

=======================================================================

C$CALLEDBY Built-In Subroutine Syntax

=======================================================================

 CALL "C$CALLEDBY" USING prog-name-area
 ~~~~              ~~~~~

=======================================================================

C$CHDIR Built-In Subroutine Syntax

=======================================================================

 CALL "C$CHDIR" USING directory-path, result
 ~~~~           ~~~~~

=======================================================================

C$COPY Built-In Subroutine Syntax

=======================================================================

 CALL "C$COPY" USING src-file-path, dest-file-path, 0
 ~~~~          ~~~~~

=======================================================================

C$DELETE Built-In Subroutine Syntax

=======================================================================

 CALL "C$DELETE" USING file-path, 0
 ~~~~            ~~~~~

=======================================================================

C$FILEINFO Built-In Subroutine Syntax

=======================================================================

 CALL "C$FILEINFO" USING file-path, file-info
 ~~~~              ~~~~~

=======================================================================

C$GETPID Built-In Subroutine Syntax

=======================================================================

 CALL "C$GETPID"
 ~~~~

=======================================================================

C$JUSTIFY Built-In Subroutine Syntax

=======================================================================

 CALL "C$JUSTIFY" USING data-item, "justification-type"
 ~~~~             ~~~~~

=======================================================================

C$MAKEDIR Built-In Subroutine Syntax

=======================================================================

 CALL "C$MAKEDIR" USING dir-path
 ~~~~             ~~~~~

=======================================================================

C$NARG Built-In Subroutine Syntax

=======================================================================

 CALL "C$NARG" USING arg-count-result
 ~~~~          ~~~~~

=======================================================================

C$PARAMSIZE Built-In Subroutine Syntax

=======================================================================

 CALL "C$PARAMSIZE" USING argument-number
 ~~~~               ~~~~~

=======================================================================

C$PRINTABLE Built-In Subroutine Syntax

=======================================================================

 CALL "C$PRINTABLE" USING data-item [ , char ]
 ~~~~               ~~~~~

=======================================================================

C$SLEEP Built-In Subroutine Syntax

=======================================================================

 CALL "C$SLEEP" USING seconds-to-sleep
 ~~~~           ~~~~~

=======================================================================

C$TOLOWER Built-In Subroutine Syntax

=======================================================================

 CALL "C$TOLOWER" USING data-item, BY VALUE convert-length
 ~~~~             ~~~~~               ~~~~~

=======================================================================

C$TOUPPER Built-In Subroutine Syntax

=======================================================================

 CALL "C$TOUPPER" USING data-item, BY VALUE convert-length
 ~~~~             ~~~~~               ~~~~~

=======================================================================

CBL_ALARM_SOUND Built-In Subroutine Syntax

=======================================================================

CALL "CBL_ALARM_SOUND"
~~~~

=======================================================================

CBL_AND Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_AND" USING item-1, item-2, BY VALUE byte-length
 ~~~~           ~~~~~                    ~~~~~

=======================================================================

CBL_BELL_SOUND Built-In Subroutine Syntax

=======================================================================

CALL "CBL_BELL_SOUND"
~~~~

=======================================================================

CBL_CHANGE_DIR Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_CHANGE_DIR" USING directory-path
 ~~~~                  ~~~~~

=======================================================================

CBL_CHECK_FILE_EXIST Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_CHECK_FILE_EXIST" USING file-path, file-info
 ~~~~                        ~~~~~

=======================================================================

CBL_CLOSE_FILE Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_CLOSE_FILE" USING file-handle
 ~~~~                  ~~~~~

=======================================================================

CBL_COPY_FILE Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_COPY_FILE" USING src-file-path, dest-file-path
 ~~~~                 ~~~~~

=======================================================================

CBL_CREATE_DIR Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_CREATE_DIR" USING dir-path
 ~~~~                  ~~~~~

=======================================================================

CBL_CREATE_FILE Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_CREATE_FILE" USING file-path, 2, 0, 0, file-handle
 ~~~~                   ~~~~~

=======================================================================

CBL_DELETE_DIR Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_DELETE_DIR" USING dir-path
 ~~~~                  ~~~~~

=======================================================================

CBL_DELETE_FILE Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_DELETE_FILE" USING file-path
 ~~~~                   ~~~~~

=======================================================================

CBL_EQ Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_EQ" USING item-1, item-2, BY VALUE byte-length
 ~~~~          ~~~~~                    ~~~~~

=======================================================================

CBL_ERROR_PROC Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_ERROR_PROC" USING function, program-pointer
 ~~~~                  ~~~~~

=======================================================================

CBL_EXIT_PROC Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_EXIT_PROC" USING function, program-pointer
 ~~~~                 ~~~~~

=======================================================================

CBL_FLUSH_FILE Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_FLUSH_FILE" USING file-handle
 ~~~~                  ~~~~~

=======================================================================

CBL_GC_FORK Built-In Subroute Syntax

=======================================================================

 CALL "CBL_GC_FORK" USING Child-PID
 ~~~~               ~~~~~

=======================================================================

CBL_GC_GETOPT Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_GC_GETOPT" USING   BY REFERENCE SHORTOPTIONS LONGOPTIONS LONGIND
 ~~~~                 ~~~~~   BY VALUE LONG-ONLY
                              BY REFERENCE RETURN-CHAR OPT-VAL

=======================================================================

CBL_GC_HOSTED Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_GC_HOSTED" USING ARG-1  ARG-2
 ~~~~                 ~~~~~

=======================================================================

CBL_GC_NANOSLEEP Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_GC_NANOSLEEP" USING nanoseconds-to-sleep
 ~~~~                    ~~~~~

=======================================================================

CBL_GC_PRINTABLE Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_GC_PRINTABLE" USING data-item [ , char ]
 ~~~~                    ~~~~~

Note replaces C$PRINTABLE which is kept as a legacy item.

=======================================================================

CBL_GC_SCR_DUMP Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_GC_SCR_DUMP" USING file-name, return-code
 ~~~~                   ~~~~~

=======================================================================

CBL_GC_SCR_RESTORE Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_GC_SCR_RESTORE" USING file-name, return-code
 ~~~~                      ~~~~~

=======================================================================

CBL_SET_GC_SCR_SIZE Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_GC_SET_SCR_SIZE" USING no-of-lines, no-of-cols
 ~~~~                       ~~~~~

=======================================================================

CBL_GC_WAITPID Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_GC_WAITPID" USING ARG-1
 ~~~~                  ~~~~~
                       RETURNING RET-STATUS
                       ~~~~~~~~~

=======================================================================

CBL_GET_CSR_POS Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_GET_CSR_POS" USING cursor-locn-buffer
 ~~~~                   ~~~~~

=======================================================================

CBL_GET_CURRENT_DIR Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_GET_CURRENT_DIR" USING BY VALUE 0,
 ~~~~                       ~~~~~    ~~~~~
                                  BY VALUE length,
                                     ~~~~~
                                  BY REFERENCE buffer
                                     ~~~~~~~~~

=======================================================================

CBL_GET_SCR_SIZE Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_GET_SCR_SIZE" USING no-of-lines, no-of-cols
 ~~~~                    ~~~~~

=======================================================================

CBL_IMP Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_IMP" USING item-1, item-2, BY VALUE byte-length
 ~~~~           ~~~~~                    ~~~~~

=======================================================================

CBL_NIMP Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_NIMP" USING item-1, item-2, BY VALUE byte-length
 ~~~~            ~~~~~                    ~~~~~

=======================================================================

CBL_NOR Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_NOR" USING item-1, item-2, BY VALUE byte-length
 ~~~~           ~~~~~                    ~~~~~

=======================================================================

CBL_NOT Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_NOT" USING item-1, BY VALUE byte-length
 ~~~~           ~~~~~            ~~~~~

=======================================================================

CBL_OPEN_FILE Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_OPEN_FILE" USING file-path, access-mode, 0, 0, handle
 ~~~~                 ~~~~~

=======================================================================

CBL_OR Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_OR" USING item-1, item-2, BY VALUE byte-length
 ~~~~          ~~~~~                    ~~~~~

=======================================================================

CBL_READ_FILE Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_READ_FILE" USING handle, offset, nbytes, flag, buffer
 ~~~~                 ~~~~~

=======================================================================

CBL_READ_KBD_CHAR Build-In Subroutine Syntax

=======================================================================

 CALL "CBL_READ_KBD_CHAR" USING char RETURNING status-code.
 ~~~~                     ~~~~~      ~~~~~~~~~

=======================================================================

CBL_RENAME_FILE Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_RENAME_FILE" USING old-file-path, new-file-path
 ~~~~                   ~~~~~

=======================================================================

CBL_RUNTIME_ERROR Built-In Subroutine Syntax

=======================================================================

CALL "CBL_RUNTIME_ERROR" USING  item-1 { error-message-string } 
~~~~                     ~~~~~         { literal-1            } 
                                       { OMITTED              } 
                                         ~~~~~~~

=======================================================================

CBL_SET_CSR_POS Build-In Subroutine Syntax

=======================================================================

 CALL "CBL_SET_CSR_POS" USING cursor-locn-buffer
 ~~~~                   ~~~~~

=======================================================================

CBL_TOLOWER Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_TOLOWER" USING data-item, BY VALUE convert-length
 ~~~~               ~~~~~               ~~~~~

=======================================================================

CBL_TOUPPER Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_TOUPPER" USING data-item, BY VALUE convert-length
 ~~~~               ~~~~~               ~~~~~

=======================================================================

CBL_WRITE_FILE Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_WRITE_FILE" USING handle, offset, nbytes, 0, buffer
 ~~~~                  ~~~~~

=======================================================================

CBL_XOR Built-In Subroutine Syntax

=======================================================================

 CALL "CBL_XOR" USING item-1, item-2, BY VALUE byte-length
 ~~~~           ~~~~~                    ~~~~~

=======================================================================

EXTFH Built-In Subroutine Syntax

=======================================================================

CALL "EXTFH" USING  opcode fcd
~~~~         ~~~~~

=======================================================================

SYSTEM Built-In Subroutine Syntax

=======================================================================

 CALL "SYSTEM" USING command
 ~~~~          ~~~~~

=======================================================================

X"91" Built-In Subroutine Syntax

=======================================================================

 CALL X"91" USING return-code, function-code, binary-variable-arg
 ~~~~       ~~~~~

=======================================================================

X"E4" Built-In Subroutine Syntax

=======================================================================

 CALL X"E4"
 ~~~~

=======================================================================

X"E5" Built-In Subroutine Syntax

=======================================================================

 CALL X"E5"
 ~~~~

=======================================================================

X"F4" Built-In Subroutine Syntax

=======================================================================

 CALL X"F4" USING byte, table
 ~~~~       ~~~~~

=======================================================================

X"F5" Built-In Subroutine Syntax

=======================================================================

 CALL X"F5" USING byte, table
 ~~~~       ~~~~~