/ payloads / libpayload / curses / form / frm_user.c
frm_user.c
 1  /****************************************************************************
 2   * Copyright (c) 1998-2004,2010 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   ****************************************************************************/
32  
33  #include "form.priv.h"
34  
35  MODULE_ID("$Id: frm_user.c,v 1.15 2010/01/23 21:14:36 tom Exp $")
36  
37  /*---------------------------------------------------------------------------
38  |   Facility      :  libnform
39  |   Function      :  int set_form_userptr(FORM *form, void *usrptr)
40  |
41  |   Description   :  Set the pointer that is reserved in any form to store
42  |                    application relevant information
43  |
44  |   Return Values :  E_OK         - on success
45  +--------------------------------------------------------------------------*/
46  NCURSES_EXPORT(int)
47  set_form_userptr(FORM *form, void *usrptr)
48  {
49    T((T_CALLED("set_form_userptr(%p,%p)"), (void *)form, (void *)usrptr));
50  
51    Normalize_Form(form)->usrptr = usrptr;
52    RETURN(E_OK);
53  }
54  
55  /*---------------------------------------------------------------------------
56  |   Facility      :  libnform
57  |   Function      :  void *form_userptr(const FORM *form)
58  |
59  |   Description   :  Return the pointer that is reserved in any form to
60  |                    store application relevant information.
61  |
62  |   Return Values :  Value of pointer. If no such pointer has been set,
63  |                    NULL is returned
64  +--------------------------------------------------------------------------*/
65  NCURSES_EXPORT(void *)
66  form_userptr(const FORM *form)
67  {
68    T((T_CALLED("form_userptr(%p)"), (const void *)form));
69    returnVoidPtr(Normalize_Form(form)->usrptr);
70  }
71  
72  /* frm_user.c ends here */