[Home] [Downloads] [Search] [Help/forum]


Script function


Read about scripting




Sends a packet over the network using the UDP protocol


long UdpSend(BSTR IP, short Port, BSTR Text);

View list of data type meanings


This sends a single UDP (User Datagram Protocol) packet over the network, to the specified IP address and port.

The intention here is to communicate with other programs, such as the status-bar stand-alone program using UDP to send short messages.

You can broadcast to more than one PC by using a broadcast address.

The address must be a dotted number, not a name (eg.

Available in MUSHclient version 3.56 onwards.

VBscript example

UdpSend "", 4111, "magic,textcolour,5555"

Jscript example

UdpSend ("", 4111, "magic,textcolour,5555")

Lua example

UdpSend ("", 4111, "magic,textcolour,5555")

Return value

If the packet was sent successfully, zero is returned.

If the address could not be decoded, -1 is returned;

For other socket errors the Windows socket error number.

See Also ...


(GetUdpPort) Find a free port for UDP listening
(UdpListen) Listens for incoming packets using the UDP protocol
(UdpPortList) Returns an array of all the UDP ports in use by this world

(Help topic: function=UdpSend)

Documentation contents page

Search ...

Enter a search string to find matching documentation.

Search for:   

Quick links: MUSHclient. MUSHclient help. Forum shortcuts. Posting templates. Lua modules. Lua documentation.

Information and images on this site are licensed under the Creative Commons Attribution 3.0 Australia License unless stated otherwise.


Written by Nick Gammon - 5K   profile for Nick Gammon on Stack Exchange, a network of free, community-driven Q&A sites   Marriage equality

Comments to: Gammon Software support
[RH click to get RSS URL] Forum RSS feed ( https://gammon.com.au/rss/forum.xml )

[Best viewed with any browser - 2K]    [Hosted at FutureQuest]