220.127.116.11.1.4 INtmsLibraryControl1::CleanNtmsDrive (Opnum 6)
The CleanNtmsDrive method queues a cleaning request for a drive.
HRESULT CleanNtmsDrive( [in] LPNTMS_GUID lpDriveId );
lpDriveId: A pointer to the identifier of a drive.
The call was successful.
Access to an object was denied.
An allocation failure occurred during processing.
The drive identifier is not valid.
A parameter is not valid.
The library identifier is not valid.
The resource required for this operation is disabled.
The database query or update failed.
The database is full.
The resource that is required for this operation does not exist.
The device is not available; it might be disabled or offline.
Upon receiving this message, the server MUST verify that lpDriveId is not NULL. If it is NULL, the server MUST immediately fail the operation and return ERROR_INVALID_PARAMETER (0x80070057).
If the parameter validation succeeds, the server MUST check the access to the library and verify that the library is enabled and online before making the call. If the client does not have the required access rights, NTMS_CONTROL_ACCESS to the library is denied and the server MUST return ERROR_ACCESS_DENIED (0x80070005). Other security errors are possible, but they indicate a security subsystem error. If the library is disabled, the server MUST return ERROR_RESOURCE_DISABLED (0x800710D5). If the library is offline, the server MUST return ERROR_RESOURCE_NOT_PRESENT (0x800710DC).
If the drive selected in the CleanNtmsDrive method is a stand-alone drive, the drive MUST be marked as cleaned and the time is noted in the server database; otherwise, the server MUST check for a cleaner and issue an operator request to mount one.
On completion of an asynchronous operation, notification will be sent with the identifier lpDriveId.