aftp_query_current_dir

The aftp_query_current_dir call queries the current directory on the AFTP server. A connection to the AFTP server must be established before using this call.

See AFTP File and Directory Concept for details on how the directory concept is handled for supported operating systems.

AFTP_ENTRY aftp_query_current_dir(
IN AFTP_HANDLE_TYPE connection_id,
OUT unsigned char AFTP_PTR directory,
IN AFTP_LENGTH_TYPE directory_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.

directory

The buffer into which the current working directory on the AFTP server will be written.

Use the AFTP_FILE_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.

directory_size

The size in bytes of the directory buffer.

returned_length

The actual length of the directory 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            directory[AFTP_FILE_NAME_SIZE+1];
    AFTP_LENGTH_TYPE         length;

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

    /*
     * Query the current working directory on the AFTP server.
     */

    aftp_query_current_dir(
        connection_id,
        directory,
        (AFTP_LENGTH_TYPE)sizeof(directory)-1,
        &length,
        &aftp_rc);


    if (aftp_rc != AFTP_RC_OK) {
        fprintf(stderr, "Error in query of current directory.\n");
    }
}
 

Line Flows

The request for the directory name is sent to the AFTP server and the call waits for a response indicating the success or failure of the query current working directory operation. The directory name of the current working directory on the AFTP server is sent as the response if the query was successful.