c3826abdec3fa95ffb73ab847dec34ec6878a075
[ncurses.git] / form / fld_info.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: fld_info.c,v 1.6 2002/07/06 15:33:27 juergen Exp $")
37
38 /*---------------------------------------------------------------------------
39 |   Facility      :  libnform  
40 |   Function      :  int field_info(const FIELD *field,
41 |                                   int *rows, int *cols,
42 |                                   int *frow, int *fcol,
43 |                                   int *nrow, int *nbuf)
44 |   
45 |   Description   :  Retrieve infos about the fields creation parameters.
46 |
47 |   Return Values :  E_OK           - success
48 |                    E_BAD_ARGUMENT - invalid field pointer
49 +--------------------------------------------------------------------------*/
50 NCURSES_EXPORT(int)
51 field_info 
52     (const FIELD *field,
53      int *rows, int *cols, 
54      int *frow, int *fcol, 
55      int *nrow, int *nbuf)
56 {
57   if (!field) 
58     RETURN(E_BAD_ARGUMENT);
59
60   if (rows) *rows = field->rows;
61   if (cols) *cols = field->cols;
62   if (frow) *frow = field->frow;
63   if (fcol) *fcol = field->fcol;
64   if (nrow) *nrow = field->nrow;
65   if (nbuf) *nbuf = field->nbuf;
66   RETURN(E_OK);
67 }
68         
69 /*---------------------------------------------------------------------------
70 |   Facility      :  libnform  
71 |   Function      :  int dynamic_field_info(const FIELD *field,
72 |                                           int *drows, int *dcols,
73 |                                           int *maxgrow)
74 |   
75 |   Description   :  Retrieve informations about a dynamic fields current
76 |                    dynamic parameters.
77 |
78 |   Return Values :  E_OK           - success
79 |                    E_BAD_ARGUMENT - invalid argument
80 +--------------------------------------------------------------------------*/
81 NCURSES_EXPORT(int)
82 dynamic_field_info
83 (const FIELD *field, int *drows, int *dcols, int *maxgrow)
84 {
85   if (!field)
86     RETURN(E_BAD_ARGUMENT);
87
88   if (drows)   *drows   = field->drows;
89   if (dcols)   *dcols   = field->dcols;
90   if (maxgrow) *maxgrow = field->maxgrow;
91
92   RETURN(E_OK);
93 }
94
95 /* fld_info.c ends here */