GetReportID Function

Retrieves the ID of the report that is currently being processed.

Syntax

GetReportID(
    IREPORTINFO_HANDLE i_hIReportInfo,
    long* o_reportId)

Parameters

i_hIReportInfo [In]

The handle of the interface. See hIReportInfo Variable.

o_reportId [Out]

The ID of the report or subreport.

Returns

Greater than zero if successful, zero or less if not. Use RET_OK(x) and RET_ERROR(x) to check for failure.

Remarks

This function will retrieve the object ID of a report or subreport. If the intercepted request is a view request, it will retrieve the ID of the report or instance that is being viewed. If the intercepted request is a schedule request, the GetReportID function returns the ID of the scheduled object, which is in fact the parent of the generated instance. For example, if you schedule an instance based on ReportA, GetReportID returns the object ID of ReportA. If you schedule an instance based on InstanceB, GetReportID returns the object ID of InstanceB.