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。 在这种情况下，将忽略 destination 参数。

[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。
Computer 在此计算机上运行的 RSM 实例中显示信息性 UI。 在此 RSM 实例中显示请求类型的 UI。 在此 RSM 实例中显示错误类型 UI。
 

请注意，调用 SetNtmsUIOptions 时会执行安全检查。 指定计算机对象时，需要具有修改计算机的权限的访问权限。 修改库的 UI 元素时，需要具有修改库对象的权限。

请注意，不会检查目标字符串。 如果调用的目标名称不是可从调用 的 SetNtmsUIOptions 的计算机访问的计算机，则返回成功。 指向空字符串的指针表示本地计算机。

注意

ntmsapi.h 标头将 SetNtmsUIOptions 定义为别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将非特定编码别名与非非特定编码的代码混合使用可能会导致不匹配，从而导致编译或运行时错误。 有关详细信息，请参阅 函数原型的约定。

要求

要求 值
最低受支持的客户端 Windows XP [仅限桌面应用]
最低受支持的服务器 Windows Server 2003 [仅限桌面应用]
目标平台 Windows
标头 ntmsapi.h
Library Ntmsapi.lib
DLL Ntmsapi.dll

另请参阅

GetNtmsUIOptions

库控制函数