Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
TICKIT_TERMCTL_NAME(3)	    Library Functions Manual	  TICKIT_TERMCTL_NAME(3)

NAME
     tickit_termctl_name - return the name of a terminal control

SYNOPSIS
     #include <tickit.h>

     const char * tickit_termctl_name(TickitTermCtl ctl);
     TickitTermCtl tickit_termctl_lookup(const char * name);

     TickitType tickit_termctl_type(TickitTermCtl ctl);

     Link with -ltickit.

DESCRIPTION
     tickit_termctl_name() returns the name of the given terminal control. These
     names are the lowercase strings given in tickit_term(7).

     tickit_termctl_lookup()  returns  the control constant for a given name. If
     the name is not recognised then -1 is returned.

     tickit_termctl_type() returns the type of the given  terminal  control,  as
     one of the following constants:

     TICKIT_TYPE_BOOL
	    The  value is an integer representing a simple boolean choice, where
	    any  nonzero  value  is  true.  Use  tickit_term_setctl_int(3)   and
	    tickit_term_getctl_int(3).

     TICKIT_TYPE_INT
	    The  value is an integer representing a quantity, or a value in some
	    particular	 enumeration.	 Use	tickit_term_setctl_int(3)    and
	    tickit_term_getctl_int(3).

     TICKIT_TYPE_STR
	    The value is a string. Use tickit_term_setctl_str(3).

     For unrecognised control types, the function returns 0.

RETURN VALUE
     tickit_termctl_name()  returns  a	constant  string  pointer.  tickit_term-
     ctl_lookup() returns an control constant or -1.  tickit_termctl_type()  re-
     turns a control type constant or 0.

SEE ALSO
     tickit_term(7), tickit(7)

							  TICKIT_TERMCTL_NAME(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=tickit_termctl_name&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help