退出NtmsCleaner 函式 (ntmsapi.h)
[從 Windows 7 和 Windows Server 2008 R2 起,已不再提供卸除式儲存管理員 。]
退出NtmsCleaner 函式會從目前保留的清除器位置退出清理器。
語法
DWORD EjectNtmsCleaner(
[in] HANDLE hSession,
[in] LPNTMS_GUID lpLibrary,
[in, out] LPNTMS_GUID lpEjectOperation,
[in] DWORD dwAction
);
參數
[in] hSession
OpenNtmsSession 函式所傳回之會話的句柄。
[in] lpLibrary
連結庫物件的唯一標識符。
[in, out] lpEjectOperation
退出行程連結庫作業的 GUID。 如果 dwAction 是NTMS_EJECT_START,此參數會接收作業的 GUID。 如果 dwAction 是NTMS_EJECT_STOP,則必須將此參數設定為 GUID,才能停止作業。
[in] dwAction
要執行的動作。 這個參數可以是下列其中一個值。
值 | 意義 |
---|---|
|
使用埠啟動退出作業。 指定的媒體會退出,直到發生逾時事件,或使用 NTMS_EJECT_STOP 再次呼叫函式。 逾時值是在連結庫物件中指定,並套用至連結庫中的所有退出。 |
|
僅適用於具有 NTMS_IEPORT 對象的連結庫。 在逾時事件中斷之前,終止 lpEjectOperation 指定的退出程式。 |
傳回值
此函式會傳回下列其中一個值。
值 | 意義 |
---|---|
|
拒絕存取一或多個 RSM 物件。 |
|
hSession 參數中提供的值無效。 |
|
無法從資料庫擷取連結庫定義。 |
|
此連結庫沒有保留更簡潔的位置。 |
|
無法連線到 RSM 服務。 |
|
清除器位置已保留,但已經是空的。 |
|
保留較簡潔的位置,但位置目前未安裝在連結庫中。 當文檔庫中至少有一個雜誌遺失時,就會發生此錯誤。 |
|
函式成功。 |
備註
一旦退出要求排入佇列, 退出 要求就會返回應用程式。
如果在 退出NtmsCleaner 函式中指定的連結庫具有NTMS_IEPORT物件,RSM 會使用 NTMS_IEPORT 物件來退出清除器。 如果沒有NTMS_IEPORT物件,則會使用 NTMS_IEDOOR 對象來允許運算符存取更簡潔的位置。
離線連結庫中不會追蹤退出的清理器。
規格需求
需求 | 值 |
---|---|
最低支援的用戶端 | Windows XP [僅限傳統型應用程式] |
最低支援的伺服器 | Windows Server 2003 [僅限桌面應用程式] |
目標平台 | Windows |
標頭 | ntmsapi.h |
程式庫 | Ntmsapi.lib |
Dll | Ntmsapi.dll |