Artcl::SeekByFreeCat (Interface: Artcl)
 
Seeks an Article card by its free category.
 
VARIANT_BOOL SeekByFreeCat (
    enum eSeekMode eSeekMode,
    BSTR bsFreeCategory,
    BSTR bsNumber,
    BYTE byIndex
)
 
Key information
This method uses key number 10+index (See SwapKey).
This is a unique key.
 
Key segment information
Segment NameTypeOrderCollation
(pFreeCategory1+index)BSTRAscendingCase insensitive
pNumberBSTRAscendingHierarchy
 
Parameters
eSeekMode
[in] A value of the 'eSeekMode' enumeration.
bsFreeCategory
[in] The free category of the Article you want to seek.
bsNumber
[in] The number of the Article you want to seek.
byIndex
[in] The index of the free category you want to seek by. The value of this index must be 0 or 1.
 
Return value
True if the record with the given properties was found, otherwise false.
 
See Also
CreateArtcl
GetDBStatus
GetNext
 
Samples
 
C++
 
// Seek all articles of which the free category 2 = 'Yellow'
CString strCateg = "Yellow";
pArtcl->SeekByFreeCat (smGreaterOrEqual, (LPCSTR)strCateg, "", 1);
while (pArtcl->GetDBStatus () == 0 && (CString)pArtcl->pFreeCategory2 == strCateg)
{
    // Process record data
    
    pArtcl->GetNext ();
}

C#
 
// Seek all articles of which the free category 2 = 'Yellow'
string strCateg = "Yellow";
oArtcl.SeekByFreeCat (eSeekMode.smGreaterOrEqual, strCateg, "", 1);
while (oArtcl.GetDBStatus () == 0 && oArtcl.pFreeCategory2.ToString () == strCateg)
{
    // Process record data
    
    oArtcl.GetNext ();
}

VBS
 
' Seek all articles of which the free category 2 = 'Yellow'
Dim strCateg
strCateg = "Yellow"
Call oArtcl.SeekByFreeCat(smGreaterOrEqual, strCateg, "", 1)
While oArtcl.GetDBStatus() = 0 And oArtcl.pFreeCategory2 = strCateg
    ' Process record data
    
    Call oArtcl.GetNext()
Wend

VB.NET
 
' Seek all articles of which the free category 2 = 'Yellow'
Dim strCateg As String
strCateg = "Yellow"
oArtcl.SeekByFreeCat(eSeekMode.smGreaterOrEqual, strCateg, "", 1)
While oArtcl.GetDBStatus() = 0 And oArtcl.pFreeCategory2 = strCateg
    ' Process record data
    
    oArtcl.GetNext()
End While