A script-enabled browser is required for this page to function properly.

SRW built-in package

Procedure/Exception/Function

Description

SRW.ADD_DEFINITION

procedure that takes an XML report definition stored in a column or variable and adds it to the document buffer

SRW.APPLY_DEFINITION

procedure that takes an XML report definition stored in the document buffer or file system and applies it to the report

SRW.BREAK

procedure that temporarily stops report execution, and displays (read-only) the current values of all columns and parameters

SRW.CONTEXT_FAILURE

exception that stops the report execution and raises the following error message

SRW.CREATE_TEMPORARY_FILENAME

function that returns the name of a temporary file that can be used within PL/SQL by the user for temporary storage

SRW.DO_SQL

procedure that executes the specified SQL statement from within Reports Builder

SRW.DO_SQL_FAILURE

exception that stops the report execution and raises an error message

SRW.GH_CREATE

function that creates and returns a group cursor (SRW.CURSOR)   for groupName

SRW.GH_GET_VALUE

function that retrieves the value of column columnName from the group cursor GC and does an implicit conversion to the output type required

SRW.GH_NEXT

function that moves group cursor GC to the next row

SRW.GET_PAGE_NUM

function that returns the current page number

SRW.GET_REPORT_NAME function that returns the file name of the report being executed

SRW.GET_VALUE

function that returns the value of the specified column

SRW.GETTERR_RUN

function that returns an error message if Reports Builder detects an error while running SRW.RUN_REPORT

SRW.INTEGER_ERROR

exception that stops the report execution and raises an error message

SRW.MAXROW_INERR

exception that stops the report execution and raises an error message

SRW.MAXROW_UNSET

exception that temporarily stops the report execution and raises an error message

SRW.MESSAGE

procedure that displays a message with the message number and text that you specify

SRW.NULL_ARGUMENTS

exception that stops the report execution and raises an error message

SRW.PROGRAM_ABORT

exception that stops the report execution and raises an error message

SRW.REFERENCE

procedure that causes Reports Builder to add the referenced object to the PL/SQL construct's dependency list to determine the object's value just before firing the PL/SQL construct

SRW.RUN_REPORT

procedure that invokes rwrun with the string that you specify

SRW.RUN_REPORT_BATCHNO

exception that stops the report execution and raises an error message

SRW.RUN_REPORT_FAILURE

(If the SRW.RUN_REPORT packaged procedure fails) exception that stops the report execution and raises an error message

SRW.SET_AFTER_FORM_HTML

procedure that inserts any text, graphics, or HTML commands that you want to appear at the bottom of the HTML Parameter Form

SRW.SET_AFTER_PAGE_HTML

procedure that inserts any text, graphics, or HTML commands that you want to appear at the end of pages of your document

SRW.SET_AFTER_PRINTING_CODE

procedure that inserts a reference to the printer escape sequence to be executed after each line of the object

SRW.SET_AFTER_REPORT_HTML

procedure that inserts any text, graphics, or HTML commands that you want to appear at the end of your document

SRW.SET_BACKGROUND_BORDER_COLOR

procedure that specifies the background border color of the object

SRW.SET_BACKGROUND_FILL_COLOR

procedure that specifies the background fill color of the object

SRW.SET_BEFORE_FORM_HTML

procedure that inserts any text, graphics, or HTML commands that you want to appear at the top of the HTML Parameter Form

SRW.SET_BEFORE_PAGE_HTML

procedure that inserts any text, graphics, or HTML commands that you want to appear at the beginning of pages of your document

SRW.SET_BEFORE_PRINTING_CODE

procedure that inserts a reference to the printer escape sequence to be executed before each line of the object

SRW.SET_BEFORE_REPORT_HTML

procedure that inserts any text, graphics, or HTML commands that you want to appear at the beginning of your document

SRW.SET_BOOKMARK

procedure that associates a bookmark with the object and specifies a string that will appear in a bookmark frame of the master HTML document or the PDF document

SRW.SET_BORDER_PATTERN

procedure that specifies the fill pattern for the border of the object

SRW.SET_BORDER_WIDTH

procedure that specifies the width of the object's border in picas

SRW.SET_CHARMODE_TEXT

procedure that specifies the font style of a CHAR, DATE, or NUMBER field in a character-mode report

SRW.SET_CUSTOM_SPACING

procedure that specifies the global text leading for a CHAR, DATE, or NUMBER field, or boilerplate text

SRW.SET_DISPLAY_NAME

procedure that specifies text that displays in a popup as the cursor moves over an image object in reports output in HTML or HTMLCSS format

SRW.SET_FIELD

procedure that sets the value of a character, number, or date field, useful when you want to conditionally change a field's value

SRW.SET_FIELD_CHAR

procedure that sets the value of a character field, useful when you want to conditionally change a field's character value

SRW.SET_FIELD_DATE

procedure that sets the value of a date field, useful when you want to conditionally change a field's date value

SRW.SET_FIELD_NUM

procedure that sets the value of a number field, useful when you want to conditionally change a field's number value

SRW.SET_FILL_PATTERN

procedure that specifies the fill pattern of the object

SRW.SET_FONT_FACE

procedure that specifies font face for a CHAR, DATE, or NUMBER field

SRW.SET_FONT_SIZE

procedure that specifies font size for a CHAR, DATE, or NUMBER field

SRW.SET_FONT_STYLE

procedure that specifies font style for a CHAR, DATE, or NUMBER field

SRW.SET_FONT_WEIGHT

procedure that specifies font weight for a CHAR, DATE, or NUMBER field

SRW.SET_FOREGROUND_BORDER_COLOR

procedure that specifies the foreground border color of the object

SRW.SET_FOREGROUND_FILL_COLOR

procedure that specifies the foreground fill color of the object

SRW.SET_FORMAT_MASK

procedure that specifies the format mask for the DATE or NUMBER field

SRW.SET_FORMAT_ORDER procedure that specifies the order in which report sections should be formatted

SRW.SET_HYPERLINK

procedure that specifies a URL Web link to another document or destination

SRW.SET_HYPERLINK_ATTRS

procedure that applies additional HTML commands to the hyperlink specified in the Property Inspector or SRW.SET HYPERLINK procedure

SRW.SET_JUSTIFICATION

procedure that procedure specifies the horizontal justification of the CHAR, DATE, or NUMBER field

SRW.SET_LINKTAG

procedure that procedure specifies an object's identifier and can be used as the destination in Web links

SRW.SET_MAXROW

procedure that sets the maximum number of records to be fetched for the specified query

SRW.SET_PAGE_NAVIGATION_HTML

procedure that specifies the scripting for navigation controls in page-streamed HTML/HTMLCSS report output

SRW.SET_PDF_ACTION

procedure that specifies a command line that will be executed on the local machine when the object is clicked in the PDF viewer

SRW.SET_PRINTER_TRAY

procedure that specifies the name of a valid printer tray and can be used to switch to different printer trays as your report formats

SRW.SET_SPACING

procedure that specifies the global text leading for a CHAR, DATE, or NUMBER field, or boilerplate text

SRW.SET_TEXT_COLOR

procedure that specifies the global text color of the CHAR, DATE, or NUMBER field

SRW.SET_XML_PROLOG

function that replaces the current report's XML prolog

SRW.SET_XML_TAG

function that replaces the current report, group, outer group, or column XML tag

SRW.SET_XML_TAG_ATTR

function similar to SRW.SET_XML_TAG, but supplies an attribute value rather than an XML tag

SRW.TRUNCATED_VALUE

exception that stops the report execution and raises one of two error messages

SRW.UNKNOWN_QUERY

procedure that stops the report execution and raises an error message

See also

About the Reports Builder built-in package (SRW)

About built-in packages