FRDU:GetFriendScreenName
Jump to navigation
Jump to search
Request[edit]
| Index Word | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| 0 |
| ||||||||
| 1 | Number of UTF16 characters the output screen names buffer can fit (maximum 0x800, corresponding to a total max buffer size of 0x1000) (Count * 11) | ||||||||
| 2 | Output Mii character sets buffer size (u8) (total max buffer size 0x800) | ||||||||
| 3 | Count | ||||||||
| 4 | bool, Mask non-ASCII characters (see description) | ||||||||
| 5 | bool, ProfanityFlag | ||||||||
| 6 | Descriptor for static buffer (id 0) | ||||||||
| 7 | Pointer to input FriendKey structures |
Request Static Buffers[edit]
The handler for this IPC command expects the following 0x100-bytes after the beginning of the above command buffer:
| Index Word | Description
|
|---|---|
| 0 | Descriptor for static buffer (id 0) |
| 1 | Pointer to output UTF-16 screen names (10 characters + null termination each) |
| 2 | Descriptor for static buffer (id 1) |
| 3 | Pointer to output Mii character sets |
Response[edit]
| Index Word | Description | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| 0 |
| ||||||||
| 1 | Result code | ||||||||
| 2 | Descriptor for static buffer (id 0) | ||||||||
| 3 | Pointer to output UTF-16 screen names | ||||||||
| 4 | Descriptor for static buffer (id 1) | ||||||||
| 5 | Pointer to output Mii character sets |
Description[edit]
Queries the Mii screen name for the provided friend keys.
Although optional, this command can also return the character set for the screen name of the Miis.
When ProfanityFlag is set, the entire screen name is set to question marks: ??????????.
When the system character set doesn't match that of the Mii and Mask non-ASCII characters is set to true, the friends module will replace every non-ASCII character with a question mark.
If an input friend key is not found in the friends list, an internal default placeholder friend entry is used to populate the data.