Skip to content

Commit 1d0548e

Browse files
committed
Rationalize the error section
1 parent 660dc86 commit 1d0548e

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

doc/api.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ limitations under the License.
1919

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

162-
The *Error* object contains a message string in the format:
163+
### <a name="properror"></a> 2.1 Error Properties
164+
165+
The *Error* object contains a message property.
163166

164167
```
165-
<origin>-<errno>: <message text>
168+
String message
166169
```
167170

171+
The text of the error message.
172+
173+
The error may be a standard Oracle message with a prefix like ORA or
174+
PLS. Alternatively it may be a driver specific error prefixed with
175+
NJS or DPI.
176+
168177
A single line error message may look like this:
169178

170179
```
171180
ORA-01017: invalid username/password; logon denied
172181
```
173182

174-
An error message may be multi-line, like this:
183+
A multi-line error message may look like this:
175184

176185
```
177186
ORA-06550: line 1, column 7:
@@ -180,15 +189,6 @@ ORA-06550: line 1, column 7:
180189
PL/SQL: Statement ignored
181190
```
182191

183-
### 2.1 Error Properties
184-
185-
```
186-
String message
187-
```
188-
189-
The text of the error message. The error may be a standard Oracle
190-
message with a prefix like ORA or PLS. Alternatively it may be a
191-
driver specific error prefixed with NJS or DPI.
192192

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

0 commit comments

Comments
 (0)