Error applet

2019-01-11T13:25:52Z

DarkLordZach: Add ApplicationError and ShowErrorRecord

The error applet is used to display an error result by several titles and applets. (AppletId 0xE)

Depending on the type, the applet will display the error in several ways.

It takes two input storages: common arguments and a custom storage.

== Error applet types ==

=== Common ===

For all of the following structures, the first two bytes are common and identify mode.

{| class="wikitable" border="1"
|-
! Offset || Size || Typical Value || Notes
|-
| 0x0 || 1 || 0 || Error Applet Mode
|-
| 0x1 || 1 || 1 || Whether or not to use 'jump' mode
|}

In SDK, the jump mode byte is always one, except for nn::err::ShowErrorWithoutJump. HW-Testing has shown this to have no visual impact on error applet.

=== Error (common one) ===

Takes a CommonArgs storage with version 0.
Uses a mode byte of 0 in the above struct.

==== Custom storage ====

Unknown exact size, using size 20 seems to work fine.

The type (byte 0 of this storage) is 0.

{| class="wikitable" border="1"
|-
! Offset || Size || Typical Value || Notes
|-
| 0x10 || 4 (u32) || 0 (2000-0000) || Result code, same Result type used everywhere in HOS.
|}

The error will display error code 2000-0000 if the Result is not set. The text is the default one.

=== SystemError ===

Takes a CommonArgs storage with version 0.
Uses a mode byte of 1 in the above struct.

==== Custom storage ====

SDK uses size 4120 for this storage.

The type (byte 0 of this storage) is 1.

{| class="wikitable" border="1"
|-
! Offset || Size || Typical Value || Notes
|-
| 0x8 || 8 (u64) || 0 (0000-0000) || ErrorCode (not Result like in normal errors) of the error to use.
|-
| 0x18 || 0x800 || - || String of the text to be shown as a short description of the error.
|-
| 0x818 || 0x800 || - || String of the text to be shown as a more detailed description of the error.
|}

If the first text is not specified but the second one is, the applet will directly load the "Details" display with the second error text.

If both texts are set, the applet will load the dialog with "Close" and "Details" options, and will load the display mentiones above after selecting "Details".

If no ErrorCode is supplied, the applet will use 0000-0000.

=== ApplicationError ===

Allows an application to show a custom-defined error text.
Uses a mode byte of 2 in the above struct.

The SDK uses size 4116 (0x1014) for this storage.

{| class="wikitable" border="1"
|-
! Offset || Size || Typical Value || Notes
|-
| 0x8 || 4 (u32) || 0 (0000-0000) || ErrorCode of the error to use.
|-
| 0xC || 8 (u64) || 'en-US\0' || The Language of the following text. This uses the same language names as settings service.
|-
| 0x14 || 0x800 || - || String of the text to be shown as a short description of the error.
|-
| 0x814 || 0x800 || - || String of the text to be shown as a more detailed description of the error.
|}

On hardware, the short description will be displayed initially in a dialog box with the error code. There is a details button that when clicked will display the detailed description.

=== ShowErrorRecord (ShowError with Timestamp) ===

Uses common arguments version 0 and a mode byte of 5.

Performs the same function as ShowError, but also displays the date and time of error.

{| class="wikitable" border="1"
|-
! Offset || Size || Typical Value || Notes
|-
| 0x8 || 8 (u64) || 0 (0000-0000) || Result code to use. This is formatted with the first u32 = description and second u32 = module + 2000.
|-
| 0x10 || 8 (u64) || 0 (Jan 1, 1970 00:00:00 AM) || POSIX time of the error to be displayed (as seconds since epoch).
|}

Unlike ShowError, this is fullscreen and not a dialog.

Profile Selector

2018-11-23T05:00:57Z

DarkLordZach: Describes the library applet interaction for the ProfileSelect applet

This is the UX presented when launching a game that allows the user to select a user.

The profile selector expects a two [[AM_services#IStorage|IStorage]] inputs and a single [[AM_services#IStorage|IStorage]] output.

The first IStorage is identical to [[Software_Keyboard#Common_Arguments|Common Arguments]] from swkbd.

== UserSelectionConfig ==

This has size 0xA0 and seems to only affect the UI display.
Typical value is all zero with byte 0x96 equal to 0x01

== Result ==

{| class="wikitable" border="1"
|-
! Offset || Size || Notes
|-
| 0x0 || 0x8 || Result (0 = Success, 2 = Failure)
|-
| 0x8 || 0x10 || UUID of selected user
|-
| 0x18 || || End of Struct
|}

== Usage ==

Homebrew should push a common arguments struct and the typical UserSelectionConfig struct as well.
After pushing in the data and calling start, homebrew should wait upon the PopOutDataEvent and then pop a single IStorage to obtain the result structure described above.

Nintendo Switch Brew - User contributions [en]

Error applet

Profile Selector