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

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

VBS
 
' Browse for a stock document, which positions the file by a key that is unknown
Call oStockDoc.Browse(False)
' Swap the key to 'STH_NUM' (1), positioning by book and document number
Call oStockDoc.SwapKey(1)
' Show the selected stock document (you can then navigate through the file using the key 'STH_NUM')
Call oStockDoc.View()

VB.NET
 
' Browse for a stock document, which positions the file by a key that is unknown
oStockDoc.Browse(False)
' Swap the key to 'STH_NUM' (1), positioning by book and document number
oStockDoc.SwapKey(1)
' Show the selected stock document (you can then navigate through the file using the key 'STH_NUM')
oStockDoc.View()