GetJournalQueryDefinitionIDs

Returns IDs of one or more journals. You can return IDs of all journals or return only those IDs that meet filtering criteria that you specify.

Syntax

<IHsvJournalsEx>.GetJournalQueryDefinitionIDs lScenario, lYear, lPeriod, lValue, varalColumns, vararvFilters, var2DalColumnsSort, pvararlJournalIDs

Argument	Description
lScenario	Long (ByVal). The member ID of the Scenario dimension member.
lYear	Long (ByVal). The member ID of the Year dimension member.
lPeriod	Long (ByVal). The member ID of the Period dimension member.
lValue	Long (ByVal). The member ID of the Value dimension member.
varalColumns	Long array (ByVal). This array specifies the display columns. To create this array, use the HFMConstants type library constants listed in Journal Column Display Constants.
vararvFilters	Variant (ByVal). Enables you to filter out journals: To return all journal IDs, pass an empty variable. To filter out journals, 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 64, Journal Filter Array Elements. Define 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. Note: In this release only the first six elements and the fourteenth and fifteenth elements of this array are supported; the remaining elements are reserved for future use.
var2DalColumnsSort	Long array (ByVal). Specifies the columns to be sorted by and whether the sort order is ascending or descending. This is a two-dimensional array, where the first dimension specifies the sort columns and the second dimension specifies the sort order. Apply the following rules when defining this array: The first dimension takes the HFMConstants type library constants listed in Journal Column Display Constants. The second dimension takes 0 to sort in ascending order, 1 in descending order. For example, suppose you want to sort by status and then by label, with both sorts in ascending order. This array would be defined as follows: (0, 0) = COLUMN_JOURNALSTATUS (0, 1) = 0 (1, 0) = COLUMN_JOURNALLABEL (1, 1) = 0
pvararlJournalIDs	Variant array. Returns the ID numbers of the journals that match the criteria specified in the arguments. The array is returned as a Long subtype.

Journal Filter Array Elements

The following table lists the index numbers, corresponding display columns, and descriptions of the supported elements in the array passed to the vararvFilters argument.

Note:

The array passed to the vararvFilters argument is a 32-element array. Indexes for this array that are not listed in the following table are reserved for future use.

Table 64. Journal Filter Array Elements

Index	Display Column	Description
0	Label	A String containing the desired label. You can use the percentage sign ( % ) as a wildcard character.
1	Status	An array of Longs containing the journal statuses to be applied. These statuses are represented by the HFMConstants type library constants listed in Journal Status Constants.
2	Type	An array of Longs containing the journal types to be applied. These journal types are represented by the HFMConstants type library constants listed in Journal Type Constants.
3	Balance Type	An array of Longs containing the balance types to be applied. These balance types are represented by the HFMConstants type library constants listed in Balance Type Constants.
4	Group	A String containing the name of the desired journal group. You can use the percentage sign ( % ) as a wildcard character.
5	Description	A String containing the name of the desired description. You can use the percentage sign ( % ) as a wildcard character.
14	Entity	The member ID (Long) of the entity by which to filter.
15	Parent	The member ID (Long) of the parent entity by which to filter.

Example

GetJournalQueryDefinitionIDs is used in the Example for GetJournalDisplayData.