NWRenameFile(3nw)

NWRenameFile -- allows client to rename file

Synopsis

#include <nwfile.h> or #include <nwcalls.h>

NWCCODE N_API NWRenameFile (NWCONN_HANDLE conn, NWDIR_HANDLE oldDirHandle, pnstr8 oldFileName, nuint8 searchAttrs, NWDIR_HANDLE newDirHandle, pnstr8 newFileName);

Description

The parameters are as follows:

conn: (IN) Specifies the NetWare server connection handle containing the file.
oldDirHandle: (IN) Specifies the directory handle containing the file.
oldFileName: (IN) Points to a string containing the original name of the file being renamed.
searchAttrs: (IN) Specifies the attributes to use in searching for the specified file.
newDirHandle: (IN) Specifies the new directory handle to contain the specified file.
newFileName: (IN) Points to the string containing the new name of the file.

Return values

0x0000: SUCCESSFUL
0x8801: INVALID_CONNECTION
0x8987: WILD_CARDS_IN_CREATE_FILE_NAME or CREATE_FILENAME_ERROR
0x898B: NO_RENAME_PRIVILEGES
0x898D: SOME_FILES_AFFECTED_IN_USE
0x898E: NO_FILES_AFFECTED_IN_USE
0x898F: SOME_FILES_AFFECTED_READ_ONLY
0x8990: NO_FILES_AFFECTED_READ_ONLY
0x8991: SOME_FILES_RENAMED_NAME_EXISTS
0x8992: NO_FILES_RENAMED_NAME_EXISTS
0x8996: SERVER_OUT_OF_MEMORY
0x8998: VOLUME_DOES_NOT_EXIST
0x899A: RENAMING_ACROSS_VOLUMES
0x899B: BAD_DIRECTORY_HANDLE
0x899C: INVALID_PATH
0x89A1: DIRECTORY_IO_ERROR
0x89FD: BAD_STATION_NUMBER
0x89FF: Failure, NO_FILES_FOUND_ERROR

Notices

The source directory (where the file resides) and the target directory (where the renamed file is to be deposited) do not need to be the same directory. However, the two files must reside on the same server. NWRenameFile cannot move a file from one server to another or from one volume to another.

oldDirHandle can be zero if oldFileName points to the complete path, including the volume name.

searchAttrs is used to include system and/or hidden files. In other words, if only the system bit is set in searchAttrs, all files are affected except hidden files. If only the hidden bit is set, all files are affected except system files. When neither bit is set (0x00), only files that are not designated either hidden or system are affected.

NOTE: A file is designated hidden or system if its corresponding file attribute is set.

searchAttrs values follow:

0x00: FA_NORMAL
0x01: FA_READ_ONLY
0x02: FA_HIDDEN
0x04: FA_SYSTEM
0x08: FA_EXECUTE_ONLY
0x20: FA_NEEDS_ARCHIVED
0x80: FA_SHAREABLE

Since the path length is restricted to 256 bytes, applications must call NWAllocTemporaryDirectoryHandle to allocate dirHandle for path lengths greater than 256 bytes.

Services

File Systems

NCP calls

0x2222 23 17 Get File Server Information

0x2222 69 - Rename File

0x2222 87 04 Rename Or Move A File Or Subdirectory

 
 ----------------------------------------- 
| 0x2222|  23|  17|  Get File Server     | 
|       |    |    |  Information         | 
|-------|----|----|----------------------| 
| 0x2222|  69|  - |  Rename File         | 
|-------|----|----|----------------------| 
| 0x2222|  87|  04|  Rename Or Move A    | 
|       |    |    |  File Or Subdirectory| 
|-------|----|----|----------------------|

References

NWPurgeErasedFiles(3nw), NWAllocTemporaryDirectoryHandle(3nw)

0x2222	23	17	Get File Server Information
0x2222	69	-	Rename File
0x2222	87	04	Rename Or Move A File Or Subdirectory