Difference between revisions of "NET:LavishVMAPI.Frame.Wait"

From Lavish Software Wiki
Jump to navigation Jump to search
m (NET:LavishVMAPI.Frame.FrameWait moved to NET:LavishVMAPI.Frame.Wait)
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:
 
See [[NET:Concepts:Frame Locking|Frame Locking]].
 
See [[NET:Concepts:Frame Locking|Frame Locking]].
  
−
FrameWait causes a thread to yield execution until the ''next frame'' begins.  Retaining a frame lock following a call to FrameWait is optional, via the bLock parameter.  If lock is retained, there must be one unlock call per successful lock call.  '''FrameWait should not be used in a thread that already has frame lock acquired''', as this results in deadlock (it is logically impossible).
+
Wait causes a thread to yield execution until the ''next frame'' begins.  Retaining a frame lock following a call to Wait is optional, via the bLock parameter.  If lock is retained, there must be one unlock call per successful lock call.  '''Wait should not be used in a thread that already has frame lock acquired''', as this results in deadlock (it is logically impossible).
  
 
=== Reference Library ===
 
=== Reference Library ===
Line 8: Line 8:
  
 
=== Fully Qualified Name ===
 
=== Fully Qualified Name ===
−
; LavishVMAPI.Frame.FrameWait
+
; LavishVMAPI.Frame.Wait
 
*[[NET:Lavish.InnerSpace.dll#LavishVMAPI_namespace|LavishVMAPI namespace]]
 
*[[NET:Lavish.InnerSpace.dll#LavishVMAPI_namespace|LavishVMAPI namespace]]
 
** [[NET:Lavish.InnerSpace.dll#Frame|Frame class]]
 
** [[NET:Lavish.InnerSpace.dll#Frame|Frame class]]
−
*** FrameWait function
+
*** Wait function
  
 
== Declaration ==
 
== Declaration ==
−
  static public void FrameWait(bool bLock);
+
  static public void Wait(bool bLock);
  
 
=== Parameters ===
 
=== Parameters ===

Latest revision as of 18:42, 19 January 2007

Overview

See Frame Locking.

Wait causes a thread to yield execution until the next frame begins. Retaining a frame lock following a call to Wait is optional, via the bLock parameter. If lock is retained, there must be one unlock call per successful lock call. Wait should not be used in a thread that already has frame lock acquired, as this results in deadlock (it is logically impossible).

Reference Library

Lavish.InnerSpace.dll

Fully Qualified Name

LavishVMAPI.Frame.Wait

Declaration

static public void Wait(bool bLock);

Parameters

  • [In] bool bLock
If true, retains an acquired frame lock. If false, the implicit frame lock is released.

Return Value

None

Examples

See Also

Retrieved from "https://www.lavishsoft.com/wiki/index.php?title=NET:LavishVMAPI.Frame.Wait&oldid=6556"