util: Add docs for virXMLProp string

To avoid confusion about usage of this function explicitly document that
this function returns copy of the attribute string.
This commit is contained in:
Peter Krempa 2013-02-21 11:07:55 +01:00
parent 2ab08e6cb1
commit 923e4bf810

View File

@ -468,6 +468,16 @@ virXPathLongLong(const char *xpath,
return ret;
}
/**
* virXMLPropString:
* @node: XML dom node pointer
* @name: Name of the property (attribute) to get
*
* Convenience function to return copy of an attribute value of a XML node.
*
* Returns the property (attribute) value as string or NULL in case of failure.
* The caller is responsible for freeing the returned buffer.
*/
char *
virXMLPropString(xmlNodePtr node,
const char *name)