Events

You can use the following events with the BatchSecurity control.

ApplicationClearanceComplete(Result, ApplicationID, UserData)

The ApplicationClearanceComplete event is raised after an ApplicationClearance method has been called and any security dialogs or other information has been provided to the security system. The Result (secResultType) argument contains the result code: 0 if the clearance request was successful, 1 if not.

FunctionClearanceComplete(Result, ApplicationID, FunctionID, UserData)

The FunctionClearance event is raised after a FunctionClearance method has been called and all security dialogs or other information has been provided to the security system. The Result (secResultType) argument contains the result code: 0 if the clearance request was successful, 1 if not.

RequestNewPassword(RequestType, UserID, UserData)

The RequestNewPassword event is called when you are using a secWindowType of secWindowlessEvent with the ApplicationClearance or FunctionClearance methods. It is called when a clearance request fails due to the user’s password expiring and it automatically tries to change their password based on the new password you return.

If RequestType is secRequestApplication or secRequestDoneBy, you must set the DoneByPassword property with a new password before returning from this event.

If RequestType (secRequestType) is secRequestCheckBy, you must set the CheckByPassword property with a new password before returning.

This event may be called repeatedly until you have returned a valid new password. You may call the AbortPendingSecurity method within this event to cancel the security request. You may also use the LastErrorCode or LastErrorMessage properties to determine if there is a previous access error to report to the user. The UserID argument specifies the ID for the user whose password must be changed. The UserData argument is the value that was passed into the original ApplicationClearance or FunctionClearance method.

RequestUserInfo(RequestType, ApplicationID, ApplicationName, FunctionID, FunctionName, UserData)

The RequestUserInfo event is called when you are using a secWindowType of secWindowlessEvent with the ApplicationClearance or FunctionClearance methods. It is called when the clearance request needs some information.

If RequestType is secRequestApplication or secRequestDoneBy, you must set the DoneByUserID and DoneByPassword properties before returning from this event.

If RequestType is secRequestCheckBy, you must set the CheckByUserID and CheckByPassword properties before returning.

This event may be called repeatedly until you have returned proper credentials. You may call the AbortPendingSecurity method within this event to cancel the security request. You may also use the LastErrorCode and/or LastErrorMessage properties to determine if there is a previous access error to report to the user. The other arguments passed into this event are the values passed into the ApplicationClearance or FunctionClearance method, except for the ApplicationName and FunctionName arguments, which are useful if you need to prompt the user for the information.