gpeIsValidAbutType

gpeIsValidAbutType (
u_sandbox
{ t_abutTypeName | x_abutType }
[ ?verbose { t | nil } ]
)
=> t / nil

Description

Validates the specified abutment type name or number for the specified Modgen sandbox object.

Arguments

u_sandbox	Specifies the Modgen sandbox object.
t_abutTypeName | x_abutType
	Specifies the abutment type name or abutment type number.
?verbose { t | nil }
	Controls the display of warning messages.

Value Returned

t	The specified abutment type name or number is valid.
nil	The specified abutment type name or number is invalid.

Example

In the following example, the value of sb is determined by calling gpeEditSandbox. This value is passed as an argument to gpeIsValidAbutType, which is used to validate different abutment type names and numbers:

sb = gpeEditSandbox()

gpeIsValidAbutType(sb "type0" ?verbose t)

> t

gpeIsValidAbutType(sb 0 ?verbose t)

> t

gpeIsValidAbutType(sb 2)

> nil

t_abutTypeName

Return to top