xref: /freebsd/lib/libkvm/kvm_geterr.3 (revision dc36d6f9bb1753f3808552f3afd30eda9a7b206a)
158f0484fSRodney W. Grimes.\" Copyright (c) 1992, 1993
258f0484fSRodney W. Grimes.\"	The Regents of the University of California.  All rights reserved.
358f0484fSRodney W. Grimes.\"
458f0484fSRodney W. Grimes.\" This code is derived from software developed by the Computer Systems
558f0484fSRodney W. Grimes.\" Engineering group at Lawrence Berkeley Laboratory under DARPA contract
658f0484fSRodney W. Grimes.\" BG 91-66 and contributed to Berkeley.
758f0484fSRodney W. Grimes.\"
858f0484fSRodney W. Grimes.\" Redistribution and use in source and binary forms, with or without
958f0484fSRodney W. Grimes.\" modification, are permitted provided that the following conditions
1058f0484fSRodney W. Grimes.\" are met:
1158f0484fSRodney W. Grimes.\" 1. Redistributions of source code must retain the above copyright
1258f0484fSRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer.
1358f0484fSRodney W. Grimes.\" 2. Redistributions in binary form must reproduce the above copyright
1458f0484fSRodney W. Grimes.\"    notice, this list of conditions and the following disclaimer in the
1558f0484fSRodney W. Grimes.\"    documentation and/or other materials provided with the distribution.
16fbbd9655SWarner Losh.\" 3. Neither the name of the University nor the names of its contributors
1758f0484fSRodney W. Grimes.\"    may be used to endorse or promote products derived from this software
1858f0484fSRodney W. Grimes.\"    without specific prior written permission.
1958f0484fSRodney W. Grimes.\"
2058f0484fSRodney W. Grimes.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
2158f0484fSRodney W. Grimes.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
2258f0484fSRodney W. Grimes.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
2358f0484fSRodney W. Grimes.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
2458f0484fSRodney W. Grimes.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
2558f0484fSRodney W. Grimes.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
2658f0484fSRodney W. Grimes.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2758f0484fSRodney W. Grimes.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
2858f0484fSRodney W. Grimes.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
2958f0484fSRodney W. Grimes.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
3058f0484fSRodney W. Grimes.\" SUCH DAMAGE.
3158f0484fSRodney W. Grimes.\"
32*7d0a282aSEnji Cooper.Dd March 21, 2017
3358f0484fSRodney W. Grimes.Dt KVM_GETERR 3
3458f0484fSRodney W. Grimes.Os
3558f0484fSRodney W. Grimes.Sh NAME
3658f0484fSRodney W. Grimes.Nm kvm_geterr
3758f0484fSRodney W. Grimes.Nd get error message on kvm descriptor
387f5e8c84SAlexey Zelkin.Sh LIBRARY
397f5e8c84SAlexey Zelkin.Lb libkvm
4058f0484fSRodney W. Grimes.Sh SYNOPSIS
4132eef9aeSRuslan Ermilov.In kvm.h
4258f0484fSRodney W. Grimes.Ft char *
4358f0484fSRodney W. Grimes.Fn kvm_geterr "kvm_t *kd"
4458f0484fSRodney W. Grimes.Sh DESCRIPTION
4558f0484fSRodney W. GrimesThis function returns a string describing the most recent error condition
4658f0484fSRodney W. Grimeson the descriptor
4758f0484fSRodney W. Grimes.Fa kd .
4858f0484fSRodney W. GrimesThe results are undefined if the most recent
4958f0484fSRodney W. Grimes.Xr kvm 3
5058f0484fSRodney W. Grimeslibrary call did not produce an error.
5158f0484fSRodney W. GrimesThe string returned is stored in memory owned by
5258f0484fSRodney W. Grimes.Xr kvm 3
5358f0484fSRodney W. Grimesso the message should be copied out and saved elsewhere if necessary.
54*7d0a282aSEnji Cooper.Sh RETURN VALUES
55*7d0a282aSEnji CooperThe function
56*7d0a282aSEnji Cooper.Fn kvm_geterr
57*7d0a282aSEnji Cooperwill return "" if
58*7d0a282aSEnji Cooper.Fa kd
59*7d0a282aSEnji Cooperis
60*7d0a282aSEnji Cooper.Dv NULL
61*7d0a282aSEnji Cooperor an error has not been captured for
62*7d0a282aSEnji Cooper.Fa kd .
6358f0484fSRodney W. Grimes.Sh SEE ALSO
6458f0484fSRodney W. Grimes.Xr kvm 3 ,
6558f0484fSRodney W. Grimes.Xr kvm_close 3 ,
6658f0484fSRodney W. Grimes.Xr kvm_getargv 3 ,
6758f0484fSRodney W. Grimes.Xr kvm_getenvv 3 ,
6858f0484fSRodney W. Grimes.Xr kvm_getprocs 3 ,
6958f0484fSRodney W. Grimes.Xr kvm_nlist 3 ,
7058f0484fSRodney W. Grimes.Xr kvm_open 3 ,
7158f0484fSRodney W. Grimes.Xr kvm_openfiles 3 ,
7258f0484fSRodney W. Grimes.Xr kvm_read 3 ,
7358f0484fSRodney W. Grimes.Xr kvm_write 3
7424a0682cSRuslan Ermilov.Sh BUGS
7524a0682cSRuslan ErmilovThis routine cannot be used to access error conditions due to a failed
7624a0682cSRuslan Ermilov.Fn kvm_openfiles
7724a0682cSRuslan Ermilovcall, since failure is indicated by returning a
7824a0682cSRuslan Ermilov.Dv NULL
7924a0682cSRuslan Ermilovdescriptor.
8024a0682cSRuslan ErmilovTherefore, errors on open are output to the special error buffer
8124a0682cSRuslan Ermilovpassed to
8224a0682cSRuslan Ermilov.Fn kvm_openfiles .
8324a0682cSRuslan ErmilovThis option is not available to
8424a0682cSRuslan Ermilov.Fn kvm_open .
85