#

| Chapter 5 PL/Vision Package Specifications |

## 5.19 PLVmsg: Message Handling

The PLVmsg (PL/Vision MeSsaGe) package consolidates various kinds of message text in a single PL/SQL-based repository. See Chapter 9, PLVmsg: Single-Sourcing PL/SQL Message Text for details.

### 5.19.1 Restricting use of text

`PROCEDURE restrict;`

  Restricts text for Oracle error numbers to be retrieved from a call to SQLERRM (the default).

`PROCEDURE norestrict;`

  Directs PLVmsg to retrieve message text only from the PL/SQL table.

`FUNCTION restricting RETURN BOOLEAN;`

  Describes current state of restrict toggle: TRUE if restricting text to SQLERRM, FALSE otherwise.

### 5.19.2 Managing and accessing message text

`FUNCTION text (num_in IN INTEGER := SQLCODE) RETURN VARCHAR2;`

  Returns the text stored in the PL/SQL table of the PLVmsg package for the specified row number.

`PROCEDURE add_text (num_in IN INTEGER, text_in IN VARCHAR2);`

  Adds text to the PL/SQL table of the PLVmsg package at the specified row number.

`PROCEDURE load_from_dbms`
`(table_in IN VARCHAR2,`
`where_clause_in IN VARCHAR2 := NULL,`
`code_col_in IN VARCHAR2 := 'error_code',`
`text_col_in IN VARCHAR2 := 'error_text');`

  Loads the PL/SQL table of the PLVmsg package from the specified table using DBMS_SQL. You can specify the table name, optional WHERE clause, and even the names of the columns.

`FUNCTION min_row RETURN BINARY_INTEGER;`

  Returns the lowest row number in use by the PLVmsg PL/SQL table. This is necessary for PL/SQL tables in PL/SQL Releases 2.2 and below.

`FUNCTION max_row RETURN BINARY_INTEGER;`

  Returns the highest row number in use by the PLVmsg PL/SQL table. This is necessary for PL/SQL tables in PL/SQL Releases 2.2 and below.

5.18 PLVlst: List Manager |  | 5.20 PLVobj: Object Interface

Copyright (c) 2000 O'Reilly & Associates. All rights reserved.