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

# PFEntityGetSecretKey

> 获取与标题实体关联的 PlayFab secretKey。如果所提供实体没有关联的 Secret Key，则失败并返回 E_PF_NOSECRETKEY。

获取与标题实体关联的 PlayFab secretKey。如果所提供实体没有关联的 Secret Key，则失败并返回 E\_PF\_NOSECRETKEY。

## 语法

```cpp theme={null}
HRESULT PFEntityGetSecretKey(  
    PFEntityHandle handle,  
    size_t secretKeySize,  
    char* secretKey,  
    size_t* secretKeyUsed  
)  
```

### 参数

**`handle`**   PFEntityHandle

实体句柄。

**`secretKeySize`**   size\_t

所提供缓冲区的大小。所需大小可通过 PFServiceConfigGetSecretKeySize 获取。

**`secretKey`**   char\*<br />*Out\_writes(secretKeySize)*

将写入 secretKey 的缓冲区。

**`secretKeyUsed`**   size\_t\*<br />*可选输出*

缓冲区中已使用的字节数，包括 null 终止符。

### 返回值

类型：HRESULT

此 API 操作的结果代码。

## 要求

**头文件：** PFEntity.h

## 另请参阅

[PFEntity 成员](/services/playfab/api-references/c/pfentity/pfentity_members)


## Related topics

- [实体句柄](/zh-CN/services/playfab/sdks/c/entity-handles.md)
- [Services C API overview - PFEntity.h](/zh-CN/services/playfab/api-references/c/pfentity/pfentity_members.md)
- [PFEntityGetSecretKeySize](/zh-CN/services/playfab/api-references/c/pfentity/functions/pfentitygetsecretkeysize.md)
- [PFAuthenticationGetEntityWithSecretKeyGetResult](/zh-CN/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationgetentitywithsecretkeygetresult.md)
- [PFAuthenticationGetEntityWithSecretKeyAsync](/zh-CN/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationgetentitywithsecretkeyasync.md)