'\" te
.\" Copyright 1989 AT&T
.\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
.TH menu_pattern 3CURSES "31 Dec 1996" "SunOS 5.11" "Curses Library Functions"
.SH NAME
menu_pattern, set_menu_pattern \- set and get menus pattern match buffer
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lmenu\fR \fB -lcurses \fR [ \fIlibrary\fR... ]
#include <menu.h>



\fBchar *\fR\fBmenu_pattern\fR(\fBMENU *\fR\fImenu\fR);
.fi

.LP
.nf
\fBint\fR \fBset_menu_pattern\fR(\fBMENU *\fR\fImenu\fR, \fBchar *\fR\fIpat\fR);
.fi

.SH DESCRIPTION
.sp
.LP
Every menu has a pattern buffer to match entered data with menu items. \fBset_menu_pattern()\fR sets the pattern buffer to \fIpat\fR and tries to find the first item that matches the pattern. If it does, the matching item becomes the current item. If not, the current item does not change. \fBmenu_pattern()\fR returns the string in the pattern buffer of \fImenu\fR.
.SH RETURN VALUES
.sp
.LP
\fBmenu_pattern()\fR returns \fINULL\fR on error. \fBset_menu_pattern()\fR returns one of the following: 
.sp
.ne 2
.mk
.na
\fBE_OK\fR
.ad
.RS 18n
.rt  
The routine returned successfully.
.RE

.sp
.ne 2
.mk
.na
\fBE_SYSTEM_ERROR\fR
.ad
.RS 18n
.rt  
System error.
.RE

.sp
.ne 2
.mk
.na
\fBE_BAD_ARGUMENT\fR
.ad
.RS 18n
.rt  
An incorrect argument was passed to the routine.
.RE

.sp
.ne 2
.mk
.na
\fBE_NO_MATCH\fR
.ad
.RS 18n
.rt  
The character failed to match.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
MT-LevelUnsafe
.TE

.SH SEE ALSO
.sp
.LP
\fBcurses\fR(3CURSES), \fBmenus\fR(3CURSES), \fBattributes\fR(5)
.SH NOTES
.sp
.LP
The header \fB<menu.h>\fR automatically includes the headers  \fB<eti.h>\fR and \fB<curses.h>\fR\&.