GetPeriodStatusMultiple

Return an array containing the statuses of a given set of periods for the specified scenario and year.

Syntax

<HFMwManageJournals>.GetPeriodStatusMultiple (bstrScenario, bstrYear, vaPeriods)

Argument

Description

bstrScenario

The label of the Scenario dimension member.

Input argument. String subtype.

bstrYear

The label of the Year dimension member.

Input argument. String subtype.

vaPeriods

An array containing the labels of the Period dimension members.

Input argument.

Return Value

Returns an array of the periods’ statuses. This array has a one-to-one correspondence with the array passed to the vaPeriods argument. Valid values are represented by the HFMConstants type library constants listed in Period Status Constants.

Example

The following function returns descriptions of the specified periods’ statuses.

Function getPerStatusStrings(sScen, sYear, vaPers)
Dim vaRet
vaRet = g_cHFMManageJournals.GetPeriodStatusMultiple(sScen, _
   sYear, vaPers)
For i = lBound(vaRet) to uBound(vaRet)
   Select Case vaRet(i)
      Case JPS_CLOSED
         vaRet(i) = "Closed"
      Case JPS_OPENED
         vaRet(i) = "Opened"
      Case JPS_UNOPENED
         vaRet(i) = "Unopened"
   End Select
Next
getPerStatusStrings = vaRet
End Function