Edit

Share via

PartyXblLocalChatUser::GetRequiredChatPermissionInfo

  • Article

Gets the cached required chat permission information related to a target chat user.

Syntax

PartyError GetRequiredChatPermissionInfo(  
    const PartyXblChatUser* targetChatUser,  
    PartyXblChatPermissionInfo* chatPermissionInfo  
)

Parameters

targetChatUser   PartyXblChatUser*

The chat user for which permissions relative to the local chat user should be retrieved.

chatPermissionInfo   PartyXblChatPermissionInfo*
output

The output chat permission info object. The chat permission info object contains the most permissive chat permission possible while still respecting Xbox Live requirements.

Return value

PartyError

c_partyErrorSuccess if the call succeeded or an error code otherwise. The human-readable form of the error code can be retrieved via PartyXblManager::GetErrorMessage().

Requirements

Header: PartyXboxLive.h

See also

PartyXblLocalChatUser
PartyXblCreateLocalChatUserCompletedStateChange
PartyXblRequiredChatPermissionInfoChangedStateChange