GetNtmsUIOptionsA 函式 (ntmsapi.h)
[ 從 Windows 7 和 Windows Server 2008 R2 起,卸除式存儲設備管理員 已無法使用。]
GetNtmsUIOptions 函式會取得針對指定物件導向指定使用者介面類型的計算機名稱清單。 GetNtmsUIOptions 呼叫會傳回由 lpObjectId 和 dwType 參數所決定之實例的目的地清單。
如果指定實例清單中沒有目的地,函式會傳回ERROR_SUCCESS以及清單長度為零。
語法
DWORD GetNtmsUIOptionsA(
[in] HANDLE hSession,
[in] const LPNTMS_GUID lpObjectId,
[in] DWORD dwType,
[out] LPSTR lpszDestination,
[in, out] LPDWORD lpdwBufSize
);
參數
[in] hSession
OpenNtmsSession 函式所傳回的會話句柄。
[in] lpObjectId
要重新導向UI之物件的唯一標識碼。 對象必須是可以是事件來源的容器。 物件可以是應用程式(應用程式觸發的掛接要求)、連結庫(門開啟要求以回應退出)或計算機(與計算機相關的所有UI)。
若要指定計算機容器,請設定 lpObjectId 指標,以指向具有卸除式儲存管理員之計算機物件 GUID 的緩衝區。 若要指定特定連結庫,請將它設定為指向具有連結庫 GUID 的緩衝區。 若要指定應用程式,請傳入 NULL 指標。 應用程式的身分識別是由 hSession中使用的會話所決定。 請注意,應用程式可以同時開啟多個會話。 在此情況下,值集僅適用於 hSession 會話。
[in] dwType
此參數可以有下列其中一個值。
價值 | 意義 |
---|---|
|
提供資訊的UI訊息。 其中包括表示進度的工作佇列專案。 例如,掛接要求。 |
|
要求UI訊息。 其中包括處理媒體的操作員要求。 例如,插入新媒體的要求。 |
|
提供錯誤資訊的 UI 訊息。 其中包括與錯誤通知相關的操作員要求。 例如,清除磁碟驅動器的要求。 |
[out] lpszDestination
多字串,傳回要重新導向UI的電腦名稱。 這個參數不能 NULL。
[in, out] lpdwBufSize
目的地字串的大小,以 TCHAR為單位。
傳回值
此函式會傳回下列其中一個值。
價值 | 意義 |
---|---|
|
拒絕存取一或多個 RSM 物件。 |
|
lpdwSize 所指定的緩衝區大小 對於找到的目的地而言太小。 函式會傳回 lpdwSize中的實際大小。 |
|
會話句柄遺失或無效。 |
|
lpdwSize 或 lpszDestination 參數 NULL,或 lpObjectId 不是有效的容器,或 dwType 不是三個有效值的其中一個。 |
|
處理期間發生配置失敗。 |
|
lpObjectId 所指定的 GUID 不是資料庫中任何電腦或連結庫物件的 GUID。 |
|
函式成功。 |
言論
GetNtmsUIOptions 呼叫會傳回由 lpObjectId 和 dwType 參數所決定之特定實例的目的地清單。
NTMS_UITYPE_INFO | NTMS_UITYPE_REQ | NTMS_UITYPE_ERR | |
---|---|---|---|
應用 | 顯示此應用程式所產生工作專案的工作專案進度 UI。 | 顯示此應用程式所採取動作所產生的操作員要求 UI。 | 定義。 應用程式無法造成這類錯誤事件。 |
圖書館 | 顯示與此連結庫相關聯之工作專案的工作專案進度 UI。 | 顯示與此連結庫相關聯之要求的UI。 | 顯示與這個連結庫相關聯的錯誤 UI。 |
計算機 | 在此電腦上執行的 RSM 實例中顯示參考 UI。 | 在此 RSM 實例中顯示要求類型 UI。 | 在此 RSM 實例中顯示錯誤類型 UI。 |
注意
ntmsapi.h 標頭會根據 UNICODE 預處理器常數的定義,將 GetNtmsUIOptions 定義為自動選取此函式的 ANSI 或 Unicode 版本。 混合使用編碼中性別名與非編碼中性的程序代碼,可能會導致編譯或運行時間錯誤不符。 如需詳細資訊,請參閱函式原型的
要求
要求 | 價值 |
---|---|
最低支援的用戶端 | Windows XP [僅限傳統型應用程式] |
支援的最低伺服器 | Windows Server 2003 [僅限傳統型應用程式] |
目標平臺 | 窗戶 |
標頭 | ntmsapi.h |
連結庫 | Ntmsapi.lib |
DLL | Ntmsapi.dll |