]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - man/curs_slk.3x
ncurses 6.5 - patch 20240615
[ncurses.git] / man / curs_slk.3x
index e1d39b2d34bd8564d076e5ccb13fdaf45a6538b7..1866064a60643668ce9f49079e532f4a44d13e18 100644 (file)
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright 2018-2022,2023 Thomas E. Dickey                                *
+.\" Copyright 2018-2023,2024 Thomas E. Dickey                                *
 .\" Copyright 1998-2016,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
@@ -27,8 +27,8 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_slk.3x,v 1.67 2023/12/16 21:18:45 tom Exp $
-.TH curs_slk 3X 2023-12-16 "ncurses 6.4" "Library calls"
+.\" $Id: curs_slk.3x,v 1.73 2024/05/25 20:10:58 tom Exp $
+.TH curs_slk 3X 2024-05-25 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
 .ie \n(.g \{\
 .ds `` \(lq
 .ds '' \(rq
@@ -228,32 +228,38 @@ In this implementation
 returns the attribute used for the soft keys.
 .TP 5
 \fBslk_attroff\fP, \fBslk_attron\fP, \fBslk_clear\fP, \fBslk_noutrefresh\fP, \fBslk_refresh\fP, \fBslk_touch\fP
-return an error
+return
+.B ERR
 if the terminal or the softkeys were not initialized.
 .TP 5
 \fBslk_attrset\fP
-returns an error
+returns
+.B ERR
 if the terminal or the softkeys were not initialized.
 .TP 5
 \fBslk_attr_set\fP
-returns an error
+returns
+.B ERR
 if the terminal or the softkeys were not initialized, or
 the color pair is outside the range 0..\fBCOLOR_PAIRS\fP\-1.
 .TP 5
 \fBslk_color\fP
-returns an error
+returns
+.B ERR
 if the terminal or the softkeys were not initialized, or
 the color pair is outside the range 0..\fBCOLOR_PAIRS\fP\-1.
 .TP 5
 \fBslk_init\fP
-returns an error
+returns
+.B ERR
 if the format parameter is outside the range 0..3.
 .TP 5
 \fBslk_label\fP
 returns \fBNULL\fP on error.
 .TP 5
 \fBslk_set\fP
-returns an error
+returns
+.B ERR
 if the terminal or the softkeys were not initialized, or
 the \fIlabnum\fP parameter is outside the range of label counts, or
 if the format parameter is outside the range 0..2, or if
@@ -277,7 +283,8 @@ if \fIopts\fP is set it is treated as a pointer to \fIint\fP,
 and used to set the color pair instead of the \fIshort\fP pair
 parameter.
 .SH PORTABILITY
-X/Open Curses, Issue 4, describes these functions,
+X/Open Curses,
+Issue 4 describes these functions,
 with some differences from SVr4 \fIcurses\fP:
 .bP
 X/Open added functions like the SVr4 attribute-manipulation functions
@@ -331,7 +338,8 @@ Finally, if there is no \fBfln\fP capability,
 If \fB\%slk_start\fP is given a non-null \fIgp\fP,
 it copies the \fIng\fP elements of the group of soft-keys, up to 16.
 .IP
-If there are more than 16 elements, \fB\%slk_start\fP returns an error.
+If there are more than 16 elements, \fB\%slk_start\fP returns
+.BR ERR "."
 .bP
 The format codes \fB2\fP and \fB3\fP for \fB\%slk_init\fP
 were added by \fI\%ncurses\fP in 1996.