BBjClientFile::renameTo

Description

In BBj 7.0 and higher, this method renames the file represented by this BBjClientFile to the specified value.

Syntax

Return Value

Method

boolean

renameTo(BBjClientFile newName!)

Parameters

Variable

Description

newName!

The new name of the file.

Return Value

Returns true (1) if the operation succeeded and false (0) if it failed.

Remarks

This method does not change the name reported by the current BBjClientFile object. After successfully calling renameTo, the BBjClientFile represented by newName! should be used.

This method may not be able to move files from one filesystem to another, and may fail if the file named by newName! already exists.

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.