Method ITcFileAccess:FileRename

Renames a file.

Syntax

virtual HRESULT TCOMAPI FileRename(PCCH szOldName, PCCH szNewName);

Parameter

szOldName: (type: PCCH) [in] the file name to be changed.

szNewName: (type: PCCH) [in] the new file name.

Return value

If successful, S_OK ("0") or another positive value will be returned, cf. Return values. Extended messages refer in particular to the column HRESULT in ADS Return Codes.

A particularly interesting error code is ADSERR_DEVICE_TIMEOUT if the timeout (5 seconds) has elapsed.

Description

This method renames a file from an old name to a new name.