ncurses 5.3
[ncurses.git] / form / frm_user.c
1 /****************************************************************************
2  * Copyright (c) 1998,2000 Free Software Foundation, Inc.                   *
3  *                                                                          *
4  * Permission is hereby granted, free of charge, to any person obtaining a  *
5  * copy of this software and associated documentation files (the            *
6  * "Software"), to deal in the Software without restriction, including      *
7  * without limitation the rights to use, copy, modify, merge, publish,      *
8  * distribute, distribute with modifications, sublicense, and/or sell       *
9  * copies of the Software, and to permit persons to whom the Software is    *
10  * furnished to do so, subject to the following conditions:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22  *                                                                          *
23  * Except as contained in this notice, the name(s) of the above copyright   *
24  * holders shall not be used in advertising or otherwise to promote the     *
25  * sale, use or other dealings in this Software without prior written       *
26  * authorization.                                                           *
27  ****************************************************************************/
28
29 /****************************************************************************
30  *   Author:  Juergen Pfeifer, 1995,1997                                    *
31  *   Contact: http://www.familiepfeifer.de/Contact.aspx?Lang=en             *
32  ****************************************************************************/
33
34 #include "form.priv.h"
35
36 MODULE_ID("$Id: frm_user.c,v 1.10 2002/07/06 15:33:27 juergen Exp $")
37
38 /*---------------------------------------------------------------------------
39 |   Facility      :  libnform  
40 |   Function      :  int set_form_userptr(FORM *form, void *usrptr)
41 |   
42 |   Description   :  Set the pointer that is reserved in any form to store
43 |                    application relevant informations
44 |
45 |   Return Values :  E_OK         - on success
46 +--------------------------------------------------------------------------*/
47 NCURSES_EXPORT(int)
48 set_form_userptr (FORM * form, void *usrptr)
49 {
50   Normalize_Form(form)->usrptr = usrptr;
51   RETURN(E_OK);
52 }
53
54 /*---------------------------------------------------------------------------
55 |   Facility      :  libnform  
56 |   Function      :  void *form_userptr(const FORM *form)
57 |   
58 |   Description   :  Return the pointer that is reserved in any form to
59 |                    store application relevant informations.
60 |
61 |   Return Values :  Value of pointer. If no such pointer has been set,
62 |                    NULL is returned
63 +--------------------------------------------------------------------------*/
64 NCURSES_EXPORT(void *)
65 form_userptr (const FORM * form)
66 {
67   return Normalize_Form(form)->usrptr;
68 }
69
70 /* frm_user.c ends here */