Appendices > Appendix J: Job Status/Actions/API > Job Admin DLL Function List > Direct UJP Access Functions

Delete all instances of a specified $ command in the UJP

Inputs: Parm1 = UJP pathname
Parm2 = Command Name (with leading $)

Returns:  0 = success
         -1 = cannot lock UJP
         -2 = cannot open UJP
         -3 = cannot read UJP
         -4 = cannot write UJP
         -5 = UJP is an active job instance
         -6 = command does not start with $

This function deletes all instances of the specified $ command in the UJP. It is not an error if no such commands are present.

The value in parm2 should normally be simply the name of the command, with a leading $ sign. However the $fs_template command is an exception to this rule and should be followed by white space and then the appropriate next parameter to select specific template command instances for deletion. If no specific second parameter is included, all $fs_template commands will be deleted.

If the command name is given as $var_def, then $fs_template $var_def commands will also be deleted. The latter commands will always be modified to remove the '$fs_template' from the front.

Example:

Delete the fax header specification:

strcopy(parm1, "@FFJOBS\\00001234\\00000123\\JOBTYPE.UJP");

strcopy(parm2, "$fax_header");

res = JobDllEntry("DeleteCommands", parm1, parm2, 0);

Delete the fax send time:

strcopy(parm1, "@FFJOBS\\00001234\\00000123\\JOBTYPE.UJP");

strcopy(parm2, "$fs_template $fax_send_time");

res = JobDllEntry("DeleteCommands", parm1, parm2, 0);

Delete all retry delays:

strcopy(parm1, "@FFJOBS\\00001234\\00000123\\JOBTYPE.UJP");

strcopy(parm2, "$retry_delays");

res = JobDllEntry("DeleteCommands", parm1, parm2, 0);

Topic url: http://www.copia.com/support/refmanual/index.html?deletecommands.htm