Fungsi EjectNtmsCleaner (ntmsapi.h)

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

Fungsi EjectNtmsCleaner mengeluarkan kartrid pembersih dari slot pembersih yang saat ini dipesan.

Sintaksis

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

Parameter

[in] hSession

Tangani ke sesi yang dikembalikan oleh fungsi OpenNtmsSession.

[in] lpLibrary

Pengidentifikasi unik objek pustaka.

[in, out] lpEjectOperation

GUID dari operasi pustaka proses keluar. Jika dwAction NTMS_EJECT_START, parameter ini menerima GUID untuk operasi tersebut. Jika dwAction NTMS_EJECT_STOP, parameter ini harus diatur ke GUID agar operasi dihentikan.

[in] dwAction

Tindakan yang harus dilakukan. Parameter ini bisa menjadi salah satu nilai berikut.

Nilai	Arti
NTMS_EJECT_START	Memulai operasi keluar dengan port. Media yang ditentukan dikeluarkan sampai peristiwa waktu habis terjadi atau fungsi dipanggil lagi dengan NTMS_EJECT_STOP. Nilai waktu habis ditentukan dalam objek pustaka dan diterapkan ke semua ejeksi di pustaka.
NTMS_EJECT_STOP	Untuk pustaka dengan objek NTMS_IEPORT saja. Mengakhiri proses ejeksi yang ditentukan oleh lpEjectOperation sebelum peristiwa waktu habis.

Mengembalikan nilai

Fungsi ini mengembalikan salah satu nilai berikut.

Nilai	Arti
ERROR_ACCESS_DENIED	Akses ke satu atau beberapa objek RSM ditolak.
ERROR_INVALID_HANDLE	Nilai yang disediakan dalam parameter hSession tidak valid.
ERROR_INVALID_LIBRARY	Tidak dapat mengambil definisi pustaka dari database.
ERROR_NO_SLOT_SET	Pustaka ini tidak memiliki slot yang lebih bersih yang dicadangkan.
ERROR_NOT_CONNECTED	Tidak dapat tersambung ke layanan RSM.
ERROR_SLOT_EMPTY	Slot pembersih dicadangkan tetapi sudah kosong.
ERROR_SLOT_NOT_PRESENT	Slot pembersih dicadangkan tetapi slot saat ini tidak diinstal di pustaka. Kesalahan ini terjadi ketika setidaknya satu majalah hilang dari pustaka.
ERROR_SUCCESS	Fungsi berhasil.

Komentar

Fungsi EjectNtmsCleaner kembali ke aplikasi segera setelah permintaan keluar diantrekan.

Jika pustaka yang ditentukan dalam fungsi EjectNtmsCleaner memiliki objek NTMS_IEPORT, RSM menggunakan objek NTMS_IEPORT untuk mengeluarkan pembersih. Jika tidak ada objek NTMS_IEPORT, objek NTMS_IEDOOR digunakan untuk memungkinkan operator mendapatkan akses ke slot yang lebih bersih.

Kartrid pembersih yang dikeluarkan tidak dilacak di pustaka offline.

Persyaratan

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

Lihat juga

CleanNtmsDrive

Cleaner Management Functions

InjectNtmsCleaner

ReleaseNtmsCleanerSlot

ReserveNtmsCleanerSlot