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 | .\" | |
| 1741f35d KB |
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 | .\" | |
| b8b13822 KM |
8 | .\" %sccs.include.redist.man% |
| 9 | .\" | |
| 1741f35d | 10 | .\" @(#)kvm_geterr.3 5.3 (Berkeley) %G% |
| b8b13822 KM |
11 | .\" |
| 12 | .Dd | |
| 13 | .Dt KVM_GETERR 3 | |
| 14 | .Os | |
| 15 | .Sh NAME | |
| 16 | .Nm kvm_geterr | |
| 17 | .Nd get error message on kvm descriptor | |
| 18 | .Sh SYNOPSIS | |
| 19 | .Fd #include <kvm.h> | |
| 20 | .br | |
| 21 | .Ft char * | |
| 22 | .Fn kvm_geterr "kvm_t *kd" | |
| 23 | .Sh DESCRIPTION | |
| 24 | This function returns a string describing the most recent error condition | |
| 25 | on the descriptor | |
| 26 | .Fa kd . | |
| 27 | The results are undefined if the most recent | |
| 28 | .Xr kvm 3 | |
| 29 | library call did not produce an error. | |
| 30 | The string returned is stored in memory owned by | |
| 31 | .Xr kvm 3 | |
| 32 | so the message should be copied out and saved elsewhere if necessary. | |
| 33 | .Sh BUGS | |
| c9c64c8b | 34 | This routine cannot be used to access error conditions due to a failed |
| b8b13822 | 35 | .Fn kvm_openfiles |
| c9c64c8b KB |
36 | call, since failure is indicated by returning a |
| 37 | .Dv NULL | |
| 38 | descriptor. | |
| b8b13822 KM |
39 | Therefore, errors on open are output to the special error buffer |
| 40 | passed to | |
| 41 | .Fn kvm_openfiles . | |
| 42 | This option is not available to | |
| 43 | .Fn kvm_open . | |
| 44 | .Sh SEE ALSO | |
| c9c64c8b KB |
45 | .Xr kvm 3 , |
| 46 | .Xr kvm_close 3 , | |
| 47 | .Xr kvm_getargv 3 , | |
| 48 | .Xr kvm_getenvv 3 , | |
| 49 | .Xr kvm_getprocs 3 , | |
| 50 | .Xr kvm_nlist 3 , | |
| 51 | .Xr kvm_open 3 , | |
| 52 | .Xr kvm_openfiles 3 , | |
| 53 | .Xr kvm_read 3 , | |
| 54 | .Xr kvm_write 3 |