EnumAuditTasks2

Returns task audit information from a given range of audit records that meet the selection criteria. Criteria include task, date range, application server, and user. Audit information is returned in arrays that have a one-to-one correspondence.

Note:

To return audit information for all tasks, either set the vbAllTasks argument to FALSE or use EnumAuditTasks.

The lStartRecord and lEndRecord arguments specify the starting and ending indexes of the range of records, and the pvarlTotalRecords argument returns the total number of records that match the selection criteria. To iterate through all the matching records, in the first call to EnumAuditTasks2 pass 0 to lStartRecord, then use the count returned by pvarlTotalRecords to loop through the remaining records.

Note:

The number of matching records can change after you call EnumAuditTasks2. For example, a user might delete some or all of the audit records.

Syntax

<HFMwSystemInfo>.EnumAuditTasks2 dStartTime, dEndTime, vbAllServers, bstrServer, vbAllUsers, bstrActivityUserName, vbAllTasks, lActivityTaskID, lStartRecord, lEndRecord, pvaravarActivityUserID, pvaravarActivityUserName, pvaravarActivitySessionID, pvaravarServerName, pvaravarActivityCode, pvaravarStartTime, pvaravarEndTime, pvaravarDescription, pvaravarModuleNames, pvarlTotalRecords

Argument

Description

dStartTime

The starting date and time of the date range. Pass a Double that can be cast to a Date format.

Tip:

To search for all dates, pass 0.

Input argument. Double subtype.

dEndTime

The ending date and time of the date range. Pass a Double that can be cast to a Date format.

Tip:

To search for all dates, pass 0.

Input argument. Double subtype.

vbAllServers

A flag that determines whether audit information for all application servers is returned. Pass TRUE for all application servers, FALSE to specify an application server with the bstrServer argument.

Input argument. Boolean subtype.

bstrServer

The name of the application server for which to return audit information. This argument is used only if the vbAllServers argument is set to FALSE.

Input argument. String subtype.

vbAllUsers

A flag that determines whether audit information for all users is returned. Pass TRUE for all users, FALSE to specify a user with the bstrActivityUserName argument.

Input argument. Boolean subtype.

bstrActivityUserName

The username of the user for whom to return audit information. This argument is used only if the vbAllUsers argument is set to FALSE.

Input argument. String subtype.

vbAllTasks

Specifies whether audit information for all tasks or a given task is returned. Pass TRUE for all tasks, FALSE to specify a task with the lActivityTaskID argument.

Input argument. Boolean subtype.

lActivityTaskID

The ID of the task for which to return audit information. This argument is used only if the vbAllTasks argument is set to FALSE.

Task IDs are represented by the HFMConstants type library constants listed in User Activity Constants.

Input argument. Long subtype.

lStartRecord

The index of the first record in the range of records to retrieve. This is a zero-based index.

Input argument. Long subtype.

lEndRecord

The index of the last record in the range of records to retrieve. This is a zero-based index.

Input argument. Long subtype.

pvaravarActivityUserID

Returns an array containing the activity user IDs for the users who performed the tasks.

The corresponding item in the array returned by the pvaravarActivityUserName argument contains the username associated with an activity user ID.

Input/output argument.

pvaravarActivityUserName

Returns an array containing the usernames of the users who performed the tasks.

Note:

This is a 1-based array.

Input/output argument.

pvaravarActivitySessionID

Returns an array containing the internal IDs of the sessions in which the tasks occurred. A user can have multiple sessions.

Input/output argument.

pvaravarServerName

Returns an array containing the names of the application servers on which the tasks occurred.

Note:

This is a 1-based array.

Input/output argument.

pvaravarActivityCode

Returns an array containing the IDs of the tasks performed by the users. Valid values are represented by the HFMConstants type library constants listed in User Activity Constants.

Input/output argument.

pvaravarStartTime

Returns an array containing the starting times of the tasks. Array items are formatted as Doubles that can be cast to the Date format.

Input/output argument.

pvaravarEndTime

Returns an array containing the ending times of the tasks. Array items are formatted as Doubles that can be cast to the Date format.

Input/output argument.

pvaravarDescription

Returns an array containing the tasks’ descriptions.

Note:

This is a 1-based array.

Input/output argument.

pvaravarModuleNames

Returns an array containing the names of the tasks’ modules.

Note:

This is a 1-based array.

Input/output argument.

pvarlTotalRecords

Returns the total number of audit records in the database that meet the filtering criteria.

Input/output argument.