Skip to main content
Version: 4.2.5

IFilterQuery.GetKeysAsync Method

Asynchronously gets the keys of the entities resulting from this query.

Overloads

NameDescription
GetKeysAsync()Gets the keys of the entities resulting from this query. Note that multiple calls to this method will always return the same set of keys.
GetKeysAsync(int)Gets the keys of the entities resulting from this query, starting at the specified start index.
GetKeysAsync(int, int)Gets the specified number of keys of the entities resulting from this query, starting at the specified start index.

GetKeysAsync() Method

Gets the keys of the entities resulting from this query. Note that multiple calls to this method will always return the same set of keys.

System.Collections.Generic.IAsyncEnumerable<iCore.Public.Types.IEntityKey> GetKeysAsync();

Returns

System.Collections.Generic.IAsyncEnumerable<IEntityKey>
An enumerator that allows foreach to be used to process the keys in this collection.

GetKeysAsync(int) Method

Gets the keys of the entities resulting from this query, starting at the specified start index.

System.Collections.Generic.IAsyncEnumerable<iCore.Public.Types.IEntityKey> GetKeysAsync(int start);

Parameters

start int
The zero-based start index to start enumeration from.

Returns

System.Collections.Generic.IAsyncEnumerable<IEntityKey>
An enumerator that allows foreach to be used to process the keys in this collection.

Exceptions

IndexOutOfRangeException
start is negative or greater than the number of items in the result set.

Remarks

Note that multiple calls to this method will always return the same set of keys.

GetKeysAsync(int, int) Method

Gets the specified number of keys of the entities resulting from this query, starting at the specified start index.

System.Collections.Generic.IAsyncEnumerable<iCore.Public.Types.IEntityKey> GetKeysAsync(int start, int count);

Parameters

start int
The zero-based start index to start enumeration from.

count int
The maximum number of items to retrieve.

Returns

System.Collections.Generic.IAsyncEnumerable<IEntityKey>
An enumerator that allows foreach to be used to process the keys in this collection.

Exceptions

IndexOutOfRangeException
start is negative or greater than the number of items in the result set.

Remarks

Note that multiple calls to this method will always return the same set of keys.