:RemoveFile()
Class
Syntax
:RemoveFile(cFilename, [hSession] ) -> lSuccess
Parameters
|
|
cFilename |
String that specifies the name of the remote file to delete. The file pathing and name conventions must be that of the remote host. |
|
|
hSession |
Optional: If hSession is not passed, the value in :Session will be used |
Return
Logical indicating Success.
Returns .T. if the operation succeeds, otherwise returns .F.
To get further error information see :nErr and :cErr
To see the remote server's response, see :GetResultCode() and :GetResultString().
Description
The :RemoveFile() method deletes the specified file from the remote host.
The current user must have the appropriate permission to delete the file, or an error will be returned by the server.
See Also
:GetFile(), :PutFile(), :RenameFile()