\" $NetBSD: prop_send_syscall.3,v 1.6 2017/02/12 16:00:53 abhinav Exp $
\"
\" Copyright (c) 2006 The NetBSD Foundation, Inc.
\" All rights reserved.
\"
\" This code is derived from software contributed to The NetBSD Foundation
\" by Jason R. Thorpe.
\"
\" Redistribution and use in source and binary forms, with or without
\" modification, are permitted provided that the following conditions
\" are met:
\" 1. Redistributions of source code must retain the above copyright
\" notice, this list of conditions and the following disclaimer.
\" 2. Redistributions in binary form must reproduce the above copyright
\" notice, this list of conditions and the following disclaimer in the
\" documentation and/or other materials provided with the distribution.
\"
\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
\" POSSIBILITY OF SUCH DAMAGE.
\"
Dd January 17, 2011
Dt PROP_SEND_SYCALL 3
Os
Sh NAME
Nm prop_array_send_syscall ,
Nm prop_array_recv_syscall ,
Nm prop_dictionary_send_syscall ,
Nm prop_dictionary_recv_syscall
Nd send and receive property lists to and from the kernel using syscalls
Sh SYNOPSIS
In prop/proplib.h
Ft int
Fn prop_array_send_syscall "prop_array_t array" "struct plistref *prefp"
Ft int
Fn prop_array_recv_syscall "const struct plistref *prefp" \
"prop_array_t *arrayp"
Ft int
Fn prop_dictionary_send_syscall "prop_dictionary_t dict" \
"struct plistref *prefp"
Ft int
Fn prop_dictionary_recv_syscall "const struct plistref *prefp" \
"prop_dictionary_t *dictp"
Sh DESCRIPTION
The
Fn prop_array_send_syscall ,
Fn prop_array_recv_syscall ,
Fn prop_dictionary_send_syscall ,
and
Fn prop_dictionary_recv_syscall
functions implement the user space side of a protocol for sending property
lists to and from the kernel using
Xr syscall 2 .
Sh RETURN VALUES
If successful, functions return zero.
Otherwise, an error number is returned to indicate the error.
Sh EXAMPLES
The following
Pq simplified
example demonstrates using
Fn prop_dictionary_send_syscall
and
Fn prop_dictionary_recv_syscall
in an application:
Bd -literal
void
foo_setprops(prop_dictionary_t dict)
{
struct pref pref;
(void) my_syscall_get(\*[Am]pref);
if (prop_dictionary_recv_syscall(\*[Am]pref, \*[Am]dict) != 0)
return (NULL);
return (dict);
}
Ed
Sh ERRORS
Fn prop_array_send_syscall
and
Fn prop_dictionary_send_syscall
will fail if:
Bl -tag -width Er
It Bq Er ENOMEM
Cannot allocate memory
It Bq Er ENOTSUP
Not supported
El
Pp
Fn prop_array_recv_syscall
and
Fn prop_dictionary_recv_syscall
will fail if:
Bl -tag -width Er
It Bq Er EIO
Input/output error
It Bq Er ENOTSUP
Not supported
El
Sh SEE ALSO
Xr prop_array 3 ,
Xr prop_dictionary 3 ,
Xr proplib 3 ,
Xr prop_copyin_ioctl 9
Sh HISTORY
The
Xr proplib 3
property container object library first appeared in
Nx 4.0 .
