AIX | HP-UX | Linux | OS/2 | OS/390 | OS/400 | PTX | SUN | Win NT |
X | X | X | X | X | X | X | X | X |
Purpose
Deletes an entire file.
Format
@DTWF_REMOVE(filename, retry)
@DTWF_REMOVE(filename)
Parameters
Table 182. DTWF_REMOVE Parameters
Data Type | Parameter | Use | Description |
---|---|---|---|
string | filename | INOUT | The name of the file to delete. On successful completion of the call, this parameter returns the fully qualified file name. |
integer | retry | IN | The number of times to retry if the file cannot be deleted immediately. The default is not to retry. |
Return Codes
Table 183. DTWF_REMOVE Return Codes
Return Code | Explanation |
---|---|
-1001 | The server could not process a Net.Data request to allocate memory. |
1001 | An input parameter contained a NULL value. |
1002 | An input parameter contained a string value which consisted of the null-terminating character. |
1003 | An incorrect number of parameters were passed on a function call. |
1005 | A parameter passed on a function call, required to be a string variable, was of a different variable type. |
1006 | A literal string was passed on a function call for a parameter which was required to be an output parameter. |
1007 | A parameter contains a value which is not valid. |
2000 | A flat file interface built-in function could not find the specified file. |
2006 | A flat file interface built-in function could not access the specified file because it was in use by this or another process and could not be shared in the specified mode. |
Examples
Example 1:
%DEFINE myFile = "c:/private/myfile" @DTWF_REMOVE(myFile)
Example 2:
%DEFINE { myFile = "c:/private/myfile" myWait = "2000" %} @DTWF_REMOVE(myFile, myWait)