 | ChannelMoveFile Method (String, String, String) |
Moves or renames a file. If the source and target paths are the same, the file will simply be renamed.
Namespace:
TeamSpeak.Sdk.Client
Assembly:
TeamSpeak.Sdk (in TeamSpeak.Sdk.dll) Version: 0.1.6124.20226 (0.1.0.0)
Syntaxpublic Task MoveFile(
string file,
string toFile,
string channelPassword = null
)
Public Function MoveFile (
file As String,
toFile As String,
Optional channelPassword As String = Nothing
) As Task
public:
Task^ MoveFile(
String^ file,
String^ toFile,
String^ channelPassword = nullptr
)
member MoveFile :
file : string *
toFile : string *
?channelPassword : string
(* Defaults:
let _channelPassword = defaultArg channelPassword null
*)
-> Task
Parameters
- file
- Type: SystemString
Old name of the file. The file name needs to include the full path within the channel, e.g. “/file” for a top-level file or “/dir1/dir2/file” for a file located in a subdirectory. - toFile
- Type: SystemString
New name of the file. The new name needs to include the full path within the channel, e.g. “/file” for a top-level file or “/dir1/dir2/file” for a file located in a subdirectory. - channelPassword (Optional)
- Type: SystemString
Optional channel password. Pass empty string or null if unused.
Return Value
Type:
TaskA task that represents the asynchronous operation.
See Also