Print this page
10067 Miscellaneous man page typos
Reviewed by: Robert Mustacchi <rm@joyent.com>
Reviewed by: Andy Fiddaman <andy@omniosce.org>
Reviewed by: Volker A. Brandt <vab@bb-c.de>


  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\&.


  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 .LP
  44 \fBset_field_buffer()\fR sets buffer \fIbuf\fR of \fIfield\fR to \fIvalue\fR.
  45 Buffer 0 stores the displayed contents of the field. Buffers other than 0 are
  46 application specific and not used by the \fBforms\fR library routines.
  47 \fBfield_buffer()\fR returns the value of \fIfield\fR buffer \fIbuf\fR.
  48 .sp
  49 .LP
  50 Every field has an associated status flag that is set whenever the contents of
  51 field buffer 0 changes. \fBset_field_status()\fR sets the status flag of
  52 \fIfield\fR to \fIstatus\fR. \fBfield_status()\fR returns the status of
  53 \fIfield\fR.
  54 .sp
  55 .LP
  56 \fBset_max_field()\fR sets a maximum growth on a dynamic field, or if
  57 \fImax=\fR\fB0\fR turns off any maximum growth.
  58 .SH RETURN VALUES

  59 .LP
  60 \fBfield_buffer()\fR returns \fINULL\fR on error.
  61 .sp
  62 .LP
  63 \fBfield_status()\fR returns \fBTRUE\fR or \fBFALSE\fR.
  64 .sp
  65 .LP
  66 \fBset_field_buffer()\fR, \fBset_field_status()\fR, and \fBset_max_field()\fR
  67 return one of the following:
  68 .sp
  69 .ne 2
  70 .na
  71 \fBE_OK\fR
  72 .ad
  73 .RS 18n
  74 The function returned successfully.
  75 .RE
  76 
  77 .sp
  78 .ne 2
  79 .na
  80 \fBE_SYSTEM_ERROR\fR
  81 .ad
  82 .RS 18n
  83 System error
  84 .RE
  85 
  86 .sp
  87 .ne 2
  88 .na
  89 \fBE_BAD_ARGUMENT\fR
  90 .ad
  91 .RS 18n
  92 An argument is incorrect.
  93 .RE
  94 
  95 .SH ATTRIBUTES

  96 .LP
  97 See \fBattributes\fR(5) for descriptions of the following attributes:
  98 .sp
  99 
 100 .sp
 101 .TS
 102 box;
 103 c | c
 104 l | l .
 105 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 106 _
 107 MT-Level        Unsafe
 108 .TE
 109 
 110 .SH SEE ALSO

 111 .LP
 112 \fBcurses\fR(3CURSES), \fBforms\fR(3CURSES), \fBattributes\fR(5)
 113 .SH NOTES

 114 .LP
 115 The header \fB<form.h>\fR automatically includes the headers  \fB<eti.h>\fR and
 116 \fB<curses.h>\fR\&.