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 that 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 function. The AREAVerifyLoginCallback call returns a pointer to the response structure as a parameter.

Here, in order to be thread-safe, the plug-in must protect any global information or resources accessed with appropriate mutual exclusion locks.

An AREA plug-in implementation must return a response. A NULL response indicates a failed login attempt.

Important

For a response from an AREA plug-in implementation, you must only free all the allocated storage.

For example:

If you get the response data from a prebuilt cache constructed during initialization, do not free the storage.

If you do not get the data from a prebuilt cache, you should deallocate response data.

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 returned.