Click or drag to resize

IObjectDbEsentListByIndexT Method (String, SeekType, Object)

Lists (enumerates) all objects of a type over an alternative key index starting at a specified seek position.

Namespace:  Orthogonal.ObjectDb.Esent
Assembly:  Orthogonal.ObjectDb.Esent (in Orthogonal.ObjectDb.Esent.dll) Version: 4.0.0
Syntax
C#
Copy
IEnumerable<T> ListByIndex<T>(
	string propertyIndexName,
	SeekType seek,
	Object seekValue
)
where T : class, new()

Parameters

propertyIndexName
Type: SystemString
The name of the property of type T containing the alternative key index values.
seek
Type: Orthogonal.ObjectDb.EsentSeekType
The seek comparison condition.
seekValue
Type: SystemObject
The alternative key index value to seek.

Type Parameters

T
The type of the object to list.

Return Value

Type: IEnumerableT
An enumerable set of objects of the specified type. If the seek condition fails the returned set will be empty, otherwise the returned objects start at the one that matched the seek condition and continue to the end of the alternative key index.
Exceptions
ExceptionCondition
ArgumentNullException Thrown if propertyIndexName or seekValue is null.
InvalidOperationException Thrown if propertyIndexName is not a property of type T.
InvalidOperationException Thrown if propertyIndexName satisifes any of the following conditions.
  • Type T does not have the property name.
  • The property is already part of the primary key.
  • The property is a "blob" type, one that can potentially hold large amounts of information that cannot be efficiently indexed.
See Also