GetTextCellsWithRowSuppression2

Returns the data and status for rows that are not suppressed.

Syntax

<HsvData>.GetTextCellsWithRowSuppression2 varalScenario, varalYear, varalPeriod, varalView, varalEntity, varalParent, varalValue, varalAccount, varalICP, varalCustom1, varalCustom2, varalCustom3, varalCustom4, sNumDecimals, sScale, lSuppressOptions, lNumRows, pvaravbRowIsSuppressed, pvarabstrData, pvaralStatus

Argument	Description
varalScenario	Long array (ByVal). The member IDs of the cells' Scenario dimension members.
varalYear	Long array (ByVal). The member IDs of the cells' Year dimension members.
varalPeriod	Long array (ByVal). The member IDs of the cells' Period dimension members.
varalView	Long array (ByVal). The member IDs of the cells' View dimension members.
varalEntity	Long array (ByVal). The member IDs of the cells' Entity dimension members.
varalParent	Long array (ByVal). The member IDs of the parents of the varalEntity argument's entities.
varalValue	Long array (ByVal). The member IDs of the cells' Value dimension members.
varalAccount	Long array (ByVal). The member IDs of the cells' Account dimension members.
varalICP	Long array (ByVal). The member IDs of the cells' Intercompany Partner dimension members.
varalCustom1	Long array (ByVal). The member IDs of the cells' Custom 1 dimension members.
varalCustom2	Long array (ByVal). The member IDs of the cells' Custom 2 dimension members.
varalCustom3	Long array (ByVal). The member IDs of the cells' Custom 3 dimension members.
varalCustom4	Long array (ByVal). The member IDs of the cells' Custom 4 dimension members.
sNumDecimals	Integer (ByVal). The number of decimal places that the data returned in the pvarabstrData argument contains. To use the application’s default number of decimals, pass the HFMConstants type library constant DEFAULT_NUM_DECIMALS, described in Number Defaults Constants.
sScale	Integer (ByVal). Indicates the degree of scaling to apply to the data returned in the pvarabstrData argument. To leave the data unscaled, pass 0. To scale the data, each whole-number increment over 0 scales by 10. In other words, passing 1 scales by 10, passing 2 scales by 100, and so on. To apply the application’s default scaling, pass the HFMConstants type library constant DEFAULT_SCALE, described in Number Defaults Constants.
lSuppressOptions	Long (ByVal). The type of suppression to be applied. You can specify any combination of the following hexadecimal values: 0x00. No suppression; data is returned for all cells specified by the dimension member arguments. 0x01. Suppress rows in which all cells contain no data. 0x02. Suppress rows in which all cells contain derived data. 0x04. Suppress rows in which all cells contain a value of zero (0). 0x08. Suppress rows in which all cells consist of invalid intersections. For example, passing 0x01 suppresses rows consisting of cells that contain no data, while passing 0x05 suppresses rows consisting of cells that contain either zero or no data.
lNumRows	Long (ByVal). Specifies the number of rows that the point of view comprises. Caution! You must pass a valid number of rows; otherwise, an error will occur. For example, if you pass 3, and the member ID arrays cannot be resolved to three rows of data, an error occurs.
pvaravbRowIsSuppressed	Variant array. Indicates whether a row is suppressed. Returns TRUE if the row is suppressed, FALSE otherwise. A row is suppressed only when all of the row’s cells meet the lSuppressOptions argument’s criteria. The array items are returned as a Boolean subtype.
pvarabstrData	Variant array. Returns data for the rows of cells that are not suppressed. Note: If only some of the cells in a row meet the lSuppressOptions argument’s suppression criteria, these cells are not suppressed. Only rows in which all the cells meet the criteria are suppressed. You can correlate this data with the members passed in the member ID arguments by looping through the array returned in the pvarabRowIsSuppressed argument. The array items are returned as a String subtype.
pvaralStatus	Variant array. Returns the statuses of the cells returned in the pvarabstrData argument. These two arrays have a one-to-one correspondence. For information on the values returned, see About Cell Statuses. The array items are returned as a Long subtype.