Click or drag to resize
ClientFileDownloadAs Method
Downloads the specified file from the MOVEit Transfer system into a file with the specified full path.

Namespace: MOVEit.DMZ.API
Assembly: MOVEit.DMZ.API (in MOVEit.DMZ.API.dll) Version: 9.0.0.0
Syntax
public bool FileDownloadAs(
	string MOVEitPath,
	string LocalPath
)

Parameters

MOVEitPath
Type: SystemString
Path or ID of the file on the MOVEit Transfer host to download.
LocalPath
Type: SystemString
Path of the file on the local filesystem to save the file to.

Return Value

Type: Boolean
true if successful; otherwise, false.
Remarks

If a file with the same local path already exists, it will be overwritten. Use this function if you want to download files from MOVEit Transfer and rename them.

NOTE: During the file download process, the file data is stored to a temporary file (the file name with .tmp appended). When the download is complete, the temporary file is renamed to the correct filename. If the download is interrupted, the temporary file will remain. If this function finds a temporary copy of the downloaded file, it will automatically resume the download, copying only the data needed to complete the transfer from the MOVEit Transfer server. This keeps API from having to start large dowloads again from the beginning if a download is interrupted.

See Also