form/frm_user.c

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