CleanNtmsDrive function (ntmsapi.h)
[Removable Storage Manager is no longer available as of Windows 7 and Windows Server 2008 R2.]
The CleanNtmsDrive function queues a cleaning request for the specified drive for cleaning.
Syntax
DWORD CleanNtmsDrive(
[in] HANDLE hSession,
[in] LPNTMS_GUID lpDriveId
);
Parameters
[in] hSession
Handle to the session returned by the OpenNtmsSession function.
[in] lpDriveId
Unique identifier of the drive to be cleaned.
Return value
This function returns one of the following values.
| Value | Meaning |
|---|---|
|
NTMS_CONTROL_ACCESS to the library is denied. Other security errors are also possible, but they would indicate a security subsystem error. |
|
The database is inaccessible or damaged. |
|
The database is full. |
|
The drive ID is not valid. |
|
The session handle is missing or is not valid. |
|
The library for the drive is not valid. |
|
The drive ID is missing. |
|
An allocation failure occurred during processing. |
|
The drive or the library is not enabled. |
|
The cleaning was queued successfully. |
Remarks
If the drive you selected in the CleanNtmsDrive function is a stand-alone drive, the drive is marked as cleaned and the time is noted in the RSM Database.
Queued cleaning requests are deleted when the service is restarted.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | ntmsapi.h |
| Library | Ntmsapi.lib |
| DLL | Ntmsapi.dll |