DocumentFileName Property
Specifies where the file will be written.
Syntax
upsfreightship.getDocumentFileName(index, [callback]) upsfreightship.setDocumentFileName(index, documentFileName, [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 getDocumentFileName([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 setDocumentFileName([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
Specifies where the file will be written. This property must be set before calling GetShipmentDocuments. It should contain the full path and filename to which the returned document will be written when GetShipmentDocuments is called.
The size of the array is controlled by the DocumentCount property.
This property is not available at design time.
Data Type
String