ClientFileUploadAs Method (String, String, String) |
Uploads the specified file into the specified MOVEit Transfer folder.
Namespace: MOVEit.DMZ.APIAssembly: MOVEit.DMZ.API (in MOVEit.DMZ.API.dll) Version: 9.0.0.0
Syntax public string FileUploadAs(
string LocalPath,
string MOVEitPath,
string Notes
)
Public Function FileUploadAs (
LocalPath As String,
MOVEitPath As String,
Notes As String
) As String
public:
String^ FileUploadAs(
String^ LocalPath,
String^ MOVEitPath,
String^ Notes
)
Parameters
- LocalPath
- Type: SystemString
Path of the file on the local filesystem to upload to the MOVEit Transfer host. - MOVEitPath
- Type: SystemString
Path of the file on the MOVEit Transfer host to upload to. - Notes
- Type: SystemString
Any notes to be included with the file.
Return Value
Type:
StringID of the newly uploaded file if successful; otherwise, "0".
Remarks
If a file of
the same name already exists in the MOVEit Transfer folder, it may not be overwritten;
the exact behavior of this function depends on the value of the "Allow Overwrite"
flag set on that particular folder. Use this function if you want to upload files
to MOVEit Transfer and rename them.
If a "Partial" file of the same name exists in the MOVEit Transfer folder, this function
will automatically execute a resumed upload, copying only the file data required to
complete the upload. This keeps API from having to start large uploads again from the
beginning if an upload is interrupted.
See Also