InternationalFormsFile Property
Filename and location to save the InternationalForms to.
Syntax
upsshipintl.getInternationalFormsFile([callback]) upsshipintl.setInternationalFormsFile( internationalFormsFile, [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 getInternationalFormsFile([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 setInternationalFormsFile([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
When the InternationalFormsFile is set to a valid path and filename, the contents of the InternationalForms are written to disk upon successful response.
The InternationalFormsFile has to have .pdf extension.
Data Type
String