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

# PartyLocalChatControl::SendText

> 向每个指定的目标聊天控件传输聊天文本字符串。

向每个指定的目标聊天控件传输聊天文本字符串。

## Syntax

```cpp theme={null}
PartyError SendText(  
    uint32_t targetChatControlCount,  
    PartyChatControlArray targetChatControls,  
    PartyString chatText,  
    uint32_t dataBufferCount,  
    const PartyDataBuffer* dataBuffers  
)  
```

### Parameters

**`targetChatControlCount`**   uint32\_t

`targetChatControls` 数组中目标聊天控件的数量。

**`targetChatControls`**   [PartyChatControlArray](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/typedefs.md)\
*input array of size `targetChatControlCount`*

目标 PartyChatControls 的 `targetChatControlCount` 条目数组。

**`chatText`**   [PartyString](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/typedefs.md)

要发送的文本。

**`dataBufferCount`**   uint32\_t

`dataBuffers` 数组中提供的缓冲区结构的数量。

**`dataBuffers`**   [PartyDataBuffer\*](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/structs/partydatabuffer.md)\
*input array of size `dataBufferCount`*

描述要发送的辅助消息负载的 PartyDataBuffer 结构的 `dataBufferCount` 条目数组。当 `dataBufferCount` 为零时将忽略此参数。

### Return value

PartyError

如果调用成功，则返回 `c_partyErrorSuccess`；否则返回错误代码。可通过 [PartyManager::GetErrorMessage()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyManager/methods/partymanager_geterrormessage.md) 检索错误代码的可读形式。

## Remarks

当前不支持向本地聊天控件发送聊天文本。如果目标聊天控件数组包含任何本地目标，则此调用将同步失败。\
\
 对文本内容没有保证的翻译、本地化或攻击性语言过滤；聊天文本字符串将按原样显示。   \
\
 文本字符串仅会传送给已通过 [PartyLocalChatControl::SetPermissions()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_setpermissions.md) 配置其自身实例以接收来自本地聊天控件的文本消息的目标聊天控件。   \
\
 如果目标聊天控件未与源聊天控件连接到至少一个共同的网络，则文本字符串将不会被传送。这在存在两个本地聊天控件时是可能的。连接到其中一个本地聊天控件的目标聊天控件可能未连接到所有其他本地聊天控件。   \
\
 `dataBuffers` 数组中的 PartyDataBuffer 结构用于与聊天文本关联的辅助数据，例如指示应用于呈现文本的颜色的元数据，或包含要与聊天文本一起呈现的图标的图像数据的二进制 blob。要发送与文本聊天无关的游戏数据，请参见 [PartyLocalEndpoint::SendMessage()](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyLocalEndpoint/methods/partylocalendpoint_sendmessage.md)，它是一个消息选项，可以对消息传输行为进行更精细的控制。   \
\
 调用方在 `dataBuffers` 数组中提供 0 个或多个 PartyDataBuffer 结构。这些结构引用的内存不必是连续的，因此可以轻松地实现例如一个固定的头部缓冲区后跟一个可变的负载。缓冲区将按顺序组装、传输，并作为单个连续的数据块（与聊天文本分开）在 [PartyChatTextReceivedStateChange](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/structs/partychattextreceivedstatechange.md) 中传递给目标聊天控件。Party 库不会花费带宽来传输描述原始 PartyDataBuffer 分段的元数据。

## Requirements

**Header:** Party.h

## See also

[PartyLocalChatControl](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/partylocalchatcontrol.md)\
[PartyChatTextReceivedStateChange](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/structs/partychattextreceivedstatechange.md)


## Related topics

- [PartyChatTextReceivedStateChange](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/structs/partychattextreceivedstatechange.md)
- [了解 PlayFab Party 聊天的工作原理](https://docs.xbox.com/zh-CN/services/playfab/community/voice-communications/concepts-chat.md)
- [PartyLocalChatControl](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/partylocalchatcontrol.md)
- [PartyLocalChatControl::SetPermissions](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_setpermissions.md)
- [PartyLocalChatControl::PopulateAvailableTextToSpeechProfiles](https://docs.xbox.com/zh-CN/services/playfab/multiplayer/networking/reference/classes/PartyLocalChatControl/methods/partylocalchatcontrol_populateavailabletexttospeechprofiles.md)