| |
| Gets the field description. |
| |
 |
BSTR GetFieldDesc (
enum eArtclFld eFieldID
) |
|
| |
| Parameters | | eFieldID | [in] Identifier of the field, e.g. artfSysNum (C++) or eArtclFld.artfSysNum (C# / VB.NET).
| |
| Warning: DO NOT hardcode numeric values for field identifiers. The numeric value of a field (i.e. the enum value) can change from one version to the next. Always use the enum or use GetFieldID |
| Warning: DO NOT assume the order of fields will remain the same (do not calculate relative fields). artfSysNum + 15 may not be valid or the same in future versions. |
| Remark: In VBS, this field identifier enumerations cannot be used! You should use GetFieldID to get a valid field identifier. |
| Remark: Within an object, field identifiers will not change as long as the object persists. You can obtain a value with GetFieldID once and then continue using the value. However, note that custom calculation fields are unique per dossier; even if they have the same field name, they may not have the same numeric value in all dossiers. |
| | | | 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 |
|
|
|
| |
| Samples |
| |
|
C++ |
| |
// Retrieve the description of the 'system number'-field.
CString strSysNumDescr = (LPCSTR)pArtcl->GetFieldDesc (artfSysNum);
|
|
|
C# |
| |
// Retrieve the description of the 'system number'-field.
string strSysNumDescr = oArtcl.GetFieldDesc (eArtclFld.artfSysNum);
|
|
|
VBS |
| |
' Retrieve the description of the 'system number'-field.
Dim strSysNumDescr
strSysNumDescr = oArtcl.GetFieldDesc(oArtcl.GetFieldID("SysNum"))
|
|
|
VB.NET |
| |
' Retrieve the description of the 'system number'-field.
Dim strSysNumDescr As String
strSysNumDescr = oArtcl.GetFieldDesc(eArtclFld.artfSysNum)
|
|
