CustomsFormInstructions Property

Image of customs form instructions.

Syntax

 uspsshipintl.getCustomsFormInstructions([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 getCustomsFormInstructions([callback]) method is defined as:

function(err, buffer){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'buffer' is the value returned by the method.

The callback for the setCustomsFormInstructions([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 is the decoded binary image file of the customs form instructions, stored in memory. This instruction page is returned in the format specified by the LabelImageType property. If the CustomsFormInstructionsFile property is set to a path and filename, the page is also saved to disk.

This property is filled after a call to the GetFormCP72 or GetFormCN22 methods.

This property is read-only.

Data Type

Buffer