RegisterAgent or RegisterAgentVer2

RegisterAgent for version 1 or RegisterAgentVer2 for version 2 supply the client with the functions required to work with the Authentication Agent.

RegisterAgentVer2

Prototype

Copy

int RegisterAgentVer2(int* version,
UserNameProcType* usernameProc,
UserNameAndPasswordVer2ProcType* usernameAndPasswordVer2Proc,
ResponseProcType* responseProc,
GoingDownProcType* goingdownProc,
AuthCompletedProcType* authCompletedProc,
ReleaseContextProcType* releaseContextProc,
InvalidateProcType invalidateProcCB)

Arguments

Argument	In/Out	Meaning
version	In	The version number of the API supported by the client is 2.
Out	The version number of the API supported by the Authentication Agent is 2.
usernameProc	Out	The address of the Authentication Agent's `UserName` function.
usernameAndPasswordVer2Proc	Out	The address of the Authentication Agent's `UserNameAndPasswordVer2` function.
responseProc	Out	The address of the Authentication Agent's `Response` function.
goingdownProc	Out	The address of the Authentication Agent's `GoingDown` function.
authCompletedProc	Out	The address of the Authentication Agent's `AuthCompleted` function.
releaseContextProc	Out	The address of the Authentication Agent's `ReleaseContext` function.
invalidateProcCB	In	The address of the client callback function that invalidates previous authentication information. The Authentication Agent might call this function to force reauthentication.

Return Values

PLUGIN_OK if successful.

PLUGIN_ABORT if the specified version of the client is not supported.

RegisterAgent

Prototype

Copy

int RegisterAgent( int *version,
UserNameProcType *Username,
UserNameAndPasswordProcType *usernameAndPassword,
ResponseProcType *Response,
TerminateProcType *Terminate,
GoingDownProcType *Goingdown,
InvalidateProcType InvalidateProcCB )

Arguments

Argument	In/Out	Meaning
version	In	The version number of the API supported by the client is 1.
Out	The version number of the API supported by the Authentication Agent is 1.
Username	Out	The address of the Authentication Agent's `UserName` function.
usernameAndPassword	Out	The address of the Authentication Agent's `UserNameAndPassword` function.
Response	Out	The address of the Authentication Agent's `Response` function.
Terminate	Out	The address of the Authentication Agent's `Terminate` function.
Goingdown	Out	The address of the Authentication Agent's `GoingDown` function.
invalidateProcCB	In	The address of the client callback function that invalidates previous authentication information. The Authentication Agent might call this function to force reauthentication.

Return Values

PLUGIN_OK if successful.
PLUGIN_ABORT if the specified version of the client is not supported.