formZ SDK | 5.0 API Reference | System | Runtime Library (FZRT) | File

# fzrt_file_copy

Description

Copies the source file to the destination folder. The src_file floc must specify a valid file. The dst_file floc may be either a folder or a file. If the destination floc specifies a folder, the destination file has the same name as the source file. If the destination contains a file of the same name, and FZRT_FILE_COPY_FLAGS_REPLACE is not specified in flags, or the destination file is read_only, the copy will fail. If FZRT_FILE_COPY_FLAGS_REPLACE is place in the flags parameter, and the file exists, it will be replaced with a copy of the source file.

Plugin Prototype

fzrt_error_td fzrt_file_copy(

fzrt_floc_ptr | src_file,
fzrt_floc_ptr | dst_file,
fzrt_file_copy_flags_enum | flags )

Parameters

src_file [Input]

pointer to a file r

dst_file [Input]

pointer to a file or folder locator

flags [Input]

FZRT_FILE_COPY_FLAGS_NONE, FZRT_FILE_COPY_FLAGS_REPLACE

Returns

FZRT_NOERR on success, Otherwise, an error ID.

Availability

5.5.0.0

Function Set

fz_fzrt_file_fset

Defined in

fzrt_api.h