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

# XblMultiplayerSessionGetRoleByName

> XblMultiplayerSessionGetRoleByName

# XblMultiplayerSessionGetRoleByName

依角色類型名稱和角色名稱擷取 XblMultiplayerRole 物件。

## 語法

```cpp theme={null}
HRESULT XblMultiplayerSessionGetRoleByName(  
         XblMultiplayerSessionHandle handle,  
         const char* roleTypeName,  
         const char* roleName,  
         const XblMultiplayerRole** role  
)  
```

### 參數

*handle*   \_In\_\
類型：[XblMultiplayerSessionHandle](/zh-TW/reference/live/xsapi-c/multiplayer_c/handles/xblmultiplayersessionhandle)

多人遊戲工作階段的控制代碼。

*roleTypeName*   \_In\_z\_\
類型：char\*

角色所屬角色類型的名稱。

*roleName*   \_In\_z\_\
類型：char\*

角色的名稱。

*role*   \_Out\_\
類型：[XblMultiplayerRole\*\*](/zh-TW/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayerrole)

傳回包含角色相關資訊之角色物件的指標。指標的記憶體在 XblMultiplayerSessionHandle 物件的生命週期內保持有效，直到其關閉為止。如果沒有此類角色，將會傳回 nullptr。

### 傳回值

類型：HRESULT

此 API 作業的 HRESULT 傳回碼。

## 備註

請注意，在呼叫 XblMultiplayerWriteSessionAsync 之前，新建立的工作階段不會填入角色資訊。

## 需求

**標頭：** multiplayer\_c.h

**程式庫：** Microsoft.Xbox.Services.14x.GDK.C.lib

## 另請參閱

[multiplayer\_c](/zh-TW/reference/live/xsapi-c/multiplayer_c/multiplayer_c_members)


## Related topics

- [XblMultiplayerSessionMemberRole](/zh-TW/reference/live/xsapi-c/multiplayer_c/structs/xblmultiplayersessionmemberrole.md)
- [XblMultiplayerSessionSetMutableRoleSettings](/zh-TW/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionsetmutablerolesettings.md)
- [XblMultiplayerSessionRoleTypes](/zh-TW/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessionroletypes.md)
- [XblMultiplayerSessionCurrentUserSetRoles](/zh-TW/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessioncurrentusersetroles.md)
- [XblMultiplayerSessionGetInfo](/zh-TW/reference/live/xsapi-c/multiplayer_c/functions/xblmultiplayersessiongetinfo.md)