ReleaseNtmsCleanerSlot

[This is preliminary documentation and subject to change.]

The ReleaseNtmsCleanerSlot function removes an existing slot reservation for a cleaning cartridge. The slot can then be used for data cartridges.

DWORD WINAPI ReleaseNtmsCleanerSlot(
  HANDLE hSession, 
  LPNTMS_GUID lpLibrary
);
 

Parameters

hSession

Handle to the session returned by the OpenNtmsSession function.

lpLibrary

Specifies the unique identifier of the library to set the cleaner slot.

Return Values

ERROR_ DEVICE_NOT_AVAILABLE

The library is not currently connected.

ERROR_INVALID_HANDLE

The value specified in the hSession parameter is invalid.

ERROR_NOT_CONNECTED

Unable to connect to the RSM service.

ERROR_NO_SLOT_RESERVED

This library has no slot reserved for a cleaner cartridge.

ERROR_SLOT_FULL

The library has a reserved cleaner cartridge slot but the slot contains a cleaner cartridge (the slot must be empty). Use the EjectNtmsCleaner function to eject a cleaner cartridge.

ERROR_SLOT_NOT_PRESENT

The library has a reserved cleaner cartridge slot, but the specified slot is currently not installed in the library. This error can occur if at least one magazine is missing from the library.

ERROR_SUCCESS

The function was successful.

Remarks

For the ReleaseNtmsCleanerSlot function to succeed, the slot must be present and empty. The library must also have a slot reserved for cleaning.

QuickInfo

  Windows NT: Requires version 5.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in ntmsapi.h.
  Import Library: Use ntmsapi.lib.

See Also

Cleaner Management Functions, CleanNtmsDrive, EjectNtmsCleaner, InjectNtmsCleaner, ReserveNtmsCleanerSlot