dm_get_parm_definition_attribute()

Returns a value of a parameter definition attribute, as defined with create_parm(). The meaning of these fields are documented under create_parm().

Syntax:

dm_get_parm_definition_attribute(parmHandle, attribute);

where

parmHandle is the handle to a parameter definition.

attributes is the type of data to retrieve from the parameter definition, where:

• DM_PARM_NAME is the name of the parameter.
• DM_PARM_LABEL is a descriptive label for the parameter.
• DM_PARM_ATTR is an integer, attribute code. See create_parm() for more information.
• DM_PARM_UNIT is the unit for the parameter.
• DM_PARM_FORMSET is the name of the formset used for this parameter value.
• DM_PARM_DEFVALUE is the handle to a parameter which contains the default value. The default value of the parameter is determined by the prm() function. See prm() for more information.

Example:

decl itemH, parmList, parmH, parmName, parmDefPtr, parmDefVal;
itemH = dm_find_item_definition("R");
parmList = dm_get_item_definition_attribute(itemH, ITEM_PARMS);
parmH = dm_first_parm_definition(parmList);
parmName = dm_get_parm_definition_attribute(parmH, DM_PARM_NAME);
//An example of how to get the default string value of the parameter
parmDefPtr = dm_get_parm_definition_attribute(parmH, DM_PARM_DEFVALUE);
parmDefVal = db_get_parm_attribute(parmDefPt, PARM_VALUE_SVALUE);

Where Used:

Schematic