usr/src/man/man3curses/form_post.3curses

   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_POST 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 form_post, post_form, unpost_form \- write or erase forms from associated
  10 subwindows
  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 \fBpost_form\fR(\fBFORM *\fR\fIform\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBunpost_form\fR(\fBFORM *\fR\fIform\fR);
  25 .fi
  26
  27 .SH DESCRIPTION
  28 .sp
  29 .LP
  30 \fBpost_form()\fR writes \fIform\fR into its associated subwindow. The
  31 application programmer must use \fBcurses\fR library routines  to display the
  32 form on the physical screen or call \fBupdate_panels()\fR if the \fBpanels\fR
  33 library is being used.
  34 .sp
  35 .LP
  36 \fBunpost_form()\fR erases \fIform\fR from its associated subwindow.
  37 .SH RETURN VALUES
  38 .sp
  39 .LP
  40 These routines return one of the following:
  41 .sp
  42 .ne 2
  43 .na
  44 \fBE_OK\fR
  45 .ad
  46 .RS 20n
  47 The function returned successfully.
  48 .RE
  49
  50 .sp
  51 .ne 2
  52 .na
  53 \fBE_SYSTEM_ERROR\fR
  54 .ad
  55 .RS 20n
  56 System error.
  57 .RE
  58
  59 .sp
  60 .ne 2
  61 .na
  62 \fBE_BAD_ARGUMENT\fR
  63 .ad
  64 .RS 20n
  65 An argument is incorrect.
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fBE_POSTED\fR
  72 .ad
  73 .RS 20n
  74 The form is posted.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fBE_NOT_POSTED\fR
  81 .ad
  82 .RS 20n
  83 The form is not posted.
  84 .RE
  85
  86 .sp
  87 .ne 2
  88 .na
  89 \fBE_NO_ROOM\fR
  90 .ad
  91 .RS 20n
  92 The form does not fit in the subwindow.
  93 .RE
  94
  95 .sp
  96 .ne 2
  97 .na
  98 \fBE_BAD_STATE\fR
  99 .ad
 100 .RS 20n
 101 The routine was called from an initialization or termination function.
 102 .RE
 103
 104 .sp
 105 .ne 2
 106 .na
 107 \fBE_NOT_CONNECTED \fR
 108 .ad
 109 .RS 20n
 110 The field is not connected to a form.
 111 .RE
 112
 113 .SH ATTRIBUTES
 114 .sp
 115 .LP
 116 See \fBattributes\fR(5) for descriptions of the following attributes:
 117 .sp
 118
 119 .sp
 120 .TS
 121 box;
 122 c | c
 123 l | l .
 124 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 125 _
 126 MT-Level        Unsafe
 127 .TE
 128
 129 .SH SEE ALSO
 130 .sp
 131 .LP
 132 \fBcurses\fR(3CURSES), \fBforms\fR(3CURSES), \fBpanel_update\fR(3CURSES),
 133 \fBpanels\fR(3CURSES), \fBattributes\fR(5)
 134 .SH NOTES
 135 .sp
 136 .LP
 137 The header \fB<form.h>\fR automatically includes the headers  \fB<eti.h>\fR and
 138 \fB<curses.h>\fR\&.