IPWorks Cloud 2020 Node.js Edition

Questions / Feedback?

ListBlocks Method

Lists the blocks associated with a block blob.

Syntax

azureblob.listBlocks(blockBlob, blockListType, [callback])

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 this 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 method lists the blocks associated with the specified BlockBlob in the container currently selected by Container. BlockListType indicates which block list(s) the server should return results from; possible values are:

Committed (0) Only committed blocks are listed. The blocks are returned in the same order that they were committed in by the most recent PutBlockList operation.
Uncommitted (1) Only uncommitted blocks are listed. The blocks are returned in alphabetical order by Id.
All (2) Both committed and uncommitted blocks are listed. The committed blocks are returned before the uncommitted blocks.

Alternatively, if Snapshot is non-empty, the committed blocks for the specified snapshot of BlockBlob are listed instead (and BlockListType is ignored).

Calling this method will fire the BlockList event once for each block, and will also repopulate the Block* properties.

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