←Select platform

LockTimeOut Method

Summary

Locks the time out for the object, preventing it from getting deleted.

Syntax
C#
VB
C++
public static void LockTimeOut( 
   string id 
) 
Public Shared Sub LockTimeOut( 
   ByVal id As String 
) 
public:  
   static void LockTimeOut( 
      String^ id 
   ) 

Parameters

id

The id of the 3D object.

Remarks
  • The timeout period is 3 minutes.
  • In order to keep an object alive indefinitely, keep calling KeepAlive before the time out runs out. For example, every 2 minutes.
  • To unlock the time out, call UnlockTimeOut.
  • LockTimeOut is necessary when the user is doing DoTimelyChecks which is a function that is called to clear out all unused volumes.

⛔ CAUTION

Exercise caution when using LockTimeOut as it will keep the resources allocated to a user alive on the server indefinitely. On the other hand, KeepAlive will reset the time out timer.

Requirements

Target Platforms

Help Version 20.0.2019.3.12
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.