The Family Historian API

Function Index

The methods for the three new objects are described in the following sections. Below is a list of all the functions. Hungarian notation is used to describe parameters. The prefixes and their meanings are given in the table below:

ptr	pointer object
ag	age object
dt	date object
dp	date-point object
rt	rich text object
sn	section object
str	text ('str' is short for 'text string')
i	number ('i' is short for integer)
b	boolean (true or false)
tbl	table

Optional parameters are shown in square brackets. Some functions have many optional parameters. For some functions, like fhNewItemPtr, all parameters are optional.

Create Objects

• fhNewAge()
• fhNewDate([iYear [, iMonth [, iDay [, strSubtype]]]] )
• fhNewDatePt( [iYear [,iMonth [, iDay [, bYearDD [, bBC [, strCalendar]]]]]] )
• fhNewItemPtr( )
• fhNewRichText([strText[,bRich]])
• fhNewSection() -- normally used for debugging only

Prompt And Information Dialogs

• fhPromptUserForDate( [dtInitialDate [,hParentWnd] )
• fhPromptUserForRecordSel(strTag [,iMaxSel [,hParentWnd]] )
• fhPromptUserForRichText(rtRichText [,hParentWnd] )
• fhMessageBox(strMessage [,strMessageBoxFormat [,strMessageBoxIcon [,hParentWnd]]] )
• fhDisplayRichTextBox(rtRichText [,strTitle [,hParentWnd]] )
• fhUpdateDisplay()

Output Information

• fhOutputResultSetColumn(strColumnHeading, strColumnType, tblData, iCount [, iWidthInChar4ths [, strAlignment [, iSortPriority [, bSortAscending[,strItemSortType[,strVisibility]]]]] )
• fhOutputResultSetTitles(strTitle [,strPrintTitle [, strPrintSubtitle]] )

Fetch Values

• fhCallBuiltInFunction (strFunctionName, ...)
• fhGetCurrentRecordSel( [strTag] )
• fhGetCurrentPropertyBoxRecord()
• fhGetAppVersion()
• fhGetContextInfo(strInfoReqd)
• fhGetDataClass(ptr)
• fhGetDataList(strType [, strQualifier])
• fhGetDisplayText(ptr, [strDataReference [, strDisplayOption]] )
• fhGetFactTag(strFactName, strFactType, strRecTag, bCreateIfNone)
• fhGetFactTypeInfo(strTag, strType[, strFlags])
• fhGetFlagTag(strFlagName, bCreateIfNone)
• fhGetGedcomInfo(ptrItem)
• fhGetItemPtr(ptr,strDataReference)
• fhGetItemText(ptr,strDataReference)
• fhGetLabelledText(ptr, strLabel)
• fhGetPluginDataFileName([strScope [,bFolder]])
• fhGetQualifiedRecordId(ptr)
• fhGetRecordId(ptr)
• fhGetRecordTypeCount()
• fhGetRecordTypeTag(iIndex)
• fhGetTag(ptr)
• fhGetTypeInfo(ptr, strType)
• fhGetValueAsAge(ptr)
• fhGetValueAsBlob(ptr, strFilename)
• fhGetValueAsDate(ptr)
• fhGetValueAsInteger(ptr)
• fhGetValueAsLink(ptr)
• fhGetValueAsRichText(ptr)
• fhGetValueAsText(ptr)
• fhGetValueType(ptr)
• fhGetMetafieldDefinition(ptr)
• fhGetMetafieldShortcut(ptr)
• fhGetMetafieldType(ptr)

Manipulate Items

• fhCreateItem(strTag [, ptrParent [, bReuseEmpties]] )
• fhDeleteItem(ptr)
• fhMoveItemAfter(ptrMove, ptrAfter)
• fhMoveItemBefore(ptrMove, ptrBefore)

Update Items

• fhSetLabelledText(ptr, strLabel, strValue)
• fhSetValueAsAge(ptr, age)
• fhSetValueAsDate(ptr, dtDate)
• fhSetValueAsInteger(ptr, iValue )
• fhSetValueAsLink(ptr, ptrLink)
• fhSetValueAsRichText(ptr, rtValue)
• fhSetValueAsText(ptr, strValue)
• fhSetValueAsBlob(ptr, strFilename)

Check Pointer Items

• fhHasChildItem(ptr)
• fhHasNextSibItem(ptr)
• fhHasParentItem(ptr)
• fhHasPrevSibItem(ptr)
• fhIsAttribute(ptr)
• fhIsEvent(ptr)
• fhIsFact(ptr)
• fhIsHidden(ptr)
• fhIsUDF(ptr)
• fhIsValidDataRef(ptr)

Text Encoding

• fhConvertANSItoUTF8(strTextToConvert)
• fhConvertUTF8toANSI(strTextToConvert)
• fhGetStringEncoding()
• fhSetStringEncoding(strEncoding)
• fhSetConversionLossFlag(bSet)
• fhIsConversionLossFlagSet()

Individual Record functions

• fhIndGetFactList(ptr[, bIncWitnessFacts[, bIncTimelineFacts[, bPrefsOnly[, bNarrStyle[, bResolveExclusions[, bExcludePrivateFacts[, bExcludeRejectedFacts]]]]]]])
• fhIndGetName(ptr[, bIncLifeDates[, bIncRecordId]])

Source Record functions

• fhSrcEnableAutoTitle(ptr, bEnable)
• fhSrcIsAutoTitleEnabled(ptr)

Report Helper functions

• fhGetNarrSentence(ptr[, IndPtr])
• fhGetNarrSentenceTemplate(ptr)

Ftf Syntax and eFtf Syntax

• fhFtfEncode(strPlainText)
• fhFtfParamEncode(strPlainText)

Ini File Support

• fhGetIniFileValue(strFile, strSection, strKey, strValueType, varDefault)
• fhSetIniFileValue(strFile, strSection, strKey, strValueType, varValue)

Miscellaneous

• fhInitialise(iMinVer1 [, iMinVer2 [, iMinVer3 [, strSaveRequirements]]])
• fhExhibitResponsiveness()
• fhOverridePreference(strPreference, bOverride [, varValue])
• fhSleep (iWaitInMillisecs [, iPumpInMillisecs] )
• fhShellExecute(strFileName [, strParams [, strDirectory [, strOperation [, iShowCmd]]]])
• fhBeginsWithVowel(strText)
• fhLoadTextFile(strFilePath[, strFileFormat])
• fhSaveTextFile(strFilePath, strContents[, strFileFormat])
• fhGetClipboardData(strFormat)