通过

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

此参数可以具有以下值之一。

价值 意义
NTMS_UITYPE_INFO
 提供信息的 UI 消息。 其中包括指示进度的工作队列项。 例如，装载请求。
NTMS_UITYPE_REQ
 是请求的 UI 消息。 其中包括处理媒体的操作员请求。 例如，注入新媒体的请求。
NTMS_UITYPE_ERR
 提供错误信息的 UI 消息。 其中包括与错误通知相关的操作员请求。 例如，清理驱动器的请求。

[out] lpszDestination

多字符串，返回要重定向 UI 的计算机的名称。 此参数不能 NULL。

[in, out] lpdwBufSize

目标字符串的大小，以 TCHAR为单位。

返回值

此函数返回以下值之一。

价值 意义
ERROR_ACCESS_DENIED
 拒绝访问一个或多个 RSM 对象。
ERROR_INSUFFICIENT_BUFFER
 lpdwSize 指定的缓冲区大小对于找到的目标来说太小。 该函数返回 lpdwSize中的实际大小。
ERROR_INVALID_HANDLE
 会话句柄缺失或无效。
ERROR_INVALID_PARAMETER
 lpdwSize 或 lpszDestination 参数 NULL，或者 lpObjectId 不是有效的容器，或者 dwType 不是三个有效值之一。
ERROR_NOT_ENOUGH_MEMORY
 处理过程中发生分配失败。
ERROR_OBJECT_NOT_FOUND
 lpObjectId 指定的 GUID 不是数据库中任何计算机或库对象的 GUID。
ERROR_SUCCESS
 函数成功。

言论

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 标头将 GetNtmsUIOptions 定义为一个别名，该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将中性编码别名与不中性编码的代码混合使用可能会导致编译或运行时错误不匹配。 有关详细信息，请参阅函数原型的 约定。

要求

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

另请参阅

库控制函数

SetNtmsUIOptions