-
Notifications
You must be signed in to change notification settings - Fork 3
File
NationalInstruments.SystemLink.Clients.File
Uploads files to SystemLink.
Initializes a new file uploader which will communicate over HTTP using the configuration provided by SystemLink Client. The system must be either be registered to a SystemLink Server, or it must be a SystemLink server itself.
This constructor has no parameters.
Name | Description |
---|---|
NationalInstruments.SystemLink.Clients.Core.ApiException | if the current system cannot communicate with a SystemLink Server, |
or if the configuration provided by SystemLink Client cannot be found. |
Initializes a new file uploader which will communicate over HTTP using the configuration provided by configuration
.
Name | Type | Description |
---|---|---|
configuration | NationalInstruments.SystemLink.Clients.Core.IHttpConfiguration | Specifies the web server, authentication, and metadata to use for communication. |
Name | Description |
---|---|
System.ArgumentNullException | if configuration is null. |
Uploads a file to SystemLink.
The ID of the uploaded file.
Name | Type | Description |
---|---|---|
path | System.String | The absolute path of the file. |
Name | Description |
---|---|
System.ArgumentNullException | if path is null. |
System.ArgumentException | if path is empty. |
System.UnauthorizedAccessException | if the operating system denies access to path . |
System.IO.PathTooLongException | if path is longer than the system-defined maximum length. |
System.IO.DirectoryNotFoundException | if path contains a directory that cannot be found. |
System.IO.FileNotFoundException | if the file at path cannot be found. |
System.NotSupportedException | if path does not support the read operation. |
System.IO.IOException | if path cannot be accessed for any reason. |
NationalInstruments.SystemLink.Clients.Core.ApiException | if the File service API call fails. |
Uploads a file to SystemLink with metadata.
The ID of the uploaded file.
Name | Type | Description |
---|---|---|
path | System.String | The absolute path of the file. |
properties | System.Collections.Generic.IDictionary{System.String,System.String} | A set of user-customizable queryable key-value-pairs attached to this file. |
Name | Description |
---|---|
System.ArgumentNullException | if path is null. |
System.ArgumentException | if path is empty. |
System.UnauthorizedAccessException | if the operating system denies access to path . |
System.IO.PathTooLongException | if path is longer than the system-defined maximum length. |
System.IO.DirectoryNotFoundException | if path contains a directory that cannot be found. |
System.IO.FileNotFoundException | if the file at path cannot be found. |
System.NotSupportedException | if path does not support the read operation. |
System.IO.IOException | if path cannot be accessed for any reason. |
NationalInstruments.SystemLink.Clients.Core.ApiException | if the File service API call fails. |
Uploads stream data to SystemLink as a file.
The ID of the uploaded file.
Name | Type | Description |
---|---|---|
stream | System.IO.Stream | A stream of data to upload. |
name | System.String | The name of the file. |
Name | Description |
---|---|
System.ArgumentNullException | if stream or name is null. |
System.ArgumentException | if stream does not support the read operation. |
NationalInstruments.SystemLink.Clients.Core.ApiException | if the File service API call fails. |
System.IO.IOException | if an error occurrs when reading stream . |
Uploads stream data to SystemLink as a file, with metadata.
The ID of the uploaded file.
Name | Type | Description |
---|---|---|
stream | System.IO.Stream | A stream of data to upload. |
name | System.String | The name of the file. |
properties | System.Collections.Generic.IDictionary{System.String,System.String} | A set of user-customizable queryable key-value-pairs attached to this file. |
Name | Description |
---|---|
System.ArgumentNullException | if stream or name is null. |
System.ArgumentException | if stream does not support the read operation. |
NationalInstruments.SystemLink.Clients.Core.ApiException | if the File service API call fails. |
System.IO.IOException | if an error occurrs when reading stream . |
Asynchronously uploads a file to SystemLink.
The ID of the uploaded file.
Name | Type | Description |
---|---|---|
path | System.String | The absolute path of the file. |
Name | Description |
---|---|
System.ArgumentNullException | if path is null. |
System.ArgumentException | if path is empty. |
System.UnauthorizedAccessException | if the operating system denies access to path . |
System.IO.PathTooLongException | if path is longer than the system-defined maximum length. |
System.IO.DirectoryNotFoundException | if path contains a directory that cannot be found. |
System.IO.FileNotFoundException | if the file at path cannot be found. |
System.NotSupportedException | if path does not support the read operation. |
System.IO.IOException | if path cannot be accessed for any reason. |
NationalInstruments.SystemLink.Clients.Core.ApiException | if the File service API call fails. |
Asynchronously uploads a file to SystemLink with metadata.
The ID of the uploaded file.
Name | Type | Description |
---|---|---|
path | System.String | The absolute path of the file. |
properties | System.Collections.Generic.IDictionary{System.String,System.String} | A set of user-customizable queryable key-value-pairs attached to this file. |
Name | Description |
---|---|
System.ArgumentNullException | if path is null. |
System.ArgumentException | if path is empty. |
System.UnauthorizedAccessException | if the operating system denies access to path . |
System.IO.PathTooLongException | if path is longer than the system-defined maximum length. |
System.IO.DirectoryNotFoundException | if path contains a directory that cannot be found. |
System.IO.FileNotFoundException | if the file at path cannot be found. |
System.NotSupportedException | if path does not support the read operation. |
System.IO.IOException | if path cannot be accessed for any reason. |
NationalInstruments.SystemLink.Clients.Core.ApiException | if the File service API call fails. |
Asynchronously uploads stream data to SystemLink as a file.
The ID of the uploaded file.
Name | Type | Description |
---|---|---|
stream | System.IO.Stream | A stream of data to upload. |
name | System.String | The name of the file. |
Name | Description |
---|---|
System.ArgumentNullException | if stream or name is null. |
System.ArgumentException | if stream does not support the read operation. |
NationalInstruments.SystemLink.Clients.Core.ApiException | if the File service API call fails. |
System.IO.IOException | if an error occurrs when reading stream . |
Asynchronously uploads stream data to SystemLink as a file, with metadata.
The ID of the uploaded file.
Name | Type | Description |
---|---|---|
stream | System.IO.Stream | A stream of data to upload. |
name | System.String | The name of the file. |
properties | System.Collections.Generic.IDictionary{System.String,System.String} | A set of user-customizable queryable key-value-pairs attached to this file. |
Name | Description |
---|---|
System.ArgumentNullException | if stream or name is null. |
System.ArgumentException | if stream does not support the read operation. |
NationalInstruments.SystemLink.Clients.Core.ApiException | if the File service API call fails. |
System.IO.IOException | if an error occurrs when reading stream . |
NationalInstruments.SystemLink.Clients.File
Uploads files to SystemLink.
Uploads a file to SystemLink.
The ID of the uploaded file.
Name | Type | Description |
---|---|---|
path | System.String | The absolute path of the file. |
Name | Description |
---|---|
System.ArgumentNullException | if path is null. |
System.ArgumentException | if path is empty. |
System.UnauthorizedAccessException | if the operating system denies access to path . |
System.IO.PathTooLongException | if path is longer than the system-defined maximum length. |
System.IO.DirectoryNotFoundException | if path contains a directory that cannot be found. |
System.IO.FileNotFoundException | if the file at path cannot be found. |
System.NotSupportedException | if path does not support the read operation. |
System.IO.IOException | if path cannot be accessed for any reason. |
NationalInstruments.SystemLink.Clients.Core.ApiException | if the File service API call fails. |
Uploads a file to SystemLink with metadata.
The ID of the uploaded file.
Name | Type | Description |
---|---|---|
path | System.String | The absolute path of the file. |
properties | System.Collections.Generic.IDictionary{System.String,System.String} | A set of user-customizable queryable key-value-pairs attached to this file. |
Name | Description |
---|---|
System.ArgumentNullException | if path is null. |
System.ArgumentException | if path is empty. |
System.UnauthorizedAccessException | if the operating system denies access to path . |
System.IO.PathTooLongException | if path is longer than the system-defined maximum length. |
System.IO.DirectoryNotFoundException | if path contains a directory that cannot be found. |
System.IO.FileNotFoundException | if the file at path cannot be found. |
System.NotSupportedException | if path does not support the read operation. |
System.IO.IOException | if path cannot be accessed for any reason. |
NationalInstruments.SystemLink.Clients.Core.ApiException | if the File service API call fails. |
Uploads stream data to SystemLink as a file.
The ID of the uploaded file.
Name | Type | Description |
---|---|---|
stream | System.IO.Stream | A stream of data to upload. |
name | System.String | The name of the file. |
Name | Description |
---|---|
System.ArgumentNullException | if stream or name is null. |
System.ArgumentException | if stream does not support the read operation. |
NationalInstruments.SystemLink.Clients.Core.ApiException | if the File service API call fails. |
System.IO.IOException | if an error occurrs when reading stream . |
Uploads stream data to SystemLink as a file, with metadata.
The ID of the uploaded file.
Name | Type | Description |
---|---|---|
stream | System.IO.Stream | A stream of data to upload. |
name | System.String | The name of the file. |
properties | System.Collections.Generic.IDictionary{System.String,System.String} | A set of user-customizable queryable key-value-pairs attached to this file. |
Name | Description |
---|---|
System.ArgumentNullException | if stream or name is null. |
System.ArgumentException | if stream does not support the read operation. |
NationalInstruments.SystemLink.Clients.Core.ApiException | if the File service API call fails. |
System.IO.IOException | if an error occurrs when reading stream . |
Asynchronously uploads a file to SystemLink.
The ID of the uploaded file.
Name | Type | Description |
---|---|---|
path | System.String | The absolute path of the file. |
Name | Description |
---|---|
System.ArgumentNullException | if path is null. |
System.ArgumentException | if path is empty. |
System.UnauthorizedAccessException | if the operating system denies access to path . |
System.IO.PathTooLongException | if path is longer than the system-defined maximum length. |
System.IO.DirectoryNotFoundException | if path contains a directory that cannot be found. |
System.IO.FileNotFoundException | if the file at path cannot be found. |
System.NotSupportedException | if path does not support the read operation. |
System.IO.IOException | if path cannot be accessed for any reason. |
NationalInstruments.SystemLink.Clients.Core.ApiException | if the File service API call fails. |
Asynchronously uploads a file to SystemLink with metadata.
The ID of the uploaded file.
Name | Type | Description |
---|---|---|
path | System.String | The absolute path of the file. |
properties | System.Collections.Generic.IDictionary{System.String,System.String} | A set of user-customizable queryable key-value-pairs attached to this file. |
Name | Description |
---|---|
System.ArgumentNullException | if path is null. |
System.ArgumentException | if path is empty. |
System.UnauthorizedAccessException | if the operating system denies access to path . |
System.IO.PathTooLongException | if path is longer than the system-defined maximum length. |
System.IO.DirectoryNotFoundException | if path contains a directory that cannot be found. |
System.IO.FileNotFoundException | if the file at path cannot be found. |
System.NotSupportedException | if path does not support the read operation. |
System.IO.IOException | if path cannot be accessed for any reason. |
NationalInstruments.SystemLink.Clients.Core.ApiException | if the File service API call fails. |
Asynchronously uploads stream data to SystemLink as a file.
The ID of the uploaded file.
Name | Type | Description |
---|---|---|
stream | System.IO.Stream | A stream of data to upload. |
name | System.String | The name of the file. |
Name | Description |
---|---|
System.ArgumentNullException | if stream or name is null. |
System.ArgumentException | if stream does not support the read operation. |
NationalInstruments.SystemLink.Clients.Core.ApiException | if the File service API call fails. |
System.IO.IOException | if an error occurrs when reading stream . |
Asynchronously uploads stream data to SystemLink as a file, with metadata.
The ID of the uploaded file.
Name | Type | Description |
---|---|---|
stream | System.IO.Stream | A stream of data to upload. |
name | System.String | The name of the file. |
properties | System.Collections.Generic.IDictionary{System.String,System.String} | A set of user-customizable queryable key-value-pairs attached to this file. |
Name | Description |
---|---|
System.ArgumentNullException | if stream or name is null. |
System.ArgumentException | if stream does not support the read operation. |
NationalInstruments.SystemLink.Clients.Core.ApiException | if the File service API call fails. |
System.IO.IOException | if an error occurrs when reading stream . |