Skip to content

Commit

Permalink
Rationalize the error section
Browse files Browse the repository at this point in the history
  • Loading branch information
cjbj committed May 6, 2015
1 parent 660dc86 commit 1d0548e
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions doc/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ limitations under the License.

1. [Introduction](#intro)
2. [Errors](#errorobj)
- 2.1 [Error Properties](#properror)
3. [Oracledb Class](#oracledbclass)
- 3.1 [Oracledb Constants](#oracledbconstants)
- ARRAY
Expand Down Expand Up @@ -159,19 +160,27 @@ If an invalid value is set for a property, then the *Error* object is
thrown by the driver. The same is true for a read operation on a
write-only property.

The *Error* object contains a message string in the format:
### <a name="properror"></a> 2.1 Error Properties

The *Error* object contains a message property.

```
<origin>-<errno>: <message text>
String message
```

The text of the error message.

The error may be a standard Oracle message with a prefix like ORA or
PLS. Alternatively it may be a driver specific error prefixed with
NJS or DPI.

A single line error message may look like this:

```
ORA-01017: invalid username/password; logon denied
```

An error message may be multi-line, like this:
A multi-line error message may look like this:

```
ORA-06550: line 1, column 7:
Expand All @@ -180,15 +189,6 @@ ORA-06550: line 1, column 7:
PL/SQL: Statement ignored
```

### 2.1 Error Properties

```
String message
```

The text of the error message. The error may be a standard Oracle
message with a prefix like ORA or PLS. Alternatively it may be a
driver specific error prefixed with NJS or DPI.

## <a name="oracledbclass"></a> 3. Oracledb Class

Expand Down

0 comments on commit 1d0548e

Please sign in to comment.