Methods

You can use the following methods with the BatchSecurity control.

AbortPendingSecurity()

The AbortPendingSecurity method aborts any pending security requests. If a security dialog is open, it closes it. There is no return code.

ApplicationClearance(ApplicationID, WinType, UserData)

The ApplicationClearance method checks for user application clearance. The ApplicationID (string) identifies the application to check for security configuration. The WinType (secWindowType) argument determines the dialog behavior for the security check. UserData (long) is a place to store a user-defined number that is to be passed through to any events raised by the clearance check. See explanation of Window Types later in this chapter. The function returns an integer Result code (secResultType).

ChangeUserPassword(UserID, OrigPassword, NewPassword)

The ChangeUserPassword method allows a user, identified by UserID (string), to change their password. They must supply their valid, current password in the OrigPassword (string) argument in order for the change to take effect. The password is set to NewPassword (string). The function returns an integer Result code (secResultType).

FunctionClearance(ApplicationID, FunctionID, RecipeID, WinType, UserData)

The FunctionClearance method authenticates a user for functional security. The function attempted is identified by the ApplicationID (long) and the FunctionID (long). The RecipeID (string) identifies the recipe affected as users may be configured to only interact with certain recipes. The WinType (secWindowType) determines the behavior of the security dialogs (see Window Types later in this section.) and the UserData (long) argument contains user-defined data that is to be passed to events raised in connection with the security check. The function returns an integer Result code (secResultType).

GetApplicationName(ApplicationID)

The GetApplicationName method returns the name (string) of the security application identified by the ApplicationID (long) argument.

GetFunctionName(ApplicationID, FunctionID)

The GetFunctionName method returns the name (string) of the security function identified by the ApplicationID (long) and FunctionID (long) arguments.

GetUserName(UserID)

The GetUserName method returns the name (string) of the user identified by the UserID (string) argument.

Init()

The Init method initializes a connection to the Security Manager service running on the Batch Server identified by the Host1 or Host2 property. The Init method first attempts to connect to the batch server on Host1, and then attempts Host2. (See Host1 and Host2 properties above). The security manager service must be running in order to be successful.

QueryApplicationSecurity(ApplicationID)

The QueryApplicationSecurity method returns an integer (secRequestType) indicating if security is required for the application identified by ApplicationID (long). The return value is 0 if no security is required to access the application, and 3 if security is required.

QueryFunctionSecurity(ApplicationID, FunctionID)

The QueryFunctionSecurity method returns an integer (secRequestType) indicating what security is required for the function identified by ApplicationID (long) and FunctionID (long). The return value is 0 if no security is required to access the function, 1 if DoneBy security is required.

ResetRetries()

The ResetRetries method resets the retry count for authentication attempts. The limit for retries is configured in the AVEVA Batch Management security system. When the limit is reached, an error results.

Term()

The Term method terminates the connection to the AVEVA Batch Management Security Manager.