Semiconductor & Computer Engineering
From WikiChip
Difference between revisions of "mirc/identifiers/$sockerr"
(Created page with "{{mirc title|$sockerr Identifier}}'''$sockerr''' return the socker error number if an error occured. For example, in the {{mIRC|on events/on sockopen|on sockopen}} event, if ...") |
|||
| (11 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{mirc title|$sockerr | + | {{mirc title|$sockerr identifier}}'''$sockerr''' returns the sock error number if an error occurred. |
| − | + | $sockerr is not a local identifier only set inside event, it is set after any /sock* command as well, meaning that $sockerr can change in value inside the same on sockread event. | |
== Synopsis == | == Synopsis == | ||
<pre>$sockerr</pre> | <pre>$sockerr</pre> | ||
| − | == | + | == Parameters == |
| + | None | ||
| + | == Properties == | ||
None | None | ||
| − | == | + | == Error codes == |
| + | |||
| + | Remember that using a /sock* command will change the $sockerr value, so these error codes must be checked prior any /sock* command | ||
| + | |||
| + | === on SOCKOPEN === | ||
| + | * 0: success | ||
| + | * 3: failure establishing socket connection (W) | ||
| + | * 4: error resolving given hostname | ||
| + | |||
| + | === on SOCKLISTEN === | ||
| + | * 0: new socket successfully accepted | ||
| + | * 1: error occurred on listening socket (W) | ||
| + | * 2: error accepting new socket (W) | ||
| + | * 4: not enough memory for new socket | ||
| + | |||
| + | === on SOCKREAD === | ||
| + | * 0: data received | ||
| + | * 3: error on connected socket occurred (W) | ||
| + | |||
| + | === on SOCKWRITE === | ||
| + | * 0: all data successfully written | ||
| + | * 3: error trying to send data (W) | ||
| + | |||
| + | === on SOCKCLOSE === | ||
| + | * 0: EOF from other end received | ||
| + | * 3: an error occurred while receiving data, or a SSL error occurred (W) | ||
| + | * 5: a certain(?) SSL error occurred during sockopen | ||
| + | |||
| + | '''Note 1:''' (W) = For these errors, $sock().wserr contains a specific WinSock error number and $sock().wsmsg the Winsock error text | ||
| − | + | '''Note 2:''' These codes were taken from http://www.xise.nl/mirc/wiki/doku.php/doku.php?id=sockerr | |
== Example == | == Example == | ||
<source lang="mIRC">on *:sockread:name:{ | <source lang="mIRC">on *:sockread:name:{ | ||
| − | if ($sockerr) return | + | if ($sockerr) return |
| − | + | … | |
}</source> | }</source> | ||
| Line 24: | Line 54: | ||
== See Also == | == See Also == | ||
| − | {{mIRC|$sock}} | + | * {{mIRC|$sock}} |
| − | {{mIRC|$sockname}} | + | * {{mIRC|$sockname}} |
| − | {{mIRC|$sockbr}} | + | * {{mIRC|$sockbr}} |
| − | [[Category: | + | {{mIRC identifier list}} |
| + | [[Category:mIRC identifiers|sockerr]] | ||
Latest revision as of 02:49, 25 April 2023
Commands & Identifiers
Basics
Events
Matching Tools
Data Storage
Control Structures
GUI Scripting
Sockets
Advanced Scripting
Additional Resources
Security
Other
$sockerr returns the sock error number if an error occurred.
$sockerr is not a local identifier only set inside event, it is set after any /sock* command as well, meaning that $sockerr can change in value inside the same on sockread event.
Contents
[hide]Synopsis[edit]
$sockerr
Parameters[edit]
None
Properties[edit]
None
Error codes[edit]
Remember that using a /sock* command will change the $sockerr value, so these error codes must be checked prior any /sock* command
on SOCKOPEN[edit]
- 0: success
- 3: failure establishing socket connection (W)
- 4: error resolving given hostname
on SOCKLISTEN[edit]
- 0: new socket successfully accepted
- 1: error occurred on listening socket (W)
- 2: error accepting new socket (W)
- 4: not enough memory for new socket
on SOCKREAD[edit]
- 0: data received
- 3: error on connected socket occurred (W)
on SOCKWRITE[edit]
- 0: all data successfully written
- 3: error trying to send data (W)
on SOCKCLOSE[edit]
- 0: EOF from other end received
- 3: an error occurred while receiving data, or a SSL error occurred (W)
- 5: a certain(?) SSL error occurred during sockopen
Note 1: (W) = For these errors, $sock().wserr contains a specific WinSock error number and $sock().wsmsg the Winsock error text
Note 2: These codes were taken from http://www.xise.nl/mirc/wiki/doku.php/doku.php?id=sockerr
Example[edit]
on *:sockread:name:{ if ($sockerr) return … }
Compatibility[edit]
Added: mIRC v5.3
Added on: 13 Dec 1997
Note: Unless otherwise stated, this was the date of original functionality.
Further enhancements may have been made in later versions.
See Also[edit]
[Expand]
mIRC identifier list