Downloads a generated file (label, manifest, or form) by its path.

Procedure Specific Information

Downloads a generated file (label, manifest, or form) by its path components. The Dir, Subdir, and Filename parameters are required and are obtained from the file path returned by label or manifest endpoints. The file can be saved to a local path via DownloadLocation, written to a stream via FileStream, or returned as base64-encoded data in the FileData output column. The procedure is executed as below:

EXEC DownloadFile Dir = 'labels', Subdir = '2024', Filename = 'label-123.pdf', DownloadLocation = 'C:/temp/label.pdf'

EXEC DownloadFile Dir = 'labels', Subdir = '2024', Filename = 'label-123.pdf'

You can also supply an instance of an output stream in the FileStream parameter.

When neither DownloadLocation nor FileStream is supplied, the downloaded file is returned in the FileData output column as a base64-encoded string.

Input

Name	Type	Description
Dir	String	The directory component of the file path.
Subdir	String	The subdirectory component of the file path.
Filename	String	The filename to download.
Download	String	The download query parameter.
Rotation	Integer	The rotation angle to apply to the downloaded file.
DownloadLocation	String	The local full file path to save the downloaded file.

Result Set Columns

Name	Type	Description
FileData	String	The base64-encoded file data. Only populated if DownloadLocation and FileStream are not set.
Status	String	The status of the operation.