PFLobbyForceRemoveMember
强制从大厅中删除实体。
语法
HRESULT PFLobbyForceRemoveMember(
PFLobbyHandle lobby,
const PFEntityKey* targetMember,
bool preventRejoin,
void* asyncContext
)
参数
lobby
PFLobbyHandle
大厅的句柄。
targetMember
PFEntityKey*
要强制删除的成员。
preventRejoin
布尔
一个标志,指示是否targetMember
在删除后阻止其重新加入大厅。
asyncContext
void*
可选
一个可选应用定义的指针大小的上下文值,可用于将完成状态更改与此调用关联起来。
返回值
类型:HRESULT
如果调用成功,则为 S_OK
,否则为错误代码。 可通过 PFMultiplayerGetErrorMessage() 检索错误代码的可读形式。
备注
这是一个异步操作。 成功完成后,将向游戏提供 PFLobbyMemberRemovedStateChange 后跟 PFLobbyForceRemoveMemberCompletedStateChange,PFLobbyForceRemoveMemberCompletedStateChange::result 字段设置为 S_OK
。 完成失败后,将向游戏提供 PFLobbyForceRemoveMemberCompletedStateChange,PFLobbyForceRemoveMemberCompletedStateChange::result 字段设置为失败 hresult。
此大厅中存在的本地 PlayFab 实体之一必须是此操作成功的所有者。 如果启动此操作的本地拥有实体在操作进行时失去其所有权状态,则该操作将异步失败。
这是一个异步操作。 在异步操作成功完成并且由 PFMultiplayerStartProcessingLobbyStateChanges 提供 PFLobbyMemberRemovedStateChange
结构之前,不会从 PFLobbyGetMembers返回的列表中删除通过此方法删除的成员。
要求
标头: PFLobby.h