The TPU$EDIT routine builds a command string from its parameters and passes it to the TPU$TPU routine. TPU$EDIT is another entry point to the TPU simplified callable interface. Format TPU$EDIT input ,output
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 – Arguments
input OpenVMS usage:char_string type: character string access: read only mechanism: by descriptor Input file name. The input argument is the address for a descriptor of a file specification. output OpenVMS usage:char_string type: character string access: read only mechanism: by descriptor Output file name. The output argument is the address for a descriptor of an output file specification. It is used with the /OUTPUT command qualifier.
3 – Description
This routine builds a command string and passes it to TPU$TPU. If the length of the output descriptor is nonzero, then the /OUTPUT qualifier is added to the command string. The /OUTPUT qualifier causes a file to be written to the specified file even if no modifications are made to the input file. If the QUIT built- in procedure is called, it prompts the user as if changes had been made to the buffer. This allows applications to check for the existence of the output file to see if the editing session was terminated, which is consistent with other OpenVMS callable editors. If your application parses information that is not related to the operation of TPU, make sure the application obtains and uses all non-TPU parse information before the application calls TPU$EDIT. Your application must do this because TPU$EDIT destroys all parse information obtained and stored before TPU$EDIT is called.
4 – Condition Values Returned
This routine returns the same values as TPU$TPU.