NWC24ReadFriendInfo

C Specification

#include <revolution/nwc24.h>
NWC24Err NWC24ReadFriendInfo( NWC24FriendInfo* info, u32 index );

Description

Gets the information from the nth position in the console Friend Roster, where n = index.

Note: Friend information is not necessarily always stored in order starting from the 0th index.

Arguments

info The NWC24FriendInfo structure that holds the information to be gotten. (Must be 32-byte aligned.)
index The Friend Roster index.

Return Values

NWC24_OK: Retrieved normally.
NWC24_ERR_NULL: No data registered in the location of the specified index.
NWC24_ERR_ALIGNMENT: The info data is not 32-byte aligned.
NWC24_ERR_INVALID_VALUE: The index value is invalid.
NWC24_ERR_LIB_NOT_OPENED: Library not open.
NWC24_ERR_FILE_*: File access error.
NWC24_ERR_BROKEN: Friend roster broken.
NWC24_ERR_VER_MISMATCH: Friend roster version error.

See Also

NWC24WriteFriendInfo, NWC24UpdateFriendInfo, NWC24DeleteFriendInfo, NWC24SearchFriendInfoById, NWC24IsFriendInfoThere

Revision History

2007/03/15 Added a note of caution.
2007/02/23 Corrected errors.
2006/10/06 Updated the list of return values.
2006/09/01 Initial version.


CONFIDENTIAL