axlGetHistoryLock

axlGetHistoryLock( 
x_historyHandle 
) 
=> t / nil 

Description

Returns the lock status of the given history. When a history item is locked, the corresponding setup details and results cannot be deleted.

Arguments

x_historyHandle

Handle to a history in the setup database

Value Returned

t	Indicates that the specified history is locked in the database
nil	Indicates that the specified history is not locked in the database

Examples

Returns the lock status of the current history.

session=axlGetWindowSession()
=> "session1"
history1=axlGetCurrentHistory(session)
=> 1067
axlGetHistoryLock(history1)
=> t

Returns the lock status of the given checkpoint history.

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

; The returned value nil shows that the Interactive.1 history is currently unlocked
; in the database.

Related Topics

axlGetCurrentHistory

axlGetHistoryCheckpoint

axlSetHistoryLock

Return to top