libnx/ectx_8h.html
2025-05-08 06:59:12 +00:00

193 lines
11 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libnx: include/switch/services/ectx.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">libnx<span id="projectnumber">&#160;v4.9.0</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_42bea3d40f1f1694e41a8f3166c98108.html">switch</a></li><li class="navelem"><a class="el" href="dir_04a7e0b94d44ce4fc7ca3462163fd33c.html">services</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">ectx.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>[11.0.0+] Error Context services IPC wrapper.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &quot;<a class="el" href="types_8h_source.html">../types.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="event_8h_source.html">../kernel/event.h</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="service_8h_source.html">../sf/service.h</a>&quot;</code><br />
</div>
<p><a href="ectx_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a7440cdfabefcba509a6cc5fc08fb9aef" id="r_a7440cdfabefcba509a6cc5fc08fb9aef"><td class="memItemLeft" align="right" valign="top"><a id="a7440cdfabefcba509a6cc5fc08fb9aef" name="a7440cdfabefcba509a6cc5fc08fb9aef"></a>
<a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><b>ectxrInitialize</b> (void)</td></tr>
<tr class="memdesc:a7440cdfabefcba509a6cc5fc08fb9aef"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initialize ectx:r. <br /></td></tr>
<tr class="separator:a7440cdfabefcba509a6cc5fc08fb9aef"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ada5d9909d7cbfe87f99be00f2e35231c" id="r_ada5d9909d7cbfe87f99be00f2e35231c"><td class="memItemLeft" align="right" valign="top"><a id="ada5d9909d7cbfe87f99be00f2e35231c" name="ada5d9909d7cbfe87f99be00f2e35231c"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><b>ectxrExit</b> (void)</td></tr>
<tr class="memdesc:ada5d9909d7cbfe87f99be00f2e35231c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exit ectx:r. <br /></td></tr>
<tr class="separator:ada5d9909d7cbfe87f99be00f2e35231c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0db172ad6c23fcd338209eeed30f0540" id="r_a0db172ad6c23fcd338209eeed30f0540"><td class="memItemLeft" align="right" valign="top"><a id="a0db172ad6c23fcd338209eeed30f0540" name="a0db172ad6c23fcd338209eeed30f0540"></a>
<a class="el" href="structService.html">Service</a> *&#160;</td><td class="memItemRight" valign="bottom"><b>ectxrGetServiceSession</b> (void)</td></tr>
<tr class="memdesc:a0db172ad6c23fcd338209eeed30f0540"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the <a class="el" href="structService.html" title="Service object structure.">Service</a> object for the actual ectx:r service session. <br /></td></tr>
<tr class="separator:a0db172ad6c23fcd338209eeed30f0540"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a75a039eac773f2596aaf57b268c281f5" id="r_a75a039eac773f2596aaf57b268c281f5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="ectx_8h.html#a75a039eac773f2596aaf57b268c281f5">ectxrPullContext</a> (<a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> *out0, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *out_total_size, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *out_size, void *dst, size_t dst_size, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> descriptor, <a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> result)</td></tr>
<tr class="memdesc:a75a039eac773f2596aaf57b268c281f5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the error context associated with an error descriptor and result. <br /></td></tr>
<tr class="separator:a75a039eac773f2596aaf57b268c281f5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>[11.0.0+] Error Context services IPC wrapper. </p>
<dl class="section author"><dt>Author</dt><dd>SciresM </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>libnx Authors </dd></dl>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a75a039eac773f2596aaf57b268c281f5" name="a75a039eac773f2596aaf57b268c281f5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75a039eac773f2596aaf57b268c281f5">&#9670;&#160;</a></span>ectxrPullContext()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> ectxrPullContext </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> *&#160;</td>
<td class="paramname"><em>out0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *&#160;</td>
<td class="paramname"><em>out_total_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *&#160;</td>
<td class="paramname"><em>out_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>dst</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t&#160;</td>
<td class="paramname"><em>dst_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>descriptor</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td>
<td class="paramname"><em>result</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Retrieves the error context associated with an error descriptor and result. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">out0</td><td>Output value. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out_total_size</td><td>Total error context size. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">out_size</td><td>Error context size. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">dst</td><td>Buffer for output error context. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">dst_size</td><td>Buffer size for output error context. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">descriptor</td><td>Error descriptor. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">result</td><td>Error result. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Result code. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
</small></address>
</body>
</html>