APINDSC

This API lets the user:

  • obtain a chunk of

    • the description of an event,

    • the description of a maintenance request,

    • a JCL text,

    • the audit report of an event,

    • the audit report of a finalized archiving event,

  • append a chunk to

    • the description of an event,

    • the description of a maintenance request,

    • a JCL text,

    • the audit report of an event,

    • the audit report of a finalized archiving event,

  • delete

    • the description of an event,

    • the description of a maintenance request,

    • a JCL text,the audit report of an event,

    • the audit report of a finalized archiving event.

APINDSC can be invoked with:

CALLNAT 'APINDSC' API-PARM API-DSC-PARM

Choose a value for API-PARM.API-MAIN-FUNC from the following table:

  a description a JCL text an audit report
to obtain a chunk of D J R
to append a chunk to E K S
to delete F L T

Set API-PARM.API-SUB-FUNC at:

E To handle an event. H To handle a finalized archiving event.
M To handle a maintenance request.
J To handle a JCL text.

This document covers the following topics:

Local Data Area UGNLDSC

A definition of API-DSC-PARM is provided in LDA UGNLDSC.

Field Name Format I/O
API-DSC-PARM    
OBJECT-NAME A32 in
LINE-CNT P5 in/out
TEXT-RECORD A80 (1:60) 1* in/out
API-PAC-AREA B20 in/out

1*: This is the proposed default value. Any value equal or greater 1 can be defined by the user.

When APINDSC is called:

  • API-DCS-PARM.OBJECT-NAME should carry the name of the entity (event, finalized archiving event, maintenance request, or JCL text).

  • If [API-PARM.API-MAIN-FUNC] is:

    • D, J, or R
      then [API-DSC-PARM.LINE-CNT] is made 0, if negative; it is made 60, if greater than 60. It is then interpreted as the number of lines (the size of the chunk) to be returned. In particular, no lines will be returned, if LINE-CNT = 0.

    • E, K, or S
      then [API-DSC-PARM.LINE-CNT] is made 0, if negative; it is made 60, if greater than 60. It is then interpreted as the number of lines (the size of the chunk) to be appended. In particular, an empty chunk will be appended, if LINE-CNT = 0.

    • F, L, or T
      then API-DSC-PARM.LINE-CNT is not used by APINDSC.

  • If [API-PARM.API-MAIN-FUNC] is:

    • D, J, or R
      then API-DSC-PARM.TEXT-RECORD will carry the returned chunk.

    • E, K, or S
      then the chunk inAPI-DSC-PARM.TEXT-RECORD(1 : [API-DSC-PARM.LINE-CNT]) will be appended.

    • F, L, or T
      then API-DSC-PARM.TEXT-RECORD is not used by APINDSC.

  • Normally, API-DSC-PARM.PAC-AREA should be reset when the first chunk of the description, text, or report is wanted or is to be appended. API-DSC-PARM.PAC-AREA should be left untouched for a next call to obtain or append an immediately following chunk of the same description, text, or report.

  • If [API-PARM.API-MAIN-FUNC] is D, J, or R then APINDSC returns in API-TEXT-PARM.LINE-CNT the number of lines of the returned chunk. It may be less than the adjusted original value, if the end of the description, text, or report has been reached.

Application API Return Codes

APINDSC returns the following [API-PARM.API-MSG-NO]:

0000 if the entity has been found and a non-final chunk is being returned, a chunk has been appended, or the description, text, or report has been deleted,
1011 if the specified ([API-PARM.API-MAIN-FUNC],[API-PARM.API-SUB-FUNC]) is meaningless,
7251 if the entity has not been found,
9999 if the entity has been found and a final chunk is being returned.