PropertyHandle :: Lock - Lock instance
This function allows locking the instance selected in the property handle within an application. As long as the instance is locked no other user is able to access the instance. Instances for shared base structures are not automatically included in the locking and must be locked separately. Locked instances can be unlocked using the Unlock () function. They are automatically unlocked, when another instance is selected in the property handle.
When locking an instance, the function checks, whether the instance data is up to date. When not, the function will reread the instance in order to obtain the current state.
The function returns NO when the instance has been locked successfully. It returns an error ( YES ) when the instance is already locked by another application, when no instance is selected in the property handle or when another error occurred.
Implementation details
When passing a timeout value in timeout ., the function waits until the instance is unlocked. When not being unlocked within the timeout interval, the function throws an error. When passing a negative timeout value, the function waits without limit.
- timeout - - Title unknown