25.5 ADD_ERROR Procedure Signature 3
This procedure adds an error message to the error stack that is used to display text as defined by a shared component. This error message can be displayed to all display locations. It can be called in a validation or process to add one or more errors to the error stack.
Note:
This procedure must be called before the Oracle APEX application has performed the last validation or process. Otherwise, the error is ignored if it does not have a display location of apex_error.c_on_error_page
.
Syntax
APEX_ERROR.ADD_ERROR (
p_error_code IN VARCHAR2,
p0 IN VARCHAR2 DEFAULT NULL,
p1 IN VARCHAR2 DEFAULT NULL,
p2 IN VARCHAR2 DEFAULT NULL,
p3 IN VARCHAR2 DEFAULT NULL,
p4 IN VARCHAR2 DEFAULT NULL,
p5 IN VARCHAR2 DEFAULT NULL,
p6 IN VARCHAR2 DEFAULT NULL,
p7 IN VARCHAR2 DEFAULT NULL,
p8 IN VARCHAR2 DEFAULT NULL,
p9 IN VARCHAR2 DEFAULT NULL,
p_escape_placeholders IN BOOLEAN DEFAULT TRUE,
p_additional_info IN VARCHAR2 DEFAULT NULL,
p_display_location IN VARCHAR2,
p_page_item_name IN VARCHAR2 );
Parameters
Parameters | Description |
---|---|
p_error_code |
Name of shared component text message. |
p_additional_info |
Additional error information needed if the error is displayed on the error page. |
p0 through p9 |
Values for %0 through %9 placeholders defined in the text message. |
p_escape_placeholders |
If set to TRUE , the values provided in p0 through p9 are escaped with sys.htf.escape_sc before replacing the placeholder in the text message. If set to FALSE , values are not escaped.
|
p_display_location |
Specifies where the error message is displayed. Use the constants defined for p_display_location . See Constants and Attributes Used for Result Types.
|
p_page_item_name |
Name of the page item on the current page that is highlighted if apex_error.c_inline_with_field or apex_error.c_inline_with_field_and_notif are used as the display location.
|
Example
This example adds a custom error message, where the text is stored in a text message, to the error stack. The P5_CUSTOMER_ID item is highlighted on the page. The error message is displayed inline in a notification. This example can be used in a validation or process.
apex_error.add_error (
p_error_code => 'INVALID_CUSTOMER_ID',
p0 => l_customer_id,
p_display_location => apex_error.c_inline_with_field_and_notif,
p_page_item_name => 'P5_CUSTOMER_ID' );
Parent topic: APEX_ERROR