aftp_local_dir_close

The aftp_local_dir_close call cancels a directory listing that is in progress on the AFTP client or ends a directory listing on the AFTP client after a nonzero no_more_entries has been returned from an aftp_local_dir_read call. A connection to the AFTP server is not required before using this call. A directory listing on the AFTP client must be started by calling aftp_local_dir_open before making this call.

AFTP_ENTRY aftp_local_dir_close(
IN AFTP_HANDLE_TYPE connection_id,
OUT AFTP_RETURN_CODE_TYPE AFTP_PTR return_code
);

Parameters

connection_id

An AFTP connection object originally created with aftp_create.

return_code

The return code issued for this function. See AFTP Return Codes for the list of possible return codes.

Example

See aftp_local_dir_read for a complete example showing the related calls aftp_local_dir_open, aftp_local_dir_read, and aftp_local_dir_close.

Line Flows

None.