BroadcastToConsole

Broadcasts a message to the server’s system console (For cross-platform functionality, see Developing NLMs with Cross-Platform Functions ( NDK: NLM Development Concepts, Tools, and Functions) and call NWBroadcastToConsole)

Local Servers:blocking
Remote Servers:blocking
Classification:3.x, 4.x, 5.x, 6.x
Service:Server-Based Message

Syntax

  #include <\nlm\nit\nwmsg.h> 
    
  int BroadcastToConsole (  
     char   *message);

Parameters

message
(IN) String containing the message to send (maximum 80 characters, including the NULL terminator).

Return Values

The following table lists return values and descriptions.

Value

Hex

Name

Description

0

(0x00)

ESUCCESS

 

252

(0xFC)

ERR_MESSAGE_QUEUE_FULL

 

254

(0xFE)

ERR_IO_FAILURE

Lack of Dynamic Workspace

Remarks

The application must check that the message does not exceed 80 bytes and that it does not contain characters with ASCII values less than 0x20 or greater than 0x7E.

The server console displays a colon prompt followed by the message on a single line.

See Also

SendBroadcastMessage