GetStatusUsingPhaseID

Returns the transaction status, metadata status, and calculation status of either a cell or a submission phase. You must pass one of the following:

To get the status of a submission phase, pass the phase ID to the lPhaseID argument and the HFMConstant MEMBERNOTUSED to the Account, Intercompany Partner, and Custom dimension arguments.
To get the status of a cell, pass member IDs to all dimension member arguments and MEMBERNOTUSED to the lPhaseID argument.

Note:

The bIncludeTransType argument enables you to exclude the transaction status from the return value.

Syntax

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

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). Pass one of the following: To get a cell's status, pass the member ID of the cell's Account dimension member. To get a submission phase's status, pass the HFMConstant MEMBERNOTUSED.
lICP	Long (ByVal). Pass one of the following: To get a cell's status, pass the member ID of the cell's Intercompany Partner dimension member. To get a submission phase's status, pass the HFMConstant MEMBERNOTUSED.
lCustom1	Long (ByVal). Pass one of the following: To get a cell's status, pass the member ID of the cell's Custom1 dimension member. To get a submission phase's status, pass the HFMConstant MEMBERNOTUSED.
lCustom2	Long (ByVal). Pass one of the following: To get a cell's status, pass the member ID of the cell's Custom2 dimension member. To get a submission phase's status, pass the HFMConstant MEMBERNOTUSED.
lCustom3	Long (ByVal). Pass one of the following: To get a cell's status, pass the member ID of the cell's Custom3 dimension member. To get a submission phase's status, pass the HFMConstant MEMBERNOTUSED.
lCustom4	Long (ByVal). Pass one of the following: To get a cell's status, pass the member ID of the cell's Custom4 dimension member. To get a submission phase's status, pass the HFMConstant MEMBERNOTUSED.
lPhaseID	Long (ByVal). Pass one of the following: To get a cell's status, pass the HFMConstant MEMBERNOTUSED. To get a submission phase's status, pass the phase ID.
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.
psReturn	Integer. For internal use.