> ## 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.

# XUserGetGamertag

> XUserGetGamertag

# XUserGetGamertag

擷取特定使用者的玩家代號。

## 語法

```cpp theme={null}
HRESULT XUserGetGamertag(  
         XUserHandle user,
         XUserGamertagComponent gamertagComponent,
         size_t gamertagSize,  
         char* gamertag,  
         size_t* gamertagUsed  
)  
```

### 參數

*user*   \_In\_\
類型：XUserHandle

要擷取其玩家代號之使用者的控制代碼。

*gamertagComponent*   \_In\_\
類型：[XUserGamertagComponent](/zh-TW/reference/system/xuser/enums/xusergamertagcomponent)

要擷取的玩家代號類型。

*gamertagSize*   \_In\_\
類型：size\_t

*gamertag* 參數中緩衝區的大小 (以位元組為單位)。

*gamertag*   \_Out\_writes\_bytes\_to\_(gamertagSize,*gamertagUsed)\
類型：char*

包含特定使用者的玩家代號。

*gamertagUsed*   \_Out\_opt\_\
類型：size\_t\*

包含用於存放玩家代號的緩衝區用量。

### 傳回值

類型：HRESULT

HRESULT 成功或錯誤碼。

| 傳回碼 | 描述 |
| - | - |
| S\_OK | 作業成功。 |
| E\_GAMEUSER\_RESOLVE\_USER\_ISSUE\_REQUIRED | 使用者必須使用 UI 來解決問題。請呼叫 [XUserResolveIssueWithUiAsync](/zh-TW/reference/system/xuser/functions/xuserresolveissuewithuiasync) 向使用者顯示 UI。 |
| E\_INSUFFICIENT\_BUFFER | *gamertagSize* 所指示的緩衝區大小不足以容納所要求的元件。 |
| E\_INVALIDARG | 提供的 *gamertagComponent* 無效。 |

如需錯誤碼清單，請參閱[錯誤碼](/zh-TW/reference/errorcodes)。

## 備註

若要擷取特定使用者的使用者識別碼，請呼叫 [XUserGetId](/zh-TW/reference/system/xuser/functions/xusergetid)。

若要擷取特定使用者的狀態，請呼叫 [XUserGetState](/zh-TW/reference/system/xuser/functions/xusergetstate)。

若要擷取特定使用者的年齡層，請呼叫 [XUserGetAgeGroup](/zh-TW/reference/system/xuser/functions/xusergetagegroup)。

## 需求

**標頭：** XUser.h

**程式庫：** xgameruntime.lib

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

## 另請參閱

[XUser](/zh-TW/reference/system/xuser/xuser_members)

[XUserGetId](/zh-TW/reference/system/xuser/functions/xusergetid)

[XUserGetState](/zh-TW/reference/system/xuser/functions/xusergetstate)

[XUserGetAgeGroup](/zh-TW/reference/system/xuser/functions/xusergetagegroup)


## Related topics

- [XUserGetGamertag](/reference/system/xuser/functions/xusergetgamertag.md)
- [XUserGamertagComponent](/reference/system/xuser/enums/xusergamertagcomponent.md)