FileSymLinkName Property

The symbolic link name, for a file that represents a symbolic link.

Syntax

 tar.getFileSymLinkName(index, [callback])
 tar.setFileSymLinkName(index,  fileSymLinkName, [callback])

Default Value

""

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 getFileSymLinkName([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 setFileSymLinkName([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

The symbolic link name, for a file that represents a symbolic link. If you specify FileSymLinkName the file will be added to the tar file as a symbolic link. You should specify the name of the link in FileCompressedName and the name of the linked file in FileSymLinkName.

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

This property is not available at design time.

Data Type

String