diff options
| author | Hans-Joerg Hoexer <hshoexer@cvs.openbsd.org> | 2004-06-24 22:02:42 +0000 |
|---|---|---|
| committer | Hans-Joerg Hoexer <hshoexer@cvs.openbsd.org> | 2004-06-24 22:02:42 +0000 |
| commit | 3da9c2f3810100c666999a5f2c6941f9c5df3d20 (patch) | |
| tree | 0869ec83d21126cd3200d6914a1a3f16caad575c | |
| parent | a35797aa2217c7744b682e3e3736d86785201924 (diff) | |
Document kn_get_string() a bit better and describe the return value.
ok ho@ msf@
| -rw-r--r-- | lib/libkeynote/keynote.3 | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/lib/libkeynote/keynote.3 b/lib/libkeynote/keynote.3 index 50391a7f5d3..2f5e00ea6eb 100644 --- a/lib/libkeynote/keynote.3 +++ b/lib/libkeynote/keynote.3 @@ -1,4 +1,4 @@ -.\" $OpenBSD: keynote.3,v 1.36 2003/07/08 11:02:23 jmc Exp $ +.\" $OpenBSD: keynote.3,v 1.37 2004/06/24 22:02:41 hshoexer Exp $ .\" .\" The author of this code is Angelos D. Keromytis (angelos@dsl.cis.upenn.edu) .\" @@ -855,6 +855,11 @@ parses the argument, treating it as a .Xr keynote 4 (quoted) string. This is useful for parsing key files. +On success, this function returns a pointer to the parsing result. +The result is dynamically allocated and should be freed after use. +On failure, +.Dv NULL +is returned. .Sh FILES .Bl -tag -width libkeynote.a -compact .It Pa keynote.h |