Locat::GetFieldID (Interface: Locat)
 
Gets the field identifier.
 
enum eLocatFld GetFieldID (
    BSTR bsFieldName
)
 
Parameters
bsFieldName
[in] A string containing the name of the field of which you want to know the identifier.
 
Return value
Identifier of the field, e.g. locfSysNum (C++) or eLocatFld.locfSysNum (C# / VB.NET).
 
Remarks
If an identifier is given for a field that does not exist, this method will return -1.
 
See Also
CreateLocat
GetFieldName
 
Samples
 
C++
 
// Retrieve the identifier of the 'system number'-field.
eLocatFld eFieldId = pLocat->GetFieldID ("SysNum");

C#
 
// Retrieve the identifier of the 'system number'-field.
eLocatFld eFieldId = oLocat.GetFieldID ("SysNum");

VBS
 
' Retrieve the identifier of the 'system number'-field.
Dim eFieldId
eFieldId = oLocat.GetFieldID("SysNum")

VB.NET
 
' Retrieve the identifier of the 'system number'-field.
Dim eFieldId As eLocatFld
eFieldId = oLocat.GetFieldID("SysNum")