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