GetBroadcastMessage

Returns a broadcast message from the current connection on the server (For cross-platform functionality, see Developing NLMs with Cross-Platform Functions ( NDK: NLM Development Concepts, Tools, and Functions) and call NWGetBroadcastMessage)

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

Syntax

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

Parameters

messageBuffer
(OUT) Returns a string containing the message (58 characters, including the NULL terminator).

Return Values

The following table lists return values and descriptions.

Value

Hex

Name

Description

0

(0x00)

ESUCCESS

 

253

(0xFC)

ERR_MESSAGE_QUEUE_FULL

 

254

(0xFE)

ERR_IO_FAILURE

Lack of Dynamic Workspace

Remarks

If no message is pending, messageBuffer[0] contains a NULL. Only one message can be stored. GetBroadcastMessage cannot be called iteratively to poll messages.

Only two broadcast modes are possible: enabled and disabled.

See Also

SendBroadcastMessage