aftp_extract_mode_name

The aftp_extract_mode_name call extracts the mode name specified for the connection to the AFTP server. If the aftp_set_mode_name call has not been invoked, the AFTP default mode name value is returned.

AFTP_ENTRY aftp_extract_mode_name(
IN AFTP_HANDLE_TYPE connection_id,
OUT unsigned char AFTP_PTR mode_name,
IN AFTP_LENGTH_TYPE mode_name_size,
OUT AFTP_LENGTH_TYPE AFTP_PTR returned_length,
OUT AFTP_RETURN_CODE_TYPE AFTP_PTR return_code
);

Parameters

connection_id

An AFTP connection object originally created with aftp_create.

mode_name

The buffer in which the mode name is to be stored.

Use the AFTP_MODE_NAME_SIZE constant to define the length of this buffer. Add 1 to the size if you want to be able to add a null terminator to the text in the buffer.

mode_name_size

The size of buffer in which the mode name will be stored.

returned_length

The actual length of the mode_name parameter 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;
    unsigned char AFTP_PTR          mode_name[AFTP_MODE_NAME_SIZE+1];
    AFTP_LENGTH_TYPE                returned_length;

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

    /*
     * Extract the APPC mode name for AFTP.
     */

    aftp_extract_mode_name(
        connection_id,
        mode_name,
        (AFTP_LENGTH_TYPE)sizeof(mode_name)-1,
        &returned_length,
        &aftp_rc);
    if (aftp_rc != AFTP_RC_OK) {
        fprintf(stderr, "Error extracting AFTP mode name.\n");
    }
}
 

Line Flows

None.