pDPSDocDelete

Deletes a file associated with a document or deletes a file directly.

Syntax

pDPSDocDelete ( in vlDocName,
                in vlFileName )

Parameters

vlDocName

The name of the document to be deleted.

vlFileName

The file name of the document to be deleted.

Comments

The pDPSDocDelete command can be used to delete the file associated with a document or it can be used to delete a specific file. vlDocName and vlFileName are either constants or expressions. The vlDocName parameter does not have to be  qualified (i.e. "MyDoc" and "zim.MyDoc" are both acceptable).

If vlDocName is neither blank nor $NULL, then the document name is looked up in the Object Dictionary to find the associated file name. If vlDocName is not a qualified name, then the file name for the first document found in the Object Dictionary with the indicated document name is used. If vlDocName is blank or $NULL, then <FileName> is used as the file name.

If vlFileName starts with a special file name character (e.g. ")", "#", etc.) appropriate conversions are made.

The pDPSDocDelete command is compiled.

Example

To delete the contents of a document called MyDoc in directory zim, enter the following:

pDPSDocDelete ("zim.MyDoc", "")