InjectNtmsCleaner-Funktion (ntmsapi.h)

Artikel
08/25/2023

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

Die Funktion InjectNtmsCleaner ermöglicht das Einfügen einer saubereren Patrone in die angegebene Bibliothekseinheit.

Syntax

DWORD InjectNtmsCleaner(
  [in]      HANDLE      hSession,
  [in]      LPNTMS_GUID lpLibrary,
  [in, out] LPNTMS_GUID lpInjectOperation,
  [out]     DWORD       dwNumberOfCleansLeft,
  [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] lpInjectOperation

GUID des Vorgangs zum Einfügen der Prozessbibliothek. Wenn dwAction NTMS_INJECT_START ist, empfängt dieser Parameter die GUID für den Vorgang. Wenn dwAction NTMS_INJECT_STOP ist, muss dieser Parameter auf die GUID festgelegt werden, damit der Vorgang beendet wird.

[out] dwNumberOfCleansLeft

Anzahl der Reinigungszyklen, die auf der eingesetzten Reinigungspatrone verbleiben.

[in] dwAction

Dieser Parameter kann einen der folgenden Werte annehmen.

Wert	Bedeutung
NTMS_INJECT_START	Starten Sie die Einfügung entweder mit dem NTMS_IEPORT- oder dem NTMS_IEDOOR-Objekt. Eine einzelne Reinigerpatrone sollte eingesetzt werden. Wenn das NTMS_IEDOOR-Objekt verwendet wird, wird keine Inventur für die Bibliothek durchgeführt.
NTMS_INJECT_STOP	Beendet die Einfügung, bevor das Timeoutereignis abgelaufen ist. (Nur für Bibliotheken mit Ports.)

Rückgabewert

Diese Funktion gibt einen der folgenden Werte zurück.

Wert	Bedeutung
ERROR_ACCESS_DENIED	Der Zugriff auf mindestens ein RSM-Objekt wird verweigert.
ERROR_DEVICE_NOT_AVAILABLE	Die Bibliothek ist derzeit nicht verbunden.
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_LIBRARY_OFFLINE	Die Bibliothek muss online sein, damit eine sauberere Patrone eingefügt werden kann.
ERROR_NO_SLOT_SET	Diese Bibliothek verfügt über keinen Slot, der als saubererer Slot reserviert ist.
ERROR_SLOT_FULL	Ein saubererer Slot ist reserviert, verfügt aber bereits über eine sauberere Patrone. Die Reinigungspatrone muss zuerst mit der Funktion EjectNtmsCleaner ausgeworfen werden.
ERROR_SLOT_NOT_PRESENT	Ein saubererer Slot ist reserviert, aber der angegebene 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

Diese Funktion kehrt an die Anwendung zurück, sobald die Einfügeanforderung in die Warteschlange eingereiht wird.

Um die InjectNtmsCleaner-Funktion zu verwenden, muss die Anzahl der Reinigungszyklen angegeben werden, die auf der Reinigungspatrone verbleiben, damit RSM sie nachverfolgen kann.

Wenn ein NTMS_IEPORT-Objekt verfügbar ist, leitet das NTMS_IEPORT-Objekt die Patrone an den derzeit reservierten Reinigungsslot weiter.

Wenn kein NTMS_IEPORT-Objekt vorhanden ist, wird ein Türzugriff ausgeführt. In diesem Fall wird der Operator angewiesen, die Medien im reservierten Slot zu platzieren.

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

Übersichtlichere Verwaltungsfunktionen

EjectNtmsCleaner

ReleaseNtmsCleanerSlot

ReserveNtmsCleanerSlot

Freigeben über