GetTemplatesDisplayData

Gets the data for the specified templates. GetTemplatesDisplayData returns data only for the columns specified in the varalColumns argument.

Syntax

<HFMwManageJournals>.GetTemplatesDisplayData (varabstrLabels, varalColumns)

Argument	Description
varabstrLabels	An array containing the labels of the templates for which to return data. Tip: You can get the labels of all templates that match given criteria with ExecuteQuery. Input argument.
varalColumns	An array of that identifies the columns for which to return data. To set this argument, use either of the following techniques: Pass the columns returned by the HFMwQueryDef method GetDefAsVariants. Construct the array by setting the array items to the desired columns. Columns are represented by the HFMConstants type library constants listed in Template Column Display Constants. Input argument.

Argument

Description

varabstrLabels

An array containing the labels of the templates for which to return data.

Tip:

You can get the labels of all templates that match given criteria with ExecuteQuery.

Input argument.

varalColumns

An array of that identifies the columns for which to return data. To set this argument, use either of the following techniques:

Pass the columns returned by the HFMwQueryDef method GetDefAsVariants.
Construct the array by setting the array items to the desired columns. Columns are represented by the HFMConstants type library constants listed in Template Column Display Constants.

Input argument.

Return Value

Returns an array of arrays containing data for the specified templates and columns. There is one array element for each template specified with the varabstrLabels argument; each element then contains an array of template data, with the size of that array corresponding to the columns specified with the varalColumns argument.

Note:

Some template data, such as template type and balance type, are represented by HFMConstants type library constants. For more information, see Journal-Related Constants.

Example

The following function returns the descriptions, groups, and template types of the specified templates. The template type longs are translated to strings using the HFMConstants type library constants listed in Template Type Constants.

Function getTemplatesDescGroupType(vaLabels)
'g_cHFMManageJournals is a global HFMwManageJournals object
Dim vaCols(2), vaRet
vaCols(0) = COLUMN_TEMPLATEDESCRIPTION
vaCols(1) = COLUMN_TEMPLATEGROUP
vaCols(2) = COLUMN_TEMPLATETYPE
vaRet = g_cHFMManageJournals.GetTemplatesDisplayData(vaLabels, _
   vaCols)
'Translate template type longs to strings
For i = lBound(vaRet) to uBound(vaRet)
   Select Case vaRet(i,2)
      Case TTF_RECURRING
         vaRet(i,2) = "Recurring"
      Case TTF_STANDARD
         vaRet(i,2) = "Standard"
   End Select
Next
getTemplatesDescGroupType = vaRet
End Function