UnpostJournals

Unposts one or more journals. The vararlJournalIDs argument takes the IDs of the journals that are being rejected.

Caution!

The user must be assigned to the Journals Administrator or Post Journals role, otherwise error number 40D (hexadecimal) will occur.

Syntax

<IHsvJournalsEx>.UnpostJournals lScenario, lYear, vararlJournalIDs, pvararnRc

Argument

Description

lScenario

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

lYear

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

vararlJournalIDs

Long array (ByVal). The IDs of the journals to be unposted. Get these IDs with the HsvJournals object’s GetItemID method; for more information, see GetItemID.

pvararnRc

Variant array. Returns codes that identify the success or failure of the journal unpostings. The elements in this array have a one-to-one correspondence with the journal IDs passed in the vararlJournalIDs argument. Successfully unposted journals return 0. The following list identifies some of the likely error codes in hexadecimal form:

  • 40F

  • 3F9

  • 418

  • 40D

  • 411

  • 40B

The array is returned as an Integer subtype.

Example

This example unposts two journals. The calls to the user-defined GetMemberID function get the example’s dimension member IDs; for details on GetMemberID, see the Examples for IHsvTreeInfo.GetItemID. The laJnlIDs array variable is then populated with the journal IDs by HsvJournals.GetItemID. The member IDs for the Scenario and Year dimension are passed along with this array to UnpostJournals.

Dim lScen As Long, lYear As Long, lPer As Long
Dim laJnlIDs(1) As Long, vaRetVal
lScen = GetMemberID(DIMENSIONSCENARIO, "Actual")
lYear = GetMemberID(DIMENSIONYEAR, "2000")
lPer = GetMemberID(DIMENSIONPERIOD, "July")
laJnlIDs(0) = m_cHsvJournals.GetItemID(lScen, lYear, lPer, _ 
"Jnl810")
laJnlIDs(1) = m_cHsvJournals.GetItemID(lScen, lYear, lPer, _ 
"Jnl811")
m_cIHsvJournalEx.UnpostJournals lScen, lYear, laJnlIDs, _ 
vaRetVal