form_hook(S-osr5)

form_hook: set_form_init, form_init, set_form_term, form_term, set_field_init, field_init, set_field_term, field_term -- assign application-specific routines for invocation by forms

Syntax

cc ... -lform -lcurses

#include <form.h>

int set_form_init(FORM *form, void (*func)(FORM *));
void (*)(FORM *) form_init(FORM *form);
int set_form_term(FORM *form, void (*func)(FORM *));
void (*)(FORM *) form_term(FORM *form);
int set_field_init(FORM *form, void (*func)(FORM *));
void (*)(FORM *) field_init(FORM *form);
int set_field_term(FORM *form, void (*func)(FORM *));
void (*)(FORM *) field_term(FORM *form);

Description

These routines let you assign application-specific routines to run automatically at initialization and termination points in the forms(S-osr5) application. The user need not specify any application-defined initialization or termination routines at all, but they may be helpful for displaying messages or page numbers and for other chores.

set_form_init(S-osr5) assigns an application-defined initialization function to be called when the form is posted and just after a page change. form_init(S-osr5) returns a pointer to the initialization function, if any.

set_form_term(S-osr5) assigns an application-defined function to be called when the form is unposted and just before a page change. form_term(S-osr5) returns a pointer to the function, if any.

set_field_init(S-osr5) assigns an application-defined function to be called when the form is posted and just after the current field changes. field_init(S-osr5) returns a pointer to the function, if any.

set_field_term(S-osr5) assigns an application-defined function to be called when the form is unposted and just before the current field changes. field_term(S-osr5) returns a pointer to the function, if any.

Return values

Routines that return pointers always return NULL on error. Routines that return an integer return one of the following:

E_OK - The function returned successfully.

E_SYSTEM_ERROR - System error.

Warning

The header file form.h automatically includes the header files eti.h and curses.h.

Files

/usr/lib/libform.a: the library

Standards conformance

set_form_init(S-osr5), form_init(S-osr5), set_form_term(S-osr5), form_term(S-osr5), set_field_init(S-osr5), field_init(S-osr5), set_field_term(S-osr5), and field_term(S-osr5) are not part of any currently supported standard; they were developed by UNIX System Laboratories, Inc. and are maintained by The SCO Group.

`E_OK`	-	The function returned successfully.
`E_SYSTEM_ERROR`	-	System error.