1.\" $OpenBSD: kvm_geterr.3,v 1.4 2000/03/04 15:29:56 aaron 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. All advertising materials mentioning features or use of this software 20.\" must display the following acknowledgement: 21.\" This product includes software developed by the University of 22.\" California, Berkeley and its contributors. 23.\" 4. Neither the name of the University nor the names of its contributors 24.\" may be used to endorse or promote products derived from this software 25.\" without specific prior written permission. 26.\" 27.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 28.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 29.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 30.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 31.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 32.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 33.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 34.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 35.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 36.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 37.\" SUCH DAMAGE. 38.\" 39.\" @(#)kvm_geterr.3 8.1 (Berkeley) 6/4/93 40.\" 41.Dd June 4, 1993 42.Dt KVM_GETERR 3 43.Os 44.Sh NAME 45.Nm kvm_geterr 46.Nd get error message on kvm descriptor 47.Sh SYNOPSIS 48.Fd #include <kvm.h> 49.Ft char * 50.Fn kvm_geterr "kvm_t *kd" 51.Sh DESCRIPTION 52This function returns a string describing the most recent error condition 53on the descriptor 54.Fa kd . 55The results are undefined if the most recent 56.Xr kvm 3 57library call did not produce an error. 58The string returned is stored in memory owned by 59.Xr kvm 3 60so the message should be copied out and saved elsewhere if necessary. 61.Sh BUGS 62This routine cannot be used to access error conditions due to a failed 63.Fn kvm_openfiles 64call, since failure is indicated by returning a 65.Dv NULL 66descriptor. 67Therefore, errors on open are output to the special error buffer 68passed to 69.Fn kvm_openfiles . 70This option is not available to 71.Fn kvm_open . 72.Sh SEE ALSO 73.Xr kvm 3 , 74.Xr kvm_close 3 , 75.Xr kvm_getargv 3 , 76.Xr kvm_getenvv 3 , 77.Xr kvm_getprocs 3 , 78.Xr kvm_nlist 3 , 79.Xr kvm_open 3 , 80.Xr kvm_openfiles 3 , 81.Xr kvm_read 3 , 82.Xr kvm_write 3 83