LocationArea Property

The name of the general location or area of a Post Office.

Syntax

 canadapostaddress.getLocationArea(index, [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 getLocationArea([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 setLocationArea([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 name of the general location or area of a Post Office. This is used to distinguish among various Post Office locations that have similar names. This is populated when FindLocations is called.

The size of the array is controlled by the LocationCount property.

This property is read-only and not available at design time.

Data Type

String