FileName Function

Format

s = filename(dictionary_name ‖ file_handler ‖ pff_name ‖ object_name ‖ paradata);

Description

The filename function returns the fully qualified name of a file. If supplying a dictionary_name, the function returns the name of the data file associated with a data dictionary. If providing a file_handler (declared in a File statement), the function returns the name of the text file associated with the file handler.

If providing a pff_name (declared in a Pff statement), the function returns the name of an existing PFF file, or the name of a temporarily created PFF file. If a PFF file was loaded (via Pff.load) and not modified, the name of that PFF file is returned. If the PFF has been modified and not saved, then calling filename will save the PFF to a temporary file and the name of that file is returned.

For several other CSPro objects, if passed an object_name, the function returns the file name associated with the content of the object. This functionality works on Audio, Document, Geometry, Image, and Report objects.

The function can also take paradata as its argument, in which case it returns the file name of the currently open paradata log.

Return Value

The function returns a string containing the folder and file name.

Example

filewrite(report_file, "Report file: %s", filename(report_file));
filewrite(report_file, "Census data file: %s", filename(CENSUS_DICT));