共用方式為

SetNtmsUIOptionsW 函式 (ntmsapi.h)

  • 發行項

[從 Windows 7 和 Windows Server 2008 R2 起，已不再提供卸除式儲存管理員 。]

SetNtmsUIOptions 函式會修改指定之 UI 類型針對指定對象導向的電腦名稱清單。

語法

DWORD SetNtmsUIOptionsW(
  [in]  HANDLE            hSession,
  [in]  const LPNTMS_GUID lpObjectId,
  [in]  DWORD             dwType,
  [in]  DWORD             dwOperation,
  [out] LPCWSTR           lpszDestination
);

參數

[in] hSession

OpenNtmsSession 函式所傳回之會話的句柄。

[in] lpObjectId

要重新導向UI之物件的唯一標識碼。 對象必須是可以是事件來源的容器。 物件可以是應用程式 (應用程式) 觸發的掛接要求、連結庫 (門開啟要求，以回應退出) 或計算機 (與計算機) 相關的所有 UI。

若要指定計算機容器，請將 lpObjectId 指標設定為指向具有卸載式儲存管理員計算機物件 GUID 的緩衝區。 若要指定特定連結庫，請將它設定為指向具有連結庫 GUID 的緩衝區。 若要指定應用程式，請傳入 NULL 指標。 應用程式的身分識別是由 hSession 中使用的會話所決定。 請注意，應用程式可以同時開啟多個會話。 在此情況下，設定的值僅適用於 hSession 工作階段。 在連結庫或計算機實例的情況下，設定會持續存在，直到明確變更為止。 關閉工作階段時，會刪除應用程式資料列。

[in] dwType

此參數可以有下列其中一個值。

值 意義
NTMS_UITYPE_INFO
 提供資訊的UI訊息。 其中包括指出進度的工作佇列專案。 例如，掛接要求。
NTMS_UITYPE_REQ
 要求UI訊息。 這些包括處理媒體的運算元要求。 例如，插入新媒體的要求。
NTMS_UITYPE_ERR
 提供錯誤資訊的 UI 訊息。 其中包括與錯誤通知相關的運算符要求。 例如，清除磁碟驅動器的要求。

[in] dwOperation

此參數可以有下列其中一個值。

值 意義
NTMS_UIDEST_ADD
 將新的目的地 (電腦名稱) 新增至清單。
NTMS_UIDEST_DELETE
 從清單中移除目的地。
NTMS_UIDEST_DELETEALL
 從清單中清除所有目的地。 不會產生物件的UI。 在此情況下，會忽略目的地自變數。

[out] lpszDestination

多字串，會傳回要重新導向 UI 的計算機名稱。 此參數不可為 NULL。

傳回值

此函式會傳回下列其中一個值。

值 意義
ERROR_ACCESS_DENIED
 拒絕存取一或多個 RSM 物件。
ERROR_ALREADY_EXISTS
 指定的目的地已存在於清單中。
ERROR_INVALID_HANDLE
 會話句柄遺失或無效。
ERROR_INVALID_PARAMETER
 lpdwSize 或 lpszDestination 指標為 NULL，或 lpObjectId 不是有效的容器，或 dwType 或 dwOperation 不是三個有效值的其中一個。
ERROR_NOT_ENOUGH_MEMORY
 處理期間發生配置失敗。
ERROR_OBJECT_NOT_FOUND
 由 lpObjectId 指定的 GUID 不是資料庫中任何電腦或連結庫物件的 GUID。
ERROR_SUCCESS
 函式成功。

備註

對 SetNtmsUIOptions 的呼叫會新增或移除由 lpObjectId 和 dwType 參數所決定之特定實例的目的地。

  NTMS_UITYPE_INFO NTMS_UITYPE_REQ NTMS_UITYPE_ERR
應用程式 顯示此應用程式所產生工作專案的工作專案進度 UI。 顯示此應用程式所採取動作所產生之操作員要求的操作員要求 UI。 未定義。 應用程式無法造成這種錯誤事件。
媒體櫃 顯示與此連結庫相關聯之工作專案的工作專案進度 UI。 顯示與此連結庫相關聯之要求的UI。 顯示與此連結庫相關聯的錯誤 UI。
電腦 在此電腦上執行的 RSM 實例中顯示參考 UI。 在此 RSM 實例中顯示要求類型 UI。 在此 RSM 實例中顯示錯誤類型 UI。
 

請注意，呼叫 SetNtmsUIOptions 時會執行安全性檢查。 指定計算機物件時，您必須具有修改計算機許可權的存取權。 修改連結庫的 UI 元素時，您必須具有修改連結庫物件許可權的存取權。

請注意，目的地字串沒有檢查。 使用目的地名稱呼叫 ，該名稱不是可從 呼叫 SetNtmsUIOptions 的電腦連線到的電腦傳回成功。 空字串的指標是用來表示本機計算機。

注意

ntmsapi.h 標頭會將 SetNtmsUIOptions 定義為別名，根據 UNICODE 預處理器常數的定義，自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼，可能會導致編譯或運行時間錯誤不符。 如需詳細資訊，請參閱 函式原型的慣例。

規格需求

需求 值
最低支援的用戶端 Windows XP [僅限傳統型應用程式]
最低支援的伺服器 Windows Server 2003 [僅限桌面應用程式]
目標平台 Windows
標頭 ntmsapi.h
程式庫 Ntmsapi.lib
Dll Ntmsapi.dll

另請參閱

GetNtmsUIOptions

連結庫控件函式