GetEventNotification

nn::friends::CTR::GetEventNotification Function

Syntax

u32 GetEventNotification(
     EventNotification * pEventNotificationList,
     size_t size = 1,
     bool * pHasOverflowed = NULL
);

Parameters

Name Description
out pEventNotificationList Specifies a pointer to a buffer storing the content of the obtained notifications.
in size Specifies the number of elements in the buffer.
out pHasOverflowed Specifies a pointer to a buffer that stores whether there has been notification that there was an overflow without acquisition. Specify NULL if not needed.

Return Values

Returns the number of notifications actually obtained.

Description

Gets the history of notifications of changes in the local user's online state and/or friends' online states.

Use this function to get the content of notifications that had not yet been obtained, in order from oldest to newest. To get backlogged notifications in chronological order, call this function repeatedly until the return value is 0.

The library can save up to 128 notifications. If there are already 128 notifications saved and another is received, the oldest is discarded. The number of notifications saved might change in future.

Revision History

2011/03/11
Added specific examples of return values.
2010/08/16
Initial version.

CONFIDENTIAL