PFEntityGetEntityKey

Get the PFEntityKey for an entity.

Syntax

HRESULT PFEntityGetEntityKey(  
    PFEntityHandle entityHandle,  
    size_t bufferSize,  
    void* buffer,  
    const PFEntityKey** entityKey,  
    size_t* bufferUsed  
)  

Parameters

entityHandle   PFEntityHandle

PFEntityHandle returned from a auth call.

bufferSize   size_t

The size of the buffer for the PFEntityKey. The required size can be obtained from PFEntityGetEntityKeySize.

buffer   void*
*Out_writes_bytes_to(bufferSize,bufferUsed)

Byte buffer used for the PFEntityKey and its fields.

entityKey   PFEntityKey**
library-allocated output

TBD

bufferUsed   size_t*
optional output

The number of bytes in the provided buffer that were used.

Return value

Type: HRESULT

Result code for this API operation.

Remarks

entityKey is a pointer within buffer and does not need to be freed separately.

Requirements

Header: PFEntity.h

See also

PFEntity members