DecodedFile Property

The filename of the decoded data.

Syntax

 netcode.getDecodedFile([callback])
 netcode.setDecodedFile( decodedFile, [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 getDecodedFile([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 setDecodedFile([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 contains the filename of the decoded data. When uuencoding, the value of FileName is the filename that will be written in EncodedData. If FileName is empty, the value of the DecodedFile property is taken, if a valid file has been specified. It is recommended that EncodedData contains the full path and FileName contains only the file name so that no problems occur while uudecoding in a foreign system.

When decoding, the class tries to generate the name for the created file in the following order: DecodedFile, FileName, or when the format is UUEncode, the specified filename in the uuencoded data itself. If DecodedFile or FileName end with a backslash "\" they are interpreted as directories and the class tries to create the given filename in this directory. If this is the case, FileName shows the name of the file that was created.

Data Type

String