> ## 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。如果沒有與所提供實體相關聯的祕密金鑰，將會失敗並傳回 E_PF_NOSECRETKEY。

取得與遊戲實體相關聯的 PlayFab secretKey。如果沒有與所提供實體相關聯的祕密金鑰，將會失敗並傳回 E\_PF\_NOSECRETKEY。

## 語法

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

### 參數

**`handle`**   PFEntityHandle

實體控制代碼。

**`secretKeySize`**   size\_t

所提供緩衝區的大小。所需大小可透過 PFEntityGetSecretKeySize 取得。

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

secretKey 將寫入的緩衝區。

**`secretKeyUsed`**   size\_t\*<br />*optional output*

緩衝區中已使用的位元組數目，包括 null 結束字元。

### 傳回值

類型：HRESULT

此 API 作業的結果代碼。

## 需求

**標頭：** PFEntity.h

## 另請參閱

[PFEntity 成員](/zh-TW/services/playfab/api-references/c/pfentity/pfentity_members)


## Related topics

- [實體控制代碼](/zh-TW/services/playfab/sdks/c/entity-handles.md)
- [服務 C API 概觀 - PFEntity.h](/zh-TW/services/playfab/api-references/c/pfentity/pfentity_members.md)
- [PFEntityGetSecretKeySize](/zh-TW/services/playfab/api-references/c/pfentity/functions/pfentitygetsecretkeysize.md)
- [PFAuthenticationGetEntityWithSecretKeyGetResult](/zh-TW/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationgetentitywithsecretkeygetresult.md)
- [PFAuthenticationGetEntityWithSecretKeyAsync](/zh-TW/services/playfab/api-references/c/pfauthentication/functions/pfauthenticationgetentitywithsecretkeyasync.md)