NetCOBOL V11.0 CBL Subroutines User's Guide

6.4 CBL_READ_VFILE

This routine reads data from a map object.

Specification

Parameter data definition

01  heap-ID                   PIC 9(4) COMP-5.
01  relative-address-in-heap  PIC 9(4) COMP-5.
01  data-length               PIC 9(4) COMP-5.
01  string-storage-area       PIC X(n).
01  status-code               PIC S9(4) COMP-5.

Calling format

CALL "CBL_READ_VFILE"
    USING BY VALUE heap-ID
          relative-address-in-heap
          data-length
          BY REFERENCE string-storage-area
    RETURNING status-code.

Interface

heap-ID

Specifies the heap-ID.

relative-address-in-heap

Specifies the relative address in a heap.

data-length

Specifies the length of data to be read.

string-storage-area

Specifies the area to store the read string.

Return code

The return code is set in the status-code specified in the RETURNING clause.

status-code

• 0: Successful

• Other than 0: Failure