ReceivedFin (Socket function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (Automatically generated page update)
 
mNo edit summary
 
(2 intermediate revisions by the same user not shown)
Line 3: Line 3:
==Syntax==
==Syntax==
{{Template:Socket:ReceivedFin syntax}}
{{Template:Socket:ReceivedFin syntax}}
===Syntax terms===
===Syntax terms===
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%ReceivedFin</th><td><var>Boolean</var> value</td></tr>
<tr><th>%ReceivedFin</th><td>A <var>[[Boolean enumeration|Boolean]]</var> enumeration %variable to contain a returned <code>True</code> or <code>False</code> value. </td></tr>
<tr><th>socket</th>
<tr><th>socket</th>
<td>Socket object</td></tr>
<td>A variable or an expression that is a reference to a <var>Socket</var> object.</td></tr>
</table>
</table>
==Usage notes==
==Usage notes==
==Examples==
As described in the <var>ReceiveAsynchronous</var> [[ReceiveAsynchronous (Socket function)#Usage notes|"Usage notes"]], <var>ReceivedFin</var> is particularly useful if that method is called and returns a 0.
 
==See also==
==See also==
{{Template:Socket:ReceivedFin footer}}
{{Template:Socket:ReceivedFin footer}}

Latest revision as of 16:17, 11 June 2012

Test if received FIN on connection (Socket class)

[Introduced in Sirius Mods 7.9]


Syntax

%receivedFin = socket:ReceivedFin

Syntax terms

%ReceivedFinA Boolean enumeration %variable to contain a returned True or False value.
socket A variable or an expression that is a reference to a Socket object.

Usage notes

As described in the ReceiveAsynchronous "Usage notes", ReceivedFin is particularly useful if that method is called and returns a 0.

See also