xref: /illumos-gate/usr/src/man/man3curses/form_userptr.3curses (revision 5801b0f01c3c34499a929ed96164a5a68b470945)
te
Copyright 1989 AT&T
Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
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.
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.
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]
FORM_USERPTR 3CURSES "Dec 31, 1996"
NAME
form_userptr, set_form_userptr - associate application data with forms
SYNOPSIS

cc [ flag... ] file... -lform  -lcurses  [ library... ]
#include <form.h>

int set_form_userptr(FORM *form, char *ptr);

char *form_userptr(FORM *form);
DESCRIPTION

Every form has an associated user pointer that can be used to store pertinent data. set_form_userptr() sets the user pointer of form. form_userptr() returns the user pointer of form.

RETURN VALUES

form_userptr() returns NULL on error. set_form_userptr() returns one of the following: E_OK

The function returned successfully.

E_SYSTEM_ERROR

System error.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level Unsafe
SEE ALSO

curses(3CURSES), forms(3CURSES), attributes(5)

NOTES

The header <form.h> automatically includes the headers <eti.h> and <curses.h>.