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

  
 
  

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

NAME
     tickit_ctl_name - return the name of a toplevel instance control

SYNOPSIS
     #include <tickit.h>

     const char * tickit_ctl_name(TickitCtl ctl);
     TickitCtl tickit_ctl_lookup(const char * name);

     TickitType tickit_ctl_type(TickitCtl ctl);

     Link with -ltickit.

DESCRIPTION
     tickit_ctl_name()	returns the name of the given toplevel instance control.
     These names are the lowercase strings given in tickit(7).

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

     tickit_ctl_type() returns the type of the given instance 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_setctl_int(3)   and
	    tickit_getctl_int(3).

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

     For unrecognised control types, the function returns 0.

RETURN VALUE
     tickit_ctl_name()	returns  a  constant string pointer. tickit_ctl_lookup()
     returns an control constant or -1. tickit_ctl_type() returns a control type
     constant or 0.

SEE ALSO
     tickit(7)

							      TICKIT_CTL_NAME(3)

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

home | help