Product Documentation
Virtuoso ADE SKILL Reference
Product Version IC23.1, November 2023

maeGetHistoryLockFlag

maeGetHistoryLockFlag(
[ ?historyName t_historyName ]
[ ?session t_sessionName ]
)
=> n_flag / nil

Description

Returns the lock status for the specified history.

Arguments

?historyName t_historyName

Name of this history for which you want to get the lock status.

?session t_sessionName

Name of a maestro session.

If not specified, the currently active session is used.

Value Returned

n_flag

Numeric value that specifies a status:

  • 0: Unlocked
  • 1: Locked by user
  • 2: Locked because it has been referenced in another history
  • 3: Locked by user as well as because it has been referenced in another history
  • 4: Locked by reuse in variation

nil

The lock status is not returned.

Examples

Returns the lock status of a Monte Carlo run history in the current session:

maeGetHistoryLockFlag("MonteCarlo.0") 
=> 4

Return to top
 ⠀
X