FBook::GetFieldStr (Interface: FBook)
 
Gets the value of a field as a string.
 
BSTR GetFieldStr (
    enum eFBookFld eFieldID
)
 
Parameters
eFieldID
[in] Identifier of the field, e.g. fbofSysNum (C++) or eFBookFld.fbofSysNum (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 value of the requested field.
 
See Also
CreateFBook
GetFieldVal
SetFieldVal
 
Samples
 
C++
 
// Retrieving the value of all fields in string format
CString strValue;
for (int nFieldID = 0; nFieldID < fbofMax; nFieldID++)
{
    strValue = (LPCSTR)pFBook->GetFieldStr ((eFBookFld)nFieldID);
    // Process strValue
}

C#
 
// Retrieving the value of all fields in string format
string strValue;
for (int nFieldID = 0; nFieldID < (int)eFBookFld.fbofMax; nFieldID++)
{
    strValue = oFBook.GetFieldStr ((eFBookFld)nFieldID);
    // Process strValue
}

VBS
 
' Retrieving the value of all fields in string format
Dim strValue
Dim iFld
For iFld=0 To oFBook.GetFieldID("FutureUse")
    strValue = oFBook.GetFieldStr(iFld)
    ' Process strValue
Next

VB.NET
 
' Retrieving the value of all (non system) fields
Dim strValue As String
For iFieldID As Integer = 0 To eFBookFld.fbofMax
    strValue = oFBook.GetFieldStr(iFieldID)
    ' Process strValue
Next