Format

int DF_BLOCKSRELEASED(dft_fil *file);
int DF_EF(dft_fil *file);
int DF_EMPTY(dft_fil *file);
int DF_ER(dft_fil *file);
int DF_ERBAM(dft_fil *file);
int DF_ERBAMSZ(dft_fil *file);
int DF_ERBTR(dft_fil *file);
int DF_ERCNT(dft_fil *file);
int DF_ERDSP(dft_fil *file);
int DF_ERLST(dft_fil *file);
int DF_ERRTN(dft_fil *file);
int DF_ERX(dft_fil *file);
int DF_LLR(dft_fil *file);
int DF_NR(dft_fil *file);
int DF_OK(dft_fil *file);
int DF_SERRC(dft_fil *file);
int DF_TEST(dft_fil *file, char cond);
int DFMULTI_OK(dft_fil *file);
int DFMULTI_BUF_ADDR_ZERO(dft_fil *file);
int DFMULTI_BUF_CORRUPT(dft_fil *file);
int DFMULTI_INCOMPLETE(dft_fil *file);
int DFMULTI_NOTHING_READ(dft_fil *file);
int DFMULTI_NOTHING_ADDED(dft_fil *file);
int DFMULTI_UNIQUE_LREC_EXISTS(dft_fil *file);
int DFMULTI_ERROR_ON_SUBFILE(dft_fil *file);
int DFMBUF_OK(dft_buf *buffer);
int DFMBUF_LREC_SIZE_NOT_VALID(dft_buf *buffer);
int DFMBUF_NO_SPACE(dft_buf *buffer);
int DFMBUF_TEST(dft_buf *buffer, char buf_cond);
int DFFSYS_OK(dft_fil *file);
int DFFSYS_ERROR_ON_SUBFILE(dft_fil *file);
int DFFSYS_FILE_ALREADY_EXISTS(dft_fil *file);
int DFFSYS_FILESYS_OPEN_ERROR(dft_fil *file);
int DFFSYS_FILESYS_WRITE_ERROR(dft_fil *file);
int DFFSYS_NOTHING_READ(dft_fil *file);
int DFFSYS_WRITE_LIMIT_REACHED(dft_fil *file);
int DFIDX_ENTRY_NOT_FOUND(dft_fil *file);
int DFIDX_ENTRY_ALREADY_EXISTS(dft_fil *file);
int DFIDX_ALG_OUT_OF_RANGE(dft_fil *file);
int DFIDX_SERIOUS_ERROR(dft_fil *file);
int DFIDX_VAR_ALG_LENGTH_ERROR(dft_fil *file);
int DFRSF_INVALID_PARAMETER(dft_fil *file);
int DFRSF_RDS_NOT_DEPLOYED(dft_fil *file);
int DFRSF_REMFIL_NOT_DEPLOYED(dft_fil *file);
int DFRSF_REMOTE_NOT_ALLOWED(dft_fil *file);
int DFRSF_SUBFILE_NOT_ACCESSED(dft_fil *file);
int DFRSF_SUBFILE_OPENED_WITHOUT_HOLD(dft_fil *file);
int DFRSF_SYSTEM_NOT_IN_NORM_STATE(dft_fil *file);
int DFRSF_INTERNAL_ERROR(dft_fil *file);
int DFRSF_AUTHENTICATION_ERROR(dft_fil *file);
int DFRSF_AUTHORIZATION_ERROR(dft_fil *file);
int DFRSF_DFDL_EXCEPTION(dft_fil *file);
int DFRSF_DOCUMENT_NOT_FOUND(dft_fil *file);
int DFRSF_JAM_ERROR(dft_fil *file);
int DFRSF_MALLOC_ERROR(dft_fil *file);;
int DFRSF_MAX_READER_ECBS_EXCEEDED (dft_fil *file);
int DFRSF_MQ_ERROR (dft_fil *file);
int DFRSF_RDS_CLIENT_UNAVAILABLE(dft_fil *file);
int DFRSF_RDS_TIMEOUT(dft_fil *file);
int DFRSF_SUBFILE_CORRUPT(dft_fil *file);
int DFRSF_TAPE_NOT_SUPPORTED(dft_fil *file);
cond Parameter Values
Read syntax diagramSkip visual syntax diagram|DFC_IOERRDFC_RCDNFDFC_FACEDFC_ALGDFC_BLOCKDFC_EOFDFC_SEQDFC_SM
buf_cond Parameter Values
Read syntax diagramSkip visual syntax diagramDF_MBUF_OKDF_MBUF_NO_SPACEDF_MBUF_LREC_SIZE_NOT_VALIDDF_MBUF_UNIQUE_LREC_EXISTSDF_MBUF_NOT_FOUNDDF_MBUF_NO_CURRENT_LRECDF_MBUF_STACKNBR_NOT_VALIDDF_MBUF_ALREADY_PUBLISHEDDF_MBUF_MOD_NOT_ALLOWEDDF_MBUF_CANNOT_GET_HEADERDF_MBUF_NOT_LOCAL_COPYDF_MBUF_KEYLIST_NOT_VALIDDF_MBUF_UNIQUE_WITHOUT_KEYS
file
is a pointer to the base address of the SW00SR slot (defined in the c_sw00sr.h) of the file that you want to access and is returned by the dfifb or dfopn function.
cond
is the condition that you want to test. Table 1 describes the values that you can specify:
Table 1. Values for the cond parameter
Value SW00RTN bit tested Condition
DFC_IOERR Bit 0 One of the following
  • I/O error.
  • B+Tree index error.
  • File header or trailer formats are not compatible.
  • File address formats are not compatible.
  • Large logical record (LLR) error.
  • Return-optional system error.
DFC_RCDNF Bit 1 One of the following:
  • The LREC was not found when using a dfred or dfdel function.
  • An LREC was found with the same keys as the LREC being added by one of the following:
    • dfadd function with the DFADD_UNIQUE value specified for the options parameter
    • dfadd function for a file with UNIQUE=YES specified on the DBDEF macro for the file.
DFC_FACE Bit 2 File address compute program (FACE) error.
DFC_ALG Bit 3 One of the following:
  • The index entry for the specific subfile does not exist in the top-level or intermediate index file.
  • The index entry for the specific subfile already exists in the top-level or intermediate index file.
  • Incorrect algorithm argument.
  • A serious error occurred when reading the top-level index file or intermediate index file.
See Table 5 for more information about how to check for the specific value in SW00RT6.
DFC_BLOCK Bit 4 One of the following:
  • Data in block is corrupt.
  • File header or trailer formats are not compatible.
  • File addresses are not compatible.
DFC_EOF Bit 5 End of file occurred during fullfile processing.
DFC_SEQ Bit 6 Sequence error using dfrst function.
DFC_SM Bit 7 Sort or merge error.
buffer
is a pointer to the base address of the z/TPFDF multiple LREC buffer that you want to access.
buf_cond
is the condition that you want to test. Table 2 describes the values that you can specify:
Table 2. Values for the buf_cond parameter
Value Buffer return value tested Condition
DF_MBUF_OK 0 dfmbuf processing completed successfully.
DF_MBUF_NO_SPACE 1 On a dfmbuf_append or dfmbuf_add operation, there was not enough space to add the new LREC or on a dfmbuf_copy operation, not all LRECs could be copied.
DF_MBUF_LREC_SIZE_NOT_VALID 2 On a dfmbuf_append, dfmbuf_add, or dfmbuf_replace operation, the LREC size that was provided is not valid.
DF_MBUF_UNIQUE_LREC_EXISTS 3 On a dfmbuf_add operation with the DFMBUF_UNIQUE option specified, an existing LREC that was found matches the unique keys.
DF_MBUF_NOT_FOUND 4 On a dfmbuf_read operation, the required LREC was not found.
DF_MBUF_NO_CURRENT_LREC 5 No current LREC was found to process. This check is only valid after one of the following operations:
  • dfmbuf_add() with the DFMBUF_ AFTER or DFMBUF_BEFORE option specified
  • dfmbuf_delete_current()
  • dfmbuf_replace()
  • dfmbuf_retain()
DF_MBUF_STACKNBR_NOT_VALID 6 On a dfmbuf_retain or dfmbuf_read_stack operation, the stack value was not valid.
DF_MBUF_ALREADY_PUBLISHED 7 On a dfmbuf_publish operation, a buffer was specified that was already published.
DF_MBUF_MOD_NOT_ALLOWED 128 A dfmbuf modification operation was requested but the buffer is in read-only mode. A system error DB018A was issued.
DF_MBUF_CANNOT_GET_HEADER 129 On a dfmbuf_gethdr operation, the buffer was not published or was a local copy of the buffer header. A system error DB018B was issued.
DF_MBUF_NOT_LOCAL_COPY 130 On a dfmbuf_read or dfmbuf_releasehdr operation, the buffer address specified is not a local copy of the buffer header. A system error DB018C was issued.
DF_MBUF_KEYLIST_NOT_VALID 131 On a dfmbuf_key operation, the number of keys in the key list is not valid. A system error DB018D was issued.
DF_MBUF_UNIQUE_WITHOUT_KEYS 132 On a dfmbuf_add with the DFMBUF_UNIQUE option specified, no active keys were found. A system error DB018E was issued.
Note: The field of buffer return value tested corresponds to fields DF_MBUFRTN for version 1 and DF_MBUF2RTN for version 2 of the buffer.