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 <style type="text/css"><!-- 8 span.static_style 9 { 10 font-size : 8pt; 11 color : white; 12 font-weight : bold; 13 background : #44f; 14 border-left : solid 1px #aaf; 15 border-top : solid 1px #aaf; 16 border-right : solid 1px #00c; 17 border-bottom : solid 1px #00c; 18 padding-left : 2px; 19 padding-right : 2px; 20 } 21 22 span.virtual_style 23 { 24 font-size : 8pt; 25 color : white; 26 font-weight : bold; 27 background : #0a0; 28 border-left : solid 1px #0f0; 29 border-top : solid 1px #0f0; 30 border-right : solid 1px #060; 31 border-bottom : solid 1px #060; 32 padding-left : 2px; 33 padding-right : 2px; 34 } 35 36 span.protected_style 37 { 38 font-size : 8pt; 39 color : white; 40 font-weight : bold; 41 background : #444; 42 border-left : solid 1px #ccc; 43 border-top : solid 1px #ccc; 44 border-right : solid 1px #222; 45 border-bottom : solid 1px #222; 46 padding-left : 2px; 47 padding-right : 2px; 48 } 49 --></style> 50 <title>nn::swkbd::CTR::Config</title> 51 </head> 52 <body> 53 <h1><CODE>nn::swkbd::CTR::Config</CODE> Structure</h1> 54 <h2>Syntax</h2> 55 <div class="section"> 56 <pre class="definition">struct Config 57{ 58 <a href="../../../../nn/swkbd/CTR/KeyboardType.html">KeyboardType</a> keyboardType; 59 <a href="../../../../nn/swkbd/CTR/BottomButtonType.html">BottomButtonType</a> bottomButtonType; 60 <a href="../../../../nn/swkbd/CTR/FinishableCondition.html">FinishableCondition</a> finishableCondition; 61 <a href="../../../../nn/swkbd/CTR/MaskMode.html">MaskMode</a> maskMode; 62 <a href="../../../../nn/swkbd/CTR/ParentalControlsMode.html">ParentalControlsMode</a> parentalControlsMode; 63 bit32 upperScreenFlag; 64 bit32 textCheckFlag; 65 bit32 extOutputDataFlag; 66 u16 textLengthMax; 67 u16 numUserWords; 68 u16 numNumbersMax; 69 wchar_t bottomButtonText[BOTTOM_BUTTON_MAX][BOTTOM_BUTTON_TEXT_LENGTH_MAX+1]; 70 wchar_t tenkeyExtKeyChar[TENKEY_EXT_KEY_MAX]; 71 wchar_t guideText[GUIDE_TEXT_LENGTH_MAX+1]; 72 bool prediction; 73 bool lineFeed; 74 bool fixedWidthMode; 75 bool homeButton; 76 bool softwareReset; 77 bool powerButton; 78 bool communicateWithOtherRegions; 79 bool bootWithQwerty; 80 bool bottomButtonToFinish[BOTTOM_BUTTON_MAX]; 81 sptr initialInputText; 82 sptr userWordArray; 83 sptr initialStatusData; 84 sptr initialLearningData; 85 size_t sharedMemorySize; 86 u16 versionNumber; 87 <a href="../../../../nn/swkbd/CTR/ReturnCode.html">ReturnCode</a> returnCode; 88 sptr statusData; 89 sptr learningData; 90 sptr inputText; 91 u16 inputTextLength; 92 <a href="../../../../nn/swkbd/CTR/AppTextCheckResult.html">AppTextCheckResult</a> appTextCheckResult; 93 wchar_t appTextCheckDialogText[APP_TEXT_CHECK_DIALOG_TEXT_LENGTH_MAX+1]; 94 u8 reserved[172]; 95}; 96</pre> 97 </div> 98 <h2>Description</h2> 99 <div class="section"> 100<p>Configuration structure.</p><p>This structure is exchanged between the application and the software keyboard applet and stores various data.<br />In addition to parameters that specify the behavior of the software keyboard, this structure also stores information about text that was input by the user.</p><p>You must always call the <a href="../../../../nn/swkbd/CTR/InitializeConfig.html"><CODE>nn::swkbd::CTR::InitializeConfig</CODE></a> function to initialize this structure before setting its member variables.<br />However, the only values you can set directly are the ones classified on this page as <I>Input (Direct Setting Possible)</I>.<br />Changing the values of the other member variables might cause abnormal behavior.</p><br /><br /><p>For <CODE>keyboardType</CODE>, use the <a href="../../../../nn/swkbd/CTR/KeyboardType.html"><CODE>nn::swkbd::CTR::KeyboardType</CODE></a> enumerated type to specify the type of keyboard you want to use.<br />If you specify any value other than <CODE>KEYBOARD_TYPE_FULL</CODE>, predictive text is not available.<br />Similarly, if you specify <CODE>KEYBOARD_TYPE_TENKEY</CODE>, newlines are also disabled.</p><p>For <CODE>bottomButtonType</CODE>, use the <a href="../../../../nn/swkbd/CTR/BottomButtonType.html"><CODE>nn::swkbd::CTR::BottomButtonType</CODE></a> enumerated type to specify the type of the bottom-row buttons (the buttons laid out along the lowest edge of the screen).</p><p>For <CODE>finishableCondition</CODE>, use the <CODE><a href="../../../../nn/swkbd/CTR/FinishableCondition.html">nn::swkbd::CTR::FinishableCondition</a></CODE> enumerated type to specify the conditions that must be met for users to finalize their text input.<br />Users cannot finalize any text input unless they meet these conditions.</p><p>For <CODE>maskMode</CODE>, use the <a href="../../../../nn/swkbd/CTR/MaskMode.html"><CODE>nn::swkbd::CTR::MaskMode</CODE></a> enumerated type to specify the method to use when masking user-entered content.<br />When you specify any value other than <CODE>MASK_MODE_DISABLE</CODE>, user-entered characters are replaced with asterisks (*) using the specified method.<br />Newlines, however, are not replaced.</p><p>For <CODE>parentalControlsMode</CODE>, use the <a href="../../../../nn/swkbd/CTR/ParentalControlsMode.html"><CODE>nn::swkbd::CTR::ParentalControlsMode</CODE></a> enumerated type to specify whether to start the software keyboard in a special mode that allows the user to temporarily disable Parental Controls.<br />When you specify any value other than <CODE>PARENTAL_CONTROLS_MODE_DISABLE</CODE>, the settings of all the other member variables except <CODE>upperScreenFlag</CODE>, <CODE>homeButton</CODE>, and <CODE>softwareReset</CODE> are ignored.</p><p>For <CODE>upperScreenFlag</CODE>, use a bitwise OR of the <a href="../../../../nn/swkbd/CTR/UpperScreenFlag.html"><CODE>nn::swkbd::CTR::UpperScreenFlag</CODE></a> enumerated type flags to specify how to display the upper screen.</p><p>For <CODE>textCheckFlag</CODE>, use a bitwise OR of the <a href="../../../../nn/swkbd/CTR/TextCheckFlag.html"><CODE>nn::swkbd::CTR::TextCheckFlag</CODE></a> enumerated type flags to specify the types of text checks you want to perform while the software keyboard is running.<br />When you specify any value other than <CODE>TEXT_CHECK_DISABLE</CODE>, the value set in the <CODE>textLengthMax</CODE> member variable is clamped so as not to exceed <a href="../../../../nn/swkbd/CTR/TEXT_CHECK_TEXT_LENGTH_MAX_MAX.html"><CODE>nn::swkbd::CTR::TEXT_CHECK_TEXT_LENGTH_MAX_MAX</CODE></a>.<br />Furthermore, if you specify <CODE>TEXT_CHECK_BANNED_WORDS</CODE>, the value set in the <CODE>textLengthMax</CODE> member variable is clamped so as not to exceed <a href="../../../../nn/swkbd/CTR/BANNED_WORD_CHECK_TEXT_LENGTH_MAX_MAX.html"><CODE>nn::swkbd::CTR::BANNED_WORD_CHECK_TEXT_LENGTH_MAX_MAX</CODE></a> and newlines are disabled.</p><p>For <CODE>extOutputDataFlag</CODE>, use a bitwise OR of the <a href="../../../../nn/swkbd/CTR/ExtOutputDataFlag.html"><CODE>nn::swkbd::CTR::ExtOutputDataFlag</CODE></a> enumerated type flags to specify the types of any data you want to output in addition to the user-entered text and the return code.</p><p>For <CODE>numUserWords</CODE>, specify the number of elements in the <a href="../../../../nn/swkbd/CTR/UserWord/Overview.html"><CODE>nn::swkbd::CTR::UserWord</CODE></a> structure array to pass as an argument to the <a href="../../../../nn/swkbd/CTR/StartKeyboardApplet.html"><CODE>nn::swkbd::CTR::StartKeyboardApplet</CODE></a> function.<br />If using user dictionaries, always set an appropriate value here.</p><p>For <CODE>numNumbersMax</CODE>, specify the maximum number of numbers that users can input when <CODE>TEXT_CHECK_NUMBER</CODE> is set in the <CODE>textCheckFlag</CODE> member variable and number input is restricted. Specify <CODE>0</CODE> to completely prohibit the input of numbers.<br />When <CODE>TEXT_CHECK_NUMBER</CODE> is not set in the <CODE>textCheckFlag</CODE> member variable, this member variable's setting is ignored.</p><p>For <CODE>bottomButtonText</CODE>, specify a NULL-terminated string for the text to display on the bottom-row buttons.<br />Use the <a href="../../../../nn/swkbd/CTR/BottomButton.html"><CODE>nn::swkbd::CTR::BottomButton</CODE></a> enumerated type to specify the primary index of the array.<br />If you specify an empty string, the default text for the system's region and language setting will be used.</p><p>For <CODE>tenkeyExtKeyChar</CODE>, specify the characters to assign to the keys placed to the immediate left and right of the <CODE>0</CODE> key on the numeric keypad.<br />Use the <a href="../../../../nn/swkbd/CTR/TenkeyExtKey.html"><CODE>nn::swkbd::CTR::TenkeyExtKey</CODE></a> enumerated type to specify the index of the array.<br />Basically, the characters you specify are displayed unchanged on the keys, but there is an exception: if you specify a single-byte space (<CODE>0x0020</CODE>) a special extended character is displayed on the key.<br />You cannot specify any of the control characters from <CODE>0x0001</CODE> to <CODE>0x001F</CODE>.<br />If you specify a <CODE>NULL</CODE> character, that key is not displayed.</p><p>For <CODE>guideText</CODE>, specify a NULL-terminated string to serve as <I>guide text</I> (text displayed in an input field before characters are input).<br />Guide text is not displayed, however, when <CODE>true</CODE> is specified for the <CODE>fixedWidthMode</CODE> member variable and the keyboard starts in fixed-width display mode.</p><p>For <CODE>fixedWidthMode</CODE>, specify whether to start the software keyboard in fixed-width display mode.<br />If you specify <CODE>true</CODE>, the keyboard starts in fixed-width display mode. Entered text is displayed as fixed-width and the number of characters that can be input is visible.<br />In addition, the value set in the <CODE>textLengthMax</CODE> member variable is clamped so as not to exceed <a href="../../../../nn/swkbd/CTR/FIXED_WIDTH_TEXT_LENGTH_MAX_MAX.html"><CODE>nn::swkbd::CTR::FIXED_WIDTH_TEXT_LENGTH_MAX_MAX</CODE></a> and newlines are disabled.</p><p>For <CODE>homeButton</CODE>, specify whether to end the software keyboard when HOME is pressed.<br />When you specify <CODE>true</CODE>, the software keyboard ends and outputs any existing user-entered text when HOME is pressed. When the keyboard ends this way, however, the output text does not undergo any of the text checks specified by the <CODE>textCheckFlag</CODE> member variable.</p><p>For <CODE>softwareReset</CODE>, specify whether to enable software resets.<br />When you specify <CODE>true</CODE>, the software keyboard ends when the button combination for a software reset is pressed.</p><p>For <CODE>powerButton</CODE>, specify whether the software keyboard ends when the POWER Button is pressed.<br />In general, do not change this from the default value of <CODE>true</CODE>.</p><p>For <CODE>communicateWithOtherRegions</CODE>, specify whether the application exchanges data with other regions.<br />When <CODE>TEXT_CHECK_BANNED_WORDS</CODE> is set in the <CODE>textCheckFlag</CODE> member variable, that text check's pattern changes as a result of this member variable's setting.<br />When <CODE>TEXT_CHECK_BANNED_WORDS</CODE> is not set in the <CODE>textCheckFlag</CODE> member variable, this member variable's setting is ignored.</p><p>For <CODE>bootWithQwerty</CODE>, specify whether to forcibly set the key layout to the QWERTY layout at startup.<br />When you specify <CODE>false</CODE>, the key layout selected at startup differs depending on the language setting.<br />Specifically, the layout is kana for Japanese, Cyrillic for Russian, and QWERTY for all other languages.<br />This member variable's setting is ignored, however, when you specify any value other than <CODE>KEYBOARD_TYPE_FULL</CODE> for the <CODE>KeyboardType</CODE> member variable, or when the initial operating status data is passed as an argument to the <a href="../../../../nn/swkbd/CTR/StartKeyboardApplet.html"><CODE>nn::swkbd::CTR::StartKeyboardApplet</CODE></a> function.</p><p>For <CODE>bottomButtonToFinish</CODE>, specify which of the bottom-row buttons is the <B>OK</B> button (the button the user presses to finalize input).<br />Use the <a href="../../../../nn/swkbd/CTR/BottomButton.html"><CODE>nn::swkbd::CTR::BottomButton</CODE></a> enumerated type to specify the index in the array; specify <CODE>true</CODE> to make that button the <B>OK</B> button.<br />The bottom-row button specified as the <B>OK</B> button is not pressable until the conditions for finalizing input (specified in the <CODE>finishableCondition</CODE> member variable) are met.</p><br /><br /><p>The data output when the software keyboard ends can be obtained by checking the values of the member variables classified as <I>Output</I> in the <B>Member Variables</B> section of this page.<br />Any comparatively large data items stored in shared memory are passed as an argument to the <a href="../../../../nn/swkbd/CTR/StartKeyboardApplet.html"><CODE>nn::swkbd::CTR::StartKeyboardApplet</CODE></a> function.<br />The starting addresses of the data items are stored in the output member variables of this structure as offsets from the start of shared memory. Obtain the data by referencing those values.</p><p><CODE>returnCode</CODE> stores the return code that indicates the reason why the software keyboard ended.<br />Among these codes are codes indicating that the POWER Button or the HOME Button was pressed, but those codes alone do not allow you to determine whether to call the <a href="../../../../nn/applet/CTR/ProcessPowerButton.html"><CODE>nn::applet::CTR::ProcessPowerButton</CODE></a> or <a href="../../../../nn/applet/CTR/ProcessHomeButton.html"><CODE>nn::applet::CTR::ProcessHomeButton</CODE></a> function.<br />To determine whether it is necessary to call those functions, you must call the <a href="../../../../nn/applet/CTR/IsExpectedToProcessPowerButton.html"><CODE>nn::applet::CTR::IsExpectedToProcessPowerButton</CODE></a> and <a href="../../../../nn/applet/CTR/IsExpectedToProcessHomeButton.html"><CODE>nn::applet::CTR::IsExpectedToProcessHomeButton</CODE></a> functions.</p><p><CODE>statusData</CODE> stores the starting address of the operating status data when the software keyboard ended as offset from the start of the shared memory region.<br />A value of <CODE>-1</CODE> is stored when <CODE>EXT_OUTPUT_DATA_STATUS</CODE> was not set in the <CODE>extOutputDataFlag</CODE> member variable of this structure when the software keyboard was started.<br />The size of the data is defined by <a href="../../../../nn/swkbd/CTR/STATUS_DATA_SIZE.html"><CODE>nn::swkbd::CTR::STATUS_DATA_SIZE</CODE></a>.<br />If you pass this data as an argument to the <a href="../../../../nn/swkbd/CTR/StartKeyboardApplet.html"><CODE>nn::swkbd::CTR::StartKeyboardApplet</CODE></a> function the next time the software keyboard is started, you can carry over the keyboard's operating status from the previous time it was used.</p><p><CODE>learningData</CODE> stores the starting address of the predictive text learning data when the software keyboard ended as offset from the start of the shared memory region.<br />A value of <CODE>-1</CODE> is stored when <CODE>EXT_OUTPUT_DATA_LEARNING</CODE> was not set in the <CODE>extOutputDataFlag</CODE> member variable of this structure when the software keyboard was started.<br />The size of the data is defined by <a href="../../../../nn/swkbd/CTR/LEARNING_DATA_SIZE.html"><CODE>nn::swkbd::CTR::LEARNING_DATA_SIZE</CODE></a>.<br />If you pass this data as an argument to the <a href="../../../../nn/swkbd/CTR/StartKeyboardApplet.html"><CODE>nn::swkbd::CTR::StartKeyboardApplet</CODE></a> function the next time the software keyboard is started, you can carry over the keyboard's learning status from the previous time it was used.</p><p><CODE>inputText</CODE> stores the starting address of the user-entered string as offset from the start of the shared memory region.<br />Strings are of the <CODE>wchar_t</CODE> type and are NULL-terminated.<br />A value of <CODE>-1</CODE> is stored if the software keyboard ended without input being finalized.</p><p><CODE>inputTextLength</CODE> stores the length of the user-entered string.<br />The <CODE>NULL</CODE> terminator is not included in this length.</p></div> 101 <a name="variable" id="variable"> 102 <h2>Member Variables</h2> 103 <div class="section"> 104 <table class="members"> 105 <tr> 106 <th class="category" colspan="3">Input (Direct Setting Possible)</th> 107 </tr> 108 <tr> 109 <td width="100"> </td> 110 <th> 111 <span class="argument"><CODE>keyboardType</CODE></span> 112 </th> 113 <td>The keyboard type.</td> 114 </tr> 115 <tr> 116 <td width="100"> </td> 117 <th> 118 <span class="argument"><CODE>bottomButtonType</CODE></span> 119 </th> 120 <td>The type of the bottom-row buttons.</td> 121 </tr> 122 <tr> 123 <td width="100"> </td> 124 <th> 125 <span class="argument"><CODE>finishableCondition</CODE></span> 126 </th> 127 <td>Conditions under which input can be finalized.</td> 128 </tr> 129 <tr> 130 <td width="100"> </td> 131 <th> 132 <span class="argument"><CODE>maskMode</CODE></span> 133 </th> 134 <td>The masking mode for input characters.</td> 135 </tr> 136 <tr> 137 <td width="100"> </td> 138 <th> 139 <span class="argument"><CODE>parentalControlsMode</CODE></span> 140 </th> 141 <td>Temporarily-disabled modes of Parental Controls.</td> 142 </tr> 143 <tr> 144 <td width="100"> </td> 145 <th> 146 <span class="argument"><CODE>upperScreenFlag</CODE></span> 147 </th> 148 <td>Flags indicating the display method for the upper screen (a bitwise OR of <a href="../../../../nn/swkbd/CTR/UpperScreenFlag.html"><CODE>nn::swkbd::CTR::UpperScreenFlag</CODE></a> values).</td> 149 </tr> 150 <tr> 151 <td width="100"> </td> 152 <th> 153 <span class="argument"><CODE>textCheckFlag</CODE></span> 154 </th> 155 <td>Flags indicating the types of text checking (a bitwise OR of <a href="../../../../nn/swkbd/CTR/TextCheckFlag.html"><CODE>nn::swkbd::CTR::TextCheckFlag</CODE></a> values).</td> 156 </tr> 157 <tr> 158 <td width="100"> </td> 159 <th> 160 <span class="argument"><CODE>extOutputDataFlag</CODE></span> 161 </th> 162 <td>Flags indicating the types of extended output data (a bitwise OR of <a href="../../../../nn/swkbd/CTR/ExtOutputDataFlag.html"><CODE>nn::swkbd::CTR::ExtOutputDataFlag</CODE></a> values).</td> 163 </tr> 164 <tr> 165 <td width="100"> </td> 166 <th> 167 <span class="argument"><CODE>textLengthMax</CODE></span> 168 </th> 169 <td>The maximum number of characters that can be input.</td> 170 </tr> 171 <tr> 172 <td width="100"> </td> 173 <th> 174 <span class="argument"><CODE>numUserWords</CODE></span> 175 </th> 176 <td>The number of words to register in the user dictionary.</td> 177 </tr> 178 <tr> 179 <td width="100"> </td> 180 <th> 181 <span class="argument"><CODE>numNumbersMax</CODE></span> 182 </th> 183 <td>The maximum number of numbers that can be input.</td> 184 </tr> 185 <tr> 186 <td width="100"> </td> 187 <th> 188 <span class="argument"><CODE>bottomButtonText</CODE></span> 189 </th> 190 <td>The text for the bottom-row buttons.</td> 191 </tr> 192 <tr> 193 <td width="100"> </td> 194 <th> 195 <span class="argument"><CODE>tenkeyExtKeyChar</CODE></span> 196 </th> 197 <td>The text for the extended keys in the numeric keypad layout.</td> 198 </tr> 199 <tr> 200 <td width="100"> </td> 201 <th> 202 <span class="argument"><CODE>guideText</CODE></span> 203 </th> 204 <td>The guide text.</td> 205 </tr> 206 <tr> 207 <td width="100"> </td> 208 <th> 209 <span class="argument"><CODE>prediction</CODE></span> 210 </th> 211 <td>Whether to use predictive text.</td> 212 </tr> 213 <tr> 214 <td width="100"> </td> 215 <th> 216 <span class="argument"><CODE>lineFeed</CODE></span> 217 </th> 218 <td>Whether to enable newlines.</td> 219 </tr> 220 <tr> 221 <td width="100"> </td> 222 <th> 223 <span class="argument"><CODE>fixedWidthMode</CODE></span> 224 </th> 225 <td>Fixed-width display mode.</td> 226 </tr> 227 <tr> 228 <td width="100"> </td> 229 <th> 230 <span class="argument"><CODE>homeButton</CODE></span> 231 </th> 232 <td>Whether to end the software keyboard applet when HOME is pressed.</td> 233 </tr> 234 <tr> 235 <td width="100"> </td> 236 <th> 237 <span class="argument"><CODE>softwareReset</CODE></span> 238 </th> 239 <td>Whether to use software resets.</td> 240 </tr> 241 <tr> 242 <td width="100"> </td> 243 <th> 244 <span class="argument"><CODE>powerButton</CODE></span> 245 </th> 246 <td>Whether to end the software keyboard applet when the POWER Button is pressed.</td> 247 </tr> 248 <tr> 249 <td width="100"> </td> 250 <th> 251 <span class="argument"><CODE>communicateWithOtherRegions</CODE></span> 252 </th> 253 <td>Whether the application exchanges data with other regions.</td> 254 </tr> 255 <tr> 256 <td width="100"> </td> 257 <th> 258 <span class="argument"><CODE>bootWithQwerty</CODE></span> 259 </th> 260 <td>Whether to make the key layout the QWERTY layout at startup.</td> 261 </tr> 262 <tr> 263 <td width="100"> </td> 264 <th> 265 <span class="argument"><CODE>bottomButtonToFinish</CODE></span> 266 </th> 267 <td>Specifies an <B>OK</B> button in the bottom row of buttons.</td> 268 </tr> 269 <tr> 270 <th class="category" colspan="3">Input (Direct Setting Impossible)</th> 271 </tr> 272 <tr> 273 <td width="100"> </td> 274 <th> 275 <span class="argument"><CODE>initialInputText</CODE></span> 276 </th> 277 <td>Offset to the initial input text.</td> 278 </tr> 279 <tr> 280 <td width="100"> </td> 281 <th> 282 <span class="argument"><CODE>userWordArray</CODE></span> 283 </th> 284 <td>Offset to the array of words registered in the user dictionary.</td> 285 </tr> 286 <tr> 287 <td width="100"> </td> 288 <th> 289 <span class="argument"><CODE>initialStatusData</CODE></span> 290 </th> 291 <td>Offset to the initial operating status data at startup.</td> 292 </tr> 293 <tr> 294 <td width="100"> </td> 295 <th> 296 <span class="argument"><CODE>initialLearningData</CODE></span> 297 </th> 298 <td>Offset to the initial predictive text learning data at startup.</td> 299 </tr> 300 <tr> 301 <td width="100"> </td> 302 <th> 303 <span class="argument"><CODE>sharedMemorySize</CODE></span> 304 </th> 305 <td>The size of the shared memory region.</td> 306 </tr> 307 <tr> 308 <td width="100"> </td> 309 <th> 310 <span class="argument"><CODE>versionNumber</CODE></span> 311 </th> 312 <td>The version number.</td> 313 </tr> 314 <tr> 315 <th class="category" colspan="3">Output</th> 316 </tr> 317 <tr> 318 <td width="100"> </td> 319 <th> 320 <span class="argument"><CODE>returnCode</CODE></span> 321 </th> 322 <td>Return codes.</td> 323 </tr> 324 <tr> 325 <td width="100"> </td> 326 <th> 327 <span class="argument"><CODE>statusData</CODE></span> 328 </th> 329 <td>Offset to the final operating status data.</td> 330 </tr> 331 <tr> 332 <td width="100"> </td> 333 <th> 334 <span class="argument"><CODE>learningData</CODE></span> 335 </th> 336 <td>Offset to the final predictive text learning data.</td> 337 </tr> 338 <tr> 339 <td width="100"> </td> 340 <th> 341 <span class="argument"><CODE>inputText</CODE></span> 342 </th> 343 <td>Offset to the entered text.</td> 344 </tr> 345 <tr> 346 <td width="100"> </td> 347 <th> 348 <span class="argument"><CODE>inputTextLength</CODE></span> 349 </th> 350 <td>Length of the entered text.</td> 351 </tr> 352 <tr> 353 <th class="category" colspan="3">Related to Text Checking by the Application</th> 354 </tr> 355 <tr> 356 <td width="100"> </td> 357 <th> 358 <span class="argument"><CODE>appTextCheckResult</CODE></span> 359 </th> 360 <td>Result of the application's text check.</td> 361 </tr> 362 <tr> 363 <td width="100"> </td> 364 <th> 365 <span class="argument"><CODE>appTextCheckDialogText</CODE></span> 366 </th> 367 <td>Dialog text of the application's text check.</td> 368 </tr> 369 <tr> 370 <th class="category" colspan="3">Other</th> 371 </tr> 372 <tr> 373 <td width="100"> </td> 374 <th> 375 <span class="argument"><CODE>reserved</CODE></span> 376 </th> 377 <td>A reserved region for future extensions.</td> 378 </tr> </table> 379 </div> 380 </a> 381 <h2>Revision History</h2> 382 <div class="section"> 383 <dl class="history"> 384 <dt>2011/03/18</dt> 385<dd>Added note to description of the <CODE>bottomButtonText</CODE> member variable that the default text will be used in accordance with the system's region and language settings.<br /> 386 </dd> 387 <dt>2011/03/01</dt> 388 <dd>Initial version.<br /> 389 </dd> 390 </dl> 391 </div> 392 <hr><p>CONFIDENTIAL</p></body> 393</html>