EjectNtmsCleaner function (ntmsapi.h)
[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.
DWORD EjectNtmsCleaner(
[in] HANDLE hSession,
[in] LPNTMS_GUID lpLibrary,
[in, out] LPNTMS_GUID lpEjectOperation,
[in] DWORD dwAction
);
[in] hSession
Handle to the session returned by the OpenNtmsSession function.
[in] lpLibrary
Unique identifier of a library object.
[in, out] lpEjectOperation
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.
[in] dwAction
Action to perform. This parameter can be either one of the following values.
This function returns one of the following values.
Value | Meaning |
---|---|
|
Access to one or more RSM objects is denied. |
|
The value supplied in the hSession parameter is not valid. |
|
Unable to retrieve the library definition from the database. |
|
This library does not have a cleaner slot reserved. |
|
Unable to connect to the RSM service. |
|
A cleaner slot is reserved but is already empty. |
|
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. |
|
The function was successful. |
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.
Requirement | Value |
---|---|
Minimum supported client | Windows XP [desktop apps only] |
Minimum supported server | Windows Server 2003 [desktop apps only] |
Target Platform | Windows |
Header | ntmsapi.h |
Library | Ntmsapi.lib |
DLL | Ntmsapi.dll |