aftp_remove_dir

The aftp_remove_dir call removes a directory from the AFTP server. A connection to the AFTP server must be established before using this call.

Platform differences are as follows:

• On VM, this call is not supported. If issued, the call fails with return code AFTP_RC_FAIL_NO_RETRY.
• On MVS, partitioned data sets act as the directory structure. This call deletes a partitioned data set with the name specified.

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

AFTP_ENTRY aftp_remove_dir(
IN AFTP_HANDLE_TYPE connection_id,
IN unsigned char AFTP_PTR directory,
IN AFTP_LENGTH_TYPE length,
OUT AFTP_RETURN_CODE_TYPE AFTP_PTR return_code
);

Parameters

connection_id

An AFTP connection object originally created with aftp_create.

directory

The directory to be removed. The format of this name can be either the native syntax on the AFTP server or the AFTP common naming convention described in the APPC Application Suite User's Guide. The directory specified can be either an absolute or relative path name.

length

The 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;

    /* The value used for filespec will vary based on platform:
     *   VM  not supported
     *   MVS PDS common naming:  directory="/user.clist/"
     *   MVS PDS native naming:  directory="'user.clist'"
     */
    static unsigned char AFTP_PTR directory = "/user.clist/";

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

    aftp_remove_dir(
        connection_id,
        directory,
        (AFTP_LENGTH_TYPE)strlen(directory),
        &aftp_rc);

    if (aftp_rc != AFTP_RC_OK) {
        fprintf(stderr, "Error removing AFTP directory.\n");
    }

}
 

Line Flows

The remove directory request and the directory name to remove are sent to the AFTP server and the call waits for a response indicating the success or failure of the remove directory operation.