ReleaseNtmsCleanerSlot Function

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

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

Syntax

DWORD ReleaseNtmsCleanerSlot(
  __in  HANDLE hSession,
  __in  LPNTMS_GUID lpLibrary
);

Parameters

hSession [in]

Handle to the session returned by the OpenNtmsSession function.

lpLibrary [in]

Unique identifier of the library to release the cleaner slot.

Return Value

This function returns one of the following values.

ValueMeaning
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_DEVICE_NOT_AVAILABLE

The library is not currently connected.

ERROR_INVALID_HANDLE

The value specified in the hSession parameter is not valid.

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 queued successfully.

 

Remarks

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

Requirements

Minimum supported client

Windows 2000 Professional

Minimum supported server

Windows 2000 Server

End of client support

Windows Vista

End of server support

Windows Server 2008

Header

Ntmsapi.h

Library

Ntmsapi.lib

DLL

Ntmsapi.dll

See Also

Cleaner Management Functions
CleanNtmsDrive
EjectNtmsCleaner
InjectNtmsCleaner
ReserveNtmsCleanerSlot

 

 

Send comments about this topic to Microsoft

Build date: 6/9/2011

Show: