1.\" $NetBSD: form_cursor.3,v 1.4 2002/02/20 11:30:57 wiz Exp $ 2.\" 3.\" Copyright (c) 2001 4.\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au 5.\" 6.\" This code is donated to The NetBSD Foundation by the author. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 3. The name of the Author may not be used to endorse or promote 17.\" products derived from this software without specific prior written 18.\" permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.Dd January 1, 2001 33.Dt FORMS 3 34.Os 35.Sh NAME 36.Nm pos_form_cursor 37.Nd form library 38.Sh LIBRARY 39.Lb libform 40.Sh SYNOPSIS 41.Fd #include \*[Lt]form.h\*[Gt] 42.Ft int 43.Fn pos_form_cursor "FORM *form" 44.Sh DESCRIPTION 45The function 46.Fn pos_form_cursor 47positions the screen cursor at the correct position for the form. 48This function can be used to restore the cursor state after using 49other curses routines. 50.Sh RETURN VALUES 51Functions returning pointers will return NULL if an error is detected. 52The functions that return an int will return one of the following error 53values: 54.Pp 55.Bl -tag -width E_UNKNOWN_COMMAND -compact 56.It Er E_OK 57The function was successful. 58.It Er E_BAD_ARGUMENT 59A bad argument was passed to the function. 60.It Er E_NOT_POSTED 61The form is not posted to the screen. 62.El 63.Sh SEE ALSO 64.Xr curses 3 , 65.Xr forms 3 66.Sh NOTES 67The header 68.Pa \*[Lt]form.h\*[Gt] 69automatically includes both 70.Pa \*[Lt]curses.h\*[Gt] 71and 72.Pa \*[Lt]eti.h\*[Gt] . 73