Help home › The Family Historian API › Function Index › fhGetDataList

functions

fhGetDataList

Description

Returns a table containing a list of strings in alphabetical order.  The strings are data values used in the current project - e.g. places, religions, etc.  The function takes 2 parameters (second is optional), specifying the data list required.

Minimum FH Version

7

Syntax

table = fhGetDataList(strType[, strQualifier])

Parameters

strType
String.  This must be one of the following: "PLACES", "ADDRESSES", "OCCUPATIONS", "RELIGIONS", "CASTES", "ORIGINS", "SOURCE_TYPES"
strQualifier
String.  Optional.  Is ignored unless strType is "ADDRESSES".  In that case, if you supply a place name, the table returned will be restricted to a list of addresses currently associated with that exact place name (case-insensitive match), in facts in the current project.

Returns

table
table containing list of strings

Example

local t = fhGetDataList("ADDRESSES", "London, England");
local sText = '';
for k, v in ipairs(t) do
	sText = sText .. v .. '
';
end
fhMessageBox(sText);
 
 

Links to

Linked from