EnumJournalIDsForExtractFilter

Returns the IDs of journals and templates that match the specified filtering criteria. The flag passed to the lJournalTypes argument determines whether IDs of journals, standard templates, recurring templates, or some combination thereof are returned.

EnumJournalIDsForExtractFilter provides arguments for numerous filtering criteria. For filtering criteria you do not want to use, pass an empty variable to the corresponding argument; only arguments containing values are used to filter. This principle applies to all arguments other than the lScenario and lYear arguments, for which valid member IDs are required.

Syntax

<IHsvJournalsEx>.EnumJournalIDsForExtractFilter lScenario, lYear, varalPeriods, varalEntities, varalParents, varalValues, lJournalTypes, varabstrLabels, varabstrGroups, varalStatus, varalAutoTypes, varalBalanceTypes, pvaralJournalIDs, pvaralTemplateIDs

Argument	Description
lScenario	Long (ByVal). The member ID of the Scenario dimension member by which to filter.
lYear	Long (ByVal). The member ID of the Year dimension member by which to filter.
varalPeriods	Long array (ByVal). The member IDs of the Period dimension members by which to filter.
varalEntities	Long array (ByVal). The member IDs of the Entity dimension members by which to filter.
varalParents	Long array (ByVal). The member IDs of the parents of the Entity dimension members passed to the varalEntities argument.
varalValues	Long array (ByVal). The member IDs of the Value dimension members by which to filter.
lJournalTypes	Long (ByVal). A flag that determines whether journals, standard templates, recurring templates, or some combination thereof are returned. Valid values are represented by the HFMConstants type library constants listed in Journal and Template Type Constants. To filter with more than one of these items, use Or with the applicable constants.
varabstrLabels	String array (ByVal). The journal labels by which to filter. You can use the percent sign ( % ) as a wildcard.
varabstrGroups	String array (ByVal). The journal groups by which to filter. You can use the percent sign ( % ) as a wildcard.
varalStatus	Long array (ByVal). The journal statuses by which to filter. Valid values are represented by the HFMConstants type library constants listed in Journal Status Constants.
varalAutoTypes	Long array (ByVal). The journal types by which to filter. Valid values are represented by the HFMConstants type library constants listed in Journal Type Constants.
varalBalanceTypes	Long array (ByVal). The balance types by which to filter. Valid values are represented by the HFMConstants type library constants listed in Balance Type Constants.
pvaralJournalIDs	Variant array. Returns the journal IDs that match the filtering criteria, if the lJournalTypes argument specifies that journals are to be returned. The array is returned as a Long subtype.
pvaralTemplateIDs	Variant array. Returns the template IDs that match the filtering criteria, if the lJournalTypes argument specifies that templates are to be returned. The array is returned as a Long subtype.