GetReportTitle Function

Retrieves the title (or name) of the report or subreport.

Syntax

GetReportTitle(
    IREPORTINFO_HANDLE i_hIReportInfo ,
    unsigned short* io_reportTitleSize, 
    Char* o_reportTitle,
    bool* o_isSubReport)

Parameters

i_hIReportInfo [In]

The handle of the interface. See hIReportInfo Variable.

io_reportTitleSize [In, Out]

The size of your buffer.

o_reportTitle

The title of the report or subreport. If o_isSubReport is False, then the title of the main report is retrieved; if o_isSubReport is True, then the title of the subreport is retrieved.

o_isSubReport

Returns True if the report being processed is a subreport, and False if it is the main report. Whether or not the report is a subreport or a main report also determines which selection formula is retrieved by the GetOldSelectionFormula Function.

Returns

Each function returns a RET_VALUE that is an error code of type Long. The return value is greater than zero if the call was successful, and zero or less if not. Use RET_OK(x) and RET_ERROR(x) to check for failure.

If the function call fails, check the value of the buffer size parameter. After a successful function call, this parameter contains the size of the buffer that you passed in. However, if the buffer size is too small, then the function returns PROCESSEXTERR_BUFFERSIZETOOSMALL, and the buffer size that is needed is specified in the parameter.