GetOBPInfo

Indicates whether the control is set to display only active Entity dimension members. If only active entities are displayed, GetOBPInfo also returns the member IDs of the Scenario, Year, and Period dimension members that define which entities are considered active for display.

For applications in which Organization by Period is enabled, a user can choose to view only active entities when selecting a member list for the Entity dimension. In addition, active entity viewing can be programmatically specified with SetOBPInfo.

Note:

To test whether Organization by Period is enabled, use HsvMetadata.IsOrgByPeriodApplication.

Syntax

<HsvPOVSelection>.GetOBPInfo pvarbEnabled, plScenario, plYear, plPeriod

Argument	Description
pvarbEnabled	Boolean. Indicates whether only active Entity members are displayed. Returns TRUE if only active entities are displayed, FALSE otherwise.
plScenario	Long. Returns the member ID of the Scenario dimension member specified for active entity viewing. If active entity viewing is not enabled, the HFMConstants type library constant MEMBERNOTUSED is returned. Note: For information on MEMBERNOTUSED, see Dimension Member Constants.
plYear	Long. Returns the member ID of the Year dimension member that the user specified for active entity viewing. If active entity viewing is not enabled, the HFMConstants type library constant MEMBERNOTUSED is returned.
plPeriod	Long. Returns the member ID of the Period dimension member that the user specified for active entity viewing. If active entity viewing is not enabled, the HFMConstants type library constant MEMBERNOTUSED is returned.