libctru/srvpm_8h.html
2024-11-03 20:36:34 +00:00

271 lines
14 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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libctru: include/3ds/services/srvpm.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 style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libctru
&#160;<span id="projectnumber">v2.4.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'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:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</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_d475325f6a9fe3bfc3a495c72a9e475e.html">3ds</a></li><li class="navelem"><a class="el" href="dir_0e005207343684f6967052d1f51a7e66.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">srvpm.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>srv:pm service.
<a href="#details">More...</a></p>
<p><a href="srvpm_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 name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a8429e3cd75bcce7049c5857cbe9c05d6"><td class="memItemLeft" align="right" valign="top"><a id="a8429e3cd75bcce7049c5857cbe9c05d6"></a>
<a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srvpm_8h.html#a8429e3cd75bcce7049c5857cbe9c05d6">srvPmInit</a> (void)</td></tr>
<tr class="memdesc:a8429e3cd75bcce7049c5857cbe9c05d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initializes srv:pm and the service API. <br /></td></tr>
<tr class="separator:a8429e3cd75bcce7049c5857cbe9c05d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab84562de6bb42fc0829822cca245b9d6"><td class="memItemLeft" align="right" valign="top"><a id="ab84562de6bb42fc0829822cca245b9d6"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srvpm_8h.html#ab84562de6bb42fc0829822cca245b9d6">srvPmExit</a> (void)</td></tr>
<tr class="memdesc:ab84562de6bb42fc0829822cca245b9d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Exits srv:pm and the service API. <br /></td></tr>
<tr class="separator:ab84562de6bb42fc0829822cca245b9d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae2c9070832f71754b2cac6d396d0d55a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srvpm_8h.html#ae2c9070832f71754b2cac6d396d0d55a">srvPmGetSessionHandle</a> (void)</td></tr>
<tr class="memdesc:ae2c9070832f71754b2cac6d396d0d55a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current srv:pm session handle. <a href="srvpm_8h.html#ae2c9070832f71754b2cac6d396d0d55a">More...</a><br /></td></tr>
<tr class="separator:ae2c9070832f71754b2cac6d396d0d55a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac0aadf18e4a21fa1f88e98742c13ea99"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srvpm_8h.html#ac0aadf18e4a21fa1f88e98742c13ea99">SRVPM_PublishToProcess</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> notificationId, <a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a> process)</td></tr>
<tr class="memdesc:ac0aadf18e4a21fa1f88e98742c13ea99"><td class="mdescLeft">&#160;</td><td class="mdescRight">Publishes a notification to a process. <a href="srvpm_8h.html#ac0aadf18e4a21fa1f88e98742c13ea99">More...</a><br /></td></tr>
<tr class="separator:ac0aadf18e4a21fa1f88e98742c13ea99"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a25b38afc8254d6f97c7937f817124810"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srvpm_8h.html#a25b38afc8254d6f97c7937f817124810">SRVPM_PublishToAll</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> notificationId)</td></tr>
<tr class="memdesc:a25b38afc8254d6f97c7937f817124810"><td class="mdescLeft">&#160;</td><td class="mdescRight">Publishes a notification to all processes. <a href="srvpm_8h.html#a25b38afc8254d6f97c7937f817124810">More...</a><br /></td></tr>
<tr class="separator:a25b38afc8254d6f97c7937f817124810"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a02dfaf51d1784abd4d20fe2f25d6bf22"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srvpm_8h.html#a02dfaf51d1784abd4d20fe2f25d6bf22">SRVPM_RegisterProcess</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> pid, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> count, const char(*serviceAccessControlList)[8])</td></tr>
<tr class="memdesc:a02dfaf51d1784abd4d20fe2f25d6bf22"><td class="mdescLeft">&#160;</td><td class="mdescRight">Registers a process with SRV. <a href="srvpm_8h.html#a02dfaf51d1784abd4d20fe2f25d6bf22">More...</a><br /></td></tr>
<tr class="separator:a02dfaf51d1784abd4d20fe2f25d6bf22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbcad1f6e4c5db0b8277480460845be9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="srvpm_8h.html#afbcad1f6e4c5db0b8277480460845be9">SRVPM_UnregisterProcess</a> (<a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> pid)</td></tr>
<tr class="memdesc:afbcad1f6e4c5db0b8277480460845be9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Unregisters a process with SRV. <a href="srvpm_8h.html#afbcad1f6e4c5db0b8277480460845be9">More...</a><br /></td></tr>
<tr class="separator:afbcad1f6e4c5db0b8277480460845be9"><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>srv:pm service. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a25b38afc8254d6f97c7937f817124810"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a25b38afc8254d6f97c7937f817124810">&#9670;&nbsp;</a></span>SRVPM_PublishToAll()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> SRVPM_PublishToAll </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>notificationId</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Publishes a notification to all processes. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">notificationId</td><td>ID of the notification. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac0aadf18e4a21fa1f88e98742c13ea99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac0aadf18e4a21fa1f88e98742c13ea99">&#9670;&nbsp;</a></span>SRVPM_PublishToProcess()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> SRVPM_PublishToProcess </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>notificationId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>&#160;</td>
<td class="paramname"><em>process</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Publishes a notification to a process. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">notificationId</td><td>ID of the notification. </td></tr>
<tr><td class="paramname">process</td><td>Process to publish to. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a02dfaf51d1784abd4d20fe2f25d6bf22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02dfaf51d1784abd4d20fe2f25d6bf22">&#9670;&nbsp;</a></span>SRVPM_RegisterProcess()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> SRVPM_RegisterProcess </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>pid</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>count</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char(*)&#160;</td>
<td class="paramname"><em>serviceAccessControlList</em>[8]&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Registers a process with SRV. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pid</td><td>ID of the process. </td></tr>
<tr><td class="paramname">count</td><td>Number of services within the service access control data. </td></tr>
<tr><td class="paramname">serviceAccessControlList</td><td>Service Access Control list. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="afbcad1f6e4c5db0b8277480460845be9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbcad1f6e4c5db0b8277480460845be9">&#9670;&nbsp;</a></span>SRVPM_UnregisterProcess()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ac830bf5a4f2cf8273f61ab99a46cf163">Result</a> SRVPM_UnregisterProcess </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a>&#160;</td>
<td class="paramname"><em>pid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Unregisters a process with SRV. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">pid</td><td>ID of the process. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae2c9070832f71754b2cac6d396d0d55a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae2c9070832f71754b2cac6d396d0d55a">&#9670;&nbsp;</a></span>srvPmGetSessionHandle()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ab6d744c6b5de129f12937e482dc674fb">Handle</a>* srvPmGetSessionHandle </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the current srv:pm session handle. </p>
<dl class="section return"><dt>Returns</dt><dd>The current srv:pm session handle. </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.1
</small></address>
</body>
</html>