Platform SDK: Removable Storage Manager

CleanNtmsDrive

The CleanNtmsDrive function queues a cleaning request for the specified drive for cleaning.

DWORD WINAPI CleanNtmsDrive(
  HANDLE hSession, 
  LPNTMS_GUID lpDriveId
);

Parameters

hSession: Handle to the session returned by the OpenNtmsSession function.
lpDriveId: Specifies the unique identifier of the drive to be cleaned.

Return Values

Value	Meaning
ERROR_ACCESS_DENIED	NTMS_CONTROL_ACCESS to the library is denied. Other security errors are also possible, but they would indicate a security subsystem error.
ERROR_DATABASE_FAILURE	The database is inaccessible or damaged.
ERROR_DATABASE_FULL	The database is full.
ERROR_DEVICE_NOT AVAILABLE	The drive or the library is not enabled.
ERROR_INVALID_DRIVE	The drive ID is invalid.
ERROR_INVALID_HANDLE	The session handle is invalid or missing.
ERROR_INVALID_LIBRARY	The library for the drive is invalid.
ERROR_INVALID_PARAMETER	The drive ID is missing.
ERROR_NOT_ENOUGH_MEMORY	An allocation failure occurred during processing.
ERROR_SUCCESS	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

  Windows NT/2000: Requires Windows 2000.
  Header: Declared in Ntmsapi.h.
  Library: Use Ntmsapi.lib.

CleanNtmsDrive

Parameters

Return Values

Remarks

Requirements

See Also