YetaWF.DataProvider.File Package Documentation

Display
Print

YetaWF.DataProvider.FileDataProvider<KEYTYPE,OBJTYPE>.GetRecordsAsync Method

Retrieves a collection of records using filtering criteria with sorting, with support for paging.

Class: YetaWF.DataProvider.FileDataProvider<KEYTYPE,OBJTYPE>
Namespace: YetaWF.DataProvider
Assembly: YetaWF.DataProvider.File

Syntax

public Task<YetaWF.Core.DataProvider.DataProviderGetRecords<OBJTYPE>> GetRecordsAsync(
    int skip,
    int take,
    List<YetaWF.Core.DataProvider.DataProviderSortInfo> sort,
    List<YetaWF.Core.DataProvider.DataProviderFilterInfo> filters,
    List<YetaWF.Core.DataProvider.JoinData> Joins = null );

Parameters

skip

The number of records to skip (paging support).

take

The number of records to retrieve (paging support). If more records are available they are dropped.

sort

A collection describing the sort order.

filters

A collection describing the filtering criteria.

Joins

A collection describing the dataset joins. Not supported by file data providers. Must be null for file data providers.

Return Value

Returns a YetaWF.Core.DataProvider.DataProviderGetRecords object describing the data returned.

See Also YetaWF.DataProvider.FileDataProvider<KEYTYPE,OBJTYPE> ClassYetaWF.DataProvider.FileYetaWF.Core