/usr/share/doc/augeas-doc/c_api/files/augeas-h.html is in augeas-doc 1.2.0-0ubuntu1.3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN" "http://www.w3.org/TR/REC-html40/strict.dtd">
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>/build/augeas-qq2tSO/augeas-1.2.0/src/augeas.h - Augeas Documentation</title><link rel="stylesheet" type="text/css" href="../styles/main.css"><script language=JavaScript src="../javascript/main.js"></script><script language=JavaScript src="../javascript/prettify.js"></script><script language=JavaScript src="../javascript/searchdata.js"></script></head><body class="ContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.51 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CFile"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="augeas.h"></a>augeas.h</h1><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#augeas.h" >augeas.h</a></td><td class=SDescription></td></tr><tr class="SGroup"><td class=SEntry><a href="#Enumerations" >Enumerations</a></td><td class=SDescription></td></tr><tr class="SEnumeration SIndent1 SMarked"><td class=SEntry><a href="#aug_flags" >aug_flags</a></td><td class=SDescription>Flags to influence the behavior of Augeas. </td></tr><tr class="SGroup"><td class=SEntry><a href="#Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#aug_init" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">aug_init</a></td><td class=SDescription>Initialize the library.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#aug_defvar" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">aug_defvar</a></td><td class=SDescription>Define a variable NAME whose value is the result of evaluating EXPR. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#aug_defnode" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">aug_defnode</a></td><td class=SDescription>Define a variable NAME whose value is the result of evaluating EXPR, which must be non-NULL and evaluate to a nodeset. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#aug_get" id=link4 onMouseOver="ShowTip(event, 'tt4', 'link4')" onMouseOut="HideTip('tt4')">aug_get</a></td><td class=SDescription>Lookup the value associated with PATH. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#aug_label" id=link5 onMouseOver="ShowTip(event, 'tt5', 'link5')" onMouseOut="HideTip('tt5')">aug_label</a></td><td class=SDescription>Lookup the label associated with PATH. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#aug_set" id=link6 onMouseOver="ShowTip(event, 'tt6', 'link6')" onMouseOut="HideTip('tt6')">aug_set</a></td><td class=SDescription>Set the value associated with PATH to VALUE. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#aug_setm" id=link7 onMouseOver="ShowTip(event, 'tt7', 'link7')" onMouseOut="HideTip('tt7')">aug_setm</a></td><td class=SDescription>Set the value of multiple nodes in one operation. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#aug_span" id=link8 onMouseOver="ShowTip(event, 'tt8', 'link8')" onMouseOut="HideTip('tt8')">aug_span</a></td><td class=SDescription>Get the span according to input file of the node associated with PATH. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#aug_insert" id=link9 onMouseOver="ShowTip(event, 'tt9', 'link9')" onMouseOut="HideTip('tt9')">aug_insert</a></td><td class=SDescription>Create a new sibling LABEL for PATH by inserting into the tree just before PATH if BEFORE == 1 or just after PATH if BEFORE == 0.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#aug_rm" id=link10 onMouseOver="ShowTip(event, 'tt10', 'link10')" onMouseOut="HideTip('tt10')">aug_rm</a></td><td class=SDescription>Remove path and all its children. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#aug_mv" id=link11 onMouseOver="ShowTip(event, 'tt11', 'link11')" onMouseOut="HideTip('tt11')">aug_mv</a></td><td class=SDescription>Move the node SRC to DST. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#aug_cp" id=link12 onMouseOver="ShowTip(event, 'tt12', 'link12')" onMouseOut="HideTip('tt12')">aug_cp</a></td><td class=SDescription>Copy the node SRC to DST. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#aug_rename" id=link13 onMouseOver="ShowTip(event, 'tt13', 'link13')" onMouseOut="HideTip('tt13')">aug_rename</a></td><td class=SDescription>Rename the label of all nodes matching SRC to LBL.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#aug_match" id=link14 onMouseOver="ShowTip(event, 'tt14', 'link14')" onMouseOut="HideTip('tt14')">aug_match</a></td><td class=SDescription>the number of matches of the path expression PATH in AUG. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#aug_save" id=link15 onMouseOver="ShowTip(event, 'tt15', 'link15')" onMouseOut="HideTip('tt15')">aug_save</a></td><td class=SDescription>Write all pending changes to disk.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#aug_load" id=link16 onMouseOver="ShowTip(event, 'tt16', 'link16')" onMouseOut="HideTip('tt16')">aug_load</a></td><td class=SDescription>Load files into the tree. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#aug_text_store" id=link17 onMouseOver="ShowTip(event, 'tt17', 'link17')" onMouseOut="HideTip('tt17')">aug_text_store</a></td><td class=SDescription>Use the value of node NODE as a string and transform it into a tree using the lens LENS and store it in the tree at PATH, which will be overwritten. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#aug_text_retrieve" id=link18 onMouseOver="ShowTip(event, 'tt18', 'link18')" onMouseOut="HideTip('tt18')">aug_text_retrieve</a></td><td class=SDescription>Transform the tree at PATH into a string using lens LENS and store it in the node NODE_OUT, assuming the tree was initially generated using the value of node NODE_IN. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#aug_print" id=link19 onMouseOver="ShowTip(event, 'tt19', 'link19')" onMouseOut="HideTip('tt19')">aug_print</a></td><td class=SDescription>Print each node matching PATH and its descendants to OUT.</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#aug_to_xml" id=link20 onMouseOver="ShowTip(event, 'tt20', 'link20')" onMouseOut="HideTip('tt20')">aug_to_xml</a></td><td class=SDescription>Turn the Augeas tree(s) matching PATH into an XML tree XMLDOC. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#aug_transform" id=link21 onMouseOver="ShowTip(event, 'tt21', 'link21')" onMouseOut="HideTip('tt21')">aug_transform</a></td><td class=SDescription>Add a transform for FILE using LENS. </td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#aug_srun" id=link22 onMouseOver="ShowTip(event, 'tt22', 'link22')" onMouseOut="HideTip('tt22')">aug_srun</a></td><td class=SDescription>Run one or more newline-separated commands. </td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#aug_close" id=link23 onMouseOver="ShowTip(event, 'tt23', 'link23')" onMouseOut="HideTip('tt23')">aug_close</a></td><td class=SDescription>Close this Augeas instance and free any storage associated with it. </td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Enumerations"></a>Enumerations</h3></div></div>
<div class="CEnumeration"><div class=CTopic><h3 class=CTitle><a name="aug_flags"></a>aug_flags</h3><div class=CBody><p>Flags to influence the behavior of Augeas. Pass a bitmask of these flags to AUG_INIT.</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_init"></a>aug_init</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>augeas *aug_init(</td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>root,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>loadpath,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>unsigned </td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap></td><td class="PParameter prettyprint " nowrap>flags</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Initialize the library.</p><p>Use ROOT as the filesystem root. If ROOT is NULL, use the value of the environment variable AUGEAS_ROOT. If that doesn’t exist eitehr, use “/”.</p><p>LOADPATH is a colon-spearated list of directories that modules should be searched in. This is in addition to the standard load path and the directories in AUGEAS_LENS_LIB</p><p>FLAGS is a bitmask made up of values from AUG_FLAGS. The flag AUG_NO_ERR_CLOSE can be used to get more information on why initialization failed. If it is set in FLAGS, the caller must check that aug_error returns AUG_NOERROR before using the returned augeas handle for any other operation. If the handle reports any error, the caller should only call the aug_error functions an aug_close on this handle.</p><h4 class=CHeading>Returns</h4><p>a handle to the Augeas tree upon success. If initialization fails, returns NULL if AUG_NO_ERR_CLOSE is not set in FLAGS. If AUG_NO_ERR_CLOSE is set, might return an Augeas handle even on failure. In that case, caller must check for errors using augeas_error, and, if an error is reported, only use the handle with the aug_error functions and aug_close.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_defvar"></a>aug_defvar</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_defvar(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>name,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>expr</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Define a variable NAME whose value is the result of evaluating EXPR. If a variable NAME already exists, its name will be replaced with the result of evaluating EXPR. Context will not be applied to EXPR.</p><p>If EXPR is NULL, the variable NAME will be removed if it is defined.</p><p>Path variables can be used in path expressions later on by prefixing them with ‘$’.</p><p>Returns -1 on error; on success, returns 0 if EXPR evaluates to anything other than a nodeset, and the number of nodes if EXPR evaluates to a nodeset</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_defnode"></a>aug_defnode</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_defnode(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>name,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>expr,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>value,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>created</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Define a variable NAME whose value is the result of evaluating EXPR, which must be non-NULL and evaluate to a nodeset. If a variable NAME already exists, its name will be replaced with the result of evaluating EXPR.</p><p>If EXPR evaluates to an empty nodeset, a node is created, equivalent to calling AUG_SET(AUG, EXPR, VALUE) and NAME will be the nodeset containing that single node.</p><p>If CREATED is non-NULL, it is set to 1 if a node was created, and 0 if it already existed.</p><p>Returns -1 on error; on success, returns the number of nodes in the nodeset</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_get"></a>aug_get</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_get(</td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>**</td><td class="PParameter prettyprint " nowrap>value</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Lookup the value associated with PATH. VALUE can be NULL, in which case it is ignored. If VALUE is not NULL, it is used to return a pointer to the value associated with PATH if PATH matches exactly one node. If PATH matches no nodes or more than one node, *VALUE is set to NULL. Note that it is perfectly legal for nodes to have a NULL value, and that that by itself does not indicate an error.</p><p>The string *VALUE must not be freed by the caller, and is valid as long as its node remains unchanged.</p><h4 class=CHeading>Returns</h4><p>1 if there is exactly one node matching PATH, 0 if there is none, and a negative value if there is more than one node matching PATH, or if PATH is not a legal path expression.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_label"></a>aug_label</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_label(</td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>**</td><td class="PParameter prettyprint " nowrap>label</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Lookup the label associated with PATH. LABEL can be NULL, in which case it is ignored. If LABEL is not NULL, it is used to return a pointer to the value associated with PATH if PATH matches exactly one node. If PATH matches no nodes or more than one node, *LABEL is set to NULL.</p><p>The string *LABEL must not be freed by the caller, and is valid as long as its node remains unchanged.</p><h4 class=CHeading>Returns</h4><p>1 if there is exactly one node matching PATH, 0 if there is none, and a negative value if there is more than one node matching PATH, or if PATH is not a legal path expression.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_set"></a>aug_set</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_set(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>value</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Set the value associated with PATH to VALUE. VALUE is copied into the internal data structure, and the caller is responsible for freeing it. Intermediate entries are created if they don’t exist.</p><h4 class=CHeading>Returns</h4><p>0 on success, -1 on error. It is an error if more than one node matches PATH.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_setm"></a>aug_setm</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_setm(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>base,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>sub,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>value</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Set the value of multiple nodes in one operation. Find or create a node matching SUB by interpreting SUB as a path expression relative to each node matching BASE. SUB may be NULL, in which case all the nodes matching BASE will be modified.</p><h4 class=CHeading>Returns</h4><p>number of modified nodes on success, -1 on error</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_span"></a>aug_span</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_span(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>**</td><td class="PParameter prettyprint " nowrap>filename,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>unsigned </td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>label_start,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>unsigned </td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>label_end,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>unsigned </td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>value_start,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>unsigned </td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>value_end,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>unsigned </td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>span_start,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>unsigned </td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>span_end</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Get the span according to input file of the node associated with PATH. If the node is associated with a file, the filename, label and value start and end positions are set, and return value is 0. The caller is responsible for freeing returned filename. If an argument for return value is NULL, then the corresponding value is not set. If the node associated with PATH doesn’t belong to a file or is doesn’t exists, filename and span are not set and return value is -1.</p><h4 class=CHeading>Returns</h4><p>0 on success with filename, label_start, label_stop, value_start, value_end, span_start, span_end -1 on error</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_insert"></a>aug_insert</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_insert(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>label,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap></td><td class="PParameter prettyprint " nowrap>before</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Create a new sibling LABEL for PATH by inserting into the tree just before PATH if BEFORE == 1 or just after PATH if BEFORE == 0.</p><p>PATH must match exactly one existing node in the tree, and LABEL must be a label, i.e. not contain a ‘/’, ‘*’ or end with a bracketed index ‘[N]’.</p><h4 class=CHeading>Returns</h4><p>0 on success, and -1 if the insertion fails.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_rm"></a>aug_rm</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_rm(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Remove path and all its children. Returns the number of entries removed. All nodes that match PATH, and their descendants, are removed.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_mv"></a>aug_mv</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_mv(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>src,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>dst</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Move the node SRC to DST. SRC must match exactly one node in the tree. DST must either match exactly one node in the tree, or may not exist yet. If DST exists already, it and all its descendants are deleted. If DST does not exist yet, it and all its missing ancestors are created.</p><p>Note that the node SRC always becomes the node DST: when you move /a/b to /x, the node /a/b is now called /x, no matter whether /x existed initially or not.</p><h4 class=CHeading>Returns</h4><p>0 on success and -1 on failure.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_cp"></a>aug_cp</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_cp(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>src,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>dst</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Copy the node SRC to DST. SRC must match exactly one node in the tree. DST must either match exactly one node in the tree, or may not exist yet. If DST exists already, it and all its descendants are deleted. If DST does not exist yet, it and all its missing ancestors are created.</p><h4 class=CHeading>Returns</h4><p>0 on success and -1 on failure.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_rename"></a>aug_rename</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_rename(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>src,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>lbl</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Rename the label of all nodes matching SRC to LBL.</p><h4 class=CHeading>Returns</h4><p>The number of nodes renamed on success and -1 on failure.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_match"></a>aug_match</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_match(</td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>***</td><td class="PParameter prettyprint " nowrap>matches</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><h4 class=CHeading>Returns</h4><p>the number of matches of the path expression PATH in AUG. If MATCHES is non-NULL, an array with the returned number of elements will be allocated and filled with the paths of the matches. The caller must free both the array and the entries in it. The returned paths are sufficiently qualified to make sure that they match exactly one node in the current tree.</p><p>If MATCHES is NULL, nothing is allocated and only the number of matches is returned.</p><p>Returns -1 on error, or the total number of matches (which might be 0).</p><h4 class=CHeading>Path expressions</h4><p>Path expressions use a very simple subset of XPath: the path PATH consists of a number of segments, separated by ‘/’; each segment can either be a ‘*’, matching any tree node, or a string, optionally followed by an index in brackets, matching tree nodes labelled with exactly that string. If no index is specified, the expression matches all nodes with that label; the index can be a positive number N, which matches exactly the Nth node with that label (counting from 1), or the special expression ‘last()’ which matches the last node with the given label. All matches are done in fixed positions in the tree, and nothing matches more than one path segment.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_save"></a>aug_save</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_save(</td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Write all pending changes to disk.</p><h4 class=CHeading>Returns</h4><p>-1 if an error is encountered, 0 on success. Only files that had any changes made to them are written.</p><p>If AUG_SAVE_NEWFILE is set in the FLAGS passed to AUG_INIT, create changed files as new files with the extension “.augnew”, and leave the original file unmodified.</p><p>Otherwise, if AUG_SAVE_BACKUP is set in the FLAGS passed to AUG_INIT, move the original file to a new file with extension “.augsave”.</p><p>If neither of these flags is set, overwrite the original file.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_load"></a>aug_load</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_load(</td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Load files into the tree. Which files to load and what lenses to use on them is specified under /augeas/load in the tree; each entry /augeas/load/NAME specifies a ‘transform’, by having itself exactly one child ‘lens’ and any number of children labelled ‘incl’ and ‘excl’. The value of NAME has no meaning.</p><p>The ‘lens’ grandchild of /augeas/load specifies which lens to use, and can either be the fully qualified name of a lens ‘Module.lens’ or ‘@Module’. The latter form means that the lens from the transform marked for autoloading in MODULE should be used.</p><p>The ‘incl’ and ‘excl’ grandchildren of /augeas/load indicate which files to transform. Their value are used as glob patterns. Any file that matches at least one ‘incl’ pattern and no ‘excl’ pattern is transformed. The order of ‘incl’ and ‘excl’ entries is irrelevant.</p><p>When AUG_INIT is first called, it populates /augeas/load with the transforms marked for autoloading in all the modules it finds.</p><p>Before loading any files, AUG_LOAD will remove everything underneath /augeas/files and /files, regardless of whether any entries have been modified or not.</p><p>Returns -1 on error, 0 on success. Note that success includes the case where some files could not be loaded. Details of such files can be found as ‘/augeas//error’.</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_text_store"></a>aug_text_store</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_text_store(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>lens,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>node,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Use the value of node NODE as a string and transform it into a tree using the lens LENS and store it in the tree at PATH, which will be overwritten. PATH and NODE are path expressions.</p><h4 class=CHeading>Returns</h4><p>0 on success, or a negative value on failure</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_text_retrieve"></a>aug_text_retrieve</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_text_retrieve(</td><td class="PTypePrefix prettyprint " nowrap>struct </td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>lens,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>node_in,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>node_out</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Transform the tree at PATH into a string using lens LENS and store it in the node NODE_OUT, assuming the tree was initially generated using the value of node NODE_IN. PATH, NODE_IN, and NODE_OUT are path expressions.</p><h4 class=CHeading>Returns</h4><p>0 on success, or a negative value on failure</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_print"></a>aug_print</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_print(</td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>FILE </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>out,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Print each node matching PATH and its descendants to OUT.</p><h4 class=CHeading>Returns</h4><p>0 on success, or a negative value on failure</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_to_xml"></a>aug_to_xml</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_to_xml(</td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>xmlNode </td><td class="PParameterPrefix prettyprint " nowrap>**</td><td class="PParameter prettyprint " nowrap>xmldoc,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>unsigned </td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap></td><td class="PParameter prettyprint " nowrap>flags</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Turn the Augeas tree(s) matching PATH into an XML tree XMLDOC. The parameter FLAGS is currently unused and must be set to 0.</p><h4 class=CHeading>Returns</h4><p>0 on success, or a negative value on failure</p><p>In case of failure, *xmldoc is set to NULL</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_transform"></a>aug_transform</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_transform(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>lens,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>file,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap></td><td class="PParameter prettyprint " nowrap>excl</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Add a transform for FILE using LENS. EXCL specifies if this the file is to be included (0) or excluded (1) from the LENS. The LENS maybe be a module name or a full lens name. If a module name is given, then lns will be the lens assumed.</p><h4 class=CHeading>Returns</h4><p>1 on success, -1 on failure</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_srun"></a>aug_srun</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_srun(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>FILE </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>out,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>text</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Run one or more newline-separated commands. The output of the commands will be printed to OUT. Running just ‘help’ will print what commands are available. Commands accepted by this are identical to what augtool accepts.</p><h4 class=CHeading>Returns</h4><p>the number of executed commands on success, -1 on failure, and -2 if a ‘quit’ command was encountered</p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="aug_close"></a>aug_close</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>void aug_close(</td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Close this Augeas instance and free any storage associated with it. After running AUG_CLOSE, AUG is invalid and can not be used for any more operations.</p></div></div></div>
</div><!--Content-->
<div id=Footer><a href="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
<div id=Menu><div class=MTitle>Augeas Documentation<div class=MSubTitle>C API</div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent1')">Main Links</a><div class=MGroupContent id=MGroupContent1><div class=MEntry><div class=MLink><a href="/index.html">Main</a></div></div><div class=MEntry><div class=MLink><a href="/docs/index.html">Documentation</a></div></div></div></div></div><div class=MEntry><div class=MFile id=MSelected>Public API</div></div><div class=MEntry><div class=MFile><a href="internal-h.html">Internal API</a></div></div><div class=MEntry><div class=MGroup><a href="javascript:ToggleMenu('MGroupContent2')">Index</a><div class=MGroupContent id=MGroupContent2><div class=MEntry><div class=MIndex><a href="../index/General.html">Everything</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Classes.html">Classes</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Functions.html">Functions</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Files.html">Files</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Macros.html">Macros</a></div></div><div class=MEntry><div class=MIndex><a href="../index/Types.html">Types</a></div></div></div></div></div><script type="text/javascript"><!--
var searchPanel = new SearchPanel("searchPanel", "HTML", "../search");
--></script><div id=MSearchPanel class=MSearchPanelInactive><input type=text id=MSearchField value=Search onFocus="searchPanel.OnSearchFieldFocus(true)" onBlur="searchPanel.OnSearchFieldFocus(false)" onKeyUp="searchPanel.OnSearchFieldChange()"><select id=MSearchType onFocus="searchPanel.OnSearchTypeFocus(true)" onBlur="searchPanel.OnSearchTypeFocus(false)" onChange="searchPanel.OnSearchTypeChange()"><option id=MSearchEverything selected value="General">Everything</option><option value="Classes">Classes</option><option value="Files">Files</option><option value="Functions">Functions</option><option value="Macros">Macros</option><option value="Types">Types</option></select></div></div><!--Menu-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>augeas *aug_init(</td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>root,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>loadpath,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>unsigned </td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap></td><td class="PParameter prettyprint " nowrap>flags</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Initialize the library.</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_defvar(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>name,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>expr</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Define a variable NAME whose value is the result of evaluating EXPR. </div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_defnode(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>name,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>expr,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>value,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>created</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Define a variable NAME whose value is the result of evaluating EXPR, which must be non-NULL and evaluate to a nodeset. </div></div><div class=CToolTip id="tt4"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_get(</td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>**</td><td class="PParameter prettyprint " nowrap>value</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Lookup the value associated with PATH. </div></div><div class=CToolTip id="tt5"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_label(</td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>**</td><td class="PParameter prettyprint " nowrap>label</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Lookup the label associated with PATH. </div></div><div class=CToolTip id="tt6"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_set(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>value</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Set the value associated with PATH to VALUE. </div></div><div class=CToolTip id="tt7"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_setm(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>base,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>sub,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>value</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Set the value of multiple nodes in one operation. </div></div><div class=CToolTip id="tt8"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_span(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>**</td><td class="PParameter prettyprint " nowrap>filename,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>unsigned </td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>label_start,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>unsigned </td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>label_end,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>unsigned </td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>value_start,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>unsigned </td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>value_end,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>unsigned </td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>span_start,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>unsigned </td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>span_end</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Get the span according to input file of the node associated with PATH. </div></div><div class=CToolTip id="tt9"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_insert(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>label,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap></td><td class="PParameter prettyprint " nowrap>before</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Create a new sibling LABEL for PATH by inserting into the tree just before PATH if BEFORE == 1 or just after PATH if BEFORE == 0.</div></div><div class=CToolTip id="tt10"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_rm(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Remove path and all its children. </div></div><div class=CToolTip id="tt11"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_mv(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>src,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>dst</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Move the node SRC to DST. </div></div><div class=CToolTip id="tt12"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_cp(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>src,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>dst</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Copy the node SRC to DST. </div></div><div class=CToolTip id="tt13"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_rename(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>src,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>lbl</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Rename the label of all nodes matching SRC to LBL.</div></div><div class=CToolTip id="tt14"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_match(</td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>***</td><td class="PParameter prettyprint " nowrap>matches</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>the number of matches of the path expression PATH in AUG. </div></div><div class=CToolTip id="tt15"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_save(</td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Write all pending changes to disk.</div></div><div class=CToolTip id="tt16"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_load(</td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Load files into the tree. </div></div><div class=CToolTip id="tt17"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_text_store(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>lens,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>node,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Use the value of node NODE as a string and transform it into a tree using the lens LENS and store it in the tree at PATH, which will be overwritten. </div></div><div class=CToolTip id="tt18"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_text_retrieve(</td><td class="PTypePrefix prettyprint " nowrap>struct </td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>lens,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>node_in,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>node_out</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Transform the tree at PATH into a string using lens LENS and store it in the node NODE_OUT, assuming the tree was initially generated using the value of node NODE_IN. </div></div><div class=CToolTip id="tt19"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_print(</td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>FILE </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>out,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Print each node matching PATH and its descendants to OUT.</div></div><div class=CToolTip id="tt20"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_to_xml(</td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>path,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>xmlNode </td><td class="PParameterPrefix prettyprint " nowrap>**</td><td class="PParameter prettyprint " nowrap>xmldoc,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>unsigned </td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap></td><td class="PParameter prettyprint " nowrap>flags</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Turn the Augeas tree(s) matching PATH into an XML tree XMLDOC. </div></div><div class=CToolTip id="tt21"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_transform(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>lens,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>file,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>int </td><td class="PParameterPrefix prettyprint " nowrap></td><td class="PParameter prettyprint " nowrap>excl</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Add a transform for FILE using LENS. </div></div><div class=CToolTip id="tt22"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>int aug_srun(</td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap></td><td class="PType prettyprint " nowrap>FILE </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>out,</td></tr><tr><td></td><td class="PTypePrefix prettyprint " nowrap>const </td><td class="PType prettyprint " nowrap>char </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>text</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Run one or more newline-separated commands. </div></div><div class=CToolTip id="tt23"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>void aug_close(</td><td class="PType prettyprint " nowrap>augeas </td><td class="PParameterPrefix prettyprint " nowrap>*</td><td class="PParameter prettyprint " nowrap>aug</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Close this Augeas instance and free any storage associated with it. </div></div><!--END_ND_TOOLTIPS-->
<div id=MSearchResultsWindow><iframe src="" frameborder=0 name=MSearchResults id=MSearchResults></iframe><a href="javascript:searchPanel.CloseResultsWindow()" id=MSearchResultsWindowClose>Close</a></div>
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>
|