Deletes data from a subcube’s cells.
The Boolean vbClearInputValueID and vbClearNoneValueID arguments enable you to delete data from the subcube cells for currency-related Value dimension members and for the [None] Value dimension member. For details on the different types of Value members, see Currency-Related Value Dimension Members.
The varlaAccountSubsetIncludeList and vbUseAccountSubsetIncludeList arguments enable you to delete data for only cells that intersect specified accounts. Conversely, the varlaAccountSubsetExcludeList and vbUseAccountSubsetExcludeList arguments enable you to delete data for all cells other than those that intersect specified accounts.
Tip: | To clear subcube cells for all accounts, set the vbUseAccountSubsetIncludeList and vbUseAccountSubsetExcludeList arguments to FALSE. |
Syntax
<HsvData>.ClearInputData lScenario, lYear, lEntity, lParent, vbClearInputValueID, vbClearNoneValueID, vbClearNodeLevelValueID, varlaPeriodSubset, varlaAccountSubsetIncludeList, vbUseAccountSubsetIncludeList, varlaAccountSubsetExcludeList, vbUseAccountSubsetExcludeList, pvbDataExistedPriorToClear
Argument | Description |
|---|
lScenario | Long (ByVal). The member ID of the subcube’s Scenario dimension member. |
lYear | Long (ByVal). The member ID of the subcube’s Year dimension member. |
lEntity | Long (ByVal). The member ID of the subcube’s Entity dimension member. |
lParent | Long (ByVal). The member ID of the parent of the lEntity argument's entity. |
vbClearInputValueID | Boolean (ByVal). Specifies whether cells for the subcube’s currency-related Value dimension members are to be cleared. Pass TRUE to clear these cells, otherwise FALSE. |
vbClearNoneValueID | Boolean (ByVal). Specifies whether cells for the subcube’s [None] Value dimension member are to be cleared. Pass TRUE to clear these cells, otherwise FALSE. Note: [None] Value dimension members are used with system accounts and currency rate accounts. |
vbClearNodeLevelValueID | Boolean (ByVal). This argument is obsolete; you must pass a Boolean, but the value passed has no effect. |
varlaPeriodSubset | Long array (ByVal). The member IDs of the cells' Period dimension members. |
varlaAccountSubsetIncludeList | Long array (ByVal). If you set the vbUseAccountSubsetIncludeList argument to TRUE, only subcube cells that intersect the accounts specified are cleared. Pass the member IDs of the Account dimension members for the cells to be cleared. Note: This argument is ignored if you set vbUseAccountSubsetIncludeList to FALSE. |
vbUseAccountSubsetIncludeList | Boolean (ByVal). Specifies whether the varlaAccountSubsetIncludeList argument is used or ignored. Pass TRUE to use it, FALSE to ignore it. |
varlaAccountSubsetExcludeList | Long array (ByVal). If you set the vbUseAccountSubsetExcludeList argument to TRUE, all subcube cells other than those that intersect the accounts specified are cleared. Pass the member IDs of the Account dimension members for the cells that should not be cleared. Note: This argument is ignored if you set vbUseAccountSubsetExcludeList to FALSE. |
vbUseAccountSubsetExcludeList | Boolean (ByVal). Specifies whether the varlaAccountSubsetExcludeList argument is used or ignored. Pass TRUE to use it, FALSE to ignore it. |
pvbDataExistedPriorToClear | Boolean. Indicates whether any of the specified cells contained data before ClearInputData was called. Returns TRUE if one or more of the cells contained data, FALSE otherwise. |
Currency-Related Value Dimension Members
To illustrate the Value dimension members that are affected by ClearInputData’s vbClearInputValueID argument and CopyInputDataForMultipleEntities’ vbCopyEntityCurrencyValueID argument, the following figure shows an application’s Value dimension members listed in hierarchical order. The members from <Parent Curr Total> down to USD are the currency-related members affected by these arguments.
