ErrInfo (Socket function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
Line 1: Line 1:
 
{{Template:Socket:ErrInfo subtitle}}
<span class="pageSubtitle"><section begin=dpl_desc/><section end=dpl_desc/></span>
[[Category:Socket methods|ErrInfo function]]
<p>
<var>ErrInfo</var> is a member of the <var>[[Socket class|Socket]]</var> class.
</p>


This [[Notation conventions for methods#Shared members|shared]] method retrieves information about the last <var
This [[Notation conventions for methods#Shared members|shared]] method retrieves information about the last <var
Line 10: Line 5:
The <var>ErrInfo</var> function is similar in effect to
The <var>ErrInfo</var> function is similar in effect to
<var>[[$Sock_Errinfo]]</var>.
<var>[[$Sock_Errinfo]]</var>.
==Syntax==
==Syntax==
<p class="syntax">%errinfo = %(Socket):ErrInfo(infotype)
{{Template:Socket:ErrInfo syntax}}
</p>
 
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
Line 33: Line 29:


<var>ErrInfo</var> is not affected by any <code>ONRESET</code> setting.
<var>ErrInfo</var> is not affected by any <code>ONRESET</code> setting.
{{Template:Socket:ErrInfo footer}}

Revision as of 23:04, 14 November 2011

Retrieve info about the most recent socket error (Socket class)


This shared method retrieves information about the last Janus Sockets error. The ErrInfo function is similar in effect to $Sock_Errinfo.

Syntax

%string = %(Socket):ErrInfo( string)

Syntax terms

%errinfo A string variable to contain the returned error information. If no Janus Sockets error has occurred since the thread logged in, a null string is returned.
%(Socket) The class name in parentheses denotes a shared method. Specifying %(Socket): is not the only way to invoke the method (see ?? refid=themeth.).
infotype One of the following strings:
CODE Retrieve the code from the last Janus Sockets error.
SOCKNUM Retrieve the socket number used by the last Janus Sockets operation with an error condition.
FUN Retrieve the name of the $function producing the last Janus Sockets error. This may also be the string "Captured print", if a captured "print" operation was the last operation that encountered a Janus Sockets error.

ErrInfo is not affected by any ONRESET setting.