> ## 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\*](/zh-TW/reference/system/xasync/structs/xasyncblock)

指向傳遞給 [XAsyncRun](/zh-TW/reference/system/xasync/functions/xasyncrun) 之 [XAsyncBlock](/zh-TW/reference/system/xasync/structs/xasyncblock) 的指標。

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

發送邀請之使用者的控制代碼。

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

指定表示遊戲之服務設定識別碼的字串。

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

指定表示多人遊戲工作階段範本名稱的字串。

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

指定表示要邀請人員加入之多人遊戲工作階段識別碼的字串。

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

指定表示自訂邀請字串識別碼的字串。<br />此字串識別碼定義於 XBOX Live 服務設定中，用來識別標準邀請文字之外的額外邀請文字。識別碼字串必須以 "///" 作為前置詞。如果您不想在邀請中加入自訂字串，請傳遞空字串。

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

受邀者可在邀請的啟用 URI 中取得的自訂啟用內容。自訂啟用內容字串必須是 URL 安全的，且二進位內容應以 URL 安全的 base64 編碼方式進行編碼。長度上限為 160 個字元。

### 傳回值

類型：HRESULT

非同步呼叫的 HRESULT 成功或錯誤碼。

## 備註

清單填入之後即可選取玩家。玩家可以針對指定的遊戲工作階段，向在選擇器 UI 中選取的人員發送遊戲邀請和/或派對聊天邀請。

呼叫 UI 會讓您的遊戲進入 *受限模式*。在受限模式下，當您的遊戲位於所呼叫 UI 的背景時，會獲得較少的系統資源。若要深入了解受限模式及遊戲的其他作業模式，請參閱 [XBOX 遊戲生命週期 (NDA 主題)](/zh-TW/build/console-features/console-workflows/xbox-game-life-cycle)。

## 需求

**標頭：** XGameUI.h

**程式庫：** xgameruntime.lib

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

## 概念文件

* [非同步程式設計的設計目標與改進](/zh-TW/build/core-features/common/async/async-whitepaper)
* [傳送邀請](/zh-TW/services/xbox-services/multiplayer/invites/how-to/live-invites-send)

## 另請參閱

[XGameUI](/zh-TW/reference/system/xgameui/xgameui_members)<br />[XGameUiShowSendGameInviteResult](/zh-TW/reference/system/xgameui/functions/xgameuishowsendgameinviteresult)<br />[XBOX 遊戲生命週期 (NDA 主題)](/zh-TW/build/console-features/console-workflows/xbox-game-life-cycle)


## Related topics

- [XGameUiShowSendGameInviteAsync](/reference/system/xgameui/functions/xgameuishowsendgameinviteasync.md)
- [XGameUiShowSendGameInviteUiCallback](/reference/system/xgameui/functions/xgameuishowsendgameinviteuicallback.md)