GetJournalDisplayData

Returns various types of information for journals. The types of information returned correspond to the display columns in the Columns tab of the Filters And Sorting dialog box. The journal information is returned as a multidimensional array, with one array dimension for each display column that you specify in the varalColumns argument.

Syntax

<IHsvJournalsEx>.GetJournalDisplayData lScenario, lYear, varalColumns, varlJournalIDs, pvar2DvarData

Argument	Description
lScenario	Long (ByVal). The member ID of the Scenario dimension member.
lYear	Long (ByVal). The member ID of the Year dimension member.
varalColumns	Long array (ByVal). Specifies the display columns for which journal information will be returned. Use the HFMConstants type library constants listed in Journal Column Display Constants to create this array.
varlJournalIDs	Long array (ByVal). The ID numbers of the journals for which you want to return information.
pvar2DvarData	Variant array. Returns information for the journals and columns that match the criteria specified in the arguments. 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 Journal Column Return Values.

Example

The following example gets the labels, date created, and creators of journals that have labels beginning with “Je,” that have statuses of Working, Submitted, or Approved, and that apply to the following dimension members:

Scenario = Actual
Year = 2000
Period = July
Value = <Entity Curr Adjs>

The calls to the user-defined GetMemberID function get these members’ IDs; for details on GetMemberID, see the Examples for IHsvTreeInfo.GetItemID. GetJournalQueryDefinitionIDs returns the journal IDs of the journals; note that the IDs are sorted in ascending order. These IDs are then passed to GetJournalDisplayData, which returns the journal information in the vaDisplayData variable. This variable’s information is then printed to Visual Basic’s Immediate window.

Dim lScen As Long, lYear As Long, lPer As Long, lVal As Long
Dim laCols(2) As Long, vaJnlIDs, vaDisplayData
Dim laSort(0, 1) As Long, vaFilter(31)
lScen = GetMemberID(DIMENSIONSCENARIO, "Actual")
lYear = GetMemberID(DIMENSIONYEAR, "2000")
lPer = GetMemberID(DIMENSIONPERIOD, "July")
lVal = GetMemberID(DIMENSIONVALUE, "<Entity Curr Adjs>")
laCols(0) = COLUMN_JOURNALLABEL
laCols(1) = COLUMN_JOURNALCREATEDON
laCols(2) = COLUMN_JOURNALCREATEDBY
laSort(0, 0) = COLUMN_JOURNALLABEL
laSort(0, 1) = 0
vaFilter(0) = "Je%"
vaFilter(1) = Array(JSF_WORKING, JSF_SUBMITTED, JSF_APPROVED)
m_cIHsvJournalEx.GetJournalQueryDefinitionIDs lScen, lYear, _ 
lPer, lVal, laCols, vaFilter, laSort, vaJnlIDs
m_cIHsvJournalEx.GetJournalDisplayData lScen, lYear, laCols, _ 
vaJnlIDs, vaDisplayData
For i = LBound(vaJnlIDs) To UBound(vaJnlIDs)
  Debug.Print "Label: " & vaDisplayData(i, 0)
  Debug.Print "Created On: " & CDate(vaDisplayData(i, 1))
  Debug.Print "Created By: " & vaDisplayData(i, 2)
Next i