Editing mirc/commands/sockwrite

{{mirc title|/sockwrite Command}}
The '''/sockwrite command''' allows you to send data to a TCP socket connection previously opened with [[/sockopen commands - mIRC|/sockopen]] (See [[TCP Sockets - mIRC|TCP sockets]]).
You can specify a {{mirc|wildcard}} for the name to send the data to all matching sockets. 

When the data has been sent, the {{mIRC|on sockwrite}} event triggers.

mIRC will queue your request up to 16384 bytes, you must check how many bytes is the send buffer with {{mirc|$sock}}().sq before trying to queue on a socket

'''Note''': If the queue is empty, (first /sockwrite ever for example), you can send more than that limit and it will be sent as chunk of the send queue limit or less.

== Synopsis ==
/sockwrite -abnt <name> [numbytes] <text|%var|&binvar>

== Switches ==
* '''-b''' - Indicates that you are specifying the numbytes value which is the number of bytes you want send, the full line is sent otherwise
* '''-n''' - Appens a {{mIRC|$crlf}} to the line being sent if it's not a &binvar or if does not already end with a $crlf
* '''-t''' - Forces mIRC to send anything beginning with a & as plain text
* '''-a''' - Prevents characters in the range 0-255 from being UTF-8 encoded as long as the line only contains characters in the range 0-255

== Parameters ==
* '''<name>''' - The socket name.
* '''[numbytes]''' - If -b has been specified, indicates the number of bytes you want to send.
* '''<text|%var|&binvar>''' - The message you want to send, can be a binary variable.

'''Note''': if /sockwrite fails, {{mirc|$sockerr}} is set as well as {{mirc|$sock}}().wserr and {{mirc|$sock}}().wsmsg inside the {{mirc|on events/on sockwrite|on sockwrite}} event.

== Example ==

See the page for the {{mIRC|on events/on sockwrite|on sockwrite}} event for more informations and examples about /sockwrite

== Compatibility ==
{{mIRC compatibility|5.3}}

== See also ==
* [[List of commands - mIRC|List of commands]]
* [[List of identifiers - mIRC|List of identifiers]]
* {{mIRC|/sockopen}}
* {{mIRC|/sockread}}
* {{mIRC|/sockmark}}
* {{mIRC|on sockwrite}}
* {{mIRC|on sockread}}
* {{mIRC|$sockerr}}
* {{mIRC|$sock|$sock()}}

{{mIRC command list}}

[[Category:mIRC commands|sockwrite command - mIRC]]