MoveMultipleKey Method (KeyValuePair(DatabaseEntry, DatabaseEntry), Boolean, Int32)

BerkeleyDB

previous page next page
Move the cursor to the specified key/data pair of the database, and store that key/data pair and as many ensuing key/data pairs that can fit in a buffer the size of BufferSize in CurrentMultipleKey. The cursor is positioned to a key/data pair if both the key and data match the values provided on the key and data parameters.

Namespace:  BerkeleyDB
Assembly:  libdb_dotnet48 (in libdb_dotnet48.dll) Version: 4.8.24.0

Syntax

C#
public bool MoveMultipleKey(
	KeyValuePair<DatabaseEntry, DatabaseEntry> pair,
	bool exact,
	int BufferSize
)
Visual Basic (Declaration)
Public Function MoveMultipleKey ( _
	pair As KeyValuePair(Of DatabaseEntry, DatabaseEntry), _
	exact As Boolean, _
	BufferSize As Integer _
) As Boolean
Visual C++
public:
bool MoveMultipleKey(
	KeyValuePair<DatabaseEntry^, DatabaseEntry^> pair, 
	bool exact, 
	int BufferSize
)

Parameters

pair
Type: System.Collections.Generic..::.KeyValuePair<(Of <(DatabaseEntry, DatabaseEntry>)>)
The key/data pair at which to position the cursor.
exact
Type: System..::.Boolean
If true, require the given key and data to match the key and data in the database exactly. If false, position the cursor at the smallest data value which is greater than or equal to the value provided by pair.Value (as determined by the comparison function).
BufferSize
Type: System..::.Int32
The size of a buffer to fill with key/data pairs. Must be at least the page size of the underlying database and be a multiple of 1024.

Return Value

True if the cursor was positioned successfully, false otherwise.

See Also

previous page start next page