File.path

Note:

The content in this help topic pertains to SuiteScript 2.0.

Property Description

The relative path to a file in the NetSuite File Cabinet.

Note:

If the folder is not set with the file.create(options) method, this property holds the file name until the File.folder property is defined.

This property is read-only.

Type

string

Supported Script Types

Server scripts

For more information, see SuiteScript 2.x Script Types.

Module

N/file Module

Since

2015.2

Errors

Error Code

Message

Thrown If

READ_ONLY_PROPERTY

You attempt to edit this property.

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/file Module Script Samples.

          //Add additional code 
...
var fileObj = file.load({
    id: 145
});
log.debug({
    details: "File Path: " + fileObj.path
});
...
 //Add additional code 

        

Related Topics

file.File
N/file Module
SuiteScript 2.x Modules
SuiteScript 2.x

General Notices