CheckESign
CheckESign is a built-in function that prompts the run-time user to electronically sign an event by entering their username and password. You can call this function to secure scripts and expressions, just as you can select the E-Sign option in object properties to secure screen objects and animations.
| Function | Group | Execution | Windows | Embedded | Thin Client | Mobile Access |
|---|---|---|---|---|---|---|
| CheckESign | Security | Synchronous | Supported | Supported | Supported | Not supported |
Syntax
CheckESign(optNumLevel)
- optNumLevel
- The security level (from 0 to 255, Runtime only) to which the user must have access in order to sign. For more information, see About security access levels.
This parameter is optional; if no value is specified, the default value is 0.
Returned value
This function returns the following possible values:
| Value | Description |
|---|---|
| 0 | Username and/or password not accepted, or the user does not have access to the specified level. |
| 1 | Username and password accepted. The event is saved in the event history with the user’s signature. |
Notes
Calling this function displays a dialog box on the client, where the user must enter their username and password.
Users and groups are managed in the project security system. For more information, see Project Security.
Examples
Prompt the user for their username and password — the user must have access to security level 20…
CheckESign(20)