GetICEntitiesLockStatus

Indicates whether any entities are locked for a given scenario, year, and period.

Note:

To return an Integer that indicates whether a given entity is locked or unlocked, use GetLockStatusICEntity.

Syntax

<HsvAdminICM>.GetICEntitiesLockStatus(lScenario, lYear, lPeriod)

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.

Return Value

Variant. Returns either an empty variant or a two-dimensional array. If no entities are locked, an empty variant is returned. If one or more entities are locked, a two-dimensional array is returned; the first dimension contains the member IDs of the Entity dimension members, and the second dimension contains the entities’ locking statuses, which are represented by the HFMConstants type library constants listed in Lock Status Constants.