DeleteLineItemDetails

Deletes line item details for the cells that intersect the specified dimension members. Line item descriptions are used to identify the line items to be deleted.

Syntax

<HFMwData>.DeleteLineItemDetails bstrScenario, bstrYear, bstrEntity, bstrAccount, bstrICP, bstrCustom1, bstrCustom2, bstrCustom3, bstrCustom4, varabstrDetail

Argument

Description

bstrScenario

The name of the Scenario dimension member for the intersecting cells.

Input argument. String subtype.

bstrYear

The name of the Year dimension member for the intersecting cells.

Input argument. String subtype.

bstrEntity

The name of the Entity dimension member for the intersecting cells.

Input argument. String subtype.

bstrAccount

The name of the Account dimension member for the intersecting cells.

Input argument. String subtype.

bstrICP

The name of the Intercompany Partner dimension member for the intersecting cells.

Input argument. String subtype.

bstrCustom1

The name of the Custom 1 dimension member for the intersecting cells.

Input argument. String subtype.

bstrCustom2

The name of the Custom 2 dimension member for the intersecting cells.

Input argument. String subtype.

bstrCustom3

The name of the Custom 3 dimension member for the intersecting cells.

Input argument. String subtype.

bstrCustom4

The name of the Custom 1 dimension member for the intersecting cells.

Input argument. String subtype.

varabstrDetail

An array of strings containing the line item descriptions to be deleted. For each array item, DeleteLineItemDetails deletes the line item with the matching description.

Note:

If an array item does not match a corresponding line item, the item is ignored and no error occurs.

Input argument.

Example

The following subroutine deletes the line items for the cells that intersect the Scenario, Year, Entity, Account, Intercompany Partner, and Custom dimension members passed to it. The first input period returned by GetInputPeriods is passed along with the above members to GetTextCellLineItems, and then the line item descriptions returned are passed to DeleteLineItemDetails.

Sub RemoveLineItems(sScen, sYr, sEnt, sAcct, sIcp, _ 
   sCust1, sCust2, sCust3, sCust4)
Dim cHFMData, vaPers, vaDescriptions
Set cHFMData = Server.CreateObject("Hyperion.HFMwData")
'g_cHFMSession is a previously set HFMwSession object
cHFMData.SetWebSession g_cHFMSession
cHFMData.GetInputPeriods sScen, vaPers
cHFMData.GetTextCellLineItems sScen, sYr, vaPers(0), sEnt, _ 
   sAcct, sIcp, sCust1, sCust2, sCust3, sCust4, vaData, _ 
   vaDescriptions
cHFMData.DeleteLineItemDetails sScen, sYr, sEnt, sAcct, _ 
   sIcp, sCust1, sCust2, sCust3, sCust4, vaDescriptions
End Sub