HELPLIB.HLB  —  LGI Routines, LGI$ICR_JOBSTEP
    The LGI$ICR_JOBSTEP callout routine signals the start of each
    batch job step.

    Format

      LGI$ICR_JOBSTEP  input_file_name ,context ,write_fao

1  –  Returns

    OpenVMS usage:cond_value
    type:         longword (unsigned)
    access:       write only
    mechanism:    by value

    Not applicable.

2  –  Arguments

 input_file_name

    OpenVMS usage:descriptor
    type:         character string
    access:       read
    mechanism:    by reference
    The name of the input file.

 context

    OpenVMS usage:context
    type:         longword (unsigned)
    access:       modify
    mechanism:    by reference
    Pointer to site's local context.

 write_fao (fao_string[,arg1[,arg2][,...]]])

    OpenVMS usage:routine
    type:         procedure
    access:       read
    mechanism:    by reference
    Address of a routine that may be called to format and display
    output. The routine has fao_string as its first argument,
    followed by a variable number of arguments. (See the $FAO system
    directive in the VSI OpenVMS System Services Reference Manual for
    more information.)

3  –  Description

    The LGI$ICR_JOBSTEP routine alerts the site of each job step in a
    batch job. The routine is invoked as LOGINOUT processes each job
    step. For the first job step, the LGI$ICR_JOBSTEP callout routine
    is invoked immediately following the LGI$ICR_IDENTIFY callout
    routine. For all other job steps, it is the only callout routine
    that is invoked.

    The routine is provided with the input file name, but the input
    file is not open when the routine is called. For the first job
    step, the LGI$ICR_INIT callout routine may provide the batch
    job step routine with context. For other job steps, the context
    argument is a null.

    For all job steps except the first, the output file is open, and
    the routine specified by the write_fao argument is available.

    There is no OpenVMS policy associated with LGI$ICR_JOBSTEP.

4  –  Typical Condition Values

    LGI$_SKIPRELATED   Access permitted; omit calls to the LGI$ICR_
    or any error       JOBSTEP callout routine in subsequent images.
    value

5  –  Associated OpenVMS Policy Function

    None.
Close Help