AddFileComponentFromPath

<< Fare clic per visualizzazione il sommario >>

Percorso:  API di piattaforma > Servizi Core > Jamio Document >

AddFileComponentFromPath

Service

JamioDocument

 

Method

AddFileComponentFromPath

 

Description

Adds a new FileComponent to a Document.

 

Input

Name

Description

Type

Optional

serverAddress

Server address for an external Domain (Null or Empty for the current Domain).

String

Y

token

The session token (for the current session in the current Domain may be null or empty).

String

Y

ownerReference

Reference of the owner document.

Reference

 

component

An initialized FileComponent.

Object of type File Component or custom type of type File Component

 

filePath

The file path.

String

 

Output

Name

Description

Type

Optional

returnValue

The initialized Document resource.

Reference

 

 

Remarks

The file name of file component is checked and if it is not a valid name it is modified according to the following criteria:

- if it is null, empty, or containing only spaces, it is set to "No_Name";

- if it contains invalid characters, these are replaced by the "_" character;

- if the name (without the extension) is a reserved name ("NUL", "PRN", "COM1", etc.), the "_" character is appended to the name;

- if the name has an extension, and this is longer than 253 characters, it is truncated to 253 characters;

- if the total length of the name (including any extension) is greater than 255 characters, the part of the name without the possible extension is truncated to a length of (255 - possible length of the extension with the point).