formZ SDK | 5.0 API Reference | Project | File Formats

# fz_file_remove_extension

Description

Removes a file extension from a file name for file formats recognized by formZ. Deletes the file extension from the end of a file name only if the extension matches a file type set by fz_ffmt_cbak_info. This is done by finding the last occurrence of '.' in the string, comparing the text following the '.' with known file extensions and if a match is found, setting the '.' character to '\0'.

Plugin Prototype

fzrt_error_td fz_file_remove_extension(

fz_ffmt_ref_td | ffmt_id,
char * | fname )

Parameters

ffmt_id [Input]

A file format reference to which to compare the extension. If this is set to FZ_FFMT_NONE, the file extension will be compared with all known file extensions. Otherwise, the file extension will only be compared to the file extension associated with the file format reference.

fname [Input, Result]

The file name from which to remove the extension.

Returns

FZRT_NOERR on success. An error otherwise.

Availability

5.0.0.0

Function Set

fz_ffmt_fset

Defined in

fz_ffmt_api.h