DisplayScreen

Displays the specified screen

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

Syntax

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

Parameters

screenHandle

(IN) Specifies the screen handle of the screen to display; if NULL is specified and the current screen is a popup screen, then a DropPopUpScreen is done on the current screen.

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.

WARNING:An invalid screen handle is not guaranteed to return EBADHNDL; it can also cause the server to abend. Always pass a handle returned from CreateScreen or GetScreenInfo.

Remarks

In addition to displaying the specified screen, this function also makes the specified screen the current screen.

If the screenHandle parameter specifies a popup screen:

  • The specified popup screen is displayed over the currently displayed screen (original screen).

  • When the DropPopUpScreen or DestroyScreen function is called for the popup screen, and the popup screen is displayed, the original screen, if it still exists, is redisplayed. Otherwise, the System Console Screen is displayed.

See Also

CheckIfScreenDisplayed, DestroyScreen