lib/libkvm/kvm_geterr.3

   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 .\" $FreeBSD: src/lib/libkvm/kvm_geterr.3,v 1.3.2.4 2001/12/17 10:08:30 ru Exp $
  38 .\" $DragonFly: src/lib/libkvm/kvm_geterr.3,v 1.3 2006/02/17 19:35:07 swildner Exp $
  39 .\"
  40 .Dd June 4, 1993
  41 .Dt KVM_GETERR 3
  42 .Os
  43 .Sh NAME
  44 .Nm kvm_geterr
  45 .Nd get error message on kvm descriptor
  46 .Sh LIBRARY
  47 .Lb libkvm
  48 .Sh SYNOPSIS
  49 .In kvm.h
  50 .Ft char *
  51 .Fn kvm_geterr "kvm_t *kd"
  52 .Sh DESCRIPTION
  53 This function returns a string describing the most recent error condition
  54 on the descriptor
  55 .Fa kd .
  56 The results are undefined if the most recent
  57 .Xr kvm 3
  58 library call did not produce an error.
  59 The string returned is stored in memory owned by
  60 .Xr kvm 3
  61 so the message should be copied out and saved elsewhere if necessary.
  62 .Sh SEE ALSO
  63 .Xr kvm 3 ,
  64 .Xr kvm_close 3 ,
  65 .Xr kvm_getargv 3 ,
  66 .Xr kvm_getenvv 3 ,
  67 .Xr kvm_getprocs 3 ,
  68 .Xr kvm_nlist 3 ,
  69 .Xr kvm_open 3 ,
  70 .Xr kvm_openfiles 3 ,
  71 .Xr kvm_read 3 ,
  72 .Xr kvm_write 3
  73 .Sh BUGS
  74 This routine cannot be used to access error conditions due to a failed
  75 .Fn kvm_openfiles
  76 call, since failure is indicated by returning a
  77 .Dv NULL
  78 descriptor.
  79 Therefore, errors on open are output to the special error buffer
  80 passed to
  81 .Fn kvm_openfiles .
  82 This option is not available to
  83 .Fn kvm_open .