Uploads a local file into the specified remote location.
Namespace: ININ.IceLib.ConnectionAssembly: ININ.IceLib (in ININ.IceLib.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public bool UploadFile( string localFileName, string remoteFileName, bool convertAudio ) |
Visual Basic |
---|
Public Function UploadFile ( _ localFileName As String, _ remoteFileName As String, _ convertAudio As Boolean _ ) As Boolean |
Parameters
- localFileName
- Type: System..::..String
The local file name.
- remoteFileName
- Type: System..::..String
The remote file name.
- convertAudio
- Type: System..::..Boolean
Convert to acceptable audio format. If falseFalsefalsefalse (False in Visual Basic), audio playback of this file may fail.
Return Value
trueTruetruetrue (True in Visual Basic) if the upload succeeded, falseFalsefalsefalse (False in Visual Basic) if it was cancelled.Remarks
Note that some types of server files are periodically purged for space reasons, so an uploaded
file may not exist for all time in the future.
Exceptions
Exception | Condition |
---|---|
System..::..ArgumentNullException | A parameter is nullNothingnullptra null reference (Nothing in Visual Basic). |
System..::..ArgumentException | A file name parameter had 0-length. |
ININ.IceLib.Connection..::..RequestTimeoutException | The request timed out while waiting for a response. |
ININ.IceLib.Connection..::..SessionDisconnectedException | The Session does not have a valid connection. |
System..::..ObjectDisposedException | The Session has been disposed. |
Version Information
Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 GA and beyond.