IPWorks Cloud 2020 Node.js Edition

Questions / Feedback?

BlockType Property

The type of block.

Syntax

 azureblob.getBlockType(index, [callback])
 azureblob.setBlockType(index,  blockType, [callback])

Possible Values

  0 (abktCommitted), 
  1 (abktUncommitted), 
  2 (abktLatest)

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 getBlockType([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 setBlockType([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 type of block.

When populated by ListBlocks, this property reflects the block's type (one of the first two values listed below). When used during a PutBlockList operation, this property specifies which block list the server should search for the block Id specified by BlockId.

Possible values are:

Value Meaning During PutBlockList Operations
abktCommitted (0) Search for a committed block with the specified Id.
abktUncommitted (1) Search for an uncommitted block with the specified Id.
abktLatest (2) Search for an uncommitted block with the specified Id; and then, if one isn't found, search for a committed block.

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

This property is not available at design time.

Data Type

Integer

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