SqlCeDataReader::Seek Method

Visual Studio 2010

Places the SqlCeDataReader on the record with indexed values that match the specified parameters.

Namespace:  System.Data.SqlServerCe
Assembly:  System.Data.SqlServerCe (in System.Data.SqlServerCe.dll)

C#
C++
F#
JScript
VB
Copy 
[SecurityCriticalAttribute]
[SecurityTreatAsSafeAttribute]
[SecurityPermissionAttribute(SecurityAction::Assert, UnmanagedCode = true)]
public:
bool Seek(
	DbSeekOptions dbSeekOptions, 
	... array<Object^>^ index
)

Parameters

dbSeekOptions
Type: System.Data.SqlServerCe::DbSeekOptions
The DbSeekOptions to use.
index
Type: array<System::Object>
The index of the record.

Return Value

Type: System::Boolean
A Boolean value; true indicates the cursor is positioned on a row.

ExceptionCondition
SqlCeException

The value was not found, or another error occurred.

This method is intended to be a faster alternative to a SELECT statement for retrieving a row from a base table. Instead of a WHERE clause in a SELECT statement, Seek can be used to quickly retrieve a row based on its index value. For example, to retrieve an employee with an employee ID of 5, you could execute a SELECT statement, but using Seek with a value of 5 on the employee ID index will greatly improve performance.

Seek 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.

After using Seek, SqlCeDataReader will return the remaining rows in their index order. When Seek is used on a SqlCeDataReader that has a range specified by SetRange, Seek will only position on rows within the range. For more information, see the "IRowsetIndex::Seek" topic in the OLE DB documentation.

C#
VB
C++
Copy
No code example is currently available or this language may not be supported.
Show: