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.InjectNtmsCleaner |
InjectNtmsCleaner function (ntmsapi.h) |
The InjectNtmsCleaner function allows a cleaner cartridge to be inserted into the specified library unit. |
|
fs\injectntmscleaner.htm |
fs |
973441cb-2ec4-4a8d-8e75-3c6d01552a59 |
12/05/2018 |
InjectNtmsCleaner, InjectNtmsCleaner function [Files], NTMS_INJECT_START, NTMS_INJECT_STOP, _zaw_injectntmscleaner, base.injectntmscleaner, fs.injectntmscleaner, ntmsapi/InjectNtmsCleaner |
ntmsapi.h |
Windows |
Windows XP [desktop apps only] |
Windows Server 2003 [desktop apps only] |
Ntmsapi.lib |
Ntmsapi.dll |
Windows |
19H1 |
|
|
|
|
|
|
[Removable Storage Manager is no longer available as of Windows 7 and Windows Server 2008 R2.]
The InjectNtmsCleaner function allows a cleaner cartridge to be inserted into the specified library unit.
Handle to the session returned by the OpenNtmsSession function.
Unique identifier of a library object.
GUID of the insert process library operation. If dwAction is NTMS_INJECT_START, this parameter receives the GUID for the operation. If dwAction is NTMS_INJECT_STOP, this parameter must be set to the GUID for the operation to be stopped.
Number of cleaning cycles left on the inserted cleaning cartridge.
This parameter can be one of the following values.
This function returns one of the following values.
Value | Meaning |
---|---|
|
Access to at least one RSM object is denied. |
|
The library is not currently connected. |
|
The value specified in the hSession parameter is not valid. |
|
Unable to retrieve the library definition from the database. |
|
The library must be online for a cleaner cartridge to be inserted. |
|
This library has no slot reserved as a cleaner slot. |
|
A cleaner slot is reserved but already has a cleaner cartridge. The cleaner cartridge must be ejected first, using the EjectNtmsCleaner function. |
|
A cleaner slot is reserved but the slot specified is currently not installed in the library. This error occurs if at least one magazine is missing from the library. |
|
The function was successful. |
This function returns to the application as soon as the insert request is queued.
To use the InjectNtmsCleaner function, the number of cleaning cycles that remain on the cleaner cartridge must be specified so that RSM can keep track of it.
If an NTMS_IEPORT object is available, the NTMS_IEPORT object directs the cartridge to the currently reserved cleaner slot.
If there is no NTMS_IEPORT object, a door access is performed. In this case, the operator is directed to place the media into the reserved slot.