Venice
Spplm::GetFieldDesc
 
Gets the field description.
 
BSTR GetFieldDesc (
    enum eSpplmFld eFieldID
)
 
Parameters
eFieldID
[in] Identifier of the field, e.g. splfSysNum (C++) or eSpplmFld.splfSysNum (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
The language in which the description is returned was set during the logon or when automatic logon is used, in the Development Kit configuration of your Venice installation (Main Menu - Venice-button - Settings - Configuration - Development Kit).
 
See Also
CreateSpplm
GetFieldID
 
Samples
 
C++
 
// Retrieve the description of the 'system number'-field.
CString strSysNumDescr = (LPCSTR)pSpplm->GetFieldDesc (splfSysNum);

C#
 
// Retrieve the description of the 'system number'-field.
string strSysNumDescr = oSpplm.GetFieldDesc (eSpplmFld.splfSysNum);

VBS
 
' Retrieve the description of the 'system number'-field.
Dim strSysNumDescr
strSysNumDescr = oSpplm.GetFieldDesc(oSpplm.GetFieldID("SysNum"))

VB.NET
 
' Retrieve the description of the 'system number'-field.
Dim strSysNumDescr As String
strSysNumDescr = oSpplm.GetFieldDesc(eSpplmFld.splfSysNum)