SSGetActiveLANBoardList

Returns information about the active LAN boards on a server. For cross-platform functionality, use NWGetActiveLANBoardList instead.

Local Servers:blocking
Remote Servers:blocking
NetWare Server:4.x, 5.x, 6.x
Platform:NLM
Service:Server-Based Server Environment

Syntax

  #include <nit\nwservst.h>  
   
  LONG SSGetActiveLANBoardList (  
     LONG    startNumber,  
     BYTE   *buffer,  
     LONG    bufferLen); 
  

Parameters

startNumber
(IN) Specifies the number of LAN board to start with.
buffer
(IN/OUT) Points to a buffer which receives a list of LAN boards.
bufferLen
(IN) Specifies the size of buffer. This should be SS_DEFAULT_BUFFER_SIZE.

Return Values

ESUCCESS or NetWare errors.

Remarks

This function returns a GetActiveLANBoardListStructure in buffer. This structure is defined in NWSERVST.H as follows:

  typedef struct GetActiveLANBoardListStructure  
  {  
     LONG   currentServerTime;  
     BYTE   vConsoleVersion;  
     BYTE   vConsoleRevision;  
     WORD   reserved;  
     LONG   maxNumOfLANs;  
     LONG   itemsCount;  
     LONG   boardNumbers;  
  }GetActiveLANBoardListStructure; 
  

The currentServerTime field contains the time elapsed since the server was brought up. This time is returned in ticks (approximately 1/18 of a second). When this field reaches 0xFFFFFFFF, it wraps to zero.

The vConsoleVersion field contains the console version number. vConsoleVersion and vConsoleRevision track packet format.

The vConsoleRevision field contains the console version revision number.

The maxNumOfLANs field contains the total number of LAN boards.

The itemsCount field contains the number of LAN boards returned by this call to SSGetActiveLANBoardList. To retrieve the rest of the board numbers, call this function again, using the total number of items returned by all previous calls to SSGetActiveLANBoardList plus 1 as startNumber.

The boardNumbers field contains the first LAN board number. This number is followed in the buffer by board numbers for each LAN board.