1.\" $NetBSD: kvm_geterr.3,v 1.9 2009/03/10 23:49:07 joerg Exp $ 2.\" 3.\" Copyright (c) 1992, 1993 4.\" The Regents of the University of California. All rights reserved. 5.\" 6.\" This code is derived from software developed by the Computer Systems 7.\" Engineering group at Lawrence Berkeley Laboratory under DARPA contract 8.\" BG 91-66 and contributed to Berkeley. 9.\" 10.\" Redistribution and use in source and binary forms, with or without 11.\" modification, are permitted provided that the following conditions 12.\" are met: 13.\" 1. Redistributions of source code must retain the above copyright 14.\" notice, this list of conditions and the following disclaimer. 15.\" 2. Redistributions in binary form must reproduce the above copyright 16.\" notice, this list of conditions and the following disclaimer in the 17.\" documentation and/or other materials provided with the distribution. 18.\" 3. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" @(#)kvm_geterr.3 8.1 (Berkeley) 6/4/93 35.\" 36.Dd June 4, 1993 37.Dt KVM_GETERR 3 38.Os 39.Sh NAME 40.Nm kvm_geterr 41.Nd get error message on kvm descriptor 42.Sh LIBRARY 43.Lb libkvm 44.Sh SYNOPSIS 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_getargv 3 , 62.Xr kvm_getenvv 3 , 63.Xr kvm_getprocs 3 , 64.Xr kvm_nlist 3 , 65.Xr kvm_open 3 , 66.Xr kvm_openfiles 3 , 67.Xr kvm_read 3 , 68.Xr kvm_write 3 69.Sh BUGS 70This routine cannot be used to access error conditions due to a failed 71.Fn kvm_openfiles 72call, since failure is indicated by returning a 73.Dv NULL 74descriptor. 75Therefore, errors on open are output to the special error buffer 76passed to 77.Fn kvm_openfiles . 78This option is not available to 79.Fn kvm_open . 80