> ## Documentation Index
> Fetch the complete documentation index at: https://devdocs.xbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# XGameUiShowSendGameInviteAsync

> XGameUiShowSendGameInviteAsync

# XGameUiShowSendGameInviteAsync

此方法会显示一个从所选玩家的好友列表和推荐好友列表中填充的选择器 UI，用于发送游戏邀请。

## 语法

```cpp theme={null}
HRESULT XGameUiShowSendGameInviteAsync(  
         XAsyncBlock* async,  
         XUserHandle requestingUser,  
         const char* sessionConfigurationId,  
         const char* sessionTemplateName,  
         const char* sessionId,  
         const char* invitationText,  
         const char* customActivationContext  
)  
```

### 参数

*async*   \_In\_<br />类型：[XAsyncBlock\*](/reference/system/xasync/structs/xasyncblock)

指向传递给 [XAsyncRun](/reference/system/xasync/functions/xasyncrun) 的 [XAsyncBlock](/reference/system/xasync/structs/xasyncblock) 的指针。

*requestingUser*   \_In\_<br />类型：XUserHandle

发送邀请的用户的句柄。

*sessionConfigurationId*   \_In\_<br />类型：char\*

指定一个字符串，用于表明该游戏的服务配置 ID。

*sessionTemplateName*   \_In\_<br />类型：char\*

指定一个字符串，用于表明多人游戏会话模板的名称。

*sessionId*   \_In\_<br />类型：char\*

指定一个字符串，用于表明要邀请他人加入的多人游戏会话的 ID。

*invitationText*   \_In\_opt\_<br />类型：char\*

指定一个字符串，用于表明自定义邀请字符串 ID。<br />此字符串 ID 定义在 XBOX Live 服务配置中，用于标识除标准邀请文本之外的附加邀请文本。ID 字符串必须以 “///” 作为前缀。如果不希望在邀请中添加自定义字符串，请传入空字符串。

*customActivationContext*   \_In\_opt\_<br />类型：char\*

在邀请的激活 URI 中提供给受邀者的自定义激活上下文。自定义激活上下文字符串必须是 URL 安全的，二进制内容应使用 URL 安全的 base64 编码。最大长度为 160 个字符。

### 返回值

类型：HRESULT

异步调用的 HRESULT 成功或错误代码。

## 备注

列表填充完成后，即可选择玩家。玩家可以向选择器 UI 中选中的个人发送邀请，共同游玩指定游戏会话并/或加入队伍语音聊天。

调用 UI 会使你的游戏进入 *受限模式*。在受限模式下，你的游戏在处于所调用 UI 的后台时将获得较少的系统资源。若要详细了解受限模式以及游戏的其他运行模式，请阅读 [XBOX 游戏生命周期（NDA 主题）](/build/console-features/console-workflows/xbox-game-life-cycle)。

## 要求

**标头：** XGameUI.h

**库：** xgameruntime.lib

**支持的平台：** Windows、Steam Deck、XBOX One 系列主机和 XBOX Series 主机

## 概念文档

* [异步编程的设计目标与改进](/build/core-features/common/async/async-whitepaper)
* [发送邀请](/services/xbox-services/multiplayer/invites/how-to/live-invites-send)

## 请参阅

[XGameUI](/reference/system/xgameui/xgameui_members)<br />[XGameUiShowSendGameInviteResult](/reference/system/xgameui/functions/xgameuishowsendgameinviteresult)<br />[XBOX 游戏生命周期（NDA 主题）](/build/console-features/console-workflows/xbox-game-life-cycle)


## Related topics

- [XGameUiShowSendGameInviteUiCallback](/zh-CN/reference/system/xgameui/functions/xgameuishowsendgameinviteuicallback.md)
- [XGameUiSetSendGameInviteUiResponse](/zh-CN/reference/system/xgameui/functions/xgameuisetsendgameinviteuiresponse.md)
- [XGameUiUiCallbacks](/zh-CN/reference/system/xgameui/structs/xgameuiuicallbacks.md)
- [从 MPSD 迁移到 PlayFab Multiplayer 和 MPA](/zh-CN/services/xbox-services/multiplayer/mpsd/concepts/live-mpsd-to-mlp.md)
- [XGameUI](/zh-CN/reference/system/xgameui/xgameui_members.md)