xref: /freebsd/lib/libkvm/kvm_geterr.3 (revision 17ee9d00bc1ae1e598c38f25826f861e4bc6c3ce)
1.\" Copyright (c) 1992, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" This code is derived from software developed by the Computer Systems
5.\" Engineering group at Lawrence Berkeley Laboratory under DARPA contract
6.\" BG 91-66 and contributed to Berkeley.
7.\"
8.\" Redistribution and use in source and binary forms, with or without
9.\" modification, are permitted provided that the following conditions
10.\" are met:
11.\" 1. Redistributions of source code must retain the above copyright
12.\"    notice, this list of conditions and the following disclaimer.
13.\" 2. Redistributions in binary form must reproduce the above copyright
14.\"    notice, this list of conditions and the following disclaimer in the
15.\"    documentation and/or other materials provided with the distribution.
16.\" 3. All advertising materials mentioning features or use of this software
17.\"    must display the following acknowledgement:
18.\"	This product includes software developed by the University of
19.\"	California, Berkeley and its contributors.
20.\" 4. Neither the name of the University nor the names of its contributors
21.\"    may be used to endorse or promote products derived from this software
22.\"    without specific prior written permission.
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34.\" SUCH DAMAGE.
35.\"
36.\"     @(#)kvm_geterr.3	8.1 (Berkeley) 6/4/93
37.\"
38.Dd June 4, 1993
39.Dt KVM_GETERR 3
40.Os
41.Sh NAME
42.Nm kvm_geterr
43.Nd get error message on kvm descriptor
44.Sh SYNOPSIS
45.Fd #include <kvm.h>
46.br
47.Ft char *
48.Fn kvm_geterr "kvm_t *kd"
49.Sh DESCRIPTION
50This function returns a string describing the most recent error condition
51on the descriptor
52.Fa kd .
53The results are undefined if the most recent
54.Xr kvm 3
55library call did not produce an error.
56The string returned is stored in memory owned by
57.Xr kvm 3
58so the message should be copied out and saved elsewhere if necessary.
59.Sh BUGS
60This routine cannot be used to access error conditions due to a failed
61.Fn kvm_openfiles
62call, since failure is indicated by returning a
63.Dv NULL
64descriptor.
65Therefore, errors on open are output to the special error buffer
66passed to
67.Fn kvm_openfiles .
68This option is not available to
69.Fn kvm_open .
70.Sh SEE ALSO
71.Xr kvm 3 ,
72.Xr kvm_close 3 ,
73.Xr kvm_getargv 3 ,
74.Xr kvm_getenvv 3 ,
75.Xr kvm_getprocs 3 ,
76.Xr kvm_nlist 3 ,
77.Xr kvm_open 3 ,
78.Xr kvm_openfiles 3 ,
79.Xr kvm_read 3 ,
80.Xr kvm_write 3
81