mika/libnx
1
0
Fork 0
mirror of https://github.com/switchbrew/libnx.git synced 2025-06-21 12:32:40 +02:00
Code Issues Packages Projects Releases Wiki Activity
gh-pages
libnx/pctlauth_8h.html
WinterMute bf00061749 Deploying to gh-pages from @ 29f6f4fa7a 🚀
2025-05-08 06:59:12 +00:00

278 lines
16 KiB
HTML
Raw Permalink Blame History

<!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/applets/pctlauth.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_68784c92a8a0520ca3b455e73fe4da44.html">applets</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">pctlauth.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Wrapper for using the Parental Controls authentication LibraryApplet.
<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 />
</div>
<p><a href="pctlauth_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="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structPctlAuthArg.html">PctlAuthArg</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Input arg storage for the applet. <a href="structPctlAuthArg.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:aed618d6c5f844570c8533eff2fd8b39c" id="r_aed618d6c5f844570c8533eff2fd8b39c"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="pctlauth_8h.html#aed618d6c5f844570c8533eff2fd8b39c">PctlAuthType</a> { <br />
&#160;&#160;<a class="el" href="pctlauth_8h.html#aed618d6c5f844570c8533eff2fd8b39caf1592875e38813b3f78d3dea0e0985fd">PctlAuthType_Show</a> = 0
, <br />
&#160;&#160;<a class="el" href="pctlauth_8h.html#aed618d6c5f844570c8533eff2fd8b39ca9a6c22db4ba59dfa7218a94dc894b95d">PctlAuthType_RegisterPasscode</a> = 1
, <br />
&#160;&#160;<a class="el" href="pctlauth_8h.html#aed618d6c5f844570c8533eff2fd8b39ca7e51716069c4cb114dac80175184b5e6">PctlAuthType_ChangePasscode</a> = 2
<br />
}</td></tr>
<tr class="memdesc:aed618d6c5f844570c8533eff2fd8b39c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Type values for <a class="el" href="structPctlAuthArg.html#abfb7e5182fdb370821b215fe8bd03c06" title="PctlAuthType">PctlAuthArg::type</a>. <a href="pctlauth_8h.html#aed618d6c5f844570c8533eff2fd8b39c">More...</a><br /></td></tr>
<tr class="separator:aed618d6c5f844570c8533eff2fd8b39c"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:a94d69451247630a20a08c563e68aa9ec" id="r_a94d69451247630a20a08c563e68aa9ec"><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="pctlauth_8h.html#a94d69451247630a20a08c563e68aa9ec">pctlauthShow</a> (bool flag)</td></tr>
<tr class="memdesc:a94d69451247630a20a08c563e68aa9ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Launches the applet. <br /></td></tr>
<tr class="separator:a94d69451247630a20a08c563e68aa9ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa301c46dcba835624a2d3a9872830eaf" id="r_aa301c46dcba835624a2d3a9872830eaf"><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="pctlauth_8h.html#aa301c46dcba835624a2d3a9872830eaf">pctlauthShowEx</a> (<a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> arg0, <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> arg1, <a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> arg2)</td></tr>
<tr class="memdesc:aa301c46dcba835624a2d3a9872830eaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Launches the applet. <br /></td></tr>
<tr class="separator:aa301c46dcba835624a2d3a9872830eaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a26590d8e7d8b042cfe4a9fd088582797" id="r_a26590d8e7d8b042cfe4a9fd088582797"><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="pctlauth_8h.html#a26590d8e7d8b042cfe4a9fd088582797">pctlauthShowForConfiguration</a> (void)</td></tr>
<tr class="memdesc:a26590d8e7d8b042cfe4a9fd088582797"><td class="mdescLeft">&#160;</td><td class="mdescRight">Just calls: pctlauthShowEx(1, 0, 1). <br /></td></tr>
<tr class="separator:a26590d8e7d8b042cfe4a9fd088582797"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab9fad9a58c8f98e494ba59d57a0e6c3c" id="r_ab9fad9a58c8f98e494ba59d57a0e6c3c"><td class="memItemLeft" align="right" valign="top"><a id="ab9fad9a58c8f98e494ba59d57a0e6c3c" name="ab9fad9a58c8f98e494ba59d57a0e6c3c"></a>
<a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a>&#160;</td><td class="memItemRight" valign="bottom"><b>pctlauthRegisterPasscode</b> (void)</td></tr>
<tr class="memdesc:ab9fad9a58c8f98e494ba59d57a0e6c3c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Launches the applet for registering the Parental Controls PIN. <br /></td></tr>
<tr class="separator:ab9fad9a58c8f98e494ba59d57a0e6c3c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6c7650828080342d502d966f62dcb864" id="r_a6c7650828080342d502d966f62dcb864"><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="pctlauth_8h.html#a6c7650828080342d502d966f62dcb864">pctlauthChangePasscode</a> (void)</td></tr>
<tr class="memdesc:a6c7650828080342d502d966f62dcb864"><td class="mdescLeft">&#160;</td><td class="mdescRight">Launches the applet for changing the Parental Controls PIN. <br /></td></tr>
<tr class="separator:a6c7650828080342d502d966f62dcb864"><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>Wrapper for using the Parental Controls authentication LibraryApplet. </p>
<p>This applet is used by qlaunch. </p><dl class="section author"><dt>Author</dt><dd>yellows8 </dd></dl>
<dl class="section copyright"><dt>Copyright</dt><dd>libnx Authors </dd></dl>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="aed618d6c5f844570c8533eff2fd8b39c" name="aed618d6c5f844570c8533eff2fd8b39c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aed618d6c5f844570c8533eff2fd8b39c">&#9670;&#160;</a></span>PctlAuthType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="pctlauth_8h.html#aed618d6c5f844570c8533eff2fd8b39c">PctlAuthType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type values for <a class="el" href="structPctlAuthArg.html#abfb7e5182fdb370821b215fe8bd03c06" title="PctlAuthType">PctlAuthArg::type</a>. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="aed618d6c5f844570c8533eff2fd8b39caf1592875e38813b3f78d3dea0e0985fd" name="aed618d6c5f844570c8533eff2fd8b39caf1592875e38813b3f78d3dea0e0985fd"></a>PctlAuthType_Show&#160;</td><td class="fielddoc"><p>ShowParentalAuthentication. </p>
</td></tr>
<tr><td class="fieldname"><a id="aed618d6c5f844570c8533eff2fd8b39ca9a6c22db4ba59dfa7218a94dc894b95d" name="aed618d6c5f844570c8533eff2fd8b39ca9a6c22db4ba59dfa7218a94dc894b95d"></a>PctlAuthType_RegisterPasscode&#160;</td><td class="fielddoc"><p>RegisterParentalPasscode. </p>
</td></tr>
<tr><td class="fieldname"><a id="aed618d6c5f844570c8533eff2fd8b39ca7e51716069c4cb114dac80175184b5e6" name="aed618d6c5f844570c8533eff2fd8b39ca7e51716069c4cb114dac80175184b5e6"></a>PctlAuthType_ChangePasscode&#160;</td><td class="fielddoc"><p>ChangeParentalPasscode. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a6c7650828080342d502d966f62dcb864" name="a6c7650828080342d502d966f62dcb864"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6c7650828080342d502d966f62dcb864">&#9670;&#160;</a></span>pctlauthChangePasscode()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> pctlauthChangePasscode </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Launches the applet for changing the Parental Controls PIN. </p>
<dl class="section note"><dt>Note</dt><dd>Should not be used if a PIN is not already registered. See <a class="el" href="pctl_8h.html#a80084ac6d28e34266b52ea2f45b05398">pctlIsRestrictionEnabled</a>. </dd></dl>
</div>
</div>
<a id="a94d69451247630a20a08c563e68aa9ec" name="a94d69451247630a20a08c563e68aa9ec"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a94d69451247630a20a08c563e68aa9ec">&#9670;&#160;</a></span>pctlauthShow()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> pctlauthShow </td>
<td>(</td>
<td class="paramtype">bool&#160;</td>
<td class="paramname"><em>flag</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Launches the applet. </p>
<dl class="section note"><dt>Note</dt><dd>Should not be used if a PIN is not already registered. See <a class="el" href="pctl_8h.html#a80084ac6d28e34266b52ea2f45b05398">pctlIsRestrictionEnabled</a>. </dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">flag</td><td>Input flag. false = temporarily disable Parental Controls. true = validate the input PIN. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aa301c46dcba835624a2d3a9872830eaf" name="aa301c46dcba835624a2d3a9872830eaf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa301c46dcba835624a2d3a9872830eaf">&#9670;&#160;</a></span>pctlauthShowEx()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> pctlauthShowEx </td>
<td>(</td>
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a>&#160;</td>
<td class="paramname"><em>arg0</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a>&#160;</td>
<td class="paramname"><em>arg1</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a>&#160;</td>
<td class="paramname"><em>arg2</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Launches the applet. </p>
<p>Only available with [4.0.0+]. </p><dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">arg0</td><td>Value for <a class="el" href="structPctlAuthArg.html#a4d24d747d72141e63d135529b47c9254" title="Arg0.">PctlAuthArg.arg0</a>. </td></tr>
<tr><td class="paramname">arg1</td><td>Value for <a class="el" href="structPctlAuthArg.html#ab360432e0a701893a9aaa573ec4f97b1" title="Arg1.">PctlAuthArg.arg1</a>. </td></tr>
<tr><td class="paramname">arg2</td><td>Value for <a class="el" href="structPctlAuthArg.html#a55f281d5fc0cbe0d52c85f020018b3c8" title="Arg2.">PctlAuthArg.arg2</a>. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a26590d8e7d8b042cfe4a9fd088582797" name="a26590d8e7d8b042cfe4a9fd088582797"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a26590d8e7d8b042cfe4a9fd088582797">&#9670;&#160;</a></span>pctlauthShowForConfiguration()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> pctlauthShowForConfiguration </td>
<td>(</td>
<td class="paramtype">void&#160;</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Just calls: pctlauthShowEx(1, 0, 1). </p>
<p>Launches the applet for checking the PIN, used when changing system-settings. </p><dl class="section note"><dt>Note</dt><dd>Should not be used if a PIN is not already registered. See <a class="el" href="pctl_8h.html#a80084ac6d28e34266b52ea2f45b05398">pctlIsRestrictionEnabled</a>. </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>
Reference in New Issue View Git Blame Copy Permalink