DestroyScreen

Closes a screen

Local Servers:nonblocking
Remote Servers:N/A
Classification:3.x, 4.x, 5.x, 6.x
Service:Screen Handling

Syntax

  #include <nwconio.h>  
   
  int DestroyScreen  (  
     int   screenHandle); 
  

Parameters

screenHandle

(IN) Specifies the screen handle of the screen being closed.

Return Values

The following table lists return values and descriptions.

Value

Hex

Name

Description

0

(0x00)

ESUCCESS

Successful.

22

(0x16)

EBADHNDL

Bad screen handle was passed in.

Remarks

DestroyScreen closes the screen specified by the screenHandle parameter. The following conditions determine which screen is displayed next:

  • If the screenHandle parameter specifies the current screen, then a new current screen is set if the NLM has any screens left.

  • If the screenHandle parameter specifies the screen that is displayed, then another one of the screens of the NLM is displayed if any are left. Otherwise, the System Console Screen is displayed.

  • If the screenHandle parameter specifies a popup screen that is displayed, the screen that was covered by the popup screen is redisplayed if it still exists. Otherwise, the System Console Screen is displayed.

See Also

CreateScreen