JCL Help:UnlockVolume
JCL Help: UnlockVolume Function
Search in JCL Help
Search in all projects
Summary
Tries to unlock the volume represented by the handle passed.
Pascal
function UnlockVolume(var Handle: THandle): Boolean;
Parameters
| Parameters | Description |
| var Handle: THandle | Handle of the volume to be unlocked previously obtained calling LockVolume function. Also this handle can be obtained by calling CreateFile Windows API function directly. |
Return Value
Returns True if the function succeeded, False otherwise.
Description
Attempts to unlock the volume specified by the handle that was previously locked by LockVolume function.
About
Unit
Donator
Rudy Velthuis
Platforms
Windows NT/2000/Vista: Requires Windows NT 4 or later. Windows 95/98: Unsupported.
Notes
This function calls Windows API DeviceIOControl function. Although Microsoft provides the way to call this function in Windows 95/98/ME environment, the implementation of UnlockVolume does not allow its usage under those operating systems. If the function succeedes the handle associated with the volume is getting freed and you should not use it again as its value will be INVALID_HANDLE_VALUE. However the handle remains valid if the function fails.
Contribute to this help topic
This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page
