AREAFreeCallback
Description
This optional function frees the data associated with the AREAResponseStruct
, which the AREAVerifyLoginCallback
function returns. Although the plug-in server normally frees the storage that other API calls return, it does not free the storage that this API call returns. Instead, the plug-in server calls this function so the plug-in can deallocate the storage. This allows the plug-in to cache information, if needed.
The plug-in server calls this function after it calls the AREAVerifyLoginCallback
call. The AREAVerifyLoginCallback
call returns a pointer to the response structure as a parameter.
To be thread-safe, your plug-in must protect any global information or resources accessed here with appropriate mutual exclusion locks.
An AREA plug-in implementation must return a response. A NULL
response indicates a failed login attempt.
Important
You must free whatever storage is allocated for the purpose of this response only. For example, if you get the response data from a prebuilt cache constructed during initialization, you do not free anything here. If you do not get the data from a prebuilt cache, you should deallocate response data here.
Synopsis
#include "area.h"
int AREAFreeCallback(
void *object,
AREAResponseStruct *response)
Input arguments
object
Pointer to the plug-in instance that the call to ARPluginCreateInstance
returned.
response
Pointer to the response structure that the call to AREAVerifyLoginCallback
returns.
Comments
Log in or register to comment.