Terminate

For version 1.

The Client calls Terminate when authentication is complete or when a password has expired or been erased by the user. In response, the Authentication Agent might release allocated resources and notify the user of the results of the authentication.

Prototype

Copy

int Terminate(void *context, int status, char *message);

Arguments

Argument	In/Out	Meaning
context	In	The context as provided by `Username`or `UsernameAndPassWord.`
status	In	The status of the authentication. One of these values: `PLUGIN_DONE_SUCCESS` - authentication was successful `PLUGIN_DONE_FAILED` - authentication failed `PLUGIN_DONE` - authentication has been cancelled for example, the password has expired or been erased.
message	In	The termination message, if provided by the authentication server.

Argument

In/Out

Meaning

context

The context as provided by Usernameor UsernameAndPassWord.

status

The status of the authentication. One of these values:

PLUGIN_DONE_SUCCESS - authentication was successful
PLUGIN_DONE_FAILED - authentication failed
PLUGIN_DONE - authentication has been cancelled for example, the password has expired or been erased.

message

The termination message, if provided by the authentication server.

Return Values

PLUGIN_OK if successful.
PLUGIN_CANCEL if the input is not correct.