CloseICPeriod

Closes a given period for intercompany transactions.

Syntax

<IHsvAdminICM>.CloseICPeriod lScenario, lYear, lPeriod

Argument

Description

lScenario

Long (ByVal). The member ID of the Scenario dimension member for which to close the period.

lYear

Long (ByVal). The member ID of the Year dimension member for which to close the period.

lPeriod

Long (ByVal). The member ID of the Period dimension member to close.

Example

The following subroutine closes a period. The subroutine takes the labels of the Scenario, Year, and Period dimension members, and obtains the corresponding member IDs with IHsvTreeInfo.GetItemID.

Sub closePeriodLabels(sScen As String, sYear As String, sPer As String)
  Dim lScen As Long, lYear As Long, lPer As Long
  Dim cAdminICM As IHsvAdminICM, cTreeInfo As IHsvTreeInfo
  'g_cSession is an HsvSession object reference
  Set cAdminICM = g_cSession.ICM
  'g_cMetadata is an HsvMetadata object reference
  Set cTreeInfo = g_cMetadata.Scenarios
  lScen = cTreeInfo.GetItemID(sScen)
  Set cTreeInfo = g_cMetadata.Years
  lYear = cTreeInfo.GetItemID(sYear)
  Set cTreeInfo = g_cMetadata.Periods
  lPer = cTreeInfo.GetItemID(sPer)
  cAdminICM.CloseICPeriod lScen, lYear, lPer
End Sub