<!--
****************************************************************************
- * Copyright (c) 1999-2006,2010 Free Software Foundation, Inc. *
+ * Copyright (c) 1999-2010,2016 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* copy of this software and associated documentation files (the *
* authorization. *
****************************************************************************
* Author: Thomas E. Dickey 1999-on
- * @Id: curs_extend.3x,v 1.19 2010/12/04 18:36:44 tom Exp @
+ * @Id: curs_extend.3x,v 1.21 2016/10/15 16:52:48 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
These functions are extensions to the curses library which
do not fit easily into other categories.
- Use <EM>curses</EM><STRONG>_</STRONG><EM>version()</EM> to get the version number, including
+
+</PRE><H3><a name="h3-curses_version">curses_version</a></H3><PRE>
+ Use <STRONG>curses_version</STRONG> to get the version number, including
patch level of the library, e.g., <STRONG>5.0.19991023</STRONG>
- The <EM>use</EM><STRONG>_</STRONG><EM>extended</EM><STRONG>_</STRONG><EM>names()</EM> function controls whether the
- calling application is able to use user-defined or non-
- standard names which may be compiled into the terminfo
- description, i.e., via the terminfo or termcap interfaces.
- Normally these names are available for use, since the
- essential decision is made by using the <STRONG>-x</STRONG> option of <STRONG>tic</STRONG>
- to compile extended terminal definitions. However you can
- disable this feature to ensure compatibility with other
- implementations of curses.
+
+</PRE><H3><a name="h3-use_extended_names">use_extended_names</a></H3><PRE>
+ The <STRONG>use_extended_names</STRONG> function controls whether the call-
+ ing application is able to use user-defined or nonstandard
+ names which may be compiled into the terminfo description,
+ i.e., via the terminfo or termcap interfaces. Normally
+ these names are available for use, since the essential
+ decision is made by using the <STRONG>-x</STRONG> option of <STRONG>tic</STRONG> to compile
+ extended terminal definitions. However you can disable
+ this feature to ensure compatibility with other implemen-
+ tations of curses.
+
+
+</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+ <STRONG>curses_version</STRONG> returns a pointer to static memory; you
+ should not free this in your application.
+
+ <STRONG>use_extended_names</STRONG> returns the previous state, allowing
+ you to save this and restore it.
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
<ul>
<li><a href="#h2-NAME">NAME</a></li>
<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
-<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>
+<ul>
+<li><a href="#h3-curses_version">curses_version</a></li>
+<li><a href="#h3-use_extended_names">use_extended_names</a></li>
+</ul>
+</li>
+<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
<li><a href="#h2-AUTHOR">AUTHOR</a></li>
projects / ncurses.git / blobdiff