Wattmon Documentation Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.

======ftp_status======

<badge>FW >= 1250</badge>

The ftp_status() function returns information about the FTP engine

====Description====

<well size="sm"><html>
<span style="font-size:125%;color:green">array
<span style="color:black">ftp_status (
<span style="color:green">int <span style="color:blue">full
<span style="color:black">)
</html></well>


====Parameter====

<html><span style="color:blue">int <span style="color:green">full <span style="color:black">Set to 1 to return the FTP command array in addition</html>

====Return Values====

<html><b><span style="color:green">array<span style="color:black"></b></html>:  Return array contains the following elements:

^ Key    ^ Value         ^
| status  | Connection transfer status  |
| file_size | Size of file being transferred |
| last_status_code | Last FTP response code |
| file_position | Position of transfer (between 0 and file_size) |
| file_direction | 0 = Download, 1 = Upload |
| file_name | name of file being transferred |
| command_log | Optional array of commands (if $full == 1) |
   
The status key will contain one of the following values: 

^ status ^ Description ^
| -1 | Error |
| 0 | Idle |
| 1 | Busy with a transfer |
| 2 | Transfer completed |

Wattmon Documentation Wiki

User Tools

Site Tools

Page Tools