nn::friends::CTR Namespace

Description

The CTR FRIENDS namespace.
(This namespace can also be written without the ::CTR portion.)

Enumerated Types

PlatformCode Enumerated type representing platform types.
AttributeFlag Enumerated type representing friend relationships using attribute flags.
NotificationType Enumerated type representing notification types.
NotificationMask Enumerated type representing notification bitmasks.

typedef Definitions

PrincipalId Represents a principal ID.
LocalFriendCode Represents a local friend code.
FriendKey Structure for comprehensively handling users' principal IDs and local friend codes.
Profile Structure storing a user's profile information.
MiiData Structure storing Mii data.
GameMode Structure storing information about the game the local host is currently playing. This information is required for friends to join in.
MyPresence Structure storing the local user's presence information.
FriendPresence Structure storing friend presence information.
EventNotification Structure storing notifications of changes in the local host's online state and friends' online states.

Constants

S INVALID_PRINCIPAL_ID Invalid principal ID.
S INVALID_LOCAL_FRIEND_CODE Invalid local friend code.
S SCREEN_NAME_SIZE The number of elements in the buffer for the screen name. Includes the terminating character.
S MODE_DESCRIPTION_SIZE The number of elements in the buffer for the game mode description string. Includes the terminating character.
S MII_SIZE The size of the Mii character binary data.
S FRIEND_LIST_SIZE The size of the friend list. This is the maximum number of users that can be registered to the friend list.

Functions

Initialize Initializes the friend presence library and makes the presence features available for use.
Finalize Finalizes the friend presence library.
IsInitialized Checks whether the friend presence library is initialized.
HasLoggedIn Checks one's own login status.
Login Requests a login to the server.
Logout Retracts a login request to a server.
GetMyPrincipalId Gets the local host's principal ID.
GetMyPreference Gets the disclosure level of the local host's information.
GetMyProfile Gets the local host's profile information.
GetMyPresence Gets the local host's presence information.
GetMyScreenName Obtains the user's own screen name.
GetMyMii Gets the user's own Mii data.
GetFriendKeyList Gets a list of the friend keys registered in the friend list.
GetFriendPresence Gets a list of friend presence information.
GetFriendScreenName Gets a list of friend screen names.
GetFriendMii Gets a list of friends' Mii data.
GetFriendProfile Gets a list of friends' profile information.
GetFriendAttributeFlags Gets a list of friend relationships.
UnscrambleLocalFriendCode Decodes a friend's encoded local friend code.
UpdateGameModeDescription Updates the game mode description string.
AttachToEventNotification Specifies an event that notifies of changes in the local host's login state and friends' login states.
SetNotificationMask Specifies the type of notification received.
GetEventNotification Gets the history of notifications of changes in the local user's online state and/or friends' online states.
GetLastResponseResult Gets the result of the completed asynchronous operation.
ResultToErrorCode Gets an error code from a friend presence library function result.

Revision History

2010/08/16
Initial version.

CONFIDENTIAL