This documentation is archived and is not being maintained.

SqlCeCommand.SetRange Method

Note: This namespace, class, or member is supported only in version 1.1 of the .NET Framework.

Restricts the set of rows that will be read by the SqlCeDataReader.

[Visual Basic]
Public Sub SetRange( _
   ByVal dbRangeOptions As DbRangeOptions, _
   ByVal startData() As Object, _
   ByVal endData() As Object _
)
[C#]
public void SetRange(
 DbRangeOptions dbRangeOptions,
 object[] startData,
 object[] endData
);
[C++]
public: void SetRange(
 DbRangeOptions dbRangeOptions,
 Object* startData __gc[],
 Object* endData __gc[]
);
[JScript]
public function SetRange(
   dbRangeOptions : DbRangeOptions,
 startData : Object[],
 endData : Object[]
);

Parameters

dbRangeOptions
The options used when specifying the range.
startData
The starting key values for the range.
endData
The ending key values for the range.

Exceptions

Exception Type Condition
InvalidOperationException IndexName property has not been set.

Remarks

This method is intended to be a faster alternative to a SELECT statement for retrieving a set of rows from a base table. Instead of a WHERE clause in a SELECT statement, SetRange can be used to quickly retrieve a set of rows based on their index values. For example, to retrieve a set of employees with an employee ID between 1 and 5, you could execute a SELECT statement, but setting a range of 1 to 5 on the employee ID index will greatly improve performance.

This method can only be used when CommandType is set to TableDirect, CommandText is set to a valid base table name, and IndexName is set to a valid index name on the specified base table. When SetRange is used, the SqlCeDataReader returned from ExecuteReader will only return rows whose key values in the specified index match the range.

When Seek is used on a SqlCeDataReader that has a range, Seek will only position on rows in the specified range. For detailed information on SetRange, see the "IRowsetIndex::SetRange" topic in the OLE DB documentation.

Requirements

Platforms: .NET Compact Framework

.NET Framework Security: 

See Also

SqlCeCommand Class | SqlCeCommand Members | System.Data.SqlServerCe Namespace

Show: