| 1 |
.TH "hwlocality_api_error_reporting" 3 "Version 2.14.0" "Hardware Locality (hwloc)" \" -*- nroff -*- |
| 2 |
.ad l |
| 3 |
.nh |
| 4 |
.SH NAME |
| 5 |
hwlocality_api_error_reporting \- Error reporting in the API |
| 6 |
.SH SYNOPSIS |
| 7 |
.br |
| 8 |
.PP |
| 9 |
.SH "Detailed Description" |
| 10 |
.PP |
| 11 |
Most functions in the hwloc API return an integer value\&. Unless documentated differently, they return 0 on success and -1 on error\&. Functions that return a pointer type return \fRNULL\fP on error\&. |
| 12 |
|
| 13 |
.PP |
| 14 |
\fRerrno\fP will be set to a meaningful value whenever possible\&. This includes the usual \fREINVAL\fP when invalid function parameters are passed or \fRENOMEM\fP when an internal allocation fails\&. Some specific \fRerrno\fP value are also used, for instance for binding errors as documented in \fBCPU binding\fP\&. |
| 15 |
|
| 16 |
.PP |
| 17 |
Some modules describe return values of their functions in their introduction, for instance in \fBThe bitmap API\fP\&. |
| 18 |
.SH "Author" |
| 19 |
.PP |
| 20 |
Generated automatically by Doxygen for Hardware Locality (hwloc) from the source code\&. |