projects / unix-history / blame
| Commit | Line | Data |
|---|---|---|
| b8b13822 KM |
1 | .\" Copyright (c) 1992 The Regents of the University of California. |
| 2 | .\" All rights reserved. | |
| 3 | .\" | |
| 4 | .\" %sccs.include.redist.man% | |
| 5 | .\" | |
| 6 | .\" @(#)kvm_geterr.3 5.1 (Berkeley) %G% | |
| 7 | .\" | |
| 8 | .Dd | |
| 9 | .Dt KVM_GETERR 3 | |
| 10 | .Os | |
| 11 | .Sh NAME | |
| 12 | .Nm kvm_geterr | |
| 13 | .Nd get error message on kvm descriptor | |
| 14 | .Sh SYNOPSIS | |
| 15 | .Fd #include <kvm.h> | |
| 16 | .br | |
| 17 | .Ft char * | |
| 18 | .Fn kvm_geterr "kvm_t *kd" | |
| 19 | .Sh DESCRIPTION | |
| 20 | This function returns a string describing the most recent error condition | |
| 21 | on the descriptor | |
| 22 | .Fa kd . | |
| 23 | The results are undefined if the most recent | |
| 24 | .Xr kvm 3 | |
| 25 | library call did not produce an error. | |
| 26 | The string returned is stored in memory owned by | |
| 27 | .Xr kvm 3 | |
| 28 | so the message should be copied out and saved elsewhere if necessary. | |
| 29 | .Sh BUGS | |
| 30 | This routine cannot be used to access error conditions do to a failed | |
| 31 | .Fn kvm_openfiles | |
| 32 | call, since failure is indicated by returning a NULL descriptor. | |
| 33 | Therefore, errors on open are output to the special error buffer | |
| 34 | passed to | |
| 35 | .Fn kvm_openfiles . | |
| 36 | This option is not available to | |
| 37 | .Fn kvm_open . | |
| 38 | .Sh SEE ALSO | |
| 39 | .Xr kvm 3 |