| |
| Gets the value of a field as a string. |
| |
 |
BSTR GetFieldStr (
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 value of the requested field. |
| |
| See Also |
|
|
|
| |
| Samples |
| |
 |
C++ |
| |
// Retrieving the value of all standard fields in string format (excludes calculation fields)
CString strValue;
for (int nFieldID = 0; nFieldID <= artfMax; nFieldID++)
{
strValue = (LPCSTR)pArtcl->GetFieldStr ((eArtclFld)nFieldID);
// Process strValue
}
|
|
|
C# |
| |
// Retrieving the value of all standard fields in string format (excludes calculation fields)
string strValue;
for (int nFieldID = 0; nFieldID <= (int)eArtclFld.artfMax; nFieldID++)
{
strValue = oArtcl.GetFieldStr ((eArtclFld)nFieldID);
// Process strValue
}
|
|
|
VBS |
| |
' Retrieving the value of all standard fields in string format (excludes calculation fields)
Dim strValue
Dim iFld
For iFld=0 To oArtcl.GetFieldID("FutureUse")
strValue = oArtcl.GetFieldStr(iFld)
' Process strValue
Next
|
|
|
VB.NET |
| |
' Retrieving the value of all standard fields (excludes calculation fields)
Dim strValue As String
For iFieldID As Integer = 0 To eArtclFld.artfMax
strValue = oArtcl.GetFieldStr(iFieldID)
' Process strValue
Next
|
|
