1*0c624ce4Suwe.\" $NetBSD: panel_userptr.3,v 1.2 2015/10/28 02:23:50 uwe Exp $ 2fe186541Suwe.\" 3fe186541Suwe.\" Copyright (c) 2015 Valery Ushakov 4fe186541Suwe.\" All rights reserved. 5fe186541Suwe.\" 6fe186541Suwe.\" Redistribution and use in source and binary forms, with or without 7fe186541Suwe.\" modification, are permitted provided that the following conditions 8fe186541Suwe.\" are met: 9fe186541Suwe.\" 1. Redistributions of source code must retain the above copyright 10fe186541Suwe.\" notice, this list of conditions and the following disclaimer. 11fe186541Suwe.\" 2. Redistributions in binary form must reproduce the above copyright 12fe186541Suwe.\" notice, this list of conditions and the following disclaimer in the 13fe186541Suwe.\" documentation and/or other materials provided with the distribution. 14fe186541Suwe.\" 15fe186541Suwe.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 16fe186541Suwe.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17fe186541Suwe.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18fe186541Suwe.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 19fe186541Suwe.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20fe186541Suwe.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21fe186541Suwe.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22fe186541Suwe.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23fe186541Suwe.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24fe186541Suwe.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25fe186541Suwe.\" 26fe186541Suwe.Dd October 28, 2015 27fe186541Suwe.Dt PANEL_USERPTR 3 28fe186541Suwe.Os 29fe186541Suwe.Sh NAME 30fe186541Suwe.Nm set_panel_userptr , 31fe186541Suwe.Nm panel_userptr 32fe186541Suwe.Nd user data associated with panels 33fe186541Suwe.Sh LIBRARY 34fe186541Suwe.Lb libpanel 35fe186541Suwe.Sh SYNOPSIS 36fe186541Suwe.In panel.h 37fe186541Suwe.\" 38fe186541Suwe.Ft int 39fe186541Suwe.Fn set_panel_userptr "PANEL *p" "char *data" 40fe186541Suwe.\" 41fe186541Suwe.Ft char * 42fe186541Suwe.Fn panel_userptr "PANEL *p" 43fe186541Suwe.\" 44fe186541Suwe.Sh DESCRIPTION 45*0c624ce4SuweThe function 46*0c624ce4Suwe.Fn set_panel_userptr 47*0c624ce4Suwecan be used to associate arbitrary user data with a panel. 48*0c624ce4Suwe.Pp 49*0c624ce4SuweThe data associated with a panel can be obtained with 50*0c624ce4Suwe.Fn panel_userptr . 51*0c624ce4Suwe.Sh RETURN VALUES 52*0c624ce4SuweFunctions returning pointers will return 53*0c624ce4Suwe.Dv NULL 54*0c624ce4Suweif an error is detected. 55*0c624ce4SuweThe functions that return an int will return one of the following 56*0c624ce4Suwevalues: 57*0c624ce4Suwe.Pp 58*0c624ce4Suwe.Bl -tag -width ".Dv ERR" -compact 59*0c624ce4Suwe.It Dv OK 60*0c624ce4SuweThe function completed successfully. 61*0c624ce4Suwe.It Dv ERR 62*0c624ce4SuweAn error occurred in the function. 63*0c624ce4Suwe.El 64fe186541Suwe.Sh SEE ALSO 65fe186541Suwe.Xr panel 3 66