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

functions

fhGetMetafieldType

Description

Takes a pointer to a metafield item and returns two strings that provide type information about it.  The two strings will both be empty if the parameter item is not a metafield.

See also fhGetMetafieldDefinition and fhGetMetafieldShortcut.

Minimum FH Version

7

Syntax

  strVarType, strCode = fhGetMetafieldType(ptr)

Parameters

ptr
Item pointer.  Should point to a metafield item.

Return Value

strVarType
A 2-letter code indicating the type of the metafield.  The possible values are:
2-letter code Meaning
TX
Text
NM
Name
DT
Date
PL
Place
AD
Address
RP
Repository
EN
Enum (enumerated type -user picks values from a dropdown list)
UL
URL

strCode
The code associated with the metafield.  For example if the label for the metafield was "Document Type", the code would be "Document_Type".

Example

strVarType, strCode = fhGetMetafieldType(pi)