TcpIsValid
Function Block - Tests if a socket is valid.
Inputs
|
Input |
Data Type |
Range |
Unit |
Default |
Description |
|---|---|---|---|---|---|
|
Execute |
BOOL |
0 to 1 |
N/A |
No default |
On the rising edge, request to perform copying a file. |
|
ID |
UDINT |
N/A |
N/A |
No default |
The ID of the client socket. |
Outputs
|
Output |
Data Type |
Range |
Unit |
Description |
|---|---|---|---|---|
|
Done |
BOOL |
|
|
If TRUE, the command completed successfully. |
|
Error |
BOOL |
|
|
If TRUE, an error has occurred. |
|
ErrorID |
DINT |
|
|
Indicates the error if Error output is TRUE. See the table in File and TCP/IP Function Block ErrorIDs. |
|
Valid |
BOOL |
|
|
TRUE if the specified socket is still valid. |
Remarks
Figure 1: TcpIsValid
FBD Language Example
Not available.
FFLD Language Example
Not available.
IL Language Example
Not available.
ST Language Example
(* TcpIsValid example *)
CASE StepCounter OF
0:
Inst_TcpIsValid(TRUE, MySocketID);
StepCounter := StepCounter + 1;
1:
Inst_TcpIsValid(TRUE, MySocketID);
IF Inst_TcpIsValid.Done THEN
MyTcpIsValid := Inst_TcpIsValid.Valid;
Inst_TcpIsValid(FALSE, 0);
StepCounter := StepCounter + 1;
END_IF;
END_CASE;
See Also
