CheckIfScreenActive

Syntax

  #include <screen.h> 
   
  int CheckIfScreenActive (
     scr_t           scrID,
     unsigned long   waitFlag);
  

Parameters

scrID

(IN) Specifies the screen to check.

waitFlag

(IN) Specifies whether to wait for the screen to become active:

• TRUE (1) Wait
• False (0) Do not wait

Return Values

When the waitFlag is TRUE, returns one of the following:

• 0 if the thread did not need to wait for the screen to become active.
• 1 if the thread waited for the screen to become active.

When the waitFlag is FALSE, returns one of the following values:

• 0 if the screen is not active.
• 1 if the screen is active.

Remarks

When the waitFlag is TRUE, this function suspends the calling thread until the specified screen becomes active.

See Also

ActivateScreen