Skip to content

Latest commit

 

History

History
216 lines (176 loc) · 4.24 KB

nf-ntmsapi-cleanntmsdrive.md

File metadata and controls

216 lines (176 loc) · 4.24 KB
Raw
UID title description helpviewer_keywords old-location tech.root ms.assetid ms.date ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames req.redist ms.custom f1_keywords dev_langs topic_type api_type api_location api_name
NF:ntmsapi.CleanNtmsDrive
CleanNtmsDrive function (ntmsapi.h)
The CleanNtmsDrive function queues a cleaning request for the specified drive for cleaning.
CleanNtmsDrive
CleanNtmsDrive function [Files]
_zaw_cleanntmsdrive
base.cleanntmsdrive
fs.cleanntmsdrive
ntmsapi/CleanNtmsDrive
fs\cleanntmsdrive.htm
fs
55a8e7c0-85fd-40c5-b5b9-46ad321761c4
12/05/2018
CleanNtmsDrive, CleanNtmsDrive function [Files], _zaw_cleanntmsdrive, base.cleanntmsdrive, fs.cleanntmsdrive, ntmsapi/CleanNtmsDrive
ntmsapi.h
Windows
Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
Ntmsapi.lib
Ntmsapi.dll
Windows
19H1
CleanNtmsDrive
ntmsapi/CleanNtmsDrive
c++
APIRef
kbSyntax
DllExport
Ntmsapi.dll
CleanNtmsDrive

CleanNtmsDrive function

-description

[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.

-parameters

-param hSession [in]

Handle to the session returned by the OpenNtmsSession function.

-param lpDriveId [in]

Unique identifier of the drive to be cleaned.

-returns

This function returns one of the following 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_INVALID_DRIVE
 The drive ID is not valid.
ERROR_INVALID_HANDLE
 The session handle is missing or is not valid.
ERROR_INVALID_LIBRARY
 The library for the drive is not valid.
ERROR_INVALID_PARAMETER
 The drive ID is missing.
ERROR_NOT_ENOUGH_MEMORY
 An allocation failure occurred during processing.
ERROR_RESOURCE_DISABLED
 The drive or the library is not enabled.
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.

-see-also

Cleaner Management Functions

EjectNtmsCleaner

InjectNtmsCleaner

ReleaseNtmsCleanerSlot

ReserveNtmsCleanerSlot