axlSetHistoryLock

axlSetHistoryLock( 
x_handleHistory 
g_enable
) 
=> t / nil 

Description

Locks the specified checkpoint history. After it is locked, you cannot delete the history or the simulation data saved for it.

Arguments

x_handleHistory	Handle to the history in the setup database for which the lock status is to be changed
g_enable	The lock status to be set for the specified history. Valid values: t and nil

Value Returned

t	The specified history is locked successfully.
nil	The specified history is not locked.

Examples

Locks the current history.

session=axlGetWindowSession()
=> "session1"
handleHistory=axlGetCurrentHistory(session)
=> 1067
axlSetHistoryLock(handleHistory t)
=> t

Locks the specified checkpoint history.

session=axlGetWindowSession()
=> "session1"
x_mainSDB=axlGetMainSetupDB(session)
=> 2468
handleHistory=axlGetHistoryCheckpoint( axlGetHistoryEntry(x_mainSDB "Interactive.1"))
=> 1067
axlSetHistoryLock(handleHistory t)
=> t

; The returned value t shows that the Interactive.1 history has been locked
; in the database.

Related Topics

axlGetCurrentHistory

axlGetHistoryCheckpoint

axlGetHistoryLock

Return to top