> ## 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](/reference/live/xsapi-c/multiplayer_c/handles/xblmultiplayersessionhandle)

多人游戏会话的句柄。

*roleTypeName*   \_In\_z\_\
类型: char\*

角色所属角色类型的名称。

*roleName*   \_In\_z\_\
类型: char\*

角色的名称。

*role*   \_Out\_\
类型: [XblMultiplayerRole\*\*](/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](/reference/live/xsapi-c/multiplayer_c/multiplayer_c_members)


## Related topics

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