RmDir Method (FTP)

10.2, PLBCMP GUI Only

The RmDir method removes a directory that is located on the FTP server. This method uses the following format:

[label]

{object}.RmDir

[GIVING {return}] USING [*Path=]{path}

Where:

label

object

Required. A FTP that has been declared.

return

Optional. A Numeric Variable that returns the pass or fail value for the operation of this method.

path

Required. A Character String Variable or string literal that specifies the directory/path that exists on the FTP server to be removed.

Flags Affected: OVER, ZERO

Note the following:

The ZERO flag is set if the {return} value is zero which indicates that the method executed successfully.
The OVER flag is set if the {return} variable is too small to receive the pass/fail value without being truncated.
Debug log entries are generated if the debug logging is enabled. See the FTP Debug Method description to enable debug logging.
If this method fails, the {return} variable contains a value of two (2).

See Also: FTP Control Methods, Method Syntax