TElWebDAVClient.UploadFile method

Discuss this help topic in SecureBlackbox Forum

TElWebDAVClient.UploadFile

Uploads a file to the server.

Declaration

[C#]
    void UploadFile(string LocalFileName, string URL, TElWebDAVLockList Locks, TElWebDAVErrorList Errors);
    void UploadFile(string LocalFileName, string URL, TSBFileTransferMode Mode, TElWebDAVLockList Locks, TElWebDAVErrorList Errors);
    void UploadFile(string LocalFileName, string URL, TSBFileTransferMode Mode, long RestartFrom, TElWebDAVLockList Locks, TElWebDAVErrorList Errors);

[VB.NET]
    Sub UploadFile(ByVal LocalFileName As String, ByVal URL As String, ByVal Locks As TElWebDAVLockList, ByVal Errors As TElWebDAVErrorList)
    Sub UploadFile(ByVal LocalFileName As String, ByVal URL As String, ByVal Mode As TSBFileTransferMode, ByVal Locks As TElWebDAVLockList, ByVal Errors As TElWebDAVErrorList)
    Sub UploadFile(ByVal LocalFileName As String, ByVal URL As String, ByVal Mode As TSBFileTransferMode, ByVal RestartFrom As Long, ByVal Locks As TElWebDAVLockList, ByVal Errors As TElWebDAVErrorList)

[Pascal]
    procedure UploadFile(LocalFileName, URL : string; Locks : TElWebDAVLockList; Errors : TElWebDAVErrorList);
    procedure UploadFile(LocalFileName, URL : string; Mode : TSBFileTransferMode; Locks : TElWebDAVLockList; Errors : TElWebDAVErrorList);
    procedure UploadFile(LocalFileName, URL : string; Mode : TSBFileTransferMode; RestartFrom : Int64; Locks : TElWebDAVLockList; Errors : TElWebDAVErrorList);

[C++]
    void UploadFile(const std::string &LocalFileName, const std::string &URL, TElWebDAVLockList &Locks, TElWebDAVErrorList &Errors);
    void UploadFile(const std::string &LocalFileName, const std::string &URL, TElWebDAVLockList *Locks, TElWebDAVErrorList *Errors);
    void UploadFile(const std::string &LocalFileName, const std::string &URL, TSBFileTransferMode Mode, TElWebDAVLockList &Locks, TElWebDAVErrorList &Errors);
    void UploadFile(const std::string &LocalFileName, const std::string &URL, TSBFileTransferMode Mode, TElWebDAVLockList *Locks, TElWebDAVErrorList *Errors);
    void UploadFile(const std::string &LocalFileName, const std::string &URL, TSBFileTransferMode Mode, int64_t RestartFrom, TElWebDAVLockList &Locks, TElWebDAVErrorList &Errors);
    void UploadFile(const std::string &LocalFileName, const std::string &URL, TSBFileTransferMode Mode, int64_t RestartFrom, TElWebDAVLockList *Locks, TElWebDAVErrorList *Errors);

[PHP]
    void UploadFile(string $LocalFileName, string $URL, TElWebDAVLockList $Locks, TElWebDAVErrorList $Errors)
    void UploadFile(string $LocalFileName, string $URL, integer $Mode, TElWebDAVLockList $Locks, TElWebDAVErrorList $Errors)
    void UploadFile(string $LocalFileName, string $URL, integer $Mode, integer $RestartFrom, TElWebDAVLockList $Locks, TElWebDAVErrorList $Errors)

[Java]
not available

Parameters

LocalFileName - the name of the file in the local file system.
URL - the URL of the new resource.
Locks - the list of locks to be put on the new resource.
Errors - the list of errors returned by the server.
Mode - specifies the file transfer mode.
RestartFrom - Specifies the position from which the data transfer should be resumed. Set to -1 to start from the beginning.

TSBFileTransferMode values

[.NET] [C++]	[Pascal]	Description
ftmOverwrite = 0	ftmOverwrite	The file will be overwritten
ftmSkip = 1	ftmSkip	The file will be skipped if the file with the same name exists
ftmAppendToEnd = 2	ftmAppend	All data from the source file isappended to the end of the destination file (if itexists). This mode is useful, for example, for updatingthe remote log file.
ftmResume = 3	ftmResume	Resumes the transfer of the file by transferring the data from the source file (starting from position specified in RestartFrom and up to the end) to the destination file (the data is written to position specified in RestartFrom ). This mode is used to resume the broken upload or download. In Resume mode the component compares the sizes of source and destination files (streams). If the size of the destination is smaller than the size of the source, the transfer is restarted from the position equal to the destination size (resuming the broken transfer). Resume mode doesn't compare file times, so your application should only use this mode if it (or the user) knows that the destination file is an incompletely transferred source file, and not, e.g., an older version of the same file.
ftmOverwriteIfDiffSize = 4	ftmOverwriteIfDiffSize	Defines a conditional overwrite onlywhen the file size is different. NOTE: file size isdetermined using the chosen transfer type (ascii/binary).In ASCII mode the file size can be determinedincorrectly, and you should not use conditionaloverwrite then.
ftmSaveWithNewName = 5	ftmSaveWithNewName	When a file has been transferred, and another file with the same name already exists, the new file will be saved with a new name.For each such file an OnFileNameChangeNeeded event is fired.
ftmRenameExistingTarget = 6	ftmRenameExistingTarget	In contrary to the ftmSaveWithNewName option, the existing file will be renamed, while the new file is saved under its original name.For each such file an OnFileNameChangeNeeded event is fired.

Description

Use this method to upload files to the server.