Edit

PFEntityGetSecretKey

Gets the PlayFab secretKey associated with a title Entity. Will fail with E_PF_NOSECRETKEY if there is no Secret Key associated with the provided Entity.

Syntax

HRESULT PFEntityGetSecretKey(  
    PFEntityHandle handle,  
    size_t secretKeySize,  
    char* secretKey,  
    size_t* secretKeyUsed  
)  

Parameters

handle   PFEntityHandle

Entity handle.

secretKeySize   size_t

Size of the provided buffer. Required size can be obtained via PFServiceConfigGetSecretKeySize.

secretKey   char*
Out_writes(secretKeySize)

Buffer the secretKey will be written to.

secretKeyUsed   size_t*
optional output

The number of bytes used in the buffer including the null terminator.

Return value

Type: HRESULT

Result code for this API operation.

Requirements

Header: PFEntity.h

See also

PFEntity members