nn::friends::CTR::UpdateGameModeDescription FunctionResult UpdateGameModeDescription( const char16 description[MODE_DESCRIPTION_SIZE] );
| Name | Description | |
|---|---|---|
| in | description[MODE_DESCRIPTION_SIZE] | Specifies a game mode description string. |
| Value | Description |
|---|---|
| Result::IsSuccess | Succeeded. |
ResultRmcNotCalled |
Succeeded. Due to connection status and limitations of frequency of sending data, however, notification to the server and friends is delayed. |
| ResultInvalidPointer | Invalid pointer passed as argument. |
| ResultNotInitialized | The friend presence library is not initialized. |
| Other | Another result may be returned, depending on the internal state of the daemon and other factors. |
Updates the game mode description string.
The string configured here is sent to friends when you are online and is displayed in their friend lists.
If the configured string is simply displayed in their friend lists, you do not need to call the nn::friends::CTR::Login function in advance. Even if the string is updated while the system is offline, it is automatically sent by the presence feature as appropriate after the system can go online, as long as background operations have not been suspended by the nn::ndm::Suspend, nn::ndm::SuspendDaemons, or nn::ndm::SuspendScheduler function. The size of the string that is passed to the argument can be as large as nn::friends::CTR::MODE_DESCRIPTION_SIZE characters, including newline and terminating characters, but the friend list is limited to the display of 16 double-byte characters x 2 lines, and anything exceeding that is cut off and not displayed.
The strings that are displayed on other players' friend lists have the following relationship with the system region.
Japan, the Americas, and Europe: The characters for Japan, the Americas, and Europe included in the internal fonts.
China: Simplified Chinese characters included in the internal fonts.
Korea: Hangul characters included in the internal fonts.
Taiwan: Traditional Chinese characters included in the internal fonts.
Characters that are not included here are replaced with the Nintendo extended character "?" (L'\xE011') for display. For details about the character sets included in each font, see the CTR Overview.
For newlines, use L'\n'.
This function will not change the game mode specified to the nn::friends::CTR::UpdateGameMode function.
Follow the guidelines when determining how often to call this function.
nn::friends::CTR::Login function in advance.CONFIDENTIAL