mirror of
https://github.com/switchbrew/libnx.git
synced 2025-06-21 20:42:44 +02:00
328 lines
59 KiB
HTML
328 lines
59 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 Source File</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>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_codefold(0); });
|
|
/* @license-end */
|
|
</script>
|
|
<!-- 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="headertitle"><div class="title">notif.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="notif_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> * @file notif.h</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"> * @brief Alarm notification (notif:*) service IPC wrapper.</span></div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> * @author yellows8</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> * @copyright libnx Authors</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#pragma once</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#include "../types.h"</span></div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#include "../kernel/event.h"</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="preprocessor">#include "../services/applet.h"</span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include "../services/acc.h"</span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include "../sf/service.h"</span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment">/// ServiceType for \ref notifInitialize.</span></div>
|
|
<div class="foldopen" id="foldopen00015" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"><a class="line" href="notif_8h.html#a0fb80e6caae6b58d8e6b002f540fced4"> 15</a></span><span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="notif_8h.html#a0fb80e6caae6b58d8e6b002f540fced4acafc81b2acf05b5440a802de1d4b3c72"> 16</a></span> <a class="code hl_enumvalue" href="notif_8h.html#a0fb80e6caae6b58d8e6b002f540fced4acafc81b2acf05b5440a802de1d4b3c72">NotifServiceType_Application</a> = 0, <span class="comment">///< Initializes notif:a, for Application.</span></div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="notif_8h.html#a0fb80e6caae6b58d8e6b002f540fced4aee3cc3d819ad02d6003fb70a706615b7"> 17</a></span> <a class="code hl_enumvalue" href="notif_8h.html#a0fb80e6caae6b58d8e6b002f540fced4aee3cc3d819ad02d6003fb70a706615b7">NotifServiceType_System</a> = 1, <span class="comment">///< Initializes notif:s, for System.</span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span>} <a class="code hl_enumeration" href="notif_8h.html#a0fb80e6caae6b58d8e6b002f540fced4">NotifServiceType</a>;</div>
|
|
</div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span><span class="comment">/// Data extracted from NotifWeeklyScheduleAlarmSetting::settings. This uses local-time.</span></div>
|
|
<div class="foldopen" id="foldopen00021" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="structNotifAlarmTime.html"> 21</a></span><span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"><a class="line" href="structNotifAlarmTime.html#ae0e8f5479c71d2a49fe6108f212896bb"> 22</a></span> <a class="code hl_typedef" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> <a class="code hl_variable" href="structNotifAlarmTime.html#ae0e8f5479c71d2a49fe6108f212896bb">hour</a>; <span class="comment">///< Hour.</span></div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="structNotifAlarmTime.html#ad4d212e51dea8828446a6ebe2a7ccf7a"> 23</a></span> <a class="code hl_typedef" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> <a class="code hl_variable" href="structNotifAlarmTime.html#ad4d212e51dea8828446a6ebe2a7ccf7a">minute</a>; <span class="comment">///< Minute.</span></div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span>} <a class="code hl_struct" href="structNotifAlarmTime.html">NotifAlarmTime</a>;</div>
|
|
</div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="comment">/// WeeklyScheduleAlarmSetting</span></div>
|
|
<div class="foldopen" id="foldopen00027" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"><a class="line" href="structNotifWeeklyScheduleAlarmSetting.html"> 27</a></span><span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="structNotifWeeklyScheduleAlarmSetting.html#a56dcbc5be25cded7ee1669a6d8297277"> 28</a></span> <a class="code hl_typedef" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> unk_x0[0xa]; <span class="comment">///< Unknown.</span></div>
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="structNotifWeeklyScheduleAlarmSetting.html#a6ea3c3794fcbc0e90661240121a26387"> 29</a></span> <a class="code hl_typedef" href="types_8h.html#aa980e2c02ba2305e0f489d5650655425">s16</a> settings[7]; <span class="comment">///< Schedule settings for each day of the week, Sun-Sat. High byte is the hour, low byte is the minute. This uses local-time.</span></div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span>} <a class="code hl_struct" href="structNotifWeeklyScheduleAlarmSetting.html">NotifWeeklyScheduleAlarmSetting</a>;</div>
|
|
</div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span><span class="comment">/// AlarmSetting</span></div>
|
|
<div class="foldopen" id="foldopen00033" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"><a class="line" href="structNotifAlarmSetting.html"> 33</a></span><span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
|
|
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"><a class="line" href="structNotifAlarmSetting.html#a1f3369f70a04fcd6d08200334f80dd75"> 34</a></span> <a class="code hl_typedef" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> <a class="code hl_variable" href="structNotifAlarmSetting.html#a1f3369f70a04fcd6d08200334f80dd75">alarm_setting_id</a>; <span class="comment">///< AlarmSettingId</span></div>
|
|
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="structNotifAlarmSetting.html#afb3f41172e4eab9f25cdfad852ec0417"> 35</a></span> <a class="code hl_typedef" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> <a class="code hl_variable" href="structNotifAlarmSetting.html#afb3f41172e4eab9f25cdfad852ec0417">kind</a>; <span class="comment">///< Kind: 0 = WeeklySchedule.</span></div>
|
|
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"><a class="line" href="structNotifAlarmSetting.html#ae5ddebfae7a96f9e67903ebe199ea71e"> 36</a></span> <a class="code hl_typedef" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> <a class="code hl_variable" href="structNotifAlarmSetting.html#ae5ddebfae7a96f9e67903ebe199ea71e">muted</a>; <span class="comment">///< u8 bool flag for whether this AlarmSetting is muted (non-zero = AlarmSetting turned off, zero = on).</span></div>
|
|
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"><a class="line" href="structNotifAlarmSetting.html#ab07308fdb5519b980e2a0bc4942180ff"> 37</a></span> <a class="code hl_typedef" href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a> pad[4]; <span class="comment">///< Padding.</span></div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="structNotifAlarmSetting.html#a882ba8661d7be481fb042f3cd08ac4d9"> 38</a></span> <a class="code hl_struct" href="structAccountUid.html">AccountUid</a> <a class="code hl_variable" href="structNotifAlarmSetting.html#a882ba8661d7be481fb042f3cd08ac4d9">uid</a>; <span class="comment">///< \ref AccountUid. User account associated with this AlarmSetting. Used for the preselected_user (\ref accountGetPreselectedUser) when launching the Application when the system was previously in sleep-mode, instead of launching the applet for selecting the user.</span></div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"><a class="line" href="structNotifAlarmSetting.html#ac7a30170ed0d90f260ae1619d4fbb1e7"> 39</a></span> <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> <a class="code hl_variable" href="structNotifAlarmSetting.html#ac7a30170ed0d90f260ae1619d4fbb1e7">application_id</a>; <span class="comment">///< ApplicationId</span></div>
|
|
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="structNotifAlarmSetting.html#ac2d32b961d5e80ce3f7a5cc938608023"> 40</a></span> <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> <a class="code hl_variable" href="structNotifAlarmSetting.html#ac2d32b961d5e80ce3f7a5cc938608023">unk_x20</a>; <span class="comment">///< Unknown.</span></div>
|
|
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="structNotifAlarmSetting.html#a694b0c4123fa5c71f2fc7669bb3488d8"> 41</a></span> <a class="code hl_struct" href="structNotifWeeklyScheduleAlarmSetting.html">NotifWeeklyScheduleAlarmSetting</a> <a class="code hl_variable" href="structNotifAlarmSetting.html#a694b0c4123fa5c71f2fc7669bb3488d8">schedule</a>; <span class="comment">///< \ref NotifWeeklyScheduleAlarmSetting</span></div>
|
|
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span>} <a class="code hl_struct" href="structNotifAlarmSetting.html">NotifAlarmSetting</a>;</div>
|
|
</div>
|
|
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span><span class="comment">/// Maximum alarms that can be registered at the same time by the host Application.</span></div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="notif_8h.html#ac25066a08555f7025db1f3352d78053a"> 45</a></span><span class="comment"></span><span class="preprocessor">#define NOTIF_MAX_ALARMS 8</span></div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span><span class="comment">/// Initialize notif. Only available on [9.0.0+].</span></div>
|
|
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="notif_8h.html#a83039327cca2c9f106a6f27eb7411257"> 48</a></span><span class="comment"></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="notif_8h.html#a83039327cca2c9f106a6f27eb7411257">notifInitialize</a>(<a class="code hl_enumeration" href="notif_8h.html#a0fb80e6caae6b58d8e6b002f540fced4">NotifServiceType</a> service_type);</div>
|
|
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span><span class="comment">/// Exit notif.</span></div>
|
|
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"><a class="line" href="notif_8h.html#a716ce6f4b9077a43807bc3f202b5c324"> 51</a></span><span class="comment"></span><span class="keywordtype">void</span> <a class="code hl_function" href="notif_8h.html#a716ce6f4b9077a43807bc3f202b5c324">notifExit</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment">/// Gets the Service object for the actual notif:* service session.</span></div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="notif_8h.html#a7dd5dee444aeb44f68980ddff0591ff2"> 54</a></span><span class="comment"></span><a class="code hl_struct" href="structService.html">Service</a>* <a class="code hl_function" href="notif_8h.html#a7dd5dee444aeb44f68980ddff0591ff2">notifGetServiceSession</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"> 57</span><span class="comment"> * @brief Creates a \ref NotifAlarmSetting.</span></div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span><span class="comment"> * @note This clears the struct, with all schedule settings set the same as \ref notifAlarmSettingDisable.</span></div>
|
|
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno"> 59</span><span class="comment"> * @param[out] alarm_setting \ref NotifAlarmSetting</span></div>
|
|
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"> 60</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno"><a class="line" href="notif_8h.html#aa223223eec5fa3374334a25ff11347e8"> 61</a></span><span class="keywordtype">void</span> <a class="code hl_function" href="notif_8h.html#aa223223eec5fa3374334a25ff11347e8">notifAlarmSettingCreate</a>(<a class="code hl_struct" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> *alarm_setting);</div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"> 62</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"> 64</span><span class="comment"> * @brief Sets whether the \ref NotifAlarmSetting is muted.</span></div>
|
|
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"> 65</span><span class="comment"> * @note By default (\ref notifAlarmSettingCreate) this is false.</span></div>
|
|
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"> 66</span><span class="comment"> * @param alarm_setting \ref NotifAlarmSetting</span></div>
|
|
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"> 67</span><span class="comment"> * @param[in] flag Whether the alarm is muted (true = Alarm turned off, false = on).</span></div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"> 68</span><span class="comment"> */</span></div>
|
|
<div class="foldopen" id="foldopen00069" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"><a class="line" href="notif_8h.html#add2b2d7db29e0f7355339d0a6c744e4f"> 69</a></span><a class="code hl_define" href="types_8h.html#a0a13a49371a760adfdde1b4d7c965abb">NX_INLINE</a> <span class="keywordtype">void</span> <a class="code hl_function" href="notif_8h.html#add2b2d7db29e0f7355339d0a6c744e4f">notifAlarmSettingSetIsMuted</a>(<a class="code hl_struct" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> *alarm_setting, <span class="keywordtype">bool</span> flag) {</div>
|
|
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"> 70</span> alarm_setting-><a class="code hl_variable" href="structNotifAlarmSetting.html#ae5ddebfae7a96f9e67903ebe199ea71e">muted</a> = flag!=0;</div>
|
|
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno"> 71</span>}</div>
|
|
</div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"> 72</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"> 74</span><span class="comment"> * @brief Sets the \ref AccountUid for the \ref NotifAlarmSetting, see NotifAlarmSetting::uid.</span></div>
|
|
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno"> 75</span><span class="comment"> * @param alarm_setting \ref NotifAlarmSetting</span></div>
|
|
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"> 76</span><span class="comment"> * @param[in] uid \ref AccountUid. If want to clear the uid after it was previously set, you can use an all-zero uid to reset to the default (\ref notifAlarmSettingCreate).</span></div>
|
|
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"> 77</span><span class="comment"> */</span></div>
|
|
<div class="foldopen" id="foldopen00078" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="notif_8h.html#a386cd906026cb43cab4bdf65a8cf9585"> 78</a></span><a class="code hl_define" href="types_8h.html#a0a13a49371a760adfdde1b4d7c965abb">NX_INLINE</a> <span class="keywordtype">void</span> <a class="code hl_function" href="notif_8h.html#a386cd906026cb43cab4bdf65a8cf9585">notifAlarmSettingSetUid</a>(<a class="code hl_struct" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> *alarm_setting, <a class="code hl_struct" href="structAccountUid.html">AccountUid</a> uid) {</div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> alarm_setting-><a class="code hl_variable" href="structNotifAlarmSetting.html#a882ba8661d7be481fb042f3cd08ac4d9">uid</a> = uid;</div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span>}</div>
|
|
</div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="comment"> * @brief Gets whether the schedule setting for the specified day_of_week is enabled, for the \ref NotifAlarmSetting.</span></div>
|
|
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><span class="comment"> * @param alarm_setting \ref NotifAlarmSetting</span></div>
|
|
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="comment"> * @param[in] day_of_week Day-of-week, must be 0-6 (Sun-Sat).</span></div>
|
|
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><span class="comment"> * @param[out] out Whether the setting is enabled.</span></div>
|
|
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"><a class="line" href="notif_8h.html#ae47d53874f41ac3ffd02786e22251d5f"> 88</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="notif_8h.html#ae47d53874f41ac3ffd02786e22251d5f">notifAlarmSettingIsEnabled</a>(<a class="code hl_struct" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> *alarm_setting, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> day_of_week, <span class="keywordtype">bool</span> *out);</div>
|
|
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span><span class="comment"> * @brief Gets the schedule setting for the specified day_of_week, for the \ref NotifAlarmSetting.</span></div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span><span class="comment"> * @note Should not be used if the output from \ref notifAlarmSettingIsEnabled is false.</span></div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="comment"> * @param alarm_setting \ref NotifAlarmSetting</span></div>
|
|
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno"> 94</span><span class="comment"> * @param[in] day_of_week Day-of-week, must be 0-6 (Sun-Sat).</span></div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"> 95</span><span class="comment"> * @param[out] out \ref NotifAlarmTime</span></div>
|
|
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno"><a class="line" href="notif_8h.html#a4cd4b3929be58653c451a03486a0e79e"> 97</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="notif_8h.html#a4cd4b3929be58653c451a03486a0e79e">notifAlarmSettingGet</a>(<a class="code hl_struct" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> *alarm_setting, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> day_of_week, <a class="code hl_struct" href="structNotifAlarmTime.html">NotifAlarmTime</a> *out);</div>
|
|
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno"> 98</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"> 99</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno"> 100</span><span class="comment"> * @brief Enables the schedule setting for the specified day_of_week, for the \ref NotifAlarmSetting. This uses local-time.</span></div>
|
|
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno"> 101</span><span class="comment"> * @param alarm_setting \ref NotifAlarmSetting</span></div>
|
|
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno"> 102</span><span class="comment"> * @param[in] day_of_week Day-of-week, must be 0-6 (Sun-Sat).</span></div>
|
|
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"> 103</span><span class="comment"> * @param[in] hour Hour.</span></div>
|
|
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno"> 104</span><span class="comment"> * @param[in] minute Minute.</span></div>
|
|
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno"> 105</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"><a class="line" href="notif_8h.html#a03e599872e08375d408cd40017130766"> 106</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="notif_8h.html#a03e599872e08375d408cd40017130766">notifAlarmSettingEnable</a>(<a class="code hl_struct" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> *alarm_setting, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> day_of_week, <a class="code hl_typedef" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> hour, <a class="code hl_typedef" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> minute);</div>
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span><span class="comment"> * @brief Disables the schedule setting for the specified day_of_week, for the \ref NotifAlarmSetting.</span></div>
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span><span class="comment"> * @note Schedule settings are disabled by default (\ref notifAlarmSettingCreate).</span></div>
|
|
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"> 111</span><span class="comment"> * @param alarm_setting \ref NotifAlarmSetting</span></div>
|
|
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno"> 112</span><span class="comment"> * @param[in] day_of_week Day-of-week, must be 0-6 (Sun-Sat).</span></div>
|
|
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno"> 113</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"><a class="line" href="notif_8h.html#a9beb01fa9ac7197fcd6e2796040d2f25"> 114</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="notif_8h.html#a9beb01fa9ac7197fcd6e2796040d2f25">notifAlarmSettingDisable</a>(<a class="code hl_struct" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> *alarm_setting, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> day_of_week);</div>
|
|
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno"> 115</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno"> 116</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"> 117</span><span class="comment"> * @brief Registers the specified AlarmSetting.</span></div>
|
|
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"> 118</span><span class="comment"> * @note See \ref NOTIF_MAX_ALARMS for the maximum alarms.</span></div>
|
|
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span><span class="comment"> * @note When indicated by the output from \ref hidIsFirmwareUpdateNeededForNotification, this will use \ref hidLaShowControllerFirmwareUpdate.</span></div>
|
|
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"> 120</span><span class="comment"> * @param[out] alarm_setting_id AlarmSettingId</span></div>
|
|
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"> 121</span><span class="comment"> * @param[in] alarm_setting \ref NotifAlarmSetting</span></div>
|
|
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"> 122</span><span class="comment"> * @param[in] buffer Input buffer containing the ApplicationParameter. Optional, can be NULL.</span></div>
|
|
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"> 123</span><span class="comment"> * @param[in] size Input buffer size, must be <=0x400. Optional, can be 0.</span></div>
|
|
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"> 124</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"><a class="line" href="notif_8h.html#ad1d6dd09a878ced28ec8fcef324ac18e"> 125</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="notif_8h.html#ad1d6dd09a878ced28ec8fcef324ac18e">notifRegisterAlarmSetting</a>(<a class="code hl_typedef" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> *alarm_setting_id, <span class="keyword">const</span> <a class="code hl_struct" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> *alarm_setting, <span class="keyword">const</span> <span class="keywordtype">void</span>* buffer, <span class="keywordtype">size_t</span> size);</div>
|
|
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span><span class="comment"> * @brief Updates the specified AlarmSetting.</span></div>
|
|
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span><span class="comment"> * @param[in] alarm_setting \ref NotifAlarmSetting</span></div>
|
|
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span><span class="comment"> * @param[in] buffer Input buffer containing the ApplicationParameter. Optional, can be NULL.</span></div>
|
|
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span><span class="comment"> * @param[in] size Input buffer size, must be <=0x400. Optional, can be 0.</span></div>
|
|
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"><a class="line" href="notif_8h.html#ada60a84deff99a352f8825c727813819"> 133</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="notif_8h.html#ada60a84deff99a352f8825c727813819">notifUpdateAlarmSetting</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> *alarm_setting, <span class="keyword">const</span> <span class="keywordtype">void</span>* buffer, <span class="keywordtype">size_t</span> size);</div>
|
|
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno"> 134</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"> 135</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"> 136</span><span class="comment"> * @brief Gets a listing of AlarmSettings.</span></div>
|
|
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno"> 137</span><span class="comment"> * @param[out] alarm_settings Output \ref NotifAlarmSetting array.</span></div>
|
|
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno"> 138</span><span class="comment"> * @param[in] count Total entries in the alarm_settings array.</span></div>
|
|
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"> 139</span><span class="comment"> * @param[out] total_out Total output entries.</span></div>
|
|
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno"> 140</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno"><a class="line" href="notif_8h.html#ab905dca16958abdd33777e5c8f951950"> 141</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="notif_8h.html#ab905dca16958abdd33777e5c8f951950">notifListAlarmSettings</a>(<a class="code hl_struct" href="structNotifAlarmSetting.html">NotifAlarmSetting</a> *alarm_settings, <a class="code hl_typedef" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> count, <a class="code hl_typedef" href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a> *total_out);</div>
|
|
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"> 142</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno"> 143</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno"> 144</span><span class="comment"> * @brief Loads the ApplicationParameter for the specified AlarmSetting.</span></div>
|
|
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"> 145</span><span class="comment"> * @param[in] alarm_setting_id AlarmSettingId</span></div>
|
|
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"> 146</span><span class="comment"> * @param[out] buffer Output buffer containing the ApplicationParameter.</span></div>
|
|
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"> 147</span><span class="comment"> * @param[in] size Output buffer size.</span></div>
|
|
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"> 148</span><span class="comment"> * @param[out] actual_size Actual output size.</span></div>
|
|
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno"> 149</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno"><a class="line" href="notif_8h.html#afe4d166c470f650589616d0f57c2c7b3"> 150</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="notif_8h.html#afe4d166c470f650589616d0f57c2c7b3">notifLoadApplicationParameter</a>(<a class="code hl_typedef" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> alarm_setting_id, <span class="keywordtype">void</span>* buffer, <span class="keywordtype">size_t</span> size, <a class="code hl_typedef" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> *actual_size);</div>
|
|
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno"> 151</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno"> 152</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno"> 153</span><span class="comment"> * @brief Deletes the specified AlarmSetting.</span></div>
|
|
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno"> 154</span><span class="comment"> * @param[in] alarm_setting_id AlarmSettingId</span></div>
|
|
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno"> 155</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno"><a class="line" href="notif_8h.html#a041a247ed4396592f17793edc81d6665"> 156</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="notif_8h.html#a041a247ed4396592f17793edc81d6665">notifDeleteAlarmSetting</a>(<a class="code hl_typedef" href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a> alarm_setting_id);</div>
|
|
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno"> 157</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno"> 158</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno"> 159</span><span class="comment"> * @brief Gets an Event which is signaled when data is available with \ref notifTryPopNotifiedApplicationParameter.</span></div>
|
|
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno"> 160</span><span class="comment"> * @note This is a wrapper for \ref appletGetNotificationStorageChannelEvent, see that for the usage requirements.</span></div>
|
|
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno"> 161</span><span class="comment"> * @note Some official apps don't use this.</span></div>
|
|
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno"> 162</span><span class="comment"> * @note The Event must be closed by the user once finished with it.</span></div>
|
|
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno"> 163</span><span class="comment"> * @param[out] out_event Output Event with autoclear=false.</span></div>
|
|
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno"> 164</span><span class="comment"> */</span></div>
|
|
<div class="foldopen" id="foldopen00165" data-start="{" data-end="}">
|
|
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno"><a class="line" href="notif_8h.html#ae2bdef15fc7bc7fbe56dc9d191d6656a"> 165</a></span><a class="code hl_define" href="types_8h.html#a0a13a49371a760adfdde1b4d7c965abb">NX_INLINE</a> <a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="notif_8h.html#ae2bdef15fc7bc7fbe56dc9d191d6656a">notifGetNotificationSystemEvent</a>(<a class="code hl_struct" href="structEvent.html">Event</a> *out_event) {</div>
|
|
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno"> 166</span> <span class="keywordflow">return</span> <a class="code hl_function" href="applet_8h.html#a6ae666566bb7c0e2ffc75f8a1915f42b">appletGetNotificationStorageChannelEvent</a>(out_event);</div>
|
|
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno"> 167</span>}</div>
|
|
</div>
|
|
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno"> 168</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno"> 169</span><span class="comment">/**</span></div>
|
|
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno"> 170</span><span class="comment"> * @brief Uses \ref appletTryPopFromNotificationStorageChannel then reads the data from there into the output params.</span></div>
|
|
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno"> 171</span><span class="comment"> * @note This is a wrapper for \ref appletTryPopFromNotificationStorageChannel, see that for the usage requirements.</span></div>
|
|
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno"> 172</span><span class="comment"> * @note 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.</span></div>
|
|
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno"> 173</span><span class="comment"> * @note Some official apps don't use this.</span></div>
|
|
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno"> 174</span><span class="comment"> * @param[out] buffer Output buffer.</span></div>
|
|
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno"> 175</span><span class="comment"> * @param[out] size Output buffer size.</span></div>
|
|
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno"> 176</span><span class="comment"> * @param[out] out_size Size of the data which was written into the output buffer. Optional, can be NULL.</span></div>
|
|
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno"> 177</span><span class="comment"> */</span></div>
|
|
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno"><a class="line" href="notif_8h.html#a1998a9b26016d6f19229efcaebdb7842"> 178</a></span><a class="code hl_typedef" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code hl_function" href="notif_8h.html#a1998a9b26016d6f19229efcaebdb7842">notifTryPopNotifiedApplicationParameter</a>(<span class="keywordtype">void</span>* buffer, <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> size, <a class="code hl_typedef" href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a> *out_size);</div>
|
|
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno"> 179</span> </div>
|
|
<div class="ttc" id="aapplet_8h_html_a6ae666566bb7c0e2ffc75f8a1915f42b"><div class="ttname"><a href="applet_8h.html#a6ae666566bb7c0e2ffc75f8a1915f42b">appletGetNotificationStorageChannelEvent</a></div><div class="ttdeci">Result appletGetNotificationStorageChannelEvent(Event *out_event)</div><div class="ttdoc">Gets an Event which is signaled when a new storage is available with appletTryPopFromNotificationStor...</div></div>
|
|
<div class="ttc" id="anotif_8h_html_a03e599872e08375d408cd40017130766"><div class="ttname"><a href="notif_8h.html#a03e599872e08375d408cd40017130766">notifAlarmSettingEnable</a></div><div class="ttdeci">Result notifAlarmSettingEnable(NotifAlarmSetting *alarm_setting, u32 day_of_week, s32 hour, s32 minute)</div><div class="ttdoc">Enables the schedule setting for the specified day_of_week, for the NotifAlarmSetting.</div></div>
|
|
<div class="ttc" id="anotif_8h_html_a041a247ed4396592f17793edc81d6665"><div class="ttname"><a href="notif_8h.html#a041a247ed4396592f17793edc81d6665">notifDeleteAlarmSetting</a></div><div class="ttdeci">Result notifDeleteAlarmSetting(u16 alarm_setting_id)</div><div class="ttdoc">Deletes the specified AlarmSetting.</div></div>
|
|
<div class="ttc" id="anotif_8h_html_a0fb80e6caae6b58d8e6b002f540fced4"><div class="ttname"><a href="notif_8h.html#a0fb80e6caae6b58d8e6b002f540fced4">NotifServiceType</a></div><div class="ttdeci">NotifServiceType</div><div class="ttdoc">ServiceType for notifInitialize.</div><div class="ttdef"><b>Definition</b> notif.h:15</div></div>
|
|
<div class="ttc" id="anotif_8h_html_a0fb80e6caae6b58d8e6b002f540fced4acafc81b2acf05b5440a802de1d4b3c72"><div class="ttname"><a href="notif_8h.html#a0fb80e6caae6b58d8e6b002f540fced4acafc81b2acf05b5440a802de1d4b3c72">NotifServiceType_Application</a></div><div class="ttdeci">@ NotifServiceType_Application</div><div class="ttdoc">Initializes notif:a, for Application.</div><div class="ttdef"><b>Definition</b> notif.h:16</div></div>
|
|
<div class="ttc" id="anotif_8h_html_a0fb80e6caae6b58d8e6b002f540fced4aee3cc3d819ad02d6003fb70a706615b7"><div class="ttname"><a href="notif_8h.html#a0fb80e6caae6b58d8e6b002f540fced4aee3cc3d819ad02d6003fb70a706615b7">NotifServiceType_System</a></div><div class="ttdeci">@ NotifServiceType_System</div><div class="ttdoc">Initializes notif:s, for System.</div><div class="ttdef"><b>Definition</b> notif.h:17</div></div>
|
|
<div class="ttc" id="anotif_8h_html_a1998a9b26016d6f19229efcaebdb7842"><div class="ttname"><a href="notif_8h.html#a1998a9b26016d6f19229efcaebdb7842">notifTryPopNotifiedApplicationParameter</a></div><div class="ttdeci">Result notifTryPopNotifiedApplicationParameter(void *buffer, u64 size, u64 *out_size)</div><div class="ttdoc">Uses appletTryPopFromNotificationStorageChannel then reads the data from there into the output params...</div></div>
|
|
<div class="ttc" id="anotif_8h_html_a386cd906026cb43cab4bdf65a8cf9585"><div class="ttname"><a href="notif_8h.html#a386cd906026cb43cab4bdf65a8cf9585">notifAlarmSettingSetUid</a></div><div class="ttdeci">static void notifAlarmSettingSetUid(NotifAlarmSetting *alarm_setting, AccountUid uid)</div><div class="ttdoc">Sets the AccountUid for the NotifAlarmSetting, see NotifAlarmSetting::uid.</div><div class="ttdef"><b>Definition</b> notif.h:78</div></div>
|
|
<div class="ttc" id="anotif_8h_html_a4cd4b3929be58653c451a03486a0e79e"><div class="ttname"><a href="notif_8h.html#a4cd4b3929be58653c451a03486a0e79e">notifAlarmSettingGet</a></div><div class="ttdeci">Result notifAlarmSettingGet(NotifAlarmSetting *alarm_setting, u32 day_of_week, NotifAlarmTime *out)</div><div class="ttdoc">Gets the schedule setting for the specified day_of_week, for the NotifAlarmSetting.</div></div>
|
|
<div class="ttc" id="anotif_8h_html_a716ce6f4b9077a43807bc3f202b5c324"><div class="ttname"><a href="notif_8h.html#a716ce6f4b9077a43807bc3f202b5c324">notifExit</a></div><div class="ttdeci">void notifExit(void)</div><div class="ttdoc">Exit notif.</div></div>
|
|
<div class="ttc" id="anotif_8h_html_a7dd5dee444aeb44f68980ddff0591ff2"><div class="ttname"><a href="notif_8h.html#a7dd5dee444aeb44f68980ddff0591ff2">notifGetServiceSession</a></div><div class="ttdeci">Service * notifGetServiceSession(void)</div><div class="ttdoc">Gets the Service object for the actual notif:* service session.</div></div>
|
|
<div class="ttc" id="anotif_8h_html_a83039327cca2c9f106a6f27eb7411257"><div class="ttname"><a href="notif_8h.html#a83039327cca2c9f106a6f27eb7411257">notifInitialize</a></div><div class="ttdeci">Result notifInitialize(NotifServiceType service_type)</div><div class="ttdoc">Initialize notif. Only available on [9.0.0+].</div></div>
|
|
<div class="ttc" id="anotif_8h_html_a9beb01fa9ac7197fcd6e2796040d2f25"><div class="ttname"><a href="notif_8h.html#a9beb01fa9ac7197fcd6e2796040d2f25">notifAlarmSettingDisable</a></div><div class="ttdeci">Result notifAlarmSettingDisable(NotifAlarmSetting *alarm_setting, u32 day_of_week)</div><div class="ttdoc">Disables the schedule setting for the specified day_of_week, for the NotifAlarmSetting.</div></div>
|
|
<div class="ttc" id="anotif_8h_html_aa223223eec5fa3374334a25ff11347e8"><div class="ttname"><a href="notif_8h.html#aa223223eec5fa3374334a25ff11347e8">notifAlarmSettingCreate</a></div><div class="ttdeci">void notifAlarmSettingCreate(NotifAlarmSetting *alarm_setting)</div><div class="ttdoc">Creates a NotifAlarmSetting.</div></div>
|
|
<div class="ttc" id="anotif_8h_html_ab905dca16958abdd33777e5c8f951950"><div class="ttname"><a href="notif_8h.html#ab905dca16958abdd33777e5c8f951950">notifListAlarmSettings</a></div><div class="ttdeci">Result notifListAlarmSettings(NotifAlarmSetting *alarm_settings, s32 count, s32 *total_out)</div><div class="ttdoc">Gets a listing of AlarmSettings.</div></div>
|
|
<div class="ttc" id="anotif_8h_html_ad1d6dd09a878ced28ec8fcef324ac18e"><div class="ttname"><a href="notif_8h.html#ad1d6dd09a878ced28ec8fcef324ac18e">notifRegisterAlarmSetting</a></div><div class="ttdeci">Result notifRegisterAlarmSetting(u16 *alarm_setting_id, const NotifAlarmSetting *alarm_setting, const void *buffer, size_t size)</div><div class="ttdoc">Registers the specified AlarmSetting.</div></div>
|
|
<div class="ttc" id="anotif_8h_html_ada60a84deff99a352f8825c727813819"><div class="ttname"><a href="notif_8h.html#ada60a84deff99a352f8825c727813819">notifUpdateAlarmSetting</a></div><div class="ttdeci">Result notifUpdateAlarmSetting(const NotifAlarmSetting *alarm_setting, const void *buffer, size_t size)</div><div class="ttdoc">Updates the specified AlarmSetting.</div></div>
|
|
<div class="ttc" id="anotif_8h_html_add2b2d7db29e0f7355339d0a6c744e4f"><div class="ttname"><a href="notif_8h.html#add2b2d7db29e0f7355339d0a6c744e4f">notifAlarmSettingSetIsMuted</a></div><div class="ttdeci">static void notifAlarmSettingSetIsMuted(NotifAlarmSetting *alarm_setting, bool flag)</div><div class="ttdoc">Sets whether the NotifAlarmSetting is muted.</div><div class="ttdef"><b>Definition</b> notif.h:69</div></div>
|
|
<div class="ttc" id="anotif_8h_html_ae2bdef15fc7bc7fbe56dc9d191d6656a"><div class="ttname"><a href="notif_8h.html#ae2bdef15fc7bc7fbe56dc9d191d6656a">notifGetNotificationSystemEvent</a></div><div class="ttdeci">static Result notifGetNotificationSystemEvent(Event *out_event)</div><div class="ttdoc">Gets an Event which is signaled when data is available with notifTryPopNotifiedApplicationParameter.</div><div class="ttdef"><b>Definition</b> notif.h:165</div></div>
|
|
<div class="ttc" id="anotif_8h_html_ae47d53874f41ac3ffd02786e22251d5f"><div class="ttname"><a href="notif_8h.html#ae47d53874f41ac3ffd02786e22251d5f">notifAlarmSettingIsEnabled</a></div><div class="ttdeci">Result notifAlarmSettingIsEnabled(NotifAlarmSetting *alarm_setting, u32 day_of_week, bool *out)</div><div class="ttdoc">Gets whether the schedule setting for the specified day_of_week is enabled, for the NotifAlarmSetting...</div></div>
|
|
<div class="ttc" id="anotif_8h_html_afe4d166c470f650589616d0f57c2c7b3"><div class="ttname"><a href="notif_8h.html#afe4d166c470f650589616d0f57c2c7b3">notifLoadApplicationParameter</a></div><div class="ttdeci">Result notifLoadApplicationParameter(u16 alarm_setting_id, void *buffer, size_t size, u32 *actual_size)</div><div class="ttdoc">Loads the ApplicationParameter for the specified AlarmSetting.</div></div>
|
|
<div class="ttc" id="astructAccountUid_html"><div class="ttname"><a href="structAccountUid.html">AccountUid</a></div><div class="ttdoc">Account UserId.</div><div class="ttdef"><b>Definition</b> acc.h:25</div></div>
|
|
<div class="ttc" id="astructEvent_html"><div class="ttname"><a href="structEvent.html">Event</a></div><div class="ttdoc">Kernel-mode event structure.</div><div class="ttdef"><b>Definition</b> event.h:13</div></div>
|
|
<div class="ttc" id="astructNotifAlarmSetting_html"><div class="ttname"><a href="structNotifAlarmSetting.html">NotifAlarmSetting</a></div><div class="ttdoc">AlarmSetting.</div><div class="ttdef"><b>Definition</b> notif.h:33</div></div>
|
|
<div class="ttc" id="astructNotifAlarmSetting_html_a1f3369f70a04fcd6d08200334f80dd75"><div class="ttname"><a href="structNotifAlarmSetting.html#a1f3369f70a04fcd6d08200334f80dd75">NotifAlarmSetting::alarm_setting_id</a></div><div class="ttdeci">u16 alarm_setting_id</div><div class="ttdoc">AlarmSettingId.</div><div class="ttdef"><b>Definition</b> notif.h:34</div></div>
|
|
<div class="ttc" id="astructNotifAlarmSetting_html_a694b0c4123fa5c71f2fc7669bb3488d8"><div class="ttname"><a href="structNotifAlarmSetting.html#a694b0c4123fa5c71f2fc7669bb3488d8">NotifAlarmSetting::schedule</a></div><div class="ttdeci">NotifWeeklyScheduleAlarmSetting schedule</div><div class="ttdoc">NotifWeeklyScheduleAlarmSetting</div><div class="ttdef"><b>Definition</b> notif.h:41</div></div>
|
|
<div class="ttc" id="astructNotifAlarmSetting_html_a882ba8661d7be481fb042f3cd08ac4d9"><div class="ttname"><a href="structNotifAlarmSetting.html#a882ba8661d7be481fb042f3cd08ac4d9">NotifAlarmSetting::uid</a></div><div class="ttdeci">AccountUid uid</div><div class="ttdoc">AccountUid. User account associated with this AlarmSetting. Used for the preselected_user (accountGet...</div><div class="ttdef"><b>Definition</b> notif.h:38</div></div>
|
|
<div class="ttc" id="astructNotifAlarmSetting_html_ac2d32b961d5e80ce3f7a5cc938608023"><div class="ttname"><a href="structNotifAlarmSetting.html#ac2d32b961d5e80ce3f7a5cc938608023">NotifAlarmSetting::unk_x20</a></div><div class="ttdeci">u64 unk_x20</div><div class="ttdoc">Unknown.</div><div class="ttdef"><b>Definition</b> notif.h:40</div></div>
|
|
<div class="ttc" id="astructNotifAlarmSetting_html_ac7a30170ed0d90f260ae1619d4fbb1e7"><div class="ttname"><a href="structNotifAlarmSetting.html#ac7a30170ed0d90f260ae1619d4fbb1e7">NotifAlarmSetting::application_id</a></div><div class="ttdeci">u64 application_id</div><div class="ttdoc">ApplicationId.</div><div class="ttdef"><b>Definition</b> notif.h:39</div></div>
|
|
<div class="ttc" id="astructNotifAlarmSetting_html_ae5ddebfae7a96f9e67903ebe199ea71e"><div class="ttname"><a href="structNotifAlarmSetting.html#ae5ddebfae7a96f9e67903ebe199ea71e">NotifAlarmSetting::muted</a></div><div class="ttdeci">u8 muted</div><div class="ttdoc">u8 bool flag for whether this AlarmSetting is muted (non-zero = AlarmSetting turned off,...</div><div class="ttdef"><b>Definition</b> notif.h:36</div></div>
|
|
<div class="ttc" id="astructNotifAlarmSetting_html_afb3f41172e4eab9f25cdfad852ec0417"><div class="ttname"><a href="structNotifAlarmSetting.html#afb3f41172e4eab9f25cdfad852ec0417">NotifAlarmSetting::kind</a></div><div class="ttdeci">u8 kind</div><div class="ttdoc">Kind: 0 = WeeklySchedule.</div><div class="ttdef"><b>Definition</b> notif.h:35</div></div>
|
|
<div class="ttc" id="astructNotifAlarmTime_html"><div class="ttname"><a href="structNotifAlarmTime.html">NotifAlarmTime</a></div><div class="ttdoc">Data extracted from NotifWeeklyScheduleAlarmSetting::settings. This uses local-time.</div><div class="ttdef"><b>Definition</b> notif.h:21</div></div>
|
|
<div class="ttc" id="astructNotifAlarmTime_html_ad4d212e51dea8828446a6ebe2a7ccf7a"><div class="ttname"><a href="structNotifAlarmTime.html#ad4d212e51dea8828446a6ebe2a7ccf7a">NotifAlarmTime::minute</a></div><div class="ttdeci">s32 minute</div><div class="ttdoc">Minute.</div><div class="ttdef"><b>Definition</b> notif.h:23</div></div>
|
|
<div class="ttc" id="astructNotifAlarmTime_html_ae0e8f5479c71d2a49fe6108f212896bb"><div class="ttname"><a href="structNotifAlarmTime.html#ae0e8f5479c71d2a49fe6108f212896bb">NotifAlarmTime::hour</a></div><div class="ttdeci">s32 hour</div><div class="ttdoc">Hour.</div><div class="ttdef"><b>Definition</b> notif.h:22</div></div>
|
|
<div class="ttc" id="astructNotifWeeklyScheduleAlarmSetting_html"><div class="ttname"><a href="structNotifWeeklyScheduleAlarmSetting.html">NotifWeeklyScheduleAlarmSetting</a></div><div class="ttdoc">WeeklyScheduleAlarmSetting.</div><div class="ttdef"><b>Definition</b> notif.h:27</div></div>
|
|
<div class="ttc" id="astructService_html"><div class="ttname"><a href="structService.html">Service</a></div><div class="ttdoc">Service object structure.</div><div class="ttdef"><b>Definition</b> service.h:14</div></div>
|
|
<div class="ttc" id="atypes_8h_html_a0a13a49371a760adfdde1b4d7c965abb"><div class="ttname"><a href="types_8h.html#a0a13a49371a760adfdde1b4d7c965abb">NX_INLINE</a></div><div class="ttdeci">#define NX_INLINE</div><div class="ttdoc">Flags a function as (always) inline.</div><div class="ttdef"><b>Definition</b> types.h:86</div></div>
|
|
<div class="ttc" id="atypes_8h_html_a3f7e2bcbb0b4c338f3c4f6c937cd4234"><div class="ttname"><a href="types_8h.html#a3f7e2bcbb0b4c338f3c4f6c937cd4234">u64</a></div><div class="ttdeci">uint64_t u64</div><div class="ttdoc">64-bit unsigned integer.</div><div class="ttdef"><b>Definition</b> types.h:22</div></div>
|
|
<div class="ttc" id="atypes_8h_html_a92c50087ca0e64fa93fc59402c55f8ca"><div class="ttname"><a href="types_8h.html#a92c50087ca0e64fa93fc59402c55f8ca">u8</a></div><div class="ttdeci">uint8_t u8</div><div class="ttdoc">8-bit unsigned integer.</div><div class="ttdef"><b>Definition</b> types.h:19</div></div>
|
|
<div class="ttc" id="atypes_8h_html_aa980e2c02ba2305e0f489d5650655425"><div class="ttname"><a href="types_8h.html#aa980e2c02ba2305e0f489d5650655425">s16</a></div><div class="ttdeci">int16_t s16</div><div class="ttdoc">16-bit signed integer.</div><div class="ttdef"><b>Definition</b> types.h:26</div></div>
|
|
<div class="ttc" id="atypes_8h_html_ace9d960e74685e2cd84b36132dbbf8aa"><div class="ttname"><a href="types_8h.html#ace9d960e74685e2cd84b36132dbbf8aa">u16</a></div><div class="ttdeci">uint16_t u16</div><div class="ttdoc">16-bit unsigned integer.</div><div class="ttdef"><b>Definition</b> types.h:20</div></div>
|
|
<div class="ttc" id="atypes_8h_html_ad1be2721625a17f1be47fac918032afe"><div class="ttname"><a href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a></div><div class="ttdeci">u32 Result</div><div class="ttdoc">Function error code result type.</div><div class="ttdef"><b>Definition</b> types.h:44</div></div>
|
|
<div class="ttc" id="atypes_8h_html_ae9b1af5c037e57a98884758875d3a7c4"><div class="ttname"><a href="types_8h.html#ae9b1af5c037e57a98884758875d3a7c4">s32</a></div><div class="ttdeci">int32_t s32</div><div class="ttdoc">32-bit signed integer.</div><div class="ttdef"><b>Definition</b> types.h:27</div></div>
|
|
<div class="ttc" id="atypes_8h_html_afaa62991928fb9fb18ff0db62a040aba"><div class="ttname"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a></div><div class="ttdeci">uint32_t u32</div><div class="ttdoc">32-bit unsigned integer.</div><div class="ttdef"><b>Definition</b> types.h:21</div></div>
|
|
</div><!-- fragment --></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>
|