Uploads a stream 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 remoteFileName, BinaryReader reader, bool convertAudio, Object userState ) |
Visual Basic |
---|
Public Function UploadFile ( _ remoteFileName As String, _ reader As BinaryReader, _ convertAudio As Boolean, _ userState As Object _ ) As Boolean |
Parameters
- remoteFileName
- Type: System..::..String
The remote file name.
- reader
- Type: System.IO..::..BinaryReader
The reader.
- convertAudio
- Type: System..::..Boolean
Convert to acceptable audio format. If falseFalsefalsefalse (False in Visual Basic), audio playback of this file may fail.
- userState
- Type: System..::..Object
An object representing state for all events fired during this operation.
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 | The remoteFileNameThe request timed out while waiting for a response.The Session does not have a valid connection.The Session has been disposed. length is zero. |
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 4.0, supported for IC Server version 4.0 GA and beyond.