Connection.removeFile(options)

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description	Removes a file.
Returns	void
Supported Script Types	Server scripts For more information, see SuiteScript 2.x Script Types.
Governance	10 units
Module	N/sftp Module
Since	2019.2

Parameters

Note:

The options parameter is a JavaScript object.

Parameter	Type	Required / Optional	Description	Since
options.path	String	required	The relative path of the directory location where this file should be removed.	2019.2

Errors

Error Code	Thrown If
FTP_PERMISSION_DENIED	Access to the file or directory on the remote FTP server was denied.
FTP_NO_SUCH_FILE_OR_DIRECTORY	The file or directory does not exist.

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/sftp Module Script Samples.

          //Add additional code
...

objConnection.removeFile({
    path: 'relative/path/test
});
...
//Add additional code 

        

Related Topics

sftp.Connection

N/sftp Module

SuiteScript 2.x Modules

SuiteScript 2.x

General Notices