PackageCount Property

The number of records in the Package arrays.

Syntax

 canadapostrates.getPackageCount([callback])
 canadapostrates.setPackageCount( packageCount, [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 getPackageCount([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 setPackageCount([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

• PackageHeight
• PackageInsuredValue
• PackageLength
• PackageSignatureType
• PackageType
• PackageWeight
• PackageWidth

The array indices start at 0 and end at PackageCount-1.

This property is not available at design time.

Data Type

Integer