1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH FORM_FIELD_BUFFER 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 form_field_buffer, set_field_buffer, field_buffer, set_field_status,
  10 field_status, set_max_field \- set and get forms field attributes
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lform\fR \fB -lcurses \fR [ \fIlibrary\fR... ]
  15 #include <form.h>
  16 
  17 
  18 
  19 \fBint\fR \fBset_field_buffer\fR(\fBFIELD *\fR\fIfield\fR, \fBint\fR \fIbuf\fR, \fBchar *\fR\fIvalue\fR);
  20 .fi
  21 
  22 .LP
  23 .nf
  24 \fBchar *\fR\fBfield_buffer\fR(\fBFIELD *\fR\fIfield\fR, \fBint\fR \fIbuf\fR);
  25 .fi
  26 
  27 .LP
  28 .nf
  29 \fBint\fR \fBset_field_status\fR(\fBFIELD *\fR\fIfield\fR, \fBint\fR \fIstatus\fR);
  30 .fi
  31 
  32 .LP
  33 .nf
  34 \fBint\fR \fBfield_status\fR(\fBFIELD *\fR\fIfield\fR);
  35 .fi
  36 
  37 .LP
  38 .nf
  39 \fBint\fR \fBset_max_field\fR(\fBFIELD *\fR\fIfield\fR, \fBint\fR \fImax\fR);
  40 .fi
  41 
  42 .SH DESCRIPTION
  43 .sp
  44 .LP
  45 \fBset_field_buffer()\fR sets buffer \fIbuf\fR of \fIfield\fR to \fIvalue\fR.
  46 Buffer 0 stores the displayed contents of the field. Buffers other than 0 are
  47 application specific and not used by the \fBforms\fR library routines.
  48 \fBfield_buffer()\fR returns the value of \fIfield\fR buffer \fIbuf\fR.
  49 .sp
  50 .LP
  51 Every field has an associated status flag that is set whenever the contents of
  52 field buffer 0 changes. \fBset_field_status()\fR sets the status flag of
  53 \fIfield\fR to \fIstatus\fR. \fBfield_status()\fR returns the status of
  54 \fIfield\fR.
  55 .sp
  56 .LP
  57 \fBset_max_field()\fR sets a maximum growth on a dynamic field, or if
  58 \fImax=\fR\fB0\fR turns off any maximum growth.
  59 .SH RETURN VALUES
  60 .sp
  61 .LP
  62 \fBfield_buffer()\fR returns \fINULL\fR on error.
  63 .sp
  64 .LP
  65 \fBfield_status()\fR returns \fBTRUE\fR or \fBFALSE\fR.
  66 .sp
  67 .LP
  68 \fBset_field_buffer()\fR, \fBset_field_status()\fR, and \fBset_max_field()\fR
  69 return one of the following:
  70 .sp
  71 .ne 2
  72 .na
  73 \fBE_OK\fR
  74 .ad
  75 .RS 18n
  76 Thefunction returned successfully.
  77 .RE
  78 
  79 .sp
  80 .ne 2
  81 .na
  82 \fBE_SYSTEM_ERROR\fR
  83 .ad
  84 .RS 18n
  85 System error
  86 .RE
  87 
  88 .sp
  89 .ne 2
  90 .na
  91 \fBE_BAD_ARGUMENT\fR
  92 .ad
  93 .RS 18n
  94 An argument is incorrect.
  95 .RE
  96 
  97 .SH ATTRIBUTES
  98 .sp
  99 .LP
 100 See \fBattributes\fR(5) for descriptions of the following attributes:
 101 .sp
 102 
 103 .sp
 104 .TS
 105 box;
 106 c | c
 107 l | l .
 108 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 109 _
 110 MT-Level        Unsafe
 111 .TE
 112 
 113 .SH SEE ALSO
 114 .sp
 115 .LP
 116 \fBcurses\fR(3CURSES), \fBforms\fR(3CURSES), \fBattributes\fR(5)
 117 .SH NOTES
 118 .sp
 119 .LP
 120 The header \fB<form.h>\fR automatically includes the headers  \fB<eti.h>\fR and
 121 \fB<curses.h>\fR\&.