\" $NetBSD: panel_userptr.3,v 1.2 2015/10/28 02:23:50 uwe Exp $

\" $NetBSD: panel_userptr.3,v 1.2 2015/10/28 02:23:50 uwe Exp $
\"
\" Copyright (c) 2015 Valery Ushakov
\" All rights reserved.
\"
\" 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 AUTHOR ``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 AUTHOR 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 October 28, 2015
Dt PANEL_USERPTR 3
Os
Sh NAME
Nm set_panel_userptr ,
Nm panel_userptr
Nd user data associated with panels
Sh LIBRARY
Lb libpanel
Sh SYNOPSIS
In panel.h
\"
Ft int
Fn set_panel_userptr "PANEL *p" "char *data"
\"
Ft char *
Fn panel_userptr "PANEL *p"
\"
Sh DESCRIPTION
The function
Fn set_panel_userptr
can be used to associate arbitrary user data with a panel.
Pp
The data associated with a panel can be obtained with
Fn panel_userptr .
Sh RETURN VALUES
Functions returning pointers will return
Dv NULL
if an error is detected.
The functions that return an int will return one of the following
values:
Pp
Bl -tag -width ".Dv ERR" -compact
It Dv OK
The function completed successfully.
It Dv ERR
An error occurred in the function.
El
Sh SEE ALSO
Xr panel 3