APIs are just programs or procedures, called the same ways that you call programs or procedures that you might write yourself. Documentation is standard among all similar APIs; so once you understand one, a bunch of others become meaningful.

The Info Center has examples of Using APIs, and lots of examples are out on the internet. The section on Common API programming errors covers almost everything you’ll run into.

Here’s a basic example for QP0LROR written in V5R3 CL:

pgm    ( +
         &pPath       +
       )

   dcl   &pPath       *char  128


   dcl   &rcvvar      *char 1024     value( ' ' )
   dcl   &lrcvvar     *uint
   dcl   &path_t      *char  512     value( ' ' )
   dcl   &CCSID       *char    4     value( x'00000000' )
   dcl   &country     *char    2     value( x'0000' )
   dcl   &lang        *char    3     value( x'000000' )
   dcl   &pathtyp     *char    4     value( x'00000000' )
   dcl   &path        *char  128
   dcl   &lPath       *char    4     value( x'00000000' )
   dcl   &LenPath     *dec (   5 0 ) value( 0 )
   dcl   &rsv3        *char    3     value( x'000000' )
   dcl   &rsv10       *char   10     value( x'00000000000000000000' )

   dcl   &nRef        *dec (   5 0 ) value( 0 )
   dcl   &oJobL       *dec (   5 0 ) value( 0 )
   dcl   &dJobLE      *dec (   5 0 ) value( 0 )
   dcl   &oJobLE      *dec (   5 0 ) value( 0 )
   dcl   &qjob        *char   26     value( ' ' )

   dcl   &x00         *char    4     value( x'00000000' )


/* Get the value away from the parm... */
   chgvar            &path            &pPath

/* Use this to determine length...     */
   rtvmsg     msgid( cpf9897 ) msgf( QSYS/QCPFMSG ) +
                msgdta( &path )   +
                msglen( &LenPath )

/* Set up the path.name structure...   */
   chgvar      %bin( &lPath )         &LenPath

   chgvar            &path_t        ( +
                                      &CCSID       *cat  +
                                      &country     *cat  +
                                      &lang        *cat  +
                                      &rsv3        *cat  +
                                      &pathtyp     *cat  +
                                      &lPath       *cat  +
                                      '/ '         *cat  +
                                      &rsv10       *cat  +
                                      &path              +
                                    )

/* Call the API...                     */
   chgvar            &lrcvvar       ( 1024 )
   call        QP0LROR     ( +
                             &rcvvar      +
                             &lrcvvar     +
                             RORO0200     +
                             &path_t      +
                             x'00000000'  +
                           )

/* If 'in use'...                      */
   if ( %sst( &rcvvar  13  4 ) *ne &x00 )  do   /* In-use indicator... */

   /* Find a job reference...             */
      chgvar         &nRef      %bin( &rcvvar   9  4 )

      if ( &nRef *gt 0 )  do
         chgvar      &oJobL     %bin( &rcvvar  33  4 )
         chgvar      &oJobL         ( &oJobL + 1 )
         chgvar      &oJobLE        ( &oJobL + 16 )
         chgvar      &dJobLE    %bin( &rcvvar &oJobLE 4 )
         chgvar      &oJobLE        ( &oJobL + 20 )
         chgvar      &qjob      %sst( &rcvvar &oJobLE 26 )

      enddo
   enddo

dmpclpgm

   return

endpgm

It accepts a path as a parm. The path is passed to QP0LROR to see if there are any active references. If the number of references is not zero, the first job from the returned list is extracted. A dump is then produced before exiting, so you can see what’s in the returned structure and in other variables.

Create any streamfile in your home directory. Then open it with EDTF and start doing some edits. In a second session, call the example program with the full path to your streamfile as the parm. (Note that the parm is 128-bytes, so include enough trailing spaces.)

That’s about all that’s needed for this API. The Info Center documentation for QP0LROR should answer most questions about what you see when it runs. If not, well, that’s what sites like this one are for.

Tom

qsh
rm /qdls/hdrpprt/~$100028.HTM

A likely possibility is that the object is in the /QDLS file system which is an old DOS 8.3 file system. More recent versions of Windows have been dropping support for those file systems over network interfaces. Combinations of Microsoft patches and IBM PTFs have kept up most support, but warnings have been coming out for more than a decade to stop using /QDLS.

At some point, it simply will no longer work at all across a network through Windows, and neither Microsoft nor IBM will have a fix. Leave it behind now.

Tom

Thanks!