GetStatusEx

Returns the transaction status, metadata status, and calculation status of a cell, as well as additional status information such as whether the cell supports intercompany transactions. The bIncludeTransType argument enables you to exclude the transaction status from the return value.

Syntax

<HsvData>.GetStatusEx lScenario, lYear, lPeriod, lView, lEntity, lParent, lValue, lAccount, lICP, lCustom1, lCustom2, lCustom3, lCustom4, bIncludeTransType, plStatus, plExtendedStatus

Argument

Description

lScenario

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

lYear

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

lPeriod

Long (ByVal). The member ID of the cell's Period dimension member.

lView

Long (ByVal). The member ID of the cell's View dimension member.

lEntity

Long (ByVal). The member ID of the cell's Entity dimension member.

lParent

Long (ByVal). The member ID of the parent of the lEntity argument's entity.

lValue

Long (ByVal). The member ID of the cell's Value dimension member.

lAccount

Long (ByVal). The member ID of the cell's Account dimension member.

lICP

Long (ByVal). The member ID of the cell's Intercompany Partner dimension member.

lCustom1

Long (ByVal). The member ID of the cell's Custom 1 dimension member.

lCustom2

Long (ByVal). The member ID of the cell's Custom 2 dimension member.

lCustom3

Long (ByVal). The member ID of the cell's Custom 3 dimension member.

lCustom4

Long (ByVal). The member ID of the cell's Custom 4 dimension member.

bIncludeTransType

Boolean (ByVal). Determines whether the cell’s transaction status will be returned in the plStatus argument. Specify TRUE to return the transaction status, otherwise FALSE.

plStatus

Long. Returns the cell’s status. For details on cell statuses, see About Cell Statuses.

plExtendedStatus

Long. Returns additional status information. Valid values are represented by the HFMConstants type library constants listed in Additional Status Information Constant.