Job Management Partner 1/Software Distribution Automatic Installation Tool Description and Reference

[Contents][Glossary][Index][Back][Next]

AIT_FileRename

Description

Change a file or directory name.

Format

bool AIT_FileRename (
  string strFileName,       // Current filename
  string strNewFileName     // New filename
);

Parameters

strFileName (input)

Specify a file or directory name you want to change.

strNewFileName (input)

Specify a new file or directory name.

Return values

The return value is true if the function was executed normally, and false if not. If the function has returned false, you can use AIT_GetLastError to acquire an extended error code. The following gives the error codes that AIT_GetLastError may return.

Extended error number Error code
2 ERROR_FILE_NOT_FOUND
3 ERROR_PATH_NOT_FOUND
5 ERROR_ACCESS_DENIED
6 ERROR_INVALID_HANDLE
8 ERROR_NOT_ENOUGH_MEMORY
14 ERROR_OUTOFMEMORY
15 ERROR_INVALID_DRIVE
19 ERROR_WRITE_PROTECT
21 ERROR_NOT_READY
38 ERROR_HANDLE_EOF
53 ERROR_BAD_NETPATH
80 ERROR_FILE_EXISTS
82 ERROR_CANNOT_MAKE
87 ERROR_INVALID_PARAMETER
123 ERROR_INVALID_NAME
148 ERROR_PATH_BUSY
161 ERROR_BAD_PATHNAME
1005 ERROR_UNRECOGNIZED_VOLUME
1210 ERROR_INVALID_COMPUTERNAME
1214 ERROR_INVALID_NETNAME
1231 ERROR_NETWORK_UNREACHABLE