PFLobbyAddMember
将本地用户作为成员添加到大厅。
语法
HRESULT PFLobbyAddMember(
PFLobbyHandle lobby,
const PFEntityKey* localUser,
uint32_t memberPropertyCount,
const char* const* memberPropertyKeys,
const char* const* memberPropertyValues,
void* asyncContext
)
参数
lobby
PFLobbyHandle
大厅的句柄。
localUser
PFEntityKey*
要作为成员添加到大厅的本地用户的 PlayFab 实体密钥。
memberPropertyCount
uint32_t
范围内的输入 0,PFLobbyMaxMemberPropertyCount
加入大厅时要为此用户设置的初始成员属性数。
memberPropertyKeys
char* const*
大小的输入数组memberPropertyCount
加入大厅时要为此用户设置的初始成员属性的键。
memberPropertyValues
char* const*
大小的输入数组memberPropertyCount
加入大厅时要为此用户设置的初始成员属性的值。
asyncContext
void*
可选
一个可选应用定义的指针大小的上下文值,可用于将完成状态更改与此调用关联起来。
返回值
类型:HRESULT
如果调用成功,则为 S_OK
,否则为错误代码。 可通过 PFMultiplayerGetErrorMessage() 检索错误代码的可读形式。
备注
这是一个异步操作。 成功完成后,将向游戏提供 PFLobbyMemberAddedStateChange 后跟 PFLobbyAddMemberCompletedStateChange,PFLobbyAddMemberCompletedStateChange::result 字段设置为 S_OK
。 完成失败后,将向游戏提供 PFLobbyAddMemberCompletedStateChange,PFLobbyAddMemberCompletedStateChange::result 字段设置为失败 hresult。
此方法用于将另一个本地 PlayFab 实体添加到预先存在的大厅对象。 由于必须已通过调用 PFMultiplayerCreateAndJoinLobby 或 PFMultiplayerJoinLobby 创建了大厅对象,因此此方法主要适用于多个本地用户应用场景。
这是一个异步操作。 在异步操作成功完成并且由 PFMultiplayerStartProcessingLobbyStateChanges 提供 PFLobbyMemberAddedStateChange
结构之前,通过此方法添加的成员将不会反映在 PFLobbyGetMembers 返回的列表中。
要求
标头: PFLobby.h