GetFileTablePreviewAsync Method
Overloads
| GetFileTablePreviewAsync(String, String, FileDataFormat, String) |
Lists the values in a table for a folder connection. FileTypeRecognized file formats are: * * * * * * * * * * * * |
|
| GetFileTablePreviewAsync(AsyncHandle, String, String, FileDataFormat, String) |
Lists the values in a table for a folder connection. FileTypeRecognized file formats are: * * * * * * * * * * * * |
|
| GetFileTablePreviewAsync<T>(AsyncHandle, Func<Response, T>, String, String, FileDataFormat, String) |
Lists the values in a table for a folder connection. FileTypeRecognized file formats are: * * * * * * * * * * * * |
GetFileTablePreviewAsync(String, String, FileDataFormat, String)
Lists the values in a table for a folder connection.
FileType
Recognized file formats are:
- CSV for Delimited
- FIX for Fixed Record
- DIF for Data Interchange Format
- EXCEL_BIFF for Microsoft Excel (XLS)
- EXCEL_OOXML for Microsoft Excel (XLSX)
- HTML for HTML
- QVD for QVD file
- XML for XML
- QVX for QVX file
- JSON for JSON format
- KML for KML file
- PARQUET for PARQUET file
Declaration
public Task<GetFileTablePreviewResult> GetFileTablePreviewAsync([QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null, [QixName("qDataFormat")] FileDataFormat dataFormat, [QixName("qTable")] string table)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | connectionId |
Identifier of the connection. |
| System.String | relativePath |
Path of the connection file. |
| FileDataFormat | dataFormat |
Type of the file. |
| System.String | table |
Name of the table.
This parameter must be set for |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<GetFileTablePreviewResult> |
Implements
GetFileTablePreviewAsync(AsyncHandle, String, String, FileDataFormat, String)
Lists the values in a table for a folder connection.
FileType
Recognized file formats are:
- CSV for Delimited
- FIX for Fixed Record
- DIF for Data Interchange Format
- EXCEL_BIFF for Microsoft Excel (XLS)
- EXCEL_OOXML for Microsoft Excel (XLSX)
- HTML for HTML
- QVD for QVD file
- XML for XML
- QVX for QVX file
- JSON for JSON format
- KML for KML file
- PARQUET for PARQUET file
Declaration
public Task<GetFileTablePreviewResult> GetFileTablePreviewAsync(AsyncHandle asyncHandle, [QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null, [QixName("qDataFormat")] FileDataFormat dataFormat, [QixName("qTable")] string table)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.String | connectionId |
Identifier of the connection. |
| System.String | relativePath |
Path of the connection file. |
| FileDataFormat | dataFormat |
Type of the file. |
| System.String | table |
Name of the table.
This parameter must be set for |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<GetFileTablePreviewResult> |
Implements
GetFileTablePreviewAsync<T>(AsyncHandle, Func<Response, T>, String, String, FileDataFormat, String)
Lists the values in a table for a folder connection.
FileType
Recognized file formats are:
- CSV for Delimited
- FIX for Fixed Record
- DIF for Data Interchange Format
- EXCEL_BIFF for Microsoft Excel (XLS)
- EXCEL_OOXML for Microsoft Excel (XLSX)
- HTML for HTML
- QVD for QVD file
- XML for XML
- QVX for QVX file
- JSON for JSON format
- KML for KML file
- PARQUET for PARQUET file
Declaration
public Task<T> GetFileTablePreviewAsync<T>(AsyncHandle asyncHandle, Func<Response, T> onResult, [QixName("qConnectionId")] string connectionId, [QixName("qRelativePath")] string relativePath = null, [QixName("qDataFormat")] FileDataFormat dataFormat, [QixName("qTable")] string table)
Parameters
| Type | Name | Description |
|---|---|---|
| AsyncHandle | asyncHandle |
Handle to asynchronous method request |
| System.Func<Response, T> | onResult |
Continuation function |
| System.String | connectionId |
Identifier of the connection. |
| System.String | relativePath |
Path of the connection file. |
| FileDataFormat | dataFormat |
Type of the file. |
| System.String | table |
Name of the table.
This parameter must be set for |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<T> |
Type Parameters
| Name | Description |
|---|---|
| T |