NameFromLock

Returns the name of a locked object (V36)

Returns a fully qualified path for the Lock. This function is guaranteed not to write more than len characters into the buffer. The name will be null-terminated.

NOTE:

If the volume is not mounted, the system will request it (unless of course you set pr_WindowPtr to -1). If the volume is not mounted or inserted, it will return an error. If the Lock passed in is NULL, "SYS:" will be returned.

The full name of the locked object will consist, in sequence, of the name of the volume, the names of all intermediate directories and also subdirectories, with the name of the locked directory/file/link itself as the final component.

lock

Lock of object to be examined.

buffer

Buffer to store name.

len

Length of buffer.

success

Success/failure indicator. If failure is indicated, call IoErr() to find out why NameFromLock() has failed. If the error returned is ERROR_LINE_TOO_LONG, then the buffer you provided was too short to hold the entire path.

The full name of the locked object always begins with the name of the volume on which the object it stored. Volume names are not guaranteed to be unique. If your use of NameFromLock() depends upon being able to uniquely identify an object, then you will have to resort to other means to achieve this, e.g. by obtaining a Lock on the device's root directory and interpreting the path relative to it (remove the volume name from the path retrieved by NameFromLock(), so that the ":" will be the first character of the path).

The total length of the full name of the locked object may exceed 255 characters, which is the maximum length an Amiga file system is required to support. Path names exceeding this length limit will be truncated, and if you use DeleteFile(), Rename(), Open(), Lock(), etc. you may end up deleting, modifying or accessing the wrong object!

Unless the Lock passed in is NULL, this function requires a shared Lock to work. If an exclusive Lock is used, it will return an error.

NameFromLock() may show unpredictable behaviour if the ChangeMode() function was used with a mode which is none of SHARED_LOCK or EXCLUSIVE_LOCK.

Should return the name of the boot volume instead of SYS: for a NULL Lock.

NameFromFH(), Lock(), Open(), DeleteFile(), Rename(), ChangeMode()