GetSettingsICPeriod

Returns the period status, matching tolerance, and Match/Validate Before Post settings for a scenario, year, and period.

Note:

To return these settings for multiple periods, use GetSettingsICPeriods.

Syntax

<IHsvAdminICM>.GetSettingsICPeriod lScenario, lYear, lPeriod, psStatus, psMVBP, pdMatchTolerance

Argument	Description
lScenario	Long (ByVal). The member ID of the Scenario dimension member.
lYear	Long (ByVal). The member ID of the Year dimension member.
lPeriod	Long (ByVal). The member ID of the Period dimension member.
psStatus	Integer. Returns the period’s status. Valid values are represented by the HFMConstants type library constants listed in Period Status Constants.
psMVBP	Integer. Returns the period’s Match/Validate Before Post setting. Valid values are represented by the HFMConstants type library constants listed in Match/Validate Before Post Constants.
pdMatchTolerance	Double. Returns the matching tolerance specified for the period.

Example

The following function takes Scenario, Year, Period, and Entity dimension member IDs and returns a Boolean that indicates whether the period’s Match/Validate Before Post setting is on.

Function isMatchValidateOn(lScen As Long, lYear As Long, lPer As Long) _
    As Boolean
  Dim cAdminICM As IHsvAdminICM, iStat As Integer, iMatch As Integer
  Dim dTol As Double
  'g_cSession is an HsvSession object reference
  Set cAdminICM = g_cSession.ICM
  cAdminICM.GetSettingsICPeriod lScen, lYear, lPer, iStat, iMatch, dTol
  If iMatch = ICM_MVBP_ON Then
    isMatchValidateOn = True
  Else
    isMatchValidateOn = False
  End If
End Function