aftp_extract_record_format

The aftp_extract_record_format call extracts the record format for the data transfer. If the aftp_set_record_format call has not been invoked, the AFTP default record format value is returned.

AFTP_ENTRY aftp_extract_record_format(
IN AFTP_HANDLE_TYPE connection_id,
OUT AFTP_RECORD_FORMAT_TYPE AFTP_PTR record_format,
OUT AFTP_RETURN_CODE_TYPE AFTP_PTR return_code
);

Parameters

connection_id

An AFTP connection object originally created with aftp_create.

record_format

The record format used for file transfer.

AFTP_DEFAULT_RECORD_FORMAT

Specifies that the system on which the file will be written should use its own default setting for record format. This is the initial setting.

AFTP_V

Variable length record, unblocked.

AFTP_VA

Variable length record, unblocked, ASA print-control characters.

AFTP_VB

Variable length record, blocked.

AFTP_VBA

Variable length record, blocked, ASA print-control characters.

AFTP_VBM

Variable length record, blocked, machine print-control codes.

AFTP_VBS

Variable length record, blocked, spanned.

AFTP_VBSA

Variable length record, blocked, spanned, ASA print-control characters.

AFTP_VBSM

Variable length record, blocked, spanned, machine print-control codes.

AFTP_VM

Variable length record, unblocked, machine print-control codes.

AFTP_VS

Variable length record, unblocked, spanned.

AFTP_VSA

Variable length record, unblocked, spanned, ASA print-control characters.

AFTP_VSM

Variable length record, unblocked, spanned, machine print-control codes.

AFTP_F

Fixed length record, unblocked.

AFTP_FA

Fixed length record, unblocked, ASA print-control characters.

AFTP_FB

Fixed length record, blocked.

AFTP_FBA

Fixed length record, blocked, ASA print-control characters.

AFTP_FBM

Fixed length record, blocked, machine print-control codes.

AFTP_FBS

Fixed length record, blocked, standard.

AFTP_FBSA

Fixed length record, blocked, standard, ASA print-control characters.

AFTP_FBSM

Fixed length record, blocked, standard, machine print-control codes.

AFTP_FM

Fixed length record, unblocked, machine print-control codes.

AFTP_U

Undefined length record.

AFTP_UA

Undefined length record, ASA print-control characters.

AFTP_UM

Undefined length record, machine print-control codes.

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_FORMAT_TYPE   record_format;

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

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

    aftp_extract_record_format(
        connection_id,
        &record_format,
        &aftp_rc);
    if (aftp_rc != AFTP_RC_OK) {
        fprintf(stderr, "Error extracting AFTP record format.\n");
    }
}
 

Line Flows

None.