InjectNtmsCleaner 函式 (ntmsapi.h)
[從 Windows 7 和 Windows Server 2008 R2 起,已不再提供卸除式儲存管理員 。]
InjectNtmsCleaner 函式允許更簡潔的管子插入指定的連結庫單位。
語法
DWORD InjectNtmsCleaner(
[in] HANDLE hSession,
[in] LPNTMS_GUID lpLibrary,
[in, out] LPNTMS_GUID lpInjectOperation,
[out] DWORD dwNumberOfCleansLeft,
[in] DWORD dwAction
);
參數
[in] hSession
OpenNtmsSession 函式所傳回之會話的句柄。
[in] lpLibrary
連結庫物件的唯一標識符。
[in, out] lpInjectOperation
插入進程連結庫作業的 GUID。 如果 dwAction 是NTMS_INJECT_START,此參數會接收作業的 GUID。 如果 dwAction 是NTMS_INJECT_STOP,則必須將此參數設定為 GUID,才能停止作業。
[out] dwNumberOfCleansLeft
插入的清理紙上剩餘的清除週期數目。
[in] dwAction
此參數可以是下列其中一個值。
值 | 意義 |
---|---|
|
使用 NTMS_IEPORT 或 NTMS_IEDOOR 物件開始插入。 應該插入單一清理器。 如果使用NTMS_IEDOOR物件,則不會對連結庫執行清查。 |
|
在逾時事件中斷之前終止插入。 (僅適用於具有埠的連結庫。) |
傳回值
此函式會傳回下列其中一個值。
值 | 意義 |
---|---|
|
拒絕存取至少一個 RSM 物件。 |
|
連結庫目前未連線。 |
|
hSession 參數中指定的值無效。 |
|
無法從資料庫擷取連結庫定義。 |
|
連結庫必須上線,才能插入更簡潔的紙筒。 |
|
此連結庫沒有保留為清除位置的位置。 |
|
清除器位置已保留,但已有更簡潔的清理器。 必須先使用退出清除器函式,再使用 EjectNtmsCleaner 函式。 |
|
保留較簡潔的位置,但目前未在連結庫中安裝指定的位置。 如果文檔庫中至少有一個雜誌遺失,就會發生此錯誤。 |
|
函式成功。 |
備註
此函式會在插入要求排入佇列時立即返回應用程式。
若要使用 InjectNtmsCleaner 函 式,必須指定保留在清理器上的清理週期數目,才能讓 RSM 追蹤它。
如果NTMS_IEPORT物件可供使用,NTMS_IEPORT物件會將NTMS_IEPORT導向至目前保留的清除器位置。
如果沒有NTMS_IEPORT物件,則會執行門存取。 在此情況下,運算符會導向將媒體放入保留位置。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows XP [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2003 [僅限桌面應用程式] |
目標平台 | Windows |
標頭 | ntmsapi.h |
程式庫 | Ntmsapi.lib |
Dll | Ntmsapi.dll |