EnumRunningTasksPOV

lTaskType

Long (ByVal). Pass the HFMConstants type library constant USERACTIVITYCODE_CONSOLIDATION.

vbAllUsers

Boolean (ByVal). Specifies whether to filter by user. Pass TRUE for all users, FALSE to filter by the user specified with the lUserID argument.

lUserID

Long (ByVal). The activity user ID of the user for whom to return task information. This argument is used only if the vbAllUsers argument is set to FALSE.

To get a user’s activity user ID, use GetActivityUserID.

vbAllServers

Boolean (ByVal). Specifies whether to filter by application server. Pass TRUE for all application servers, FALSE to filter by the application server specified with the bstrServerName argument.

bstrServerName

String (ByVal). The name of the application server for which to return task information. This argument is used only if the vbAllServers argument is set to FALSE.

vbAllSessions

Boolean (ByVal). Specifies whether to return information for all user sessions or only the session for the connected user. Pass TRUE for all sessions, FALSE otherwise.

pvaralTaskIds

Variant. Returns an array containing the task IDs that identify the running tasks. The array is returned as a Long subtype.

pvaralTaskProgress

Variant. Returns an array containing the progress complete percentages of the consolidations. The array is returned as a Long subtype.

pvaralTaskStatus

Variant. Returns an array containing the consolidations’ task statuses. Valid values are represented by the HFMConstants type library constants listed in Task Status Constants. The array is returned as a Long subtype.

pvarabstrUserNames

Variant. Returns an array containing the usernames of the consolidations’ users. The array is returned as a String subtype.

pvarabstrServerNames

Variant. Returns an array containing the names of the application servers for the consolidations. The array is returned as a String subtype.

pvaralEntity

Variant. Returns an array containing the member IDs of the Entity dimension members for the running tasks. The array is returned as a Long subtype.

pvaralParent

Variant. Returns an array containing the member IDs of the parents of the entities returned by the pvaralEntity argument. The array is returned as a Long subtype.

pvaralScenario

Variant. Returns an array containing the member IDs of the Scenario dimension members for the consolidations. The array is returned as a Long subtype.

pvaralYear

Variant. Returns an array containing the member IDs of the Year dimension members for the consolidations. The array is returned as a Long subtype.

pvaralStartPeriod

Variant. Returns an array containing the member IDs of the first Period dimension member in the range of periods for the consolidations. The array is returned as a Long subtype.

pvaralEndPeriod

Variant. Returns an array containing the member IDs of the last Period dimension member in the range of periods for the consolidations. The array is returned as a Long subtype.

pvaralConsolType

Variant. Returns an array of flags that indicate the consolidation types of the consolidations. Valid values are represented by the HFMConstants type library constants described in Consolidation Type Constants.

plTotalRecords

Long. Returns a count of the number of consolidations returned by EnumRunningTasksPOV.