SAP Business One UI API 10.0 - Objects Reference (10.00.270)

• GetReportData Method

  • UI API

  • • Description

      Returns the report as an XML string.

  • • Syntax

      Visual Basic
      Public Function GetReportData( _    Optional ByVal lPageNum As Long = 0, _    Optional ByVal lNumOfPages As Long = 1, _    Optional ByVal bWithProperties As Boolean = False _ ) As String

  • • Parameters

      lPageNum

      The start page of the report (default is 0, which returns all pages)

      lNumOfPages

      The number of pages to return (default is 1).

      If the number of pages requested is more than the number of pages in the report, the method returns the number of pages in the report.

      bWithProperties

      Indicates whether the data is returned with properties (default is false).

      If set to true and RegisterForReport was called with false, an exception is thrown.

  • • Return Type

      A string representing the report in XML format.

  • • Remarks

      You must call this method when BeforeAction=False and ActionSuccess=True, otherwise it throws an exception.

  • • See Also

      ReportDataInfo Object