]> git.saurik.com Git - apple/xnu.git/blobdiff - bsd/man/man2/aio_suspend.2
xnu-4903.270.47.tar.gz
[apple/xnu.git] / bsd / man / man2 / aio_suspend.2
index c0b85ce105f7dd2899641f99e4cc10c89e91e244..3b576c8343d1b98cab426d5ab091f2283c43d393 100644 (file)
 .Sh SYNOPSIS
 .In aio.h
 .Ft int
 .Sh SYNOPSIS
 .In aio.h
 .Ft int
-.Fn aio_suspend "const struct aiocb * const iocbs[]" "int niocb" "const struct timespec * timeout"
+.Fo aio_suspend
+.Fa "const struct aiocb *const list[]"
+.Fa "int nent"
+.Fa "const struct timespec *timeout"
+.Fc
 .Sh DESCRIPTION
 The
 .Fn aio_suspend
 .Sh DESCRIPTION
 The
 .Fn aio_suspend
@@ -46,10 +50,10 @@ delivered, or the
 has passed.
 .Pp
 The
 has passed.
 .Pp
 The
-.Fa iocbs
+.Fa list
 argument
 is an array of
 argument
 is an array of
-.Fa niocb
+.Fa nent
 pointers to asynchronous I/O requests.  Array members containing
 NULL will be silently ignored.
 .Pp
 pointers to asynchronous I/O requests.  Array members containing
 NULL will be silently ignored.
 .Pp
@@ -63,10 +67,10 @@ poll, the
 .Fa timeout
 should point to a zero-value timespec structure.
 .Sh RETURN VALUES
 .Fa timeout
 should point to a zero-value timespec structure.
 .Sh RETURN VALUES
-If one or more of the specified asynchronous I/O requests have
-completed,
+If one or more of the specified asynchronous I/O requests have completed,
 .Fn aio_suspend
 .Fn aio_suspend
-returns 0.  Otherwise it returns -1 and sets
+returns 0.
+Otherwise, it returns -1 and sets
 .Va errno
 to indicate the error, as enumerated below.
 .Sh ERRORS
 .Va errno
 to indicate the error, as enumerated below.
 .Sh ERRORS
@@ -75,19 +79,21 @@ The
 system call will fail if:
 .Bl -tag -width Er
 .It Bq Er EAGAIN
 system call will fail if:
 .Bl -tag -width Er
 .It Bq Er EAGAIN
-the
+The
 .Fa timeout
 .Fa timeout
-expired before any I/O requests completed.
+expired before any of the listed I/O requests completed.
+.\" ==========
+.It Bq Er EINTR
+The suspend was interrupted by a signal.
+.\" ==========
 .It Bq Er EINVAL
 The
 .It Bq Er EINVAL
 The
-.Fa iocbs
+.Fa list
 argument
 contains more than
 .Dv AIO_LISTIO_MAX
 asynchronous I/O requests, or at least one of the requests is not
 valid.
 argument
 contains more than
 .Dv AIO_LISTIO_MAX
 asynchronous I/O requests, or at least one of the requests is not
 valid.
-.It Bq Er EINTR
-the suspend was interrupted by a signal.
 .El
 .Sh SEE ALSO
 .Xr aio_cancel 2 ,
 .El
 .Sh SEE ALSO
 .Xr aio_cancel 2 ,