aftp_set_write_mode

The aftp_set_write_mode call sets the way existing files will be handled during data transfer. A connection to the AFTP server is not required before using this call. The write mode can be changed at any time.

AFTP_ENTRY aftp_set_write_mode(
IN AFTP_HANDLE_TYPE connection_id,
IN AFTP_WRITE_MODE_TYPE write_mode,
OUT AFTP_RETURN_CODE_TYPE AFTP_PTR return_code
);

Parameters

connection_id

An AFTP connection object originally created with aftp_create.

write_mode

The method used to write a file if a copy of the file already exists. If the file does not exist on the target, a new file is created.

AFTP_REPLACE

Transferred file will replace the existing file. This is the default.

AFTP_APPEND

Transferred file will be appended to the existing file.

return_code

The return code issued for this function. See AFTP Return Codes for the list of possible return codes.

Example

{
    AFTP_HANDLE_TYPE       connection_id;
    AFTP_RETURN_CODE_TYPE  aftp_rc;

    /*
     * Before issuing the example call, you must have:
     *    a connection_id, use:  aftp_create()
     */

    /*
     * Set the write mode for the AFTP
     * file transfer.
     */

    aftp_set_write_mode(
        connection_id,
        AFTP_REPLACE,
        &aftp_rc);

    if (aftp_rc != AFTP_RC_OK) {
        fprintf(stderr, "Error setting AFTP write mode.\n");
    }
}
 

Line Flows

None.