 | ChannelRequestFile Method (String, String, Boolean, Boolean, String, String) |
Request downloading a file from the server.
Namespace:
TeamSpeak.Sdk.Client
Assembly:
TeamSpeak.Sdk (in TeamSpeak.Sdk.dll) Version: 0.1.6124.20226 (0.1.0.0)
Syntaxpublic FileTransfer RequestFile(
string fileName,
string destinationDirectory,
bool overwrite,
bool resume,
string channelPassword,
string returnCode
)
Public Function RequestFile (
fileName As String,
destinationDirectory As String,
overwrite As Boolean,
resume As Boolean,
channelPassword As String,
returnCode As String
) As FileTransfer
public:
FileTransfer^ RequestFile(
String^ fileName,
String^ destinationDirectory,
bool overwrite,
bool resume,
String^ channelPassword,
String^ returnCode
)
member RequestFile :
fileName : string *
destinationDirectory : string *
overwrite : bool *
resume : bool *
channelPassword : string *
returnCode : string -> FileTransfer
Parameters
- fileName
- Type: SystemString
Filename of the remote file, which is to be downloaded. - destinationDirectory
- Type: SystemString
Local target directory name where the download file should be saved. - overwrite
- Type: SystemBoolean
when false, download will abort if local file exists - resume
- Type: SystemBoolean
If we have a previously halted transfer: true = resume, false = restart transfer - channelPassword
- Type: SystemString
Optional channel password. Pass empty string or null if unused. - returnCode
- Type: SystemString
a custom string. The ServerError-Event will receive the same custom string in its returnCode parameter. If no error occurred, ServerError will indicate success by passing Ok.
Return Value
Type:
FileTransferA FileTransfer that represents the asynchronous download operation.
See Also