mirror of
https://github.com/switchbrew/libnx.git
synced 2025-06-21 12:32:40 +02:00
820 lines
51 KiB
HTML
820 lines
51 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/notif.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"> 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&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&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="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#enum-members">Enumerations</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle"><div class="title">notif.h File Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<p>Alarm notification (notif:*) service IPC wrapper.
|
|
<a href="#details">More...</a></p>
|
|
<div class="textblock"><code>#include "<a class="el" href="types_8h_source.html">../types.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="event_8h_source.html">../kernel/event.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="applet_8h_source.html">../services/applet.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="acc_8h_source.html">../services/acc.h</a>"</code><br />
|
|
<code>#include "<a class="el" href="service_8h_source.html">../sf/service.h</a>"</code><br />
|
|
</div>
|
|
<p><a href="notif_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  </td><td class="memItemRight" valign="bottom"><a class="el" href="structNotifAlarmTime.html">NotifAlarmTime</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Data extracted from <a class="el" href="structNotifWeeklyScheduleAlarmSetting.html#a6ea3c3794fcbc0e90661240121a26387" title="Schedule settings for each day of the week, Sun-Sat. High byte is the hour, low byte is the minute....">NotifWeeklyScheduleAlarmSetting::settings</a>. This uses local-time. <a href="structNotifAlarmTime.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structNotifWeeklyScheduleAlarmSetting.html">NotifWeeklyScheduleAlarmSetting</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">WeeklyScheduleAlarmSetting. <a href="structNotifWeeklyScheduleAlarmSetting.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a></td></tr>
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">AlarmSetting. <a href="structNotifAlarmSetting.html#details">More...</a><br /></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:ac25066a08555f7025db1f3352d78053a" id="r_ac25066a08555f7025db1f3352d78053a"><td class="memItemLeft" align="right" valign="top"><a id="ac25066a08555f7025db1f3352d78053a" name="ac25066a08555f7025db1f3352d78053a"></a>
|
|
#define </td><td class="memItemRight" valign="bottom"><b>NOTIF_MAX_ALARMS</b>   8</td></tr>
|
|
<tr class="memdesc:ac25066a08555f7025db1f3352d78053a"><td class="mdescLeft"> </td><td class="mdescRight">Maximum alarms that can be registered at the same time by the host Application. <br /></td></tr>
|
|
<tr class="separator:ac25066a08555f7025db1f3352d78053a"><td class="memSeparator" colspan="2"> </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:a0fb80e6caae6b58d8e6b002f540fced4" id="r_a0fb80e6caae6b58d8e6b002f540fced4"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="notif_8h.html#a0fb80e6caae6b58d8e6b002f540fced4">NotifServiceType</a> { <br />
|
|
  <a class="el" href="notif_8h.html#a0fb80e6caae6b58d8e6b002f540fced4acafc81b2acf05b5440a802de1d4b3c72">NotifServiceType_Application</a> = 0
|
|
, <br />
|
|
  <a class="el" href="notif_8h.html#a0fb80e6caae6b58d8e6b002f540fced4aee3cc3d819ad02d6003fb70a706615b7">NotifServiceType_System</a> = 1
|
|
<br />
|
|
}</td></tr>
|
|
<tr class="memdesc:a0fb80e6caae6b58d8e6b002f540fced4"><td class="mdescLeft"> </td><td class="mdescRight">ServiceType for <a class="el" href="notif_8h.html#a83039327cca2c9f106a6f27eb7411257">notifInitialize</a>. <a href="notif_8h.html#a0fb80e6caae6b58d8e6b002f540fced4">More...</a><br /></td></tr>
|
|
<tr class="separator:a0fb80e6caae6b58d8e6b002f540fced4"><td class="memSeparator" colspan="2"> </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:a83039327cca2c9f106a6f27eb7411257" id="r_a83039327cca2c9f106a6f27eb7411257"><td class="memItemLeft" align="right" valign="top"><a id="a83039327cca2c9f106a6f27eb7411257" name="a83039327cca2c9f106a6f27eb7411257"></a>
|
|
<a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><b>notifInitialize</b> (<a class="el" href="notif_8h.html#a0fb80e6caae6b58d8e6b002f540fced4">NotifServiceType</a> service_type)</td></tr>
|
|
<tr class="memdesc:a83039327cca2c9f106a6f27eb7411257"><td class="mdescLeft"> </td><td class="mdescRight">Initialize notif. Only available on [9.0.0+]. <br /></td></tr>
|
|
<tr class="separator:a83039327cca2c9f106a6f27eb7411257"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a716ce6f4b9077a43807bc3f202b5c324" id="r_a716ce6f4b9077a43807bc3f202b5c324"><td class="memItemLeft" align="right" valign="top"><a id="a716ce6f4b9077a43807bc3f202b5c324" name="a716ce6f4b9077a43807bc3f202b5c324"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>notifExit</b> (void)</td></tr>
|
|
<tr class="memdesc:a716ce6f4b9077a43807bc3f202b5c324"><td class="mdescLeft"> </td><td class="mdescRight">Exit notif. <br /></td></tr>
|
|
<tr class="separator:a716ce6f4b9077a43807bc3f202b5c324"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7dd5dee444aeb44f68980ddff0591ff2" id="r_a7dd5dee444aeb44f68980ddff0591ff2"><td class="memItemLeft" align="right" valign="top"><a id="a7dd5dee444aeb44f68980ddff0591ff2" name="a7dd5dee444aeb44f68980ddff0591ff2"></a>
|
|
<a class="el" href="structService.html">Service</a> * </td><td class="memItemRight" valign="bottom"><b>notifGetServiceSession</b> (void)</td></tr>
|
|
<tr class="memdesc:a7dd5dee444aeb44f68980ddff0591ff2"><td class="mdescLeft"> </td><td class="mdescRight">Gets the <a class="el" href="structService.html" title="Service object structure.">Service</a> object for the actual notif:* service session. <br /></td></tr>
|
|
<tr class="separator:a7dd5dee444aeb44f68980ddff0591ff2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:aa223223eec5fa3374334a25ff11347e8" id="r_aa223223eec5fa3374334a25ff11347e8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="notif_8h.html#aa223223eec5fa3374334a25ff11347e8">notifAlarmSettingCreate</a> (<a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> *alarm_setting)</td></tr>
|
|
<tr class="memdesc:aa223223eec5fa3374334a25ff11347e8"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a>. <br /></td></tr>
|
|
<tr class="separator:aa223223eec5fa3374334a25ff11347e8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:add2b2d7db29e0f7355339d0a6c744e4f" id="r_add2b2d7db29e0f7355339d0a6c744e4f"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="notif_8h.html#add2b2d7db29e0f7355339d0a6c744e4f">notifAlarmSettingSetIsMuted</a> (<a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> *alarm_setting, bool flag)</td></tr>
|
|
<tr class="memdesc:add2b2d7db29e0f7355339d0a6c744e4f"><td class="mdescLeft"> </td><td class="mdescRight">Sets whether the <a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> is muted. <br /></td></tr>
|
|
<tr class="separator:add2b2d7db29e0f7355339d0a6c744e4f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a386cd906026cb43cab4bdf65a8cf9585" id="r_a386cd906026cb43cab4bdf65a8cf9585"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="notif_8h.html#a386cd906026cb43cab4bdf65a8cf9585">notifAlarmSettingSetUid</a> (<a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> *alarm_setting, <a class="el" href="structAccountUid.html">AccountUid</a> uid)</td></tr>
|
|
<tr class="memdesc:a386cd906026cb43cab4bdf65a8cf9585"><td class="mdescLeft"> </td><td class="mdescRight">Sets the <a class="el" href="structAccountUid.html">AccountUid</a> for the <a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a>, see <a class="el" href="structNotifAlarmSetting.html#a882ba8661d7be481fb042f3cd08ac4d9" title="AccountUid. User account associated with this AlarmSetting. Used for the preselected_user (accountGet...">NotifAlarmSetting::uid</a>. <br /></td></tr>
|
|
<tr class="separator:a386cd906026cb43cab4bdf65a8cf9585"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae47d53874f41ac3ffd02786e22251d5f" id="r_ae47d53874f41ac3ffd02786e22251d5f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="notif_8h.html#ae47d53874f41ac3ffd02786e22251d5f">notifAlarmSettingIsEnabled</a> (<a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> *alarm_setting, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> day_of_week, bool *out)</td></tr>
|
|
<tr class="memdesc:ae47d53874f41ac3ffd02786e22251d5f"><td class="mdescLeft"> </td><td class="mdescRight">Gets whether the schedule setting for the specified day_of_week is enabled, for the <a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a>. <br /></td></tr>
|
|
<tr class="separator:ae47d53874f41ac3ffd02786e22251d5f"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4cd4b3929be58653c451a03486a0e79e" id="r_a4cd4b3929be58653c451a03486a0e79e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="notif_8h.html#a4cd4b3929be58653c451a03486a0e79e">notifAlarmSettingGet</a> (<a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> *alarm_setting, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> day_of_week, <a class="el" href="structNotifAlarmTime.html">NotifAlarmTime</a> *out)</td></tr>
|
|
<tr class="memdesc:a4cd4b3929be58653c451a03486a0e79e"><td class="mdescLeft"> </td><td class="mdescRight">Gets the schedule setting for the specified day_of_week, for the <a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a>. <br /></td></tr>
|
|
<tr class="separator:a4cd4b3929be58653c451a03486a0e79e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a03e599872e08375d408cd40017130766" id="r_a03e599872e08375d408cd40017130766"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="notif_8h.html#a03e599872e08375d408cd40017130766">notifAlarmSettingEnable</a> (<a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> *alarm_setting, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> day_of_week, <a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> hour, <a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> minute)</td></tr>
|
|
<tr class="memdesc:a03e599872e08375d408cd40017130766"><td class="mdescLeft"> </td><td class="mdescRight">Enables the schedule setting for the specified day_of_week, for the <a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a>. <br /></td></tr>
|
|
<tr class="separator:a03e599872e08375d408cd40017130766"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a9beb01fa9ac7197fcd6e2796040d2f25" id="r_a9beb01fa9ac7197fcd6e2796040d2f25"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="notif_8h.html#a9beb01fa9ac7197fcd6e2796040d2f25">notifAlarmSettingDisable</a> (<a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> *alarm_setting, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> day_of_week)</td></tr>
|
|
<tr class="memdesc:a9beb01fa9ac7197fcd6e2796040d2f25"><td class="mdescLeft"> </td><td class="mdescRight">Disables the schedule setting for the specified day_of_week, for the <a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a>. <br /></td></tr>
|
|
<tr class="separator:a9beb01fa9ac7197fcd6e2796040d2f25"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ad1d6dd09a878ced28ec8fcef324ac18e" id="r_ad1d6dd09a878ced28ec8fcef324ac18e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="notif_8h.html#ad1d6dd09a878ced28ec8fcef324ac18e">notifRegisterAlarmSetting</a> (<a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> *alarm_setting_id, const <a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> *alarm_setting, const void *buffer, size_t size)</td></tr>
|
|
<tr class="memdesc:ad1d6dd09a878ced28ec8fcef324ac18e"><td class="mdescLeft"> </td><td class="mdescRight">Registers the specified AlarmSetting. <br /></td></tr>
|
|
<tr class="separator:ad1d6dd09a878ced28ec8fcef324ac18e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ada60a84deff99a352f8825c727813819" id="r_ada60a84deff99a352f8825c727813819"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="notif_8h.html#ada60a84deff99a352f8825c727813819">notifUpdateAlarmSetting</a> (const <a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> *alarm_setting, const void *buffer, size_t size)</td></tr>
|
|
<tr class="memdesc:ada60a84deff99a352f8825c727813819"><td class="mdescLeft"> </td><td class="mdescRight">Updates the specified AlarmSetting. <br /></td></tr>
|
|
<tr class="separator:ada60a84deff99a352f8825c727813819"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab905dca16958abdd33777e5c8f951950" id="r_ab905dca16958abdd33777e5c8f951950"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="notif_8h.html#ab905dca16958abdd33777e5c8f951950">notifListAlarmSettings</a> (<a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> *alarm_settings, <a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> count, <a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> *total_out)</td></tr>
|
|
<tr class="memdesc:ab905dca16958abdd33777e5c8f951950"><td class="mdescLeft"> </td><td class="mdescRight">Gets a listing of AlarmSettings. <br /></td></tr>
|
|
<tr class="separator:ab905dca16958abdd33777e5c8f951950"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afe4d166c470f650589616d0f57c2c7b3" id="r_afe4d166c470f650589616d0f57c2c7b3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="notif_8h.html#afe4d166c470f650589616d0f57c2c7b3">notifLoadApplicationParameter</a> (<a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> alarm_setting_id, void *buffer, size_t size, <a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *actual_size)</td></tr>
|
|
<tr class="memdesc:afe4d166c470f650589616d0f57c2c7b3"><td class="mdescLeft"> </td><td class="mdescRight">Loads the ApplicationParameter for the specified AlarmSetting. <br /></td></tr>
|
|
<tr class="separator:afe4d166c470f650589616d0f57c2c7b3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a041a247ed4396592f17793edc81d6665" id="r_a041a247ed4396592f17793edc81d6665"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="notif_8h.html#a041a247ed4396592f17793edc81d6665">notifDeleteAlarmSetting</a> (<a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> alarm_setting_id)</td></tr>
|
|
<tr class="memdesc:a041a247ed4396592f17793edc81d6665"><td class="mdescLeft"> </td><td class="mdescRight">Deletes the specified AlarmSetting. <br /></td></tr>
|
|
<tr class="separator:a041a247ed4396592f17793edc81d6665"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ae2bdef15fc7bc7fbe56dc9d191d6656a" id="r_ae2bdef15fc7bc7fbe56dc9d191d6656a"><td class="memItemLeft" align="right" valign="top">static <a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="notif_8h.html#ae2bdef15fc7bc7fbe56dc9d191d6656a">notifGetNotificationSystemEvent</a> (<a class="el" href="structEvent.html">Event</a> *out_event)</td></tr>
|
|
<tr class="memdesc:ae2bdef15fc7bc7fbe56dc9d191d6656a"><td class="mdescLeft"> </td><td class="mdescRight">Gets an <a class="el" href="structEvent.html" title="Kernel-mode event structure.">Event</a> which is signaled when data is available with <a class="el" href="notif_8h.html#a1998a9b26016d6f19229efcaebdb7842">notifTryPopNotifiedApplicationParameter</a>. <br /></td></tr>
|
|
<tr class="separator:ae2bdef15fc7bc7fbe56dc9d191d6656a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a1998a9b26016d6f19229efcaebdb7842" id="r_a1998a9b26016d6f19229efcaebdb7842"><td class="memItemLeft" align="right" valign="top"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="notif_8h.html#a1998a9b26016d6f19229efcaebdb7842">notifTryPopNotifiedApplicationParameter</a> (void *buffer, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> size, <a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *out_size)</td></tr>
|
|
<tr class="memdesc:a1998a9b26016d6f19229efcaebdb7842"><td class="mdescLeft"> </td><td class="mdescRight">Uses <a class="el" href="applet_8h.html#a9164a322c61b5825eab3e02cff527263">appletTryPopFromNotificationStorageChannel</a> then reads the data from there into the output params. <br /></td></tr>
|
|
<tr class="separator:a1998a9b26016d6f19229efcaebdb7842"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
|
<div class="textblock"><p>Alarm notification (notif:*) service IPC wrapper. </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="a0fb80e6caae6b58d8e6b002f540fced4" name="a0fb80e6caae6b58d8e6b002f540fced4"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0fb80e6caae6b58d8e6b002f540fced4">◆ </a></span>NotifServiceType</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">enum <a class="el" href="notif_8h.html#a0fb80e6caae6b58d8e6b002f540fced4">NotifServiceType</a></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>ServiceType for <a class="el" href="notif_8h.html#a83039327cca2c9f106a6f27eb7411257">notifInitialize</a>. </p>
|
|
<table class="fieldtable">
|
|
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a0fb80e6caae6b58d8e6b002f540fced4acafc81b2acf05b5440a802de1d4b3c72" name="a0fb80e6caae6b58d8e6b002f540fced4acafc81b2acf05b5440a802de1d4b3c72"></a>NotifServiceType_Application </td><td class="fielddoc"><p>Initializes notif:a, for Application. </p>
|
|
</td></tr>
|
|
<tr><td class="fieldname"><a id="a0fb80e6caae6b58d8e6b002f540fced4aee3cc3d819ad02d6003fb70a706615b7" name="a0fb80e6caae6b58d8e6b002f540fced4aee3cc3d819ad02d6003fb70a706615b7"></a>NotifServiceType_System </td><td class="fielddoc"><p>Initializes notif:s, for System. </p>
|
|
</td></tr>
|
|
</table>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Function Documentation</h2>
|
|
<a id="aa223223eec5fa3374334a25ff11347e8" name="aa223223eec5fa3374334a25ff11347e8"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa223223eec5fa3374334a25ff11347e8">◆ </a></span>notifAlarmSettingCreate()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">void notifAlarmSettingCreate </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> * </td>
|
|
<td class="paramname"><em>alarm_setting</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Creates a <a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a>. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This clears the struct, with all schedule settings set the same as <a class="el" href="notif_8h.html#a9beb01fa9ac7197fcd6e2796040d2f25">notifAlarmSettingDisable</a>. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">alarm_setting</td><td><a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a9beb01fa9ac7197fcd6e2796040d2f25" name="a9beb01fa9ac7197fcd6e2796040d2f25"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9beb01fa9ac7197fcd6e2796040d2f25">◆ </a></span>notifAlarmSettingDisable()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> notifAlarmSettingDisable </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> * </td>
|
|
<td class="paramname"><em>alarm_setting</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>day_of_week</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Disables the schedule setting for the specified day_of_week, for the <a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a>. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Schedule settings are disabled by default (<a class="el" href="notif_8h.html#aa223223eec5fa3374334a25ff11347e8">notifAlarmSettingCreate</a>). </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">alarm_setting</td><td><a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">day_of_week</td><td>Day-of-week, must be 0-6 (Sun-Sat). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a03e599872e08375d408cd40017130766" name="a03e599872e08375d408cd40017130766"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a03e599872e08375d408cd40017130766">◆ </a></span>notifAlarmSettingEnable()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> notifAlarmSettingEnable </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> * </td>
|
|
<td class="paramname"><em>alarm_setting</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>day_of_week</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> </td>
|
|
<td class="paramname"><em>hour</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> </td>
|
|
<td class="paramname"><em>minute</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Enables the schedule setting for the specified day_of_week, for the <a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a>. </p>
|
|
<p>This uses local-time. </p><dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">alarm_setting</td><td><a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">day_of_week</td><td>Day-of-week, must be 0-6 (Sun-Sat). </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">hour</td><td>Hour. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">minute</td><td>Minute. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a4cd4b3929be58653c451a03486a0e79e" name="a4cd4b3929be58653c451a03486a0e79e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a4cd4b3929be58653c451a03486a0e79e">◆ </a></span>notifAlarmSettingGet()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> notifAlarmSettingGet </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> * </td>
|
|
<td class="paramname"><em>alarm_setting</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>day_of_week</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structNotifAlarmTime.html">NotifAlarmTime</a> * </td>
|
|
<td class="paramname"><em>out</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets the schedule setting for the specified day_of_week, for the <a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a>. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>Should not be used if the output from <a class="el" href="notif_8h.html#ae47d53874f41ac3ffd02786e22251d5f">notifAlarmSettingIsEnabled</a> is false. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">alarm_setting</td><td><a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">day_of_week</td><td>Day-of-week, must be 0-6 (Sun-Sat). </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td><a class="el" href="structNotifAlarmTime.html">NotifAlarmTime</a> </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae47d53874f41ac3ffd02786e22251d5f" name="ae47d53874f41ac3ffd02786e22251d5f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae47d53874f41ac3ffd02786e22251d5f">◆ </a></span>notifAlarmSettingIsEnabled()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> notifAlarmSettingIsEnabled </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> * </td>
|
|
<td class="paramname"><em>alarm_setting</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> </td>
|
|
<td class="paramname"><em>day_of_week</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool * </td>
|
|
<td class="paramname"><em>out</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets whether the schedule setting for the specified day_of_week is enabled, for the <a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">alarm_setting</td><td><a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">day_of_week</td><td>Day-of-week, must be 0-6 (Sun-Sat). </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">out</td><td>Whether the setting is enabled. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="add2b2d7db29e0f7355339d0a6c744e4f" name="add2b2d7db29e0f7355339d0a6c744e4f"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#add2b2d7db29e0f7355339d0a6c744e4f">◆ </a></span>notifAlarmSettingSetIsMuted()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void notifAlarmSettingSetIsMuted </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> * </td>
|
|
<td class="paramname"><em>alarm_setting</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">bool </td>
|
|
<td class="paramname"><em>flag</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets whether the <a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> is muted. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>By default (<a class="el" href="notif_8h.html#aa223223eec5fa3374334a25ff11347e8">notifAlarmSettingCreate</a>) this is false. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">alarm_setting</td><td><a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">flag</td><td>Whether the alarm is muted (true = Alarm turned off, false = on). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a386cd906026cb43cab4bdf65a8cf9585" name="a386cd906026cb43cab4bdf65a8cf9585"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a386cd906026cb43cab4bdf65a8cf9585">◆ </a></span>notifAlarmSettingSetUid()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static void notifAlarmSettingSetUid </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> * </td>
|
|
<td class="paramname"><em>alarm_setting</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="structAccountUid.html">AccountUid</a> </td>
|
|
<td class="paramname"><em>uid</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Sets the <a class="el" href="structAccountUid.html">AccountUid</a> for the <a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a>, see <a class="el" href="structNotifAlarmSetting.html#a882ba8661d7be481fb042f3cd08ac4d9" title="AccountUid. User account associated with this AlarmSetting. Used for the preselected_user (accountGet...">NotifAlarmSetting::uid</a>. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir"></td><td class="paramname">alarm_setting</td><td><a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">uid</td><td><a class="el" href="structAccountUid.html">AccountUid</a>. If want to clear the uid after it was previously set, you can use an all-zero uid to reset to the default (<a class="el" href="notif_8h.html#aa223223eec5fa3374334a25ff11347e8">notifAlarmSettingCreate</a>). </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a041a247ed4396592f17793edc81d6665" name="a041a247ed4396592f17793edc81d6665"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a041a247ed4396592f17793edc81d6665">◆ </a></span>notifDeleteAlarmSetting()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> notifDeleteAlarmSetting </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> </td>
|
|
<td class="paramname"><em>alarm_setting_id</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Deletes the specified AlarmSetting. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">alarm_setting_id</td><td>AlarmSettingId </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ae2bdef15fc7bc7fbe56dc9d191d6656a" name="ae2bdef15fc7bc7fbe56dc9d191d6656a"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae2bdef15fc7bc7fbe56dc9d191d6656a">◆ </a></span>notifGetNotificationSystemEvent()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">static <a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> notifGetNotificationSystemEvent </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structEvent.html">Event</a> * </td>
|
|
<td class="paramname"><em>out_event</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">static</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets an <a class="el" href="structEvent.html" title="Kernel-mode event structure.">Event</a> which is signaled when data is available with <a class="el" href="notif_8h.html#a1998a9b26016d6f19229efcaebdb7842">notifTryPopNotifiedApplicationParameter</a>. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This is a wrapper for <a class="el" href="applet_8h.html#a6ae666566bb7c0e2ffc75f8a1915f42b">appletGetNotificationStorageChannelEvent</a>, see that for the usage requirements. </dd>
|
|
<dd>
|
|
Some official apps don't use this. </dd>
|
|
<dd>
|
|
The <a class="el" href="structEvent.html" title="Kernel-mode event structure.">Event</a> must be closed by the user once finished with it. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">out_event</td><td>Output <a class="el" href="structEvent.html" title="Kernel-mode event structure.">Event</a> with autoclear=false. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ab905dca16958abdd33777e5c8f951950" name="ab905dca16958abdd33777e5c8f951950"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab905dca16958abdd33777e5c8f951950">◆ </a></span>notifListAlarmSettings()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> notifListAlarmSettings </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> * </td>
|
|
<td class="paramname"><em>alarm_settings</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> </td>
|
|
<td class="paramname"><em>count</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> * </td>
|
|
<td class="paramname"><em>total_out</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Gets a listing of AlarmSettings. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">alarm_settings</td><td>Output <a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> array. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>Total entries in the alarm_settings array. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">total_out</td><td>Total output entries. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="afe4d166c470f650589616d0f57c2c7b3" name="afe4d166c470f650589616d0f57c2c7b3"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afe4d166c470f650589616d0f57c2c7b3">◆ </a></span>notifLoadApplicationParameter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> notifLoadApplicationParameter </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> </td>
|
|
<td class="paramname"><em>alarm_setting_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>size</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> * </td>
|
|
<td class="paramname"><em>actual_size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Loads the ApplicationParameter for the specified AlarmSetting. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">alarm_setting_id</td><td>AlarmSettingId </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">buffer</td><td>Output buffer containing the ApplicationParameter. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Output buffer size. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">actual_size</td><td>Actual output size. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ad1d6dd09a878ced28ec8fcef324ac18e" name="ad1d6dd09a878ced28ec8fcef324ac18e"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ad1d6dd09a878ced28ec8fcef324ac18e">◆ </a></span>notifRegisterAlarmSetting()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> notifRegisterAlarmSetting </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> * </td>
|
|
<td class="paramname"><em>alarm_setting_id</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const <a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> * </td>
|
|
<td class="paramname"><em>alarm_setting</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const void * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Registers the specified AlarmSetting. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>See <a class="el" href="notif_8h.html#ac25066a08555f7025db1f3352d78053a">NOTIF_MAX_ALARMS</a> for the maximum alarms. </dd>
|
|
<dd>
|
|
When indicated by the output from <a class="el" href="hid_8h.html#a2d8bb53bf1e7cd47fe54c2a6372c3fa0">hidIsFirmwareUpdateNeededForNotification</a>, this will use <a class="el" href="hid__la_8h.html#ac05630a62f231d0f12203254f1bb5abf">hidLaShowControllerFirmwareUpdate</a>. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">alarm_setting_id</td><td>AlarmSettingId </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">alarm_setting</td><td><a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Input buffer containing the ApplicationParameter. Optional, can be NULL. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Input buffer size, must be <=0x400. Optional, can be 0. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="a1998a9b26016d6f19229efcaebdb7842" name="a1998a9b26016d6f19229efcaebdb7842"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a1998a9b26016d6f19229efcaebdb7842">◆ </a></span>notifTryPopNotifiedApplicationParameter()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> notifTryPopNotifiedApplicationParameter </td>
|
|
<td>(</td>
|
|
<td class="paramtype">void * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> </td>
|
|
<td class="paramname"><em>size</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a class="el" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> * </td>
|
|
<td class="paramname"><em>out_size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Uses <a class="el" href="applet_8h.html#a9164a322c61b5825eab3e02cff527263">appletTryPopFromNotificationStorageChannel</a> then reads the data from there into the output params. </p>
|
|
<dl class="section note"><dt>Note</dt><dd>This is a wrapper for <a class="el" href="applet_8h.html#a9164a322c61b5825eab3e02cff527263">appletTryPopFromNotificationStorageChannel</a>, see that for the usage requirements. </dd>
|
|
<dd>
|
|
The system will only push data for this when launching the Application when the Alarm was triggered, where the system was previously in sleep-mode. </dd>
|
|
<dd>
|
|
Some official apps don't use this. </dd></dl>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">buffer</td><td>Output buffer. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">size</td><td>Output buffer size. </td></tr>
|
|
<tr><td class="paramdir">[out]</td><td class="paramname">out_size</td><td>Size of the data which was written into the output buffer. Optional, can be NULL. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
<a id="ada60a84deff99a352f8825c727813819" name="ada60a84deff99a352f8825c727813819"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ada60a84deff99a352f8825c727813819">◆ </a></span>notifUpdateAlarmSetting()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> notifUpdateAlarmSetting </td>
|
|
<td>(</td>
|
|
<td class="paramtype">const <a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> * </td>
|
|
<td class="paramname"><em>alarm_setting</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">const void * </td>
|
|
<td class="paramname"><em>buffer</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey"></td>
|
|
<td></td>
|
|
<td class="paramtype">size_t </td>
|
|
<td class="paramname"><em>size</em> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Updates the specified AlarmSetting. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">alarm_setting</td><td><a class="el" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">buffer</td><td>Input buffer containing the ApplicationParameter. Optional, can be NULL. </td></tr>
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>Input buffer size, must be <=0x400. Optional, can be 0. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
|
|
</div>
|
|
</div>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <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>
|