You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
<trid="row_0_22_"class="even"><tdclass="entry"><spanstyle="width:32px;display:inline-block;"> </span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="classjinja2_1_1_template.html"target="_self">Template</a></td><tdclass="desc"><aclass="el"href="classjinja2_1_1_template.html"title="Template object which is used to render narrow char templates.">Template</a> object which is used to render narrow char templates</td></tr>
Copy file name to clipboardExpand all lines: docs/reference/html/classjinja2_1_1_template.html
+90-1Lines changed: 90 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -98,35 +98,48 @@
98
98
</div><!--header-->
99
99
<divclass="contents">
100
100
101
+
<p><aclass="el"href="classjinja2_1_1_template.html"title="Template object which is used to render narrow char templates.">Template</a> object which is used to render narrow char templates.
<trclass="memdesc:a3c4a2705c8d281271dc36e5c7d1643a4"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Load template from the zero-terminated narrow char string.<ahref="classjinja2_1_1_template.html#a3c4a2705c8d281271dc36e5c7d1643a4">More...</a><br/></td></tr>
<trclass="memdesc:a406e6aad7df0a661519a858d3e40aa09"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Load template from the std::string.<ahref="classjinja2_1_1_template.html#a406e6aad7df0a661519a858d3e40aa09">More...</a><br/></td></tr>
<trclass="memdesc:aa9220ec3ee1953c20d16f38142f94465"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Load template from the stream.<ahref="classjinja2_1_1_template.html#aa9220ec3ee1953c20d16f38142f94465">More...</a><br/></td></tr>
<trclass="memdesc:ac005e76046969f9bf81c2f3257e630e4"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Load template from the specified file.<ahref="classjinja2_1_1_template.html#ac005e76046969f9bf81c2f3257e630e4">More...</a><br/></td></tr>
<trclass="memdesc:a471750a94036f4ceffe9aaa159f46615"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Render previously loaded template to the narrow char stream.<ahref="classjinja2_1_1_template.html#a471750a94036f4ceffe9aaa159f46615">More...</a><br/></td></tr>
<trclass="memdesc:aecba9a5cae9f93f7c54598f5270e80de"><tdclass="mdescLeft"> </td><tdclass="mdescRight">Render previously loaded template to the narrow char string.<ahref="classjinja2_1_1_template.html#aecba9a5cae9f93f7c54598f5270e80de">More...</a><br/></td></tr>
<divclass="textblock"><p><aclass="el"href="classjinja2_1_1_template.html"title="Template object which is used to render narrow char templates.">Template</a> object which is used to render narrow char templates.</p>
142
+
</div><h2class="groupheader">Constructor & Destructor Documentation</h2>
<p>Creates instance of the template with the specified template environment object</p>
196
+
<dlclass="params"><dt>Parameters</dt><dd>
197
+
<tableclass="params">
198
+
<tr><tdclass="paramname">env</td><td><aclass="el"href="classjinja2_1_1_template.html"title="Template object which is used to render narrow char templates.">Template</a> environment object which created template should refer to</td></tr>
<p>Load template from the zero-terminated narrow char string.</p>
251
+
<p>Takes specified narrow char string and parses it as a Jinja2 template. In case of error returns detailed diagnostic</p>
252
+
<dlclass="params"><dt>Parameters</dt><dd>
253
+
<tableclass="params">
254
+
<tr><tdclass="paramname">tpl</td><td>Zero-terminated narrow char string with template description</td></tr>
255
+
<tr><tdclass="paramname">tplName</td><td>Optional name of the template (for the error reporting purposes)</td></tr>
256
+
</table>
257
+
</dd>
258
+
</dl>
259
+
<dlclass="section return"><dt>Returns</dt><dd>Either noting or instance of<aclass="el"href="classjinja2_1_1_error_info_tpl.html">ErrorInfoTpl</a> as an error</dd></dl>
<p>Takes specified std::string object and parses it as a Jinja2 template. In case of error returns detailed diagnostic</p>
291
+
<dlclass="params"><dt>Parameters</dt><dd>
292
+
<tableclass="params">
293
+
<tr><tdclass="paramname">tpl</td><td>std::string object with template description</td></tr>
294
+
<tr><tdclass="paramname">tplName</td><td>Optional name of the template (for the error reporting purposes)</td></tr>
295
+
</table>
296
+
</dd>
297
+
</dl>
298
+
<dlclass="section return"><dt>Returns</dt><dd>Either noting or instance of<aclass="el"href="classjinja2_1_1_error_info_tpl.html">ErrorInfoTpl</a> as an error</dd></dl>
<p>Takes specified stream object and parses it as a source of Jinja2 template. In case of error returns detailed diagnostic</p>
330
+
<dlclass="params"><dt>Parameters</dt><dd>
331
+
<tableclass="params">
332
+
<tr><tdclass="paramname">tpl</td><td>Stream object with template description</td></tr>
333
+
<tr><tdclass="paramname">tplName</td><td>Optional name of the template (for the error reporting purposes)</td></tr>
334
+
</table>
335
+
</dd>
336
+
</dl>
337
+
<dlclass="section return"><dt>Returns</dt><dd>Either noting or instance of<aclass="el"href="classjinja2_1_1_error_info_tpl.html">ErrorInfoTpl</a> as an error</dd></dl>
<p>Loads file with the specified name and parses it as a source of Jinja2 template. In case of error returns detailed diagnostic</p>
359
+
<dlclass="params"><dt>Parameters</dt><dd>
360
+
<tableclass="params">
361
+
<tr><tdclass="paramname">fileName</td><td>Name of the file to load</td></tr>
362
+
</table>
363
+
</dd>
364
+
</dl>
365
+
<dlclass="section return"><dt>Returns</dt><dd>Either noting or instance of<aclass="el"href="classjinja2_1_1_error_info_tpl.html">ErrorInfoTpl</a> as an error</dd></dl>
<p>Render previously loaded template to the narrow char stream.</p>
396
+
<p>Renders previously loaded template to the specified narrow char stream and specified set of params.</p>
397
+
<dlclass="params"><dt>Parameters</dt><dd>
398
+
<tableclass="params">
399
+
<tr><tdclass="paramname">os</td><td>Stream to render template to</td></tr>
400
+
<tr><tdclass="paramname">params</td><td>Set of params which should be passed to the template engine and can be used within the template</td></tr>
401
+
</table>
402
+
</dd>
403
+
</dl>
404
+
<dlclass="section return"><dt>Returns</dt><dd>Either noting or instance of<aclass="el"href="classjinja2_1_1_error_info_tpl.html">ErrorInfoTpl</a> as an error</dd></dl>
<p>Render previously loaded template to the narrow char string.</p>
425
+
<p>Renders previously loaded template as a narrow char string and with specified set of params.</p>
426
+
<dlclass="params"><dt>Parameters</dt><dd>
427
+
<tableclass="params">
428
+
<tr><tdclass="paramname">params</td><td>Set of params which should be passed to the template engine and can be used within the template</td></tr>
429
+
</table>
430
+
</dd>
431
+
</dl>
432
+
<dlclass="section return"><dt>Returns</dt><dd>Either rendered string or instance of<aclass="el"href="classjinja2_1_1_error_info_tpl.html">ErrorInfoTpl</a> as an error</dd></dl>
433
+
345
434
</div>
346
435
</div>
347
436
<h2class="groupheader">Friends And Related Function Documentation</h2>
<trid="row_25_"><tdclass="entry"><spanstyle="width:16px;display:inline-block;"> </span><spanclass="icona"><spanclass="icon">C</span></span><aclass="el"href="classjinja2_1_1_template.html"target="_self">jinja2::Template</a></td><tdclass="desc"><aclass="el"href="classjinja2_1_1_template.html"title="Template object which is used to render narrow char templates.">Template</a> object which is used to render narrow char templates</td></tr>