EjectNtmsCleaner-Funktion (ntmsapi.h)

Artikel
08/25/2023

[Wechseldatenträger-Manager ist ab Windows 7 und Windows Server 2008 R2 nicht mehr verfügbar.]

Die Funktion EjectNtmsCleaner wirft die Reinigungskassette aus dem derzeit reservierten Reinigerslot aus.

Syntax

DWORD EjectNtmsCleaner(
  [in]      HANDLE      hSession,
  [in]      LPNTMS_GUID lpLibrary,
  [in, out] LPNTMS_GUID lpEjectOperation,
  [in]      DWORD       dwAction
);

Parameter

[in] hSession

Handle für die von der OpenNtmsSession-Funktion zurückgegebene Sitzung.

[in] lpLibrary

Eindeutiger Bezeichner eines Bibliotheksobjekts.

[in, out] lpEjectOperation

GUID des Vorgangs der Auswerfprozessbibliothek. Wenn dwAction NTMS_EJECT_START ist, empfängt dieser Parameter die GUID für den Vorgang. Wenn dwAction NTMS_EJECT_STOP ist, muss dieser Parameter auf die GUID festgelegt werden, damit der Vorgang beendet wird.

[in] dwAction

Auszuführende Aktion. Dieser Parameter kann einer der folgenden Werte sein.

Wert	Bedeutung
NTMS_EJECT_START	Startet den Auswurfvorgang mit einem Port. Das angegebene Medium wird ausgeworfen, bis das Timeoutereignis auftritt oder die Funktion mit NTMS_EJECT_STOP erneut aufgerufen wird. Der Timeoutwert wird im Bibliotheksobjekt angegeben und auf alle Auswerfungen in der Bibliothek angewendet.
NTMS_EJECT_STOP	Nur für Bibliotheken mit NTMS_IEPORT-Objekten. Beendet den von lpEjectOperation angegebenen Auswurfprozess vor Ablauf des Timeoutereignisses.

Rückgabewert

Diese Funktion gibt einen der folgenden Werte zurück.

Wert	Bedeutung
ERROR_ACCESS_DENIED	Der Zugriff auf ein oder mehrere RSM-Objekte wird verweigert.
ERROR_INVALID_HANDLE	Der im hSession-Parameter angegebene Wert ist ungültig.
ERROR_INVALID_LIBRARY	Die Bibliotheksdefinition kann nicht aus der Datenbank abgerufen werden.
ERROR_NO_SLOT_SET	Diese Bibliothek verfügt nicht über einen saubereren Slot.
ERROR_NOT_CONNECTED	Es kann keine Verbindung mit dem RSM-Dienst hergestellt werden.
ERROR_SLOT_EMPTY	Ein saubererer Slot ist reserviert, aber bereits leer.
ERROR_SLOT_NOT_PRESENT	Ein saubererer Slot ist reserviert, aber der Slot ist derzeit nicht in der Bibliothek installiert. Dieser Fehler tritt auf, wenn mindestens ein Magazin in der Bibliothek fehlt.
ERROR_SUCCESS	Die Funktion war erfolgreich.

Hinweise

Die Funktion EjectNtmsCleaner kehrt zur Anwendung zurück, sobald die Auswerfanforderung in die Warteschlange gestellt wird.

Wenn die in der Funktion EjectNtmsCleaner angegebene Bibliothek über ein NTMS_IEPORT-Objekt verfügt, verwendet RSM das NTMS_IEPORT-Objekt, um den Cleaner auszuwerfen. Wenn kein NTMS_IEPORT-Objekt vorhanden ist, wird das NTMS_IEDOOR-Objekt verwendet, um dem Operator den Zugriff auf den Sauberer-Slot zu ermöglichen.

Ausgeworfene Reinigerkassetten werden nicht in der Offlinebibliothek nachverfolgt.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	ntmsapi.h
Bibliothek	Ntmsapi.lib
DLL	Ntmsapi.dll

Weitere Informationen

CleanNtmsDrive

Sauberere Verwaltungsfunktionen

InjectNtmsCleaner

ReleaseNtmsCleanerSlot

ReserveNtmsCleanerSlot

Freigeben über