HELPLIB.HLB  —  DCX Routines, DCX$EXPAND_DONE
    The DCX$EXPAND_DONE routine deletes the context area and sets the
    context variable to zero.

    Format

      DCX$EXPAND_DONE  context

1  –  Returns

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

    Longword condition value. Most utility routines return a
    condition value in R0. Condition values that this routine can
    return are listed under Condition Values Returned.

2  –  Argument

 context

    OpenVMS usage:context
    type:         longword (unsigned)
    access:       write only
    mechanism:    by reference
    Value identifying the data stream that DCX$EXPAND_DONE deletes.
    The context argument is the address of a longword containing this
    value. DCX$EXPAND_INIT initializes this value; you should not
    modify it. You can define multiple context arguments to identify
    multiple data streams that are processed simultaneously.

3  –  Description

    The DCX$EXPAND_DONE routine deletes the context area and sets
    the context variable to zero, thus undoing the work of the
    DCX$EXPAND_INIT routine. Call DCX$EXPAND_DONE when all data
    records have been expanded (using DCX$EXPAND_DATA).

4  –  Condition Values Returned

    DCX$_INVCTX        Error. The context variable is invalid, or the
                       context area is invalid or corrupted. This may
                       be caused by a failure to call the appropriate
                       routine to initialize the context variable or
                       by an application program error.
    DCX$NORMAL         Normal successful completion.

    This routine also returns any condition values returned by
    LIB$FREE_VM.
Close Help