SclIsSecurityClassEnabled

Overview

This function has been superseded by SclLicenseManager isSecurityClassEnabled .It will continue to be supported but you are advised to use SclLicenseManager isSecurityClassEnabled.

GEOVIA software products are protected using a sophisticated licensing system. Developers of complex suites of TCL/SCL scripts can avail themselves of this licensing system by determining whether or not a particular class of licence may be executed in an GEOVIA software product.

Synopsis

SclIsSecurityClassEnabled <security class name>

Description

SclIsSecurityClassEnabled returns 1 if the requested security class is enabled in the software product and returns 0 if it is not enabled.

Names for the security classes encapsulated in any GEOVIA product can be found by using the UPDATE LICENCE function.

Arguments

<security class name>

Any quoted string will suffice. If the security class name is unknown or is not licenced then a value of 0 is returned. If the security class is licenced a value of 1 is returned.

Examples

#
# This example shows how the enablement status of a number of 
# security classes can be determined
# 
puts "security class core enabled state = [SclIsSecurityClassEnabled core]"
puts "security class 'abcxyz' enabled state = [SclIsSecurityClassEnabled abcxyz]"
puts "security class 'string tools' enabled state = [SclIsSecurityClassEnabled {string tools}]"