Novell Doc: NDK: NSN Components - Part Two (N-Z)

9.17 Screens Collection

Features:

Enumerates all console screens on a server.
Supports several other functions, such as reading from and writing to a console screen.

9.17.1 CurrentScreen method

Returns the current screen.

Syntax

object.CurrentScreen()

Parameters

None.

Return Values

Screen.

Example

This example returns the current screen.

set srv = createobject ("ucx:Server") 
set screens = srv.Screens 
set screen = Screens.CurrentScreen 
     Print("Screen name is:" & Screen.Name)

9.17.2 HasMoreElements method

Determines whether or not any more Screen objects exist in the collection.

Syntax

object.HasMoreElements()

Parameters

None.

Return Values

Boolean. Returns TRUE if more Screen objects exist in the collection; otherwise, FALSE.

Example

This example determines whether or not any more Screen objects exist in the collection.

set srv = createobject ("ucx:Server") 
set screens = srv.Screens 
Screens.Reset() 
while (Screens.HasMoreElements(=TRUE) 
     set screen=Screens.Next() 
     print ("Screen name is:" & Screen.Name) 
Wend

9.17.3 Next method

Returns the next Screen object in the collection.

Syntax

object.Next()

Parameters

None.

Return Values

Screen. Returns NULL if the collection has no more elements.

Example

This example returns the next Screen object in the collection.

set srv = createobject ("ucx:Server") 
set screens = srv.Screens 
Screens.Reset() 
while (Screens.HasMoreElements=TRUE) 
     set screen=Screens.Next() 
     print ("Screen name is:" & Screen.Name) 
Wend

9.17.4 Reset method

Resets the Screens collection and starts an iteration.

Syntax

object.Reset()

Parameters

None.

Return Values

Void.

Example

This example resets the Screens collection and starts an iteration.

’Reset the collection 
set srv = createobject ("ucx:Server") 
set screens = srv.Screens 
Screens.Reset 
while (Screens.HasMoreElements=TRUE) 
     set screen=Screens.Next() 
     print ("Screen name is:" & Screen.Name) 
wend