aftp_extract_record_length

The aftp_extract_record_length call extracts the record length for fixed length records, or the maximum possible record length for variable length records used for data transfer. If the aftp_set_record_length call has not been invoked, the AFTP default record length value is returned.

AFTP_ENTRY aftp_extract_record_length(
IN AFTP_HANDLE_TYPE connection_id,
OUT AFTP_RECORD_LENGTH_TYPE AFTP_PTR record_length,
OUT AFTP_RETURN_CODE_TYPE AFTP_PTR return_code
);

Parameters

connection_id

An AFTP connection object originally created with aftp_create.

record_length

The record length for the data transfer specified in bytes.

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;
    AFTP_RECORD_LENGTH_TYPE     record_length;

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

    /*
     * Extract the file record length for AFTP.
     */

    aftp_extract_record_length(
        connection_id,
        &record_length,
        &aftp_rc);
    if (aftp_rc != AFTP_RC_OK) {
       fprintf(stderr, "Error extracting AFTP record length.\n");
    }
}
 

Line Flows

None.