Permalink
Browse files

updated documentation

  • Loading branch information...
1 parent 95b2f3b commit fde9bdcdaf1ed1a6366cbd35f005d2707e3120d6 @penduin penduin committed Aug 28, 2015
Showing with 32 additions and 1 deletion.
  1. +32 −1 documentation/wjelement.html
@@ -312,13 +312,16 @@
</pre></blockquote>
</p>
<p>
-<strong>WJEString</strong>
+<strong>WJEString, WJEStringN</strong>
- Access a string element
</p>
<p>
<blockquote><pre>
char * WJEString(WJElement container, char *path, WJEAction action, char *value);
char * _WJEString(WJElement container, char *path, WJEAction action, WJElement *last, char *value);
+
+char * WJEStringN(WJElement container, char *path, WJEAction action, char *value, size_t len);
+char * _WJEStringN(WJElement container, char *path, WJEAction action, WJElement *last, char *value, size_t len);
</pre></blockquote>
</p>
<p>
@@ -402,6 +405,34 @@
</pre></blockquote>
</p>
<p>
+<strong>WJE...F variants</strong>
+ - Format-capable versions of element functions
+</p>
+<p>
+The following functions...
+<ul>
+<li><strong>WJEGetF</strong></li>
+<li><strong>WJEBoolF</strong></li>
+<li><strong>WJEStringF</strong></li>
+<li><strong>WJEStringNF</strong></li>
+<li><strong>WJEObjectF</strong></li>
+<li><strong>WJEArrayF</strong></li>
+<li><strong>WJENullF</strong></li>
+<li><strong>WJEInt32F</strong></li>
+<li><strong>WJEUInt32F</strong></li>
+<li><strong>WJEInt64F</strong></li>
+<li><strong>WJEUInt64F</strong></li>
+<li><strong>WJEDoubleF</strong></li>
+</ul>
+...are identical to the non F variants except that the
+path argument has been moved to the end and is used as a format string. For
+example if you need a value by index, and that index is stored in the
+variable x:
+<blockquote><pre>
+val = WJENumberF(doc, WJE_GET, NULL, 0, "foo[%d]", x);
+</pre></blockquote>
+</p>
+<p>
<strong>WJEChild</strong>
- Find, create or update an element by name instead of path. This allows
access to elements that would be difficult to reference by path. No selector

0 comments on commit fde9bdc

Please sign in to comment.