Skip to content

Commit 5c4b5c1

Browse files
author
Sebastian Carpenter
committed
updated WolfSSL-Manual Chapter 8
links to two particular files were causing lines to be truncated, so I have removed the links to these files.
1 parent 1016123 commit 5c4b5c1

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

wolfSSL/src/chapter08.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,17 @@ The log levels can be found in `wolfssl/wolfcrypt/logging.h`, and the implementa
1919
2020
wolfSSL tries to provide informative error messages in order to help with debugging.
2121
22-
Each [`wolfSSL_read()`](group__IO.md#function-wolfssl_read) and [`wolfSSL_write()`](group__IO.md#function-wolfssl_write) call will return the number of bytes written upon success, 0 upon connection closure, and -1 for an error, just like `read()` and `write()`. In the event of an error you can use two calls to get more information about the error.
22+
[//]: # (This is a comment. links to group__IO.md and group__Debug.md are causing lines to be truncated so I have removed references to them.)
2323
24-
The function [`wolfSSL_get_error()`](group__Debug.md#function-wolfssl_get_error) will return the current error code. It takes the current `WOLFSSL` object, and [`wolfSSL_read()`](group__IO.md#function-wolfssl_read) or [`wolfSSL_write()`](group__IO.md#function-wolfssl_write) result value as an arguments and returns the corresponding error code.
24+
Each `wolfSSL_read()` and `wolfSSL_write()` call will return the number of bytes written upon success, 0 upon connection closure, and -1 for an error, just like `read()` and `write()`. In the event of an error you can use two calls to get more information about the error.
25+
26+
The function `wolfSSL_get_error()` will return the current error code. It takes the current `WOLFSSL` object, and `wolfSSL_read()` or `wolfSSL_write()` result value as arguments and returns the current error code.
2527
2628
```c
2729
int err = wolfSSL_get_error(ssl, result);
2830
```
2931

30-
To get a more human-readable error code description, the [`wolfSSL_ERR_error_string()`](group__Debug.md#function-wolfssl_err_error_string) function can be used. It takes the return code from [`wolfSSL_get_error`](group__Debug.md#function-wolfssl_get_error) and a storage buffer as arguments, and places the corresponding error description into the storage buffer (`errorString` in the example below).
32+
To get a more human-readable error code description, the `wolfSSL_ERR_error_string()` function can be used. It takes the return code from `wolfSSL_get_error` and a storage buffer as arguments, and places the corresponding error description into the storage buffer (`errorString` in the example below).
3133

3234
```c
3335
char errorString[80];

0 commit comments

Comments
 (0)