X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fdefine_key.3x;h=d87b8f572f0bcb381f170f12f0b1070ead218d1f;hp=216a3cbce4b6a22c9af127a6765aa2a2650a4e5d;hb=41677b308e138027b7e435f741ee7fe5651237b0;hpb=027ae42953e3186daed8f3882da73de48291b606 diff --git a/man/define_key.3x b/man/define_key.3x index 216a3cbc..d87b8f57 100644 --- a/man/define_key.3x +++ b/man/define_key.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2004,2006 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2006,2009 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 * @@ -28,7 +28,7 @@ .\" .\" Author: Thomas E. Dickey 1997 .\" -.\" $Id: define_key.3x,v 1.12 2006/02/25 21:49:19 tom Exp $ +.\" $Id: define_key.3x,v 1.13 2009/09/19 21:09:35 tom Exp $ .TH define_key 3X "" .SH NAME \fBdefine_key\fP \- define a keycode @@ -47,7 +47,11 @@ removed. Similarly, if the given keycode is negative or zero, any existing string for the given definition is removed. .SH RETURN VALUE -The keycode must be greater than zero, else ERR is returned. +The keycode must be greater than zero, and the string non-null, +otherwise ERR is returned. +ERR may also be returned if there is insufficient memory to allocate the +data to store the definition. +If no error is detected, OK is returned. .SH PORTABILITY These routines are specific to ncurses. They were not supported on Version 7, BSD or System V implementations. It is recommended that