Venice
Artcl::IsFieldVirtual
 
Is the field virtual?
 
VARIANT_BOOL IsFieldVirtual (
    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.
 
See Also
CreateArtcl
 
Samples
 
C++
 
if (pArtcl->IsFieldVirtual (artfSysNum))
    // This field can not be updated.

C#
 
if (oArtcl.IsFieldVirtual (eArtclFld.artfSysNum))
    // This field can not be updated.

VBS
 
If oArtcl.IsFieldVirtual(oArtcl.GetFieldID("SysNum")) Then
    ' This field can not be updated.
End If

VB.NET
 
If oArtcl.IsFieldVirtual(eArtclFld.artfSysNum) Then
    ' This field can not be updated.
End If