IPWorks Cloud 2020 Node.js Edition

Questions / Feedback?

StartByte Property

The byte offset from which to start download.

Syntax

 cloudstorage.getStartByte([callback])
 cloudstorage.setStartByte( startByte, [callback])

Default Value

0

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 getStartByte([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 setStartByte([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 may be set to resume a download. This specifies the offset in the file from which to resume. See Download for details about resuming downloads.

Note: Resuming uploads is not currently supported.

This property is not available at design time.

Data Type

Long64

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