StockInfo::GetFieldDesc (Interface: StockInfo)
 
Gets the field description.
 
BSTR GetFieldDesc (
    enum eStockInfoFld eFieldID
)
 
Parameters
eFieldID
[in] Identifier of the field, e.g. stofQuantity (C++) or eStockInfoFld.stofQuantity (C# / VB.NET).
 
Remark: In VBS, this field identifier enumerations cannot be used! You should use GetFieldID to get a valid field identifier.
 
Return value
A BSTR containing the description of the requested field.
 
Remarks
You have to call GetFirstChange (to fill the stock changes file) before you can use this method, otherwise an exception will be thrown.
 
See Also
CreateStockInfo
GetFieldID
 
Samples
 
C++
 
// Retrieve the description of the 'Quantity'-field.
CString strDescr = (LPCSTR)pStockInfo->GetFieldDesc (stofQuantity);

C#
 
// Retrieve the description of the 'Quantity'-field.
string strDescr = oStockInfo.GetFieldDesc (eStockInfoFld.stofQuantity);

VBS
 
' Retrieve the description of the 'Quantity'-field.
Dim strDescr
strDescr = oStockInfo.GetFieldDesc(oStockInfo.GetFieldID("Quantity"))

VB.NET
 
' Retrieve the description of the 'Quantity'-field.
Dim strDescr As String
strDescr = oStockInfo.GetFieldDesc(eStockInfoFld.stofQuantity)