OpenCustomScreen

Creates and opens the specified custom screen.

Library:LibC
Classification:NetWare OS
Service:Screen Support

Syntax

  #include <screen.h> 
   
  int OpenCustomScreen (
     const char   *name,
     rtag_t        rTag,
     scr_t        *newScrID,
     int           mode );
  

Parameters

name

(IN) Points to a null-terminated string, which gives a name to the screen.

rTag

(IN) Specifies a resource tag. See Resource Tag Signatures in Volume 2.

newScrID

(OUT) Points to a handle for screen, which is used to identify the screen for most other screen operations.

mode

(IN) Specifies the screen mode, using the following values:

Flag

Value

Description

SCREEN_MODE_TTY

0x00000000

SCREEN_MODE_80X25

0x00000001

SCREEN_MODE _80X43

0x00000002

SCREEN_MODE_80X50

0x00000003

SCREEN_MODE_D

0x0000000D

SCREEN_MODE_E

0x0000000E

SCREEN_MODE_F

0x0000000F

SCREEN_MODE_10

0x00000010

SCREEN_MODE_11

0x00000011

SCREEN_MODE_12

0x00000012

SCREEN_MODE_13

0x00000013

SCREEN_MODE_SCROLLABLE

0x80000000

Adds scroll bars to the screen. This mode consumes a lot of memory. It is OR'd to one of the other modes.

IMPORTANT:Scrollable screens are only available in ring 0 and on NetWare 6.5 SP2 or later.

Return Values

If successful, returns 0.

Remarks

The OpenCustomScreen function creates a screen for the NLM. To make the screen the current displayed screen on the console, call ActivateScreen.

Screens created with the OpenCustomScreen function can be managed only with NetWare OS functions. For example, your application's stdin and stdout are not mapped to this screen, and therefore you cannot use standard functions for input or output. Use the following types of functions:

  • To obtain input from the screen, use GetKey or InputFromScreen.

  • To send output to the screen, use OutputToScreen.

  • To close and destroy the screen, call CloseScreen.

This is the only interface by which a scrollable screen can be explicitly created. For sample code, see Scroll.c.

To create a scrollable screen which is accessible through stdin, stdout, and stderr, see Designating an Application Screen.

See Also