PartDecodedFile Property

The filename with the decoded data.

Syntax

 mime.getPartDecodedFile(index, [callback])
 mime.setPartDecodedFile(index,  partDecodedFile, [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 getPartDecodedFile([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 setPartDecodedFile([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 filename with the decoded data. Accessing this property for the first time after calling the DecodeFromString or DecodeFromFile method, directs the class to actually decode the part and save the data in a temporary file. The user is responsible for deleting the temporary file.

Setting a value to PartDecodedFile directs the component to calculate the file size and fill out the respective PartSize.

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

This property is not available at design time.

Data Type

String