ftp_fget

Downloads a file from the FTP server and saves to an open file

&reftitle.description; `bool` `ftp_fget` `FTP\Connection` `ftp` `resource` `stream` `string` `remote_filename` `int` `mode` `FTP_BINARY` `int` `offset` 0

`ftp_fget` retrieves `remote_filename` from the FTP server, and writes it to the given file pointer.

&reftitle.parameters;

`ftp`

- &ftp.parameter.ftp;

`stream`

- An open file pointer in which we store the data.

`remote_filename`

- The remote file path.

`mode`

- The transfer mode. Must be either `FTP_ASCII` or `FTP_BINARY`.

`offset`

- The position in the remote file to start downloading from.

&reftitle.returnvalues;

&return.success;

&reftitle.changelog;

&Version; | &Description;
&ftp.changelog.ftp-param;
7.3.0 | The `mode` parameter is now optional. Formerly it has been mandatory.

&reftitle.examples;

### `ftp_fget` example

    <?php

    // path to remote file
    $remote_file = 'somefile.txt';
    $local_file = 'localfile.txt';

    // open some file to write to
    $handle = fopen($local_file, 'w');

    // set up basic connection
    $ftp = ftp_connect($ftp_server);

    // login with username and password
    $login_result = ftp_login($ftp, $ftp_user_name, $ftp_user_pass);

    // try to download $remote_file and save it to $handle
    if (ftp_fget($ftp, $handle, $remote_file, FTP_ASCII, 0)) {
     echo "successfully written to $local_file\n";
    } else {
     echo "There was a problem while downloading $remote_file to $local_file\n";
    }

    // close the connection and the file handler
    ftp_close($ftp);
    fclose($handle);
    ?>

&reftitle.seealso;

- `ftp_get`
- `ftp_nb_get`
- `ftp_nb_fget`