termkey_interpret_modereport man page on DragonFly

Man page or keyword search:  
man Server   44335 pages
apropos Keyword Search (all sections)
Output format
DragonFly logo
[printable version]

TERMKEY_INTERPRET_MODEREPORT(3)		       TERMKEY_INTERPRET_MODEREPORT(3)

NAME
       termkey_interpret_modereport - interpret opaque mode report data

SYNOPSIS
       #include <termkey.h>

       TermKeyResult termkey_interpret_modereport(TermKey *tk, const TermKeyKey *key,
	   int *initial, int *mode, int *value);

       Link with -ltermkey.

DESCRIPTION
       termkey_interpret_modereport()  fills in variables in the passed point‐
       ers according to the mode report event  found  in  key.	It  should  be
       called  if  termkey_getkey(3) or similar have returned a key event with
       the type of TERMKEY_TYPE_MODEREPORT.

       Any pointer may instead be given as NULL to not return that value.

       The initial variable will be filled with 0 for an ANSI mode report,  or
       '?'  for	 a  DEC mode report. The mode variable will be filled with the
       number of the mode, and value will be filled with the  value  from  the
       report.

RETURN VALUE
       If  passed  a key event of the type TERMKEY_TYPE_MODEREPORT, this func‐
       tion will return TERMKEY_RES_KEY and will affect	 the  variables	 whose
       pointers were passed in, as described above.

       For  other event types it will return TERMKEY_RES_NONE, and its effects
       on any variables whose pointers were passed in, are undefined.

SEE ALSO
       termkey_waitkey(3), termkey_getkey(3), termkey(7)

					       TERMKEY_INTERPRET_MODEREPORT(3)
[top]

List of man pages available for DragonFly

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net