1.\" $NetBSD: prop_send_syscall.3,v 1.3 2011/01/20 10:48:37 wiz Exp $ 2.\" 3.\" Copyright (c) 2006 The NetBSD Foundation, Inc. 4.\" All rights reserved. 5.\" 6.\" This code is derived from software contributed to The NetBSD Foundation 7.\" by Jason R. Thorpe. 8.\" 9.\" Redistribution and use in source and binary forms, with or without 10.\" modification, are permitted provided that the following conditions 11.\" are met: 12.\" 1. Redistributions of source code must retain the above copyright 13.\" notice, this list of conditions and the following disclaimer. 14.\" 2. Redistributions in binary form must reproduce the above copyright 15.\" notice, this list of conditions and the following disclaimer in the 16.\" documentation and/or other materials provided with the distribution. 17.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 21.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28.\" POSSIBILITY OF SUCH DAMAGE. 29.\" 30.Dd January 17, 2011 31.Dt PROP_SEND_SYCALL 3 32.Os 33.Sh NAME 34.Nm prop_array_send_syscall , 35.Nm prop_array_recv_syscall , 36.Nm prop_dictionary_send_syscall , 37.Nm prop_dictionary_recv_syscall 38.Nd send and receive property lists to and from the kernel using syscalls 39.Sh SYNOPSIS 40.In prop/proplib.h 41.Ft bool 42.Fn prop_array_send_syscall "prop_array_t array" "struct plistref *prefp" 43.Ft bool 44.Fn prop_array_recv_syscall "const struct plistref *prefp" \ 45 "prop_array_t *arrayp" 46.Ft bool 47.Fn prop_dictionary_send_syscall "prop_dictionary_t dict" \ 48 "struct plistref *prefp" 49.Ft bool 50.Fn prop_dictionary_recv_syscall "const struct plistref *prefp" \ 51 "prop_dictionary_t *dictp" 52.Sh DESCRIPTION 53The 54.Nm prop_array_send_syscall , 55.Nm prop_array_recv_syscall , 56.Nm prop_dictionary_send_syscall , 57and 58.Nm prop_dictionary_recv_syscall 59functions implement the user space side of a protocol for sending property 60lists to and from the kernel using 61.Xr syscall 2 . 62.Sh RETURN VALUES 63If successful, the functions return true, false otherwise. 64.Sh EXAMPLES 65The following 66.Pq simplified 67example demonstrates using 68.Fn prop_dictionary_send_syscall 69and 70.Fn prop_dictionary_recv_syscall 71in an application: 72.Bd -literal 73void 74foo_setprops(prop_dictionary_t dict) 75{ 76 struct pref pref; 77 78 (void) prop_dictionary_send_ioctl(dict, \*[Am]pref); 79 (void) my_syscall_set(\*[Am]pref); 80 81} 82 83prop_dictionary_t 84foo_getprops(void) 85{ 86 prop_dictionary_t dict; 87 struct pref pref; 88 89 (void) my_syscall_get(\*[Am]pref); 90 if (!prop_dictionary_recv_syscall(\*[Am]pref, \*[Am]dict)) 91 return (NULL); 92 93 return (dict); 94} 95.Ed 96.Sh SEE ALSO 97.Xr prop_array 3 , 98.Xr prop_dictionary 3 , 99.Xr proplib 3 , 100.Xr prop_copyin_ioctl 9 101.Sh HISTORY 102The 103.Nm proplib 104property container object library first appeared in 105.Nx 4.0 . 106