Skip to content

Latest commit

 

History

History
233 lines (185 loc) · 5.46 KB

nf-ntmsapi-ejectntmscleaner.md

File metadata and controls

233 lines (185 loc) · 5.46 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.EjectNtmsCleaner
EjectNtmsCleaner function (ntmsapi.h)
The EjectNtmsCleaner function ejects the cleaning cartridge from the currently reserved cleaner slot.
EjectNtmsCleaner
EjectNtmsCleaner function [Files]
NTMS_EJECT_START
NTMS_EJECT_STOP
_zaw_ejectntmscleaner
base.ejectntmscleaner
fs.ejectntmscleaner
ntmsapi/EjectNtmsCleaner
fs\ejectntmscleaner.htm
fs
a55a8f17-1a14-4267-ae39-1585e1090f21
12/05/2018
EjectNtmsCleaner, EjectNtmsCleaner function [Files], NTMS_EJECT_START, NTMS_EJECT_STOP, _zaw_ejectntmscleaner, base.ejectntmscleaner, fs.ejectntmscleaner, ntmsapi/EjectNtmsCleaner
ntmsapi.h
Windows
Windows XP [desktop apps only]
Windows Server 2003 [desktop apps only]
Ntmsapi.lib
Ntmsapi.dll
Windows
19H1
EjectNtmsCleaner
ntmsapi/EjectNtmsCleaner
c++
APIRef
kbSyntax
DllExport
Ntmsapi.dll
EjectNtmsCleaner

EjectNtmsCleaner function

-description

[Removable Storage Manager is no longer available as of Windows 7 and Windows Server 2008 R2.]

The EjectNtmsCleaner function ejects the cleaning cartridge from the currently reserved cleaner slot.

-parameters

-param hSession [in]

Handle to the session returned by the OpenNtmsSession function.

-param lpLibrary [in]

Unique identifier of a library object.

-param lpEjectOperation [in, out]

GUID of the eject process library operation. If dwAction is NTMS_EJECT_START, this parameter receives the GUID for the operation. If dwAction is NTMS_EJECT_STOP, this parameter must be set to the GUID for the operation to be stopped.

-param dwAction [in]

Action to perform. This parameter can be either one of the following values.

Value Meaning
NTMS_EJECT_START
 Starts the eject operation with a port. The specified medium is ejected until the time-out event occurs or the function is called again with NTMS_EJECT_STOP. The time-out value is specified in the library object and is applied to all ejections in the library.
NTMS_EJECT_STOP
 For libraries with NTMS_IEPORT objects only. Terminates the ejection process specified by lpEjectOperation prior to the time-out event lapsing.

-returns

This function returns one of the following values.

Value Meaning
ERROR_ACCESS_DENIED
 Access to one or more RSM objects is denied.
ERROR_INVALID_HANDLE
 The value supplied in the hSession parameter is not valid.
ERROR_INVALID_LIBRARY
 Unable to retrieve the library definition from the database.
ERROR_NO_SLOT_SET
 This library does not have a cleaner slot reserved.
ERROR_NOT_CONNECTED
 Unable to connect to the RSM service.
ERROR_SLOT_EMPTY
 A cleaner slot is reserved but is already empty.
ERROR_SLOT_NOT_PRESENT
 A cleaner slot is reserved but the slot is currently not installed in the library. This error occurs when at least one magazine is missing from the library.
ERROR_SUCCESS
 The function was successful.

-remarks

The EjectNtmsCleaner function returns to the application as soon as the eject request is queued.

If the library specified in the EjectNtmsCleaner function has an NTMS_IEPORT object, RSM uses the NTMS_IEPORT object to eject the cleaner. If there is no NTMS_IEPORT object, the NTMS_IEDOOR object is used to allow the operator to gain access to the cleaner slot.

Ejected cleaner cartridges are not tracked in the offline library.

-see-also

CleanNtmsDrive

Cleaner Management Functions

InjectNtmsCleaner

ReleaseNtmsCleanerSlot

ReserveNtmsCleanerSlot