Book::SwapKey (Interface: Book)
 
Swaps the file to another key.
 
VARIANT_BOOL SwapKey (
    SHORT sKeyNum
)
 
Parameters
sKeyNum
[in] The number of the key by which you want the file positioned.
 
Return value
True if the file was positioned according to the given key, otherwise false (e.g. if the current record is a null value for the given key or if an invalid sKeyNum was supplied).
 
See Also
CreateBook
Browse
View
The possible keys (and their numerical value) can be found in the SeekBy-methods of this interface.
 
Samples
 
C++
 
// Browse for a book, which positions the file by a key that is unknown
pBook->Browse (VARIANT_FALSE);
// Swap the key to 'BOO_BOO' (1), positioning by the book code
pBook->SwapKey (1);
// Show the selected book (you can then navigate through the file using the key 'BOO_BOO')
pBook->View ();

C#
 
// Browse for a book, which positions the file by a key that is unknown
oBook.Browse (false);
// Swap the key to 'BOO_BOO' (1), positioning by the book code
oBook.SwapKey (1);
// Show the selected book (you can then navigate through the file using the key 'BOO_BOO')
oBook.View ();

VBS
 
' Browse for a book, which positions the file by a key that is unknown
Call oBook.Browse(False)
' Swap the key to 'BOO_BOO' (1), positioning by the book code
Call oBook.SwapKey(1)
' Show the selected book (you can then navigate through the file using the key 'BOO_BOO')
Call oBook.View()

VB.NET
 
' Browse for a book, which positions the file by a key that is unknown
oBook.Browse(False)
' Swap the key to 'BOO_BOO' (1), positioning by the book code
oBook.SwapKey(1)
' Show the selected book (you can then navigate through the file using the key 'BOO_BOO')
oBook.View()