Functions (all)

GetFieldText

Function Name:
GetFieldText
Description:

Returns the value of a particular field within a given record (or possibly, a subfield within another field such as a Fact field). You pass in a reference to the record (or a field) as one parameter, and a data reference specified using a text expression, in the second parameter.

Can also be used to find the data stored in fields in other records - e.g. a person's mother-in-law's surname. Is similar to the GetField function, but that function is used to reference fields, and ignores qualifiers (see Understanding Data References for an explanation of the role of qualifiers). This function, because it returns a text value, will honour qualifiers.

This function is also similar to the FieldText function. GetFieldText is more flexible as you can use operators to construct the text expressions. But FieldText is much faster to execute. Consequently, you are recommended to use FieldText for preference, but use GetFieldText if you need the added flexibility that it offers. For example, the following function used in a query will retrieve a census event for a given individual and prompt you to specify the year of the census:

=GetFieldText(%INDI%,"%INDI.CENS[year=" . ["Year"] . "]%")

This would not be possible with the FieldText function as it uses the concatenation operator '.' which only works with text expressions.

Since version 6.0 of Family Historian, you can now use relative data references with this function, and also with the GetField function. Relative data references begin with a single '~' character. To learn more about them see Understanding Data References.

Minimum FH Version:
4.0
No. of Parameters:
2
Return Type:
Text
Parameter 1:
A datanode to use as a starting point. Usually a record.
Parameter 2:

A text expression that contains a data reference. For example:

"%INDI.DEAT.DATE%" or "%~.DEAT.DATE% (see note above about relative data references).

Note the double-quotes around the data reference. These are always needed for text expressions.

Examples:

=GetFieldText(["Person"], "%INDI.DEAT.DATE%")
=GetFieldText(%INDI.~SPOU>%, "%INDI.DEAT.DATE%")
=GetFieldText(%INDI%,"%INDI.CENS[year=" . ["Year"] . "]%")