1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> 2<html xml:lang="en-US" lang="en-US" xmlns="http://www.w3.org/1999/xhtml"> 3 <head> 4 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> 5 <meta http-equiv="Content-Style-Type" content="text/css" /> 6 <link rel="stylesheet" href="../../css/manpage.css" type="text/css" /> 7 <title>RegisterImmediateTask</title> 8 </head> 9 <body> 10 <h1><CODE><a href="../../nn/Overview.html">nn</a>::<a href="../../nn/boss/Overview.html">boss</a>::RegisterImmediateTask</CODE> Function</h1> 11 <h2>Syntax</h2> 12 <div class="section"> 13 <pre class="definition"> 14<a href="../../nn/Result/Overview.html">nn::Result</a> RegisterImmediateTask( 15 <a href="../../nn/boss/Task/Overview.html">Task</a> * pTask, 16 <a href="../../nn/boss/TaskAction/Overview.html">TaskAction</a> * pAction, 17 const char * pFilePath, 18 <a href="../../nn/boss/TaskPolicy/Overview.html">TaskPolicy</a> * pPolicy = NULL, 19 <a href="../../nn/boss/TaskOption/Overview.html">TaskOption</a> * pOption = NULL, 20 <a href="../../nn_types/u8.html">u8</a> taskStep = DEFAULT_STEP_ID 21); 22</pre> 23 </div> 24 <h2>Parameters</h2> 25 <div class="section"> 26 <table class="arguments"> 27 <thead> 28 <tr> 29 <td width="15" /> 30 <th>Name</th> 31 <td>Description</td> 32 </tr> 33 </thead> 34 <tr> 35 <td>in</td> 36 <th>pTask</th> 37 <td>Specifies a task by task ID.</td> 38 </tr> 39 <tr> 40 <td>in</td> 41 <th>pAction</th> 42 <td>Specifies a task action.</td> 43 </tr> 44 <tr> 45 <td>in</td> 46 <th>pFilePath</th> 47 <td>File path.</td> 48 </tr> 49 <tr> 50 <td>in</td> 51 <th>pPolicy</th> 52 <td>Specifies a task policy. (Optional.)</td> 53 </tr> 54 <tr> 55 <td>in</td> 56 <th>pOption</th> 57 <td>Specifies task options. (Can be omitted)<br />Note: This parameter is not currently supported because it is used with extended features. Do not specify it.</td> 58 </tr> 59 <tr> 60 <td>in</td> 61 <th>taskStep</th> 62 <td>Specifies a task step ID. (Can be omitted if there is only one task execution step)<br /><B>Note</B>: This parameter is for a feature extension and is currently not supported. Do not specify it.</td> 63 </tr> </table> 64 </div> 65 <h2>Return Values</h2> 66 <div class="section">Returns the function's execution result. Returns one of the <a href="../../nn/Result/Overview.html"><CODE>Result</CODE></a> values listed below.<br /> <br /> 67 <table class="arguments"> 68 <thead> 69 <tr> 70 <th>Value</th> 71 <td>Description</td> 72 </tr> 73 </thead> 74 <tr> 75 <th>Result::IsSuccess</th> 76 <td>Registration successful.</td> 77 </tr> 78 <tr> 79 <th>ResultInvalidTaskId</th> 80 <td>The <SPAN class="argument">pTask</SPAN> argument is <CODE>NULL</CODE>.<br /> Alternatively, the <SPAN class="argument">pTask</SPAN> argument is uninitialized, or the pointer of the task ID specified by <SPAN class="argument">pTask</SPAN> is <CODE>NULL</CODE> or an empty string.</td> 81 </tr> 82 <tr> 83 <th>ResultInvalidAction</th> 84 <td>The <CODE>pAction</CODE> parameter is <CODE>NULL</CODE>.</td> 85 </tr> 86 <tr> 87 <th>ResultActionCodeOutOfRange</th> 88 <td>The task action code is out of range. Confirm that it is in the range of <CODE><a href="../../nn/boss/Action.html">Action</a></CODE>.</td> 89 </tr> 90 <tr> 91 <th>ResultInvalidUrl</th> 92 <td>The URL string pointer is <CODE>NULL</CODE> or a zero-length string.</td> 93 </tr> 94 <tr> 95 <th>ResultApInfoTypeOutOfRange</th> 96 <td>The AP information type is out of range. Confirm that it is in the range of <CODE><a href="../../nn/boss/ApInfoType.html">ApInfoType</a></CODE>.</td> 97 </tr> 98 <tr> 99 <th>ResultCfgInfoTypeOutOfRange</th> 100 <td>The Cfg information type is out of range. Confirm that it is in the range of <CODE><a href="../../nn/boss/ApInfoType.html">ApInfoType</a></CODE>.</td> 101 </tr> 102 <tr> 103 <th>ResultInvalidFilePath</th> 104 <td>The file path string pointer is <CODE>NULL</CODE> or a zero-length string.</td> 105 </tr> 106 <tr> 107 <th>ResultInvalidOption</th> 108 <td>The <CODE>pOption</CODE> parameter is uninitialized or the option code is out of range. Confirm that it is in the range of <CODE><a href="../../nn/boss/ExecOption.html">ExecOption</a></CODE>.</td> 109 </tr> 110 <tr> 111 <th>ResultStorageNotFound</th> 112 <td>Storage has not been registered for the corresponding application ID.</td> 113 </tr> 114 <tr> 115 <th>ResultDatabaseFull</th> 116 <td>BOSS storage and tasks cannot be registered because the maximum number of registered application IDs and tasks has been reached.</td> 117 </tr> 118 <tr> 119 <th>ResultFileAccess</th> 120 <td>Failed to access a file.<BR> This <a href="../../nn/Result/Overview.html"><CODE>Result</CODE></a> is returned when the SD Card is removed or data is corrupted.</td> 121 </tr> 122 <tr> 123 <th>ResultIpcNotSessionInitialized</th> 124 <td>The session has not been initialized.<BR> This <CODE><a href="../../nn/Result/Overview.html">Result</a></CODE> is returned if this function is called before the <CODE><a href="../../nn/boss/Initialize.html">Initialize</A></CODE> function. Always call the <a href="../../nn/boss/Initialize.html"><CODE>Initialize</CODE></a> function first when using the BOSS library.</td> 125 </tr> 126 <tr> 127 <th>ResultInvalidFilePath</th> 128 <td>The file path string pointer is <CODE>NULL</CODE> or a zero-length string. (<B>Note:</B> This is probably operationally impossible, but there is an escape if the specfied file cannot be found.)</td> 129 </tr> 130 <tr> 131 <th>A value other than the above</th> 132 <td>Unexpected error (see <CODE>boss_Result.h</CODE> for error details).</td> 133 </tr> 134 </table> </div> 135 <h2>Description</h2> 136 <div class="section"> 137 <p>Registers a specified file to an immediate execution task.</p><!-- write here --></div> 138 <h2>Revision History</h2> 139 <div class="section"> 140 <dl class="history"> 141 <dt>2011/10/27</dt> 142 <dd>Initial version.<br /> 143 </dd> 144 </dl> 145 </div> 146 <hr><p>CONFIDENTIAL</p></body> 147</html>