1.\" $NetBSD: aio_return.3,v 1.5 2011/08/13 11:10:31 jmcneill Exp $ 2.\" 3.\" Copyright (c) 1999 Softweyr LLC. 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 15.\" THIS SOFTWARE IS PROVIDED BY Softweyr LLC AND CONTRIBUTORS ``AS IS'' AND 16.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18.\" ARE DISCLAIMED. IN NO EVENT SHALL Softweyr LLC OR CONTRIBUTORS BE LIABLE 19.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25.\" SUCH DAMAGE. 26.\" 27.\" $FreeBSD: /repoman/r/ncvs/src/lib/libc/sys/aio_return.2,v 1.19 2006/10/07 10:49:20 trhodes Exp $ 28.\" 29.Dd August 13, 2011 30.Dt AIO_RETURN 3 31.Os 32.Sh NAME 33.Nm aio_return 34.Nd retrieve return status of asynchronous I/O operation (REALTIME) 35.Sh LIBRARY 36.Lb librt 37.Sh SYNOPSIS 38.In aio.h 39.Ft ssize_t 40.Fn aio_return "struct aiocb *aiocbp" 41.Sh DESCRIPTION 42The 43.Fn aio_return 44system call returns the final status of the asynchronous I/O request 45associated with the structure pointed to by 46.Fa aiocbp . 47.Pp 48The 49.Fn aio_return 50system call 51should only be called once, to obtain the final status of an asynchronous 52I/O operation once it has completed 53.Po Xr aio_error 3 54returns something other than 55.Er EINPROGRESS Pc . 56.Sh RETURN VALUES 57If the asynchronous I/O request has completed, the status is returned 58as described in 59.Xr read 2 , 60.Xr write 2 , 61or 62.Xr fsync 2 . 63Otherwise, 64.Fn aio_return 65returns \-1 and sets 66.Va errno 67to indicate the error condition. 68.Sh ERRORS 69The 70.Fn aio_return 71system call will fail if: 72.Bl -tag -width Er 73.It Bq Er EINVAL 74The 75.Fa aiocbp 76argument 77does not reference a completed asynchronous I/O request. 78.El 79.Sh SEE ALSO 80.Xr fsync 2 , 81.Xr read 2 , 82.Xr write 2 , 83.Xr aio 3 84.Sh STANDARDS 85The 86.Fn aio_return 87system call 88is expected to conform to the 89.St -p1003.1-2001 90standard. 91.Sh HISTORY 92The 93.Fn aio_return 94system call first appeared in 95.Nx 5.0 . 96