ArtWrh::SwapKey (Interface: ArtWrh)
 
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
CreateArtWrh
Browse
View
The possible keys (and their numerical value) can be found in the SeekBy-methods of this interface.
 
Samples
 
C++
 
// Browse for an article warehouse, which positions the file by a key that is unknown
pArtWrh->Browse (VARIANT_FALSE);
// Swap the key to 'AWH_ART' (1), positioning by the article number
pArtWrh->SwapKey (1);
// Show the selected article warehouse (you can then navigate through the file using the key 'AWH_ART')
pArtWrh->View ();

C#
 
// Browse for an article warehouse, which positions the file by a key that is unknown
oArtWrh.Browse (false);
// Swap the key to 'AWH_ART' (1), positioning by the article number
oArtWrh.SwapKey (1);
// Show the selected article warehouse (you can then navigate through the file using the key 'AWH_ART')
oArtWrh.View ();

VBS
 
' Browse for an article warehouse, which positions the file by a key that is unknown
Call oArtWrh.Browse(False)
' Swap the key to 'AWH_ART' (1), positioning by the article number
Call oArtWrh.SwapKey(1)
' Show the selected article warehouse (you can then navigate through the file using the key 'AWH_ART')
Call oArtWrh.View()

VB.NET
 
' Browse for an article warehouse, which positions the file by a key that is unknown
oArtWrh.Browse(False)
' Swap the key to 'AWH_ART' (1), positioning by the article number
oArtWrh.SwapKey(1)
' Show the selected article warehouse (you can then navigate through the file using the key 'AWH_ART')
oArtWrh.View()