document virCommandRunRegex function

Signed-off-by: Ján Tomko <jtomko@redhat.com>
This commit is contained in:
Christian Loehle 2015-11-23 15:06:37 +01:00 committed by Ján Tomko
parent eebe58adeb
commit e7aa45055c

View File

@ -2889,12 +2889,25 @@ virCommandSetDryRun(virBufferPtr buf,
}
#ifndef WIN32
/*
/**
* virCommandRunRegex:
* @cmd: command to run
* @nregex: number of regexes to apply
* @regex: array of regexes to apply
* @nvars: array of numbers of variables each regex will produce
* @func: callback function that is called for every line of output,
* needs to return 0 on success
* @data: additional data that will be passed to the callback function
* @prefix: prefix that will be skipped at the beginning of each line
*
* Run an external program.
*
* Read its output and apply a series of regexes to each line
* When the entire set of regexes has matched consecutively
* then run a callback passing in all the matches
* then run a callback passing in all the matches on the current line.
*
* Returns: 0 on success, -1 on memory allocation error, virCommandRun
* error or callback function error
*/
int
virCommandRunRegex(virCommandPtr cmd,