Fungsi InjectNtmsCleaner (ntmsapi.h)

[Manajer Penyimpanan yang Dapat Dilepas tidak lagi tersedia pada Windows 7 dan Windows Server 2008 R2.]

Fungsi InjectNtmsCleaner memungkinkan kartrid pembersih dimasukkan ke dalam unit pustaka yang ditentukan.

Sintaks

DWORD InjectNtmsCleaner(
  [in]      HANDLE      hSession,
  [in]      LPNTMS_GUID lpLibrary,
  [in, out] LPNTMS_GUID lpInjectOperation,
  [out]     DWORD       dwNumberOfCleansLeft,
  [in]      DWORD       dwAction
);

Parameter

[in] hSession

Tangani ke sesi yang dikembalikan oleh fungsi OpenNtmsSession .

[in] lpLibrary

Pengidentifikasi unik objek pustaka.

[in, out] lpInjectOperation

GUID dari operasi sisipkan pustaka proses. Jika dwAction NTMS_INJECT_START, parameter ini menerima GUID untuk operasi. Jika dwAction NTMS_INJECT_STOP, parameter ini harus diatur ke GUID agar operasi dihentikan.

[out] dwNumberOfCleansLeft

Jumlah siklus pembersihan yang tersisa pada kartrid pembersih yang dimasukkan.

[in] dwAction

Parameter ini bisa menjadi salah satu nilai berikut.

Nilai	Makna
NTMS_INJECT_START	Mulai penyisipan dengan NTMS_IEPORT atau objek NTMS_IEDOOR. Kartrid pembersih tunggal harus dimasukkan. Jika objek NTMS_IEDOOR digunakan, tidak ada inventori yang akan dilakukan pada pustaka.
NTMS_INJECT_STOP	Mengakhiri penyisipan sebelum lap peristiwa waktu habis. (Hanya untuk pustaka dengan port.)

Nilai kembali

Fungsi ini mengembalikan salah satu nilai berikut.

Nilai	Makna
ERROR_ACCESS_DENIED	Akses ke setidaknya satu objek RSM ditolak.
ERROR_DEVICE_NOT_AVAILABLE	Pustaka saat ini tidak tersambung.
ERROR_INVALID_HANDLE	Nilai yang ditentukan dalam parameter hSession tidak valid.
ERROR_INVALID_LIBRARY	Tidak dapat mengambil definisi pustaka dari database.
ERROR_LIBRARY_OFFLINE	Pustaka harus online agar kartrid pembersih dimasukkan.
ERROR_NO_SLOT_SET	Pustaka ini tidak memiliki slot yang dicadangkan sebagai slot yang lebih bersih.
ERROR_SLOT_FULL	Slot yang lebih bersih dicadangkan tetapi sudah memiliki kartrid yang lebih bersih. Kartrid pembersih harus dikeluarkan terlebih dahulu, menggunakan fungsi EjectNtmsCleaner .
ERROR_SLOT_NOT_PRESENT	Slot pembersih dicadangkan tetapi slot yang ditentukan saat ini tidak diinstal di pustaka. Kesalahan ini terjadi jika setidaknya satu majalah hilang dari pustaka.
ERROR_SUCCESS	Fungsi berhasil.

Keterangan

Fungsi ini kembali ke aplikasi segera setelah permintaan sisipan diantrekan.

Untuk menggunakan fungsi InjectNtmsCleaner , jumlah siklus pembersihan yang tetap berada di kartrid pembersih harus ditentukan sehingga RSM dapat melacaknya.

Jika objek NTMS_IEPORT tersedia, objek NTMS_IEPORT mengarahkan kartrid ke slot pembersih yang saat ini dipesan.

Jika tidak ada objek NTMS_IEPORT, akses pintu dilakukan. Dalam hal ini, operator diarahkan untuk menempatkan media ke slot yang dipesan.

Persyaratan

Persyaratan	Nilai
Klien minimum yang didukung	Windows XP [hanya aplikasi desktop]
Server minimum yang didukung	Windows Server 2003 [hanya aplikasi desktop]
Target Platform	Windows
Header	ntmsapi.h
Pustaka	Ntmsapi.lib
DLL	Ntmsapi.dll

Lihat juga

CleanNtmsDrive

Fungsi Manajemen Pembersih

EjectNtmsCleaner

ReleaseNtmsCleanerSlot

ReserveNtmsCleanerSlot