IPWorks SFTP 2020 Node.js Edition

Questions / Feedback?

DirListIsSymlink Property

This property indicates whether the entry is a symbolic link.

Syntax

 sftp.getDirListIsSymlink(index, [callback])

Default Value

FALSE

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getDirListIsSymlink([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setDirListIsSymlink([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

This property indicates whether the entry is a symbolic link. When the entry is a symbolic link the value of DirListIsDir will always be False since this information is not returned in the directory listing. To inspect a symlink to determine if it is a link to a file or folder set RemoteFile and query the FileAttributes.FileIsDir property.

The index parameter specifies the index of the item in the array. The size of the array is controlled by the DirListCount property.

This property is read-only and not available at design time.

Data Type

Boolean

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks SFTP 2020 Node.js Edition - Version 20.0 [Build 8263]