IsJoinable

nnfriendsFriendPresence::IsJoinable Member Function

Syntax

bool IsJoinable(
bit64 joinGameModeMask
) const;

Arguments

Name Description
in joinGameModeMask Specifies the bitmask for the game modes that the local system can join. The least significant bit indicates mode 0, and the most significant bit indicates mode 63.

Return Values

Returns true if the local system can participate in the communication partner's matchmaking group, and false otherwise.

The function always returns false if the library is uninitialized even though the participation is allowed.

Description

Checks if the local system is allowed to join a matchmaking group that a communication partner system is participating in.

When attempting to join a matchmaking group that a friend is participating in, first call this function to find out if a partner allows you to join that group.

This function only returns true(allowed) when the partner's join-in game ID is the same as the local system's.

The results of this function are no guarantee that the local system can successfully join. The application must also handle the results of actually attempting to join.


CONFIDENTIAL