EnumReports

Returns the names, descriptions, and timestamps of reports on the application server.

Syntax

<HsvReports>.EnumReports nReportFileType, vbFilterByCurrentUserOnly, vbFilterByCreateTime, dStartTime, dStopTime, vbFilterByReportType, nReportType, pvarabstrNames, pvarabstrDescriptions, pvaradTimestamp

Argument

Description

nReportFileType

Integer (ByVal). Identifies the file type of the report for which you want to return information. Pass one of the constants listed in Document File Type Constants.

vbFilterByCurrentUserOnly

Boolean (ByVal). Determines whether only reports created by the connected user will be returned. Pass TRUE to only return reports created by the connected user, FALSE otherwise.

vbFilterByCreateTime

Boolean (ByVal). For internal use.

dStartTime

Double (ByVal). For internal use.

dStopTime

Double (ByVal). For internal use.

vbFilterByReportType

Boolean (ByVal). Determines whether reports of all types will be returned. Pass TRUE to return only the type of report identified by the nReportType argument, FALSE to return all types of reports.

nReportType

Integer (ByVal). If you pass TRUE for the vbFilterByReportType argument, this argument determines the type of report for which information will be returned. Pass one of the report type constants listed in Document Type Constants that represent report types.

pvarabstrNames

Variant array. Returns the names of the reports that match the criteria specified in EnumReports’ arguments.

The array is returned as a String subtype.

pvarabstrDescriptions

Variant array. Returns the descriptions of the reports. The array is returned as a String subtype.

pvaradTimestamp

Variant array. Returns the timestamps of the reports.

The array is returned as a Double subtype; the array elements are formatted so that they can be cast to the Date data type.

Example

The following example deletes the reports that meet all of the following criteria:

EnumReports returns the names of all the reports that meet these criteria. The report names are then passed to DeleteReports.

Dim dOne As Double, dTwo As Double, vaNames, vaDescs
Dim vaTime, vaRet
'm_cReports is an HsvReports object reference
m_cReports.EnumReports WEBOM_DOCFILETYPE_RPTDEF, True, False, _
   dOne, dTwo, True, WEBOM_DOCTYPE_RPTJOURNAL, vaNames, _
   vaDescs, vaTime
m_cReports.DeleteReports vaNames, WEBOM_DOCFILETYPE_RPTDEF, _
   WEBOM_DOCTYPE_RPTJOURNAL, vaRet