PFMultiplayerStartListeningForLobbyInvites

为给定实体启用大厅邀请侦听器。

语法

HRESULT PFMultiplayerStartListeningForLobbyInvites(  
    PFMultiplayerHandle handle,  
    const PFEntityKey* listeningEntity  
)  

参数

handle PFMultiplayerHandle

PFMultiplayer API 实例的句柄。

listeningEntityPFEntityKey*

将侦听邀请的实体。

返回值

类型:HRESULT

如果调用成功,则为 S_OK,否则为错误代码。 可通过 PFMultiplayerGetErrorMessage() 检索错误代码的可读形式。

备注

此操作将代表提供的实体以同步方式开始侦听邀请。 收到邀请后,将通过 PFLobbyInviteReceivedStateChange 结构提供邀请。 当邀请侦听器的状态更改时,将通过 PFLobbyInviteListenerStatusChangedStateChange 结构提供通知。

仅在此客户端上接收侦听器启动后发送的邀请。 当此侦听器处于非活动状态时发送的邀请将不会排队。

默认情况下,所有实体均禁用邀请侦听功能。 应为游戏要接收大厅邀请的每个本地实体调用此方法。

大厅邀请和此邀请侦听器与平台邀请机制无关,不受平台邀请机制的影响。

仅当尚未为给定实体启用大厅邀请侦听器时,才能调用此方法。

要求

标头: PFLobby.h

另请参阅

PFLobby 成员