aftp_extract_block_size

The aftp_extract_block_size call extracts the file block size. If the aftp_set_block_size call has not been invoked, the AFTP default block size value is returned.

AFTP_ENTRY aftp_extract_block_size(
IN AFTP_HANDLE_TYPE connection_id,
OUT AFTP_BLOCK_SIZE_TYPE AFTP_PTR block_size,
OUT AFTP_RETURN_CODE_TYPE AFTP_PTR return_code
);

Parameters

connection_id

An AFTP connection object originally created with aftp_create.

block_size

The AFTP file block size 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_BLOCK_SIZE_TYPE     block_size;

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

    aftp_extract_block_size(
        connection_id,
        &block_size,
        &aftp_rc);
    if (aftp_rc != AFTP_RC_OK) {
        fprintf(stderr, "Error extracting AFTP block size.\n");
    }

}
 

Line Flows

None.