PFEntityRegisterTokenExpiredEventHandler

Register a handler for EntityToken expired events.

Syntax

HRESULT PFEntityRegisterTokenExpiredEventHandler(  
    XTaskQueueHandle queue,  
    void* context,  
    PFEntityTokenExpiredEventHandler* handler,  
    PFRegistrationToken* token  
)  

Parameters

queue   XTaskQueueHandle
optional

The async queue the callback should be invoked on.

context   void*
optional

Optional pointer to data used by the event handler.

handler   PFEntityTokenExpiredEventHandler*

The event handler, XUserRegisterForChangeEvent.

token   PFRegistrationToken*
output

The token for unregistering this callback

Return value

Type: HRESULT

Result code for this API operation. Possible values are S_OK, E_PF_NOT_INITIALIZED, or E_FAIL.

Requirements

Header: PFEntity.h

See also

PFEntity members