External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-10-20 04:59:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

util: error: Improve docs for virErrorMsg

Browse Source 
Clarify how @info is used and what the returned values look like.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Erik Skultety <eskultet@redhat.com>
This commit is contained in:
Peter Krempa 2018-12-05 14:33:30 +01:00
parent d9baf0d75b
commit de4cbbb556
1 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/util/virerror.c
View File

@ -905,12 +905,14 @@ void virRaiseErrorObject(const char *filename,
/**
* virErrorMsg:
* @error: the virErrorNumber
* @info: usually the first parameter string
* @info: additional info string
*
* Internal routine to get the message associated to an error raised
* from the library
* Internal routine to get the message associated to @error raised
* from the library.
*
* Returns the constant string associated to @error
* Returns a *printf format string which describes @error. The returned string
* contains exactly one '%s' modifier if @info is non-NULL, or no modifiers at
* all if @info is NULL. If @error is invalid NULL is returned.
*/
const char *
virErrorMsg(virErrorNumber error, const char *info)