ncurses 4.1
[ncurses.git] / form / fld_user.c
1 /*-----------------------------------------------------------------------------+
2 |           The ncurses form library is  Copyright (C) 1995-1997               |
3 |             by Juergen Pfeifer <Juergen.Pfeifer@T-Online.de>                 |
4 |                          All Rights Reserved.                                |
5 |                                                                              |
6 | Permission to use, copy, modify, and distribute this software and its        |
7 | documentation for any purpose and without fee is hereby granted, provided    |
8 | that the above copyright notice appear in all copies and that both that      |
9 | copyright notice and this permission notice appear in supporting             |
10 | documentation, and that the name of the above listed copyright holder(s) not |
11 | be used in advertising or publicity pertaining to distribution of the        |
12 | software without specific, written prior permission.                         | 
13 |                                                                              |
14 | THE ABOVE LISTED COPYRIGHT HOLDER(S) DISCLAIM ALL WARRANTIES WITH REGARD TO  |
15 | THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FIT-  |
16 | NESS, IN NO EVENT SHALL THE ABOVE LISTED COPYRIGHT HOLDER(S) BE LIABLE FOR   |
17 | ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RE- |
18 | SULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, |
19 | NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH    |
20 | THE USE OR PERFORMANCE OF THIS SOFTWARE.                                     |
21 +-----------------------------------------------------------------------------*/
22
23 #include "form.priv.h"
24
25 MODULE_ID("$Id: fld_user.c,v 1.4 1997/05/01 16:47:54 juergen Exp $")
26
27 /*---------------------------------------------------------------------------
28 |   Facility      :  libnform  
29 |   Function      :  int set_field_userptr(FIELD *field, void *usrptr)
30 |   
31 |   Description   :  Set the pointer that is reserved in any field to store
32 |                    application relevant informations
33 |
34 |   Return Values :  E_OK         - on success
35 +--------------------------------------------------------------------------*/
36 int set_field_userptr(FIELD * field, const void  *usrptr)
37 {
38   Normalize_Field( field )->usrptr = usrptr;
39   RETURN(E_OK);
40 }
41
42 /*---------------------------------------------------------------------------
43 |   Facility      :  libnform  
44 |   Function      :  void *field_userptr(const FIELD *field)
45 |   
46 |   Description   :  Return the pointer that is reserved in any field to
47 |                    store application relevant informations.
48 |
49 |   Return Values :  Value of pointer. If no such pointer has been set,
50 |                    NULL is returned
51 +--------------------------------------------------------------------------*/
52 const void *field_userptr(const FIELD *field)
53 {
54   return Normalize_Field( field )->usrptr;
55 }
56
57 /* fld_user.c ends here */