visus
/
toolchain-gcc-arm-embedded
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2 Commits
1 Branch
Tree: 898a39b5ab
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '898a39b5ab'
${ noResults }
toolchain-gcc-arm-embedded/share/doc/gcc-arm-none-eabi/html/libc/strerror.html

535 lines
14KB
Raw Blame History 

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">

  2. <html>

  3. <!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->

  4. <head>

  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">

  6. <title>strerror (The Red Hat newlib C Library)</title>

  7. 

  8. <meta name="description" content="strerror (The Red Hat newlib C Library)">

  9. <meta name="keywords" content="strerror (The Red Hat newlib C Library)">

  10. <meta name="resource-type" content="document">

  11. <meta name="distribution" content="global">

  12. <meta name="Generator" content="makeinfo">

  13. <link href="index.html#Top" rel="start" title="Top">

  14. <link href="Document-Index.html#Document-Index" rel="index" title="Document Index">

  15. <link href="Document-Index.html#SEC_Contents" rel="contents" title="Table of Contents">

  16. <link href="Strings.html#Strings" rel="up" title="Strings">

  17. <link href="strerror_005fr.html#strerror_005fr" rel="next" title="strerror_r">

  18. <link href="strcspn.html#strcspn" rel="prev" title="strcspn">

  19. <style type="text/css">

  20. <!--

  21. a.summary-letter {text-decoration: none}

  22. blockquote.indentedblock {margin-right: 0em}

  23. blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}

  24. blockquote.smallquotation {font-size: smaller}

  25. div.display {margin-left: 3.2em}

  26. div.example {margin-left: 3.2em}

  27. div.lisp {margin-left: 3.2em}

  28. div.smalldisplay {margin-left: 3.2em}

  29. div.smallexample {margin-left: 3.2em}

  30. div.smalllisp {margin-left: 3.2em}

  31. kbd {font-style: oblique}

  32. pre.display {font-family: inherit}

  33. pre.format {font-family: inherit}

  34. pre.menu-comment {font-family: serif}

  35. pre.menu-preformatted {font-family: serif}

  36. pre.smalldisplay {font-family: inherit; font-size: smaller}

  37. pre.smallexample {font-size: smaller}

  38. pre.smallformat {font-family: inherit; font-size: smaller}

  39. pre.smalllisp {font-size: smaller}

  40. span.nolinebreak {white-space: nowrap}

  41. span.roman {font-family: initial; font-weight: normal}

  42. span.sansserif {font-family: sans-serif; font-weight: normal}

  43. ul.no-bullet {list-style: none}

  44. -->

  45. </style>

  46. 

  47. 

  48. </head>

  49. 

  50. <body lang="en">

  51. <a name="strerror"></a>

  52. <div class="header">

  53. <p>

  54. Next: <a href="strerror_005fr.html#strerror_005fr" accesskey="n" rel="next">strerror_r</a>, Previous: <a href="strcspn.html#strcspn" accesskey="p" rel="prev">strcspn</a>, Up: <a href="Strings.html#Strings" accesskey="u" rel="up">Strings</a> &nbsp; [<a href="Document-Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Document-Index.html#Document-Index" title="Index" rel="index">Index</a>]</p>

  55. </div>

  56. <hr>

  57. <a name="strerror_002c-strerror_005fl_002d_002d_002dconvert-error-number-to-string"></a>

  58. <h3 class="section">5.27 <code>strerror</code>, <code>strerror_l</code>&mdash;convert error number to string</h3>

  59. <a name="index-strerror"></a>

  60. <a name="index-strerror_005fl"></a>

  61. <p><strong>Synopsis</strong>

  62. </p><div class="example">

  63. <pre class="example">#include &lt;string.h&gt;

  64. char *strerror(int <var>errnum</var>);

  65. char *strerror_l(int <var>errnum</var>, locale_t <var>locale</var>);

  66. char *_strerror_r(struct _reent <var>ptr</var>, int <var>errnum</var>,

  67.     int <var>internal</var>, int *<var>error</var>);

  68. 

  69. </pre></div>

  70. <p><strong>Description</strong><br>

  71. <code>strerror</code> converts the error number <var>errnum</var> into a

  72. string.  The value of <var>errnum</var> is usually a copy of <code>errno</code>.

  73. If <code>errnum</code> is not a known error number, the result points to an

  74. empty string.

  75. </p>

  76. <p><code>strerror_l</code> is like <code>strerror</code> but creates a string in a format

  77. as expected in locale <var>locale</var>.  If <var>locale</var> is LC_GLOBAL_LOCALE or

  78. not a valid locale object, the behaviour is undefined.

  79. </p>

  80. <p>This implementation of <code>strerror</code> prints out the following strings

  81. for each of the values defined in &lsquo;<code>errno.h</code>&rsquo;:

  82. </p>

  83. <dl compact="compact">

  84. <dt><code>0</code></dt>

  85. <dd><p>Success

  86. </p>

  87. </dd>

  88. <dt><code>E2BIG</code></dt>

  89. <dd><p>Arg list too long

  90. </p>

  91. </dd>

  92. <dt><code>EACCES</code></dt>

  93. <dd><p>Permission denied

  94. </p>

  95. </dd>

  96. <dt><code>EADDRINUSE</code></dt>

  97. <dd><p>Address already in use

  98. </p>

  99. </dd>

  100. <dt><code>EADDRNOTAVAIL</code></dt>

  101. <dd><p>Address not available

  102. </p>

  103. </dd>

  104. <dt><code>EADV</code></dt>

  105. <dd><p>Advertise error

  106. </p>

  107. </dd>

  108. <dt><code>EAFNOSUPPORT</code></dt>

  109. <dd><p>Address family not supported by protocol family

  110. </p>

  111. </dd>

  112. <dt><code>EAGAIN</code></dt>

  113. <dd><p>No more processes

  114. </p>

  115. </dd>

  116. <dt><code>EALREADY</code></dt>

  117. <dd><p>Socket already connected

  118. </p>

  119. </dd>

  120. <dt><code>EBADF</code></dt>

  121. <dd><p>Bad file number

  122. </p>

  123. </dd>

  124. <dt><code>EBADMSG</code></dt>

  125. <dd><p>Bad message

  126. </p>

  127. </dd>

  128. <dt><code>EBUSY</code></dt>

  129. <dd><p>Device or resource busy

  130. </p>

  131. </dd>

  132. <dt><code>ECANCELED</code></dt>

  133. <dd><p>Operation canceled

  134. </p>

  135. </dd>

  136. <dt><code>ECHILD</code></dt>

  137. <dd><p>No children

  138. </p>

  139. </dd>

  140. <dt><code>ECOMM</code></dt>

  141. <dd><p>Communication error

  142. </p>

  143. </dd>

  144. <dt><code>ECONNABORTED</code></dt>

  145. <dd><p>Software caused connection abort

  146. </p>

  147. </dd>

  148. <dt><code>ECONNREFUSED</code></dt>

  149. <dd><p>Connection refused

  150. </p>

  151. </dd>

  152. <dt><code>ECONNRESET</code></dt>

  153. <dd><p>Connection reset by peer

  154. </p>

  155. </dd>

  156. <dt><code>EDEADLK</code></dt>

  157. <dd><p>Deadlock

  158. </p>

  159. </dd>

  160. <dt><code>EDESTADDRREQ</code></dt>

  161. <dd><p>Destination address required

  162. </p>

  163. </dd>

  164. <dt><code>EEXIST</code></dt>

  165. <dd><p>File exists

  166. </p>

  167. </dd>

  168. <dt><code>EDOM</code></dt>

  169. <dd><p>Mathematics argument out of domain of function

  170. </p>

  171. </dd>

  172. <dt><code>EFAULT</code></dt>

  173. <dd><p>Bad address

  174. </p>

  175. </dd>

  176. <dt><code>EFBIG</code></dt>

  177. <dd><p>File too large

  178. </p>

  179. </dd>

  180. <dt><code>EHOSTDOWN</code></dt>

  181. <dd><p>Host is down

  182. </p>

  183. </dd>

  184. <dt><code>EHOSTUNREACH</code></dt>

  185. <dd><p>Host is unreachable

  186. </p>

  187. </dd>

  188. <dt><code>EIDRM</code></dt>

  189. <dd><p>Identifier removed

  190. </p>

  191. </dd>

  192. <dt><code>EILSEQ</code></dt>

  193. <dd><p>Illegal byte sequence

  194. </p>

  195. </dd>

  196. <dt><code>EINPROGRESS</code></dt>

  197. <dd><p>Connection already in progress

  198. </p>

  199. </dd>

  200. <dt><code>EINTR</code></dt>

  201. <dd><p>Interrupted system call

  202. </p>

  203. </dd>

  204. <dt><code>EINVAL</code></dt>

  205. <dd><p>Invalid argument

  206. </p>

  207. </dd>

  208. <dt><code>EIO</code></dt>

  209. <dd><p>I/O error

  210. </p>

  211. </dd>

  212. <dt><code>EISCONN</code></dt>

  213. <dd><p>Socket is already connected

  214. </p>

  215. </dd>

  216. <dt><code>EISDIR</code></dt>

  217. <dd><p>Is a directory

  218. </p>

  219. </dd>

  220. <dt><code>ELIBACC</code></dt>

  221. <dd><p>Cannot access a needed shared library

  222. </p>

  223. </dd>

  224. <dt><code>ELIBBAD</code></dt>

  225. <dd><p>Accessing a corrupted shared library

  226. </p>

  227. </dd>

  228. <dt><code>ELIBEXEC</code></dt>

  229. <dd><p>Cannot exec a shared library directly

  230. </p>

  231. </dd>

  232. <dt><code>ELIBMAX</code></dt>

  233. <dd><p>Attempting to link in more shared libraries than system limit

  234. </p>

  235. </dd>

  236. <dt><code>ELIBSCN</code></dt>

  237. <dd><p><code>.lib</code> section in a.out corrupted

  238. </p>

  239. </dd>

  240. <dt><code>EMFILE</code></dt>

  241. <dd><p>File descriptor value too large

  242. </p>

  243. </dd>

  244. <dt><code>EMLINK</code></dt>

  245. <dd><p>Too many links

  246. </p>

  247. </dd>

  248. <dt><code>EMSGSIZE</code></dt>

  249. <dd><p>Message too long

  250. </p>

  251. </dd>

  252. <dt><code>EMULTIHOP</code></dt>

  253. <dd><p>Multihop attempted

  254. </p>

  255. </dd>

  256. <dt><code>ENAMETOOLONG</code></dt>

  257. <dd><p>File or path name too long

  258. </p>

  259. </dd>

  260. <dt><code>ENETDOWN</code></dt>

  261. <dd><p>Network interface is not configured

  262. </p>

  263. </dd>

  264. <dt><code>ENETRESET</code></dt>

  265. <dd><p>Connection aborted by network

  266. </p>

  267. </dd>

  268. <dt><code>ENETUNREACH</code></dt>

  269. <dd><p>Network is unreachable

  270. </p>

  271. </dd>

  272. <dt><code>ENFILE</code></dt>

  273. <dd><p>Too many open files in system

  274. </p>

  275. </dd>

  276. <dt><code>ENOBUFS</code></dt>

  277. <dd><p>No buffer space available

  278. </p>

  279. </dd>

  280. <dt><code>ENODATA</code></dt>

  281. <dd><p>No data

  282. </p>

  283. </dd>

  284. <dt><code>ENODEV</code></dt>

  285. <dd><p>No such device

  286. </p>

  287. </dd>

  288. <dt><code>ENOENT</code></dt>

  289. <dd><p>No such file or directory

  290. </p>

  291. </dd>

  292. <dt><code>ENOEXEC</code></dt>

  293. <dd><p>Exec format error

  294. </p>

  295. </dd>

  296. <dt><code>ENOLCK</code></dt>

  297. <dd><p>No lock

  298. </p>

  299. </dd>

  300. <dt><code>ENOLINK</code></dt>

  301. <dd><p>Virtual circuit is gone

  302. </p>

  303. </dd>

  304. <dt><code>ENOMEM</code></dt>

  305. <dd><p>Not enough space

  306. </p>

  307. </dd>

  308. <dt><code>ENOMSG</code></dt>

  309. <dd><p>No message of desired type

  310. </p>

  311. </dd>

  312. <dt><code>ENONET</code></dt>

  313. <dd><p>Machine is not on the network

  314. </p>

  315. </dd>

  316. <dt><code>ENOPKG</code></dt>

  317. <dd><p>No package

  318. </p>

  319. </dd>

  320. <dt><code>ENOPROTOOPT</code></dt>

  321. <dd><p>Protocol not available

  322. </p>

  323. </dd>

  324. <dt><code>ENOSPC</code></dt>

  325. <dd><p>No space left on device

  326. </p>

  327. </dd>

  328. <dt><code>ENOSR</code></dt>

  329. <dd><p>No stream resources

  330. </p>

  331. </dd>

  332. <dt><code>ENOSTR</code></dt>

  333. <dd><p>Not a stream

  334. </p>

  335. </dd>

  336. <dt><code>ENOSYS</code></dt>

  337. <dd><p>Function not implemented

  338. </p>

  339. </dd>

  340. <dt><code>ENOTBLK</code></dt>

  341. <dd><p>Block device required

  342. </p>

  343. </dd>

  344. <dt><code>ENOTCONN</code></dt>

  345. <dd><p>Socket is not connected

  346. </p>

  347. </dd>

  348. <dt><code>ENOTDIR</code></dt>

  349. <dd><p>Not a directory

  350. </p>

  351. </dd>

  352. <dt><code>ENOTEMPTY</code></dt>

  353. <dd><p>Directory not empty

  354. </p>

  355. </dd>

  356. <dt><code>ENOTRECOVERABLE</code></dt>

  357. <dd><p>State not recoverable

  358. </p>

  359. </dd>

  360. <dt><code>ENOTSOCK</code></dt>

  361. <dd><p>Socket operation on non-socket

  362. </p>

  363. </dd>

  364. <dt><code>ENOTSUP</code></dt>

  365. <dd><p>Not supported

  366. </p>

  367. </dd>

  368. <dt><code>ENOTTY</code></dt>

  369. <dd><p>Not a character device

  370. </p>

  371. </dd>

  372. <dt><code>ENXIO</code></dt>

  373. <dd><p>No such device or address

  374. </p>

  375. </dd>

  376. <dt><code>EOPNOTSUPP</code></dt>

  377. <dd><p>Operation not supported on socket

  378. </p>

  379. </dd>

  380. <dt><code>EOVERFLOW</code></dt>

  381. <dd><p>Value too large for defined data type

  382. </p>

  383. </dd>

  384. <dt><code>EOWNERDEAD</code></dt>

  385. <dd><p>Previous owner died

  386. </p>

  387. </dd>

  388. <dt><code>EPERM</code></dt>

  389. <dd><p>Not owner

  390. </p>

  391. </dd>

  392. <dt><code>EPIPE</code></dt>

  393. <dd><p>Broken pipe

  394. </p>

  395. </dd>

  396. <dt><code>EPROTO</code></dt>

  397. <dd><p>Protocol error

  398. </p>

  399. </dd>

  400. <dt><code>EPROTOTYPE</code></dt>

  401. <dd><p>Protocol wrong type for socket

  402. </p>

  403. </dd>

  404. <dt><code>EPROTONOSUPPORT</code></dt>

  405. <dd><p>Unknown protocol

  406. </p>

  407. </dd>

  408. <dt><code>ERANGE</code></dt>

  409. <dd><p>Result too large

  410. </p>

  411. </dd>

  412. <dt><code>EREMOTE</code></dt>

  413. <dd><p>Resource is remote

  414. </p>

  415. </dd>

  416. <dt><code>EROFS</code></dt>

  417. <dd><p>Read-only file system

  418. </p>

  419. </dd>

  420. <dt><code>ESHUTDOWN</code></dt>

  421. <dd><p>Can&rsquo;t send after socket shutdown

  422. </p>

  423. </dd>

  424. <dt><code>ESOCKTNOSUPPORT</code></dt>

  425. <dd><p>Socket type not supported

  426. </p>

  427. </dd>

  428. <dt><code>ESPIPE</code></dt>

  429. <dd><p>Illegal seek

  430. </p>

  431. </dd>

  432. <dt><code>ESRCH</code></dt>

  433. <dd><p>No such process

  434. </p>

  435. </dd>

  436. <dt><code>ESRMNT</code></dt>

  437. <dd><p>Srmount error

  438. </p>

  439. </dd>

  440. <dt><code>ESTRPIPE</code></dt>

  441. <dd><p>Strings pipe error

  442. </p>

  443. </dd>

  444. <dt><code>ETIME</code></dt>

  445. <dd><p>Stream ioctl timeout

  446. </p>

  447. </dd>

  448. <dt><code>ETIMEDOUT</code></dt>

  449. <dd><p>Connection timed out

  450. </p>

  451. </dd>

  452. <dt><code>ETXTBSY</code></dt>

  453. <dd><p>Text file busy

  454. </p>

  455. </dd>

  456. <dt><code>EWOULDBLOCK</code></dt>

  457. <dd><p>Operation would block (usually same as EAGAIN)

  458. </p>

  459. </dd>

  460. <dt><code>EXDEV</code></dt>

  461. <dd><p>Cross-device link

  462. </p>

  463. </dd>

  464. </dl>

  465. 

  466. 

  467. <p><code>_strerror_r</code> is a reentrant version of the above.

  468. </p>

  469. <br>

  470. <p><strong>Returns</strong><br>

  471. This function returns a pointer to a string.  Your application must

  472. not modify that string.

  473. </p>

  474. <br>

  475. <p><strong>Portability</strong><br>

  476. ANSI C requires <code>strerror</code>, but does not specify the strings used

  477. for each error number.

  478. </p>

  479. <p><code>strerror_l</code> is POSIX-1.2008.

  480. </p>

  481. <p>Although this implementation of <code>strerror</code> is reentrant (depending

  482. on <code>_user_strerror</code>), ANSI C declares that subsequent calls to

  483. <code>strerror</code> may overwrite the result string; therefore portable

  484. code cannot depend on the reentrancy of this subroutine.

  485. </p>

  486. <p>Although this implementation of <code>strerror</code> guarantees a non-null

  487. result with a NUL-terminator, some implementations return <code>NULL</code>

  488. on failure.  Although POSIX allows <code>strerror</code> to set <code>errno</code>

  489. to EINVAL on failure, this implementation does not do so (unless

  490. you provide <code>_user_strerror</code>).

  491. </p>

  492. <p>POSIX recommends that unknown <var>errnum</var> result in a message

  493. including that value, however it is not a requirement and this

  494. implementation does not provide that information (unless you

  495. provide <code>_user_strerror</code>).

  496. </p>

  497. <p>This implementation of <code>strerror</code> provides for user-defined

  498. extensibility.  <code>errno.h</code> defines <var>__ELASTERROR</var>, which can be

  499. used as a base for user-defined error values.  If the user supplies a

  500. routine named <code>_user_strerror</code>, and <var>errnum</var> passed to

  501. <code>strerror</code> does not match any of the supported values,

  502. <code>_user_strerror</code> is called with three arguments.  The first is of

  503. type <var>int</var>, and is the <var>errnum</var> value unknown to <code>strerror</code>.

  504. The second is of type <var>int</var>, and matches the <var>internal</var> argument

  505. of <code>_strerror_r</code>; this should be zero if called from <code>strerror</code>

  506. and non-zero if called from any other function; <code>_user_strerror</code> can

  507. use this information to satisfy the POSIX rule that no other

  508. standardized function can overwrite a static buffer reused by

  509. <code>strerror</code>.  The third is of type <var>int *</var>, and matches the

  510. <var>error</var> argument of <code>_strerror_r</code>; if a non-zero value is stored

  511. into that location (usually <var>EINVAL</var>), then <code>strerror</code> will set

  512. <code>errno</code> to that value, and the XPG variant of <code>strerror_r</code> will

  513. return that value instead of zero or <var>ERANGE</var>.  <code>_user_strerror</code>

  514. returns a <var>char *</var> value; returning <var>NULL</var> implies that the user

  515. function did not choose to handle <var>errnum</var>.  The default

  516. <code>_user_strerror</code> returns <var>NULL</var> for all input values.  Note that

  517. <code>_user_sterror</code> must be thread-safe, and only denote errors via the

  518. third argument rather than modifying <code>errno</code>, if <code>strerror</code> and

  519. <code>strerror_r</code> are are to comply with POSIX.

  520. </p>

  521. <p><code>strerror</code> requires no supporting OS subroutines.

  522. </p>

  523. <br>

  524. 

  525. <hr>

  526. <div class="header">

  527. <p>

  528. Next: <a href="strerror_005fr.html#strerror_005fr" accesskey="n" rel="next">strerror_r</a>, Previous: <a href="strcspn.html#strcspn" accesskey="p" rel="prev">strcspn</a>, Up: <a href="Strings.html#Strings" accesskey="u" rel="up">Strings</a> &nbsp; [<a href="Document-Index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Document-Index.html#Document-Index" title="Index" rel="index">Index</a>]</p>

  529. </div>

  530. 

  531. 

  532. 

  533. </body>

  534. </html>