LOCK_FRAMEWORK Function

Locks the framework and specifies the locking message to be displayed.

Equivalent to using Set #avFrameworkManager uLocked(USER|PROGRAM|PROGRAM_EXIT) uLockedMessage('message') in a VL component.

Only valid in VLF-WIN environments – ignored in other environments.

Syntax

LOCK_FRAMEWORK(lock type, lock message)

Parameters

Lock type

Required. A string containing the type of lock required as "USER", "PROGRAM" or "PROGRAM_EXIT".

USER means that the Framework is locked, but that the user can elect to end the lock.

PROGRAM means that the Framework is locked and only a program can unlock it.

PROGRAM_EXIT means that the Framework is locked except when exiting or closing down and only a program can unlock it.

Lock message

Required. A string containing the message to be shown to the user if they attempt to do something that would violate the lock state.

Return Value

None

Example

LOCK_FRAMEWORK("PROGRAM", "You need to return to the details screen before attempting this action");

Notes

If this function is encountered in a RAMP script executing in a VLF-ONE environment, it will be ignored.