GetInputPeriods

Returns the labels of the input periods for a given scenario. You optionally can filter periods that for a given Point of View are read-only or do not support line item input . Passing a Scenario member label returns labels of all the scenario’s input periods; passing an array containing a Point of View’s labels filters the return value.

Note:

A scenario’s input periods are determined by the scenario’s DefaultFreq attribute.

Syntax

<HFMwData>.GetInputPeriods varbstrScenarioStrOrPovArray, pvarbstrPeriods

Argument	Description
varbstrScenarioStrOrPovArray	Specifies the scenario and whether to filter the return value. Pass one of the following values: To return labels of all the scenario’s input periods, pass the scenario’s label. To filter the return value, pass an array of member labels that identify a Point of View. The array must contain 12 elements, and is indexed by the HFMConstants type library constants listed in Dimension ID Constants. For the View dimension, always specify the <Scenario View> member. The Period dimension member must be specified but is ignored. If you specify a parent for the Entity dimension member, the parent is ignored. Following is an example that shows how to define a Point of View array: Dim vaPov(11) vaPov(DIMENSIONSCENARIO) = "Actual" vaPov(DIMENSIONYEAR) = "2004" vaPov(DIMENSIONPERIOD) = "June" vaPov(DIMENSIONVIEW) = "<Scenario View>" vaPov(DIMENSIONENTITY) = "Virginia" vaPov(DIMENSIONVALUE) = "USD" vaPov(DIMENSIONACCOUNT) = "Salaries" vaPov(DIMENSIONICP) = "[ICP None]" vaPov(DIMENSIONCUSTOM1) = "Golfballs" vaPov(DIMENSIONCUSTOM2) = "Customer2" vaPov(DIMENSIONCUSTOM3) = "[None]" vaPov(DIMENSIONCUSTOM4) = "Increases" Input argument.
pvarbstrPeriods	Returns an array of strings containing the labels of the input periods. If you pass in a Point of View array, the return value is filtered in the following ways: Input periods that are invalid for line item details are omitted. If all periods are invalid, an empty array is returned. A read-only period is flagged with a pipe ( \| ) character prefixed to its label. The caller will need to parse for pipe characters. Note: Locked periods that do not contain line item details are considered as invalid input periods and thus are omitted. Output argument.

Argument

Description

varbstrScenarioStrOrPovArray

Specifies the scenario and whether to filter the return value. Pass one of the following values:

To return labels of all the scenario’s input periods, pass the scenario’s label.
To filter the return value, pass an array of member labels that identify a Point of View. The array must contain 12 elements, and is indexed by the HFMConstants type library constants listed in Dimension ID Constants.
For the View dimension, always specify the <Scenario View> member. The Period dimension member must be specified but is ignored. If you specify a parent for the Entity dimension member, the parent is ignored.
Following is an example that shows how to define a Point of View array:
```
Dim vaPov(11)
vaPov(DIMENSIONSCENARIO) = "Actual"
vaPov(DIMENSIONYEAR) = "2004"
vaPov(DIMENSIONPERIOD) = "June"
vaPov(DIMENSIONVIEW) = "<Scenario View>"
vaPov(DIMENSIONENTITY) = "Virginia"
vaPov(DIMENSIONVALUE) = "USD"
vaPov(DIMENSIONACCOUNT) = "Salaries"
vaPov(DIMENSIONICP) = "[ICP None]" 
vaPov(DIMENSIONCUSTOM1) = "Golfballs"
vaPov(DIMENSIONCUSTOM2) = "Customer2"
vaPov(DIMENSIONCUSTOM3) = "[None]"
vaPov(DIMENSIONCUSTOM4) = "Increases"
```

Input argument.

pvarbstrPeriods

Returns an array of strings containing the labels of the input periods.

If you pass in a Point of View array, the return value is filtered in the following ways:

Input periods that are invalid for line item details are omitted. If all periods are invalid, an empty array is returned.
A read-only period is flagged with a pipe ( | ) character prefixed to its label. The caller will need to parse for pipe characters.
Note:
Locked periods that do not contain line item details are considered as invalid input periods and thus are omitted.

Output argument.

Example

GetInputPeriods is used in the example for DeleteLineItemDetails.