BBjClientFile::getCanonicalFile

Description

In BBj 7.0 and higher, this method returns a BBjClientFile that represents the "canonical" file represented by this BBjClientFile.

Syntax

Return Value

Method

BBjClientFile

getCanonicalFile()

Parameters

None.

Return Value

Returns the canonical file for this BBjClientFile.

Remarks

The canonical file name does not contain any "." or ".." path elements.

If a path element of this BBjClientFile represents a symbolic link, the canonical file may have the symbolic link replaced with the file or directory named by the link.

If the file does not exist, creating the file may change the return value of this method.

The BUI client returns this BBjClientFile. See BUI: Interacting with client files for a detailed discussion of the BUI BBjClientFile.


Example

See Also

BBjAPI

BBjThinClient

BBjClientFileSystem

BBjClientFile

See the BBj Object Diagram for an illustration of the relationship between BBj Objects.



______________________________________________________________________________________

Copyright BASIS International Ltd. BBj®, Visual PRO/5®, PRO/5®, and BBx® are registered trademarks.