DD_TEMPLATE

Retrieve template information

WTSupported in traditional Synergy on Windows
WNSupported in Synergy .NET on Windows
USupported on UNIX
VSupported on OpenVMS
xcall DD_TEMPLATE(dcs, DDT_INFO, name, t_info)

or

xcall DD_TEMPLATE(dcs, DDT_TEXT, field, data)

dcs

The repository control structure.

DDT_INFO

Returns general template information and sets the current template.

name

The unique template name. (a30)

t_info

Returned with the template data. See the t_info record definition in ddinfo.def.

DDT_TEXT

Returns textual information about the current template.

field

A field in the t_info record that indicates what type of textual information should be returned in data (if the field is non‑zero):

ti_desc = Short description. (a40)

ti_ldesc = Long description. (a1800)

ti_usrtyp = User data type string. (a30)

ti_heading = Column heading. (a40)

ti_prompt = Prompt text. (a80)

ti_help = Help identifier. (a80)

ti_infoln = Information string. (a80)

ti_utext = User text string. (a80)

ti_altnm = Alternate field name. (a30)

ti_font = Font. (a30)

ti_prmptfont = Prompt font. (a30)

ti_def = Default value. (a80)

ti_alwlst = Allow list entries. (See fti_entlst in ddinfo.def.)

ti_range = Range values. (See fti_range in ddinfo.def.)

ti_enum = Enumerated template data. (See fti_enum in ddinfo.def.)

ti_sellist = Selection list entries. (See fti_entlst in ddinfo.def.)

ti_arrivemeth = Arrive method. (a30)

ti_leavemeth = Leave method. (a30)

ti_drillmeth = Drill method. (a30)

ti_hypermeth = Hyperlink method. (a30)

ti_changemeth = Change method. (a30)

ti_dispmeth = Display method. (a30)

ti_editfmtmeth = Edit format method. (a30)

data

Returned with the requested textual data.

The DD_TEMPLATE subroutine returns information about template definitions. There are two ways to call DD_TEMPLATE:

DDT_INFO

If you pass DDT_INFO, the DD_TEMPLATE subroutine reads the specified template. If that template is not found, the relevant error code is returned in the control structure. If it is found, the template name is recorded in the control structure and general information is returned in t_info.

DDT_TEXT

Once a template has been selected, the DDT_TEXT function is then valid. The DDT_TEXT function is used to obtain textual or variable‑length information about the template. For each type of textual information, a corresponding field in the t_info record is non‑zero. For example, if the ti_desc field in the t_info record is non‑zero, a short description exists for the template. If you pass DDT_TEXT along with the non‑zero field, the corresponding textual information is returned.