axlSDBHp

aaxlSDBHp(
g_potentialSDBH
)
=> t / nil

Description

Returns whether the supplied argument is a valid setup database handle.

It is more accurate than checking whether a handle is greater than zero because it verifies that the element exists. Therefore, this function will return nil if a previously valid but now invalid (stale) handle is provided.

Arguments

g_potentialSDBH

Setup database handle

Value Returned

t	Indicates that the setup database handle is valid.
nil	Indicates that the setup database handle is invalid.

Examples

Indicates that the setup database handle is valid.

;; given mainSDBH pointing to current setup and variable "VDC"

varSDBH = axlGetVar(mainSDBH "VDC")
axlSDBHp(varSDBH)
=> t

To remove the variable:

axlRemoveElement(varSDBH)

;; now the handle is invalid

axlSDBHp(varSDBH)
=> nil

Return to top