GetReportData2

Returns data for journals; scaled and actual journal amounts are returned.

Syntax

<IHsvJournalsReport>.GetReportData2 lScenario, lYear, lPeriod, lValue, varavFilters, varalColumns, varanSortFlags, pvar2DvarData, pvardScaledValues, pvardValues, pvarlStatus

Argument

Description

lScenario

Long (ByVal). The member ID of the Scenario dimension member for the report data.

lYear

Long (ByVal). The member ID of the Year dimension member for the report data.

lPeriod

Long (ByVal). The member ID of the Period dimension member for the report data.

lValue

Long (ByVal). The member ID of the Value dimension member for the report data.

varavFilters

Variant (ByVal). Filters out journals:

  • To return all journals in the report, pass an empty variable.

  • To filter out journals from the report, pass this as a Variant array that consists of 32 elements

When filtering journals, each array element corresponds to a type of filter. The available filters and their indexes in this 32-element array are described in Table 66, Journal Report Filter Array Elements. Specify values for only those elements that correspond to the desired filtering criteria; if you do not want to use a filter, leave the corresponding array element empty.

In this release only, elements 1-6 and elements 14-16 of this array are supported; the remaining elements are reserved for future use.

varalColumns

Long array (ByVal). Specifies the display columns that the report data will contain. To create this array, use the constants listed in Table 67, Report Column Display Constants.

Tip:

Specify the sortable columns as the top elements of this array, which has a one-to-one correspondence with the varanSortFlags argument’s array.

varanSortFlags

Integer array (ByVal). Specifies the columns on which the report data will be sorted, as well as the sort order. This array has a one-to-one correspondence with the varalColumns argument’s array. To specify these columns, use one of the HFMConstants type library constants listed in Journal Report Sort Option Constants.

pvar2DvarData

Variant array. Returns information for the specified columns. This is a multidimensional array, with one dimension for each column specified in the varalColumns argument; in each dimension, there is one element per journal.

For details on the values returned in the array elements, see Table 67, Report Column Display Constants.

pvardScaledValues

Variant array. Returns the scaled debit and credit amounts for the journals in the report. This array has a one-to-one correspondence with the pvar2DvarData argument’s array, and is returned as a Double subtype.

pvardValues

Variant array. Returns the actual debit and credit amounts for the journals in the report. This array has a one-to-one correspondence with the pvar2DvarData argument’s array, and is returned as a Double subtype.

pvarlStatus

Variant array. Returns an array that indicates whether the connected user has access to the line items. Each array element returns one of the following values:

  • 0 if the user has access to the corresponding line item.

  • CELLSTATUS_NOREADACCESS, which is an HFMConstants type library constant indicating that the user does not have access to a cell.

This array has a one-to-one correspondence with the pvar2DvarData argument’s array, and is returned as a Long subtype.