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

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

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

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