ntmsapi.h 标头

此标头由数据访问和存储使用。 有关详细信息，请参阅：

• 数据访问和存储

ntmsapi.h 包含以下编程接口：

函数

AccessNtmsLibraryDoor AccessNtmsLibraryDoor 函数解锁指定库的门。 如果库正忙，RSM 会将请求排队并成功返回。
AddNtmsMediaType 如果当前库对象中没有关系，则 AddNtmsMediaType 函数会将指定的媒体类型添加到指定的库中。 然后， 函数创建系统媒体池（如果它们不存在）。
AllocateNtmsMedia AllocateNtmsMedia 函数分配一段可用媒体。
BeginNtmsDeviceChangeDetection BeginNtmsDeviceChangeDetection 函数允许应用程序开始设备更改检测会话。
CancelNtmsLibraryRequest CancelNtmsLibraryRequest 函数取消未完成的 RSM 请求，例如对 CleanNtmsDrive 函数的调用。 如果库正忙，RSM 会将取消排队并返回成功。
CancelNtmsOperatorRequest CancelNtmsOperatorRequest 函数取消指定的 RSM 运算符请求。
ChangeNtmsMediaType ChangeNtmsMediaType 函数将指定的 PMID 移动到指定的目标媒体池，并将 PMID 的媒体类型标识符设置为目标媒体池的媒体类型。
CleanNtmsDrive CleanNtmsDrive 函数将指定驱动器的清理请求排队进行清理。
CloseNtmsNotification CloseNtmsNotification 函数关闭指定的打开通知通道。
CloseNtmsSession CloseNtmsSession 函数关闭指定的 RSM 会话。
CreateNtmsMediaA CreateNtmsMedia 函数为脱机媒体的新片段创建 PMID 和侧 (或侧) 。 媒体放置在为 lpPhysicalMedia 指定的媒体池中。 (ANSI)
CreateNtmsMediaPool CreateNtmsMediaPool 函数创建新的应用程序媒体池。 (CreateNtmsMediaPool)
CreateNtmsMediaPoolA CreateNtmsMediaPool 函数创建新的应用程序媒体池。 (CreateNtmsMediaPoolA)
CreateNtmsMediaPoolW CreateNtmsMediaPoolW (Unicode) 函数创建新的应用程序媒体池。 (CreateNtmsMediaPoolW)
CreateNtmsMediaW CreateNtmsMedia 函数为脱机媒体的新片段创建 PMID 和侧 (或侧) 。 媒体放置在为 lpPhysicalMedia 指定的媒体池中。 (Unicode)
DeallocateNtmsMedia DeallocateNtmsMedia 函数解除分配与指定逻辑媒体关联的端。
DecommissionNtmsMedia DecommissionNtmsMedia 函数将一侧从“可用”状态移动到“已解除授权”状态。
DeleteNtmsDrive DeleteNtmsDrive 函数从 RSM 数据库中删除驱动器。 驱动器的 dwOperationalState 必须为 NTMS_NOT_PRESENT。
DeleteNtmsLibrary DeleteNtmsLibrary 函数从 RSM 数据库中删除库以及库中包含的所有设备。 库中的所有媒体将移动到脱机库。
DeleteNtmsMedia DeleteNtmsMedia 函数通过从数据库中删除对指定媒体的所有引用，从 RSM 中删除脱机媒体的物理部分。
DeleteNtmsMediaPool DeleteNtmsMediaPool 函数删除指定的应用程序媒体池。
DeleteNtmsMediaType DeleteNtmsMediaType 函数从指定的库中删除指定的媒体类型关系，前提是该库不包含指定媒体类型的任何物理媒体对象。
DeleteNtmsRequests DeleteNtmsRequests 函数从 RSM 数据库中删除请求或请求列表。
DisableNtmsObject DisableNtmsObject 函数禁用指定的 RSM 对象。
DismountNtmsDrive DismountNtmsDrive 函数将命令排队，以将指定驱动器中的媒体移动到其存储槽。 此函数应与 MountNtmsMedia 函数配对。
DismountNtmsMedia DismountNtmsMedia 函数将命令排队，以将驱动器中的指定媒体移动到其存储。 此函数应与 MountNtmsMedia 函数配对。
弹出DiskFromSADriveA 弹出DiskFromSADrive 函数弹出独立可移动驱动器中的媒体。 (ANSI)
弹出DiskFromSADriveW 弹出DiskFromSADrive 函数弹出独立可移动驱动器中的媒体。 (Unicode)
弹出NtmsCleaner EjectNtmsCleaner 函数从当前保留的清洁槽中弹出清洁盒。
弹出NtmsMedia 弹出媒体函数从当前库的端口弹出指定的介质。 如果库正忙，RSM 会将弹出的媒体排队并返回成功。
EnableNtmsObject EnableNtmsObject 函数启用指定的对象。
EndNtmsDeviceChangeDetection EndNtmsDeviceChangeDetection 函数结束对使用 SetNtmsDeviceChangeDetection 函数指定的任何目标设备的设备更改检测，并关闭更改检测句柄。
EnumerateNtmsObject EnumerateNtmsObject 函数枚举 lpContainerId 参数中包含的 RSM 对象。
ExportNtmsDatabase ExportNtmsDatabase 函数在 RSM 数据库目录中创建一组一致的数据库文件。
GetNtmsMediaPoolNameA GetNtmsMediaPoolName 函数检索指定媒体池的全名层次结构。 (ANSI)
GetNtmsMediaPoolNameW GetNtmsMediaPoolName 函数检索指定媒体池的全名层次结构。 (Unicode)
GetNtmsObjectAttributeA GetNtmsObjectAttribute 函数从指定的 RSM 对象检索 (命名为私有数据) 的扩展属性。 (ANSI)
GetNtmsObjectAttributeW GetNtmsObjectAttribute 函数从指定的 RSM 对象检索 (命名为私有数据) 的扩展属性。 (Unicode)
GetNtmsObjectInformation GetNtmsObjectInformation 函数返回指定对象的信息结构。 (GetNtmsObjectInformation)
GetNtmsObjectInformationA GetNtmsObjectInformation 函数返回指定对象的信息结构。 (GetNtmsObjectInformationA)
GetNtmsObjectInformationW GetNtmsObjectInformationW (Unicode) 函数返回指定对象的信息结构。 (GetNtmsObjectInformationW)
GetNtmsObjectSecurity GetNtmsObjectSecurity 函数读取指定 RSM 对象的安全描述符。
GetNtmsRequestOrder GetNtmsRequestOrder 函数获取在库队列中处理指定请求的顺序。
GetNtmsUIOptionsA GetNtmsUIOptions 函数获取指定类型的用户界面正针对给定对象定向到的计算机名称列表。 (ANSI)
GetNtmsUIOptionsW GetNtmsUIOptions 函数获取指定类型的用户界面正针对给定对象定向到的计算机名称列表。 (Unicode)
GetVolumesFromDriveA GetVolumesFromDrive 函数检索给定可移动存储媒体驱动器的卷和驱动器号。 (ANSI)
GetVolumesFromDriveW GetVolumesFromDrive 函数检索给定可移动存储媒体驱动器的卷和驱动器号。 (Unicode)
IdentifyNtmsSlot IdentifyNtmsSlot 函数标识库中指定槽中的媒体。 标识完成后，命令将返回。
ImportNtmsDatabase ImportNtmsDatabase 函数会导致 RSM 在下一次重新启动 RSM 时从数据库导出目录中导入数据库文件。
InjectNtmsCleaner InjectNtmsCleaner 函数允许将更清洁的墨盒插入到指定的库单元中。
InjectNtmsMedia InjectNtmsMedia 函数允许将媒体插入指定库的端口。 如果库正忙，RSM 会将 InjectNtmsMedia 排队并返回成功。
InventoryNtmsLibrary InventoryNtmsLibrary 函数将指定库的清单排队。 如果库正忙，RSM 会将 InventoryNtmsLibrary 排队并返回成功。
MountNtmsMedia MountNtmsMedia 函数同步装载一个或多个媒体片段。
MoveToNtmsMediaPool MoveToNtmsMediaPool 函数将指定的介质从其当前媒体池移动到指定的媒体池。
OpenNtmsNotification OpenNtmsNotification 函数打开一个通道，用于接收指定类型的对象的 RSM 对象更改通知。
OpenNtmsSessionA OpenNtmsSession 函数设置与 RSM 服务器的会话。 (ANSI)
OpenNtmsSessionW OpenNtmsSession 函数设置与 RSM 服务器的会话。 (Unicode)
ReleaseNtmsCleanerSlot ReleaseNtmsCleanerSlot 函数删除了清洁墨盒的现有槽预留。 然后，该槽可用于数据盒。
ReserveNtmsCleanerSlot ReserveNtmsCleanerSlot 函数在驱动器清洁器盒的库单元中保留单个槽。
SatisfyNtmsOperatorRequest SatisfyNtmsOperatorRequest 函数完成指定的 RSM 运算符请求。
SetNtmsDeviceChangeDetection SetNtmsDeviceChangeDetection 函数设置一个或多个用于检测更改的目标设备。
SetNtmsMediaComplete SetNtmsMediaComplete 函数将一段逻辑媒体标记为已完成。
SetNtmsObjectAttributeA SetNtmsObjectAttribute 函数 (指定的 RSM 对象中创建名为私有数据) 的扩展属性。 (ANSI)
SetNtmsObjectAttributeW SetNtmsObjectAttribute 函数 (指定的 RSM 对象中创建名为私有数据) 的扩展属性。 (Unicode)
SetNtmsObjectInformation SetNtmsObjectInformation 函数更改指定对象的信息结构。 (SetNtmsObjectInformation)
SetNtmsObjectInformationA SetNtmsObjectInformation 函数更改指定对象的信息结构。 (SetNtmsObjectInformationA)
SetNtmsObjectInformationW SetNtmsObjectInformationW (Unicode) 函数更改指定对象的信息结构。 (SetNtmsObjectInformationW)
SetNtmsObjectSecurity SetNtmsObjectSecurity 函数为指定的 RSM 对象写入安全描述符。
SetNtmsRequestOrder SetNtmsRequestOrder 函数设置在库队列中处理指定请求的顺序。
SetNtmsUIOptionsA SetNtmsUIOptions 函数修改指定类型 UI 正定向到的给定对象的计算机名称列表。 (ANSI)
SetNtmsUIOptionsW SetNtmsUIOptions 函数修改指定类型 UI 正定向到的给定对象的计算机名称列表。 (Unicode)
SubmitNtmsOperatorRequestA SubmitNtmsOperatorRequest 函数提交 RSM 运算符请求。 (ANSI)
SubmitNtmsOperatorRequestW SubmitNtmsOperatorRequest 函数提交 RSM 运算符请求。 (Unicode)
SwapNtmsMedia SwapNtmsMedia 函数交换与两个指定 LMID 关联的侧。 指定的 LMID 必须位于同一媒体池中。
UpdateNtmsOmidInfo UpdateNtmsOmidInfo 函数在写入新分配的介质后立即使用标签信息更新 RSM 数据库。
WaitForNtmsNotification WaitForNtmsNotification 函数等待下一个对象更改通知。
WaitForNtmsOperatorRequest WaitForNtmsOperatorRequest 函数等待指定的 RSM 运算符请求。

结构

NTMS_ALLOCATION_INFORMATION NTMS_ALLOCATION_INFORMATION结构包含有关从中获取介质的源媒体池的信息。
NTMS_CHANGERINFORMATIONA NTMS_CHANGERINFORMATION 结构定义特定于机器人更换器对象的属性。 (ANSI)
NTMS_CHANGERINFORMATIONW NTMS_CHANGERINFORMATION 结构定义特定于机器人更换器对象的属性。 (Unicode)
NTMS_CHANGERTYPEINFORMATIONA NTMS_CHANGERTYPEINFORMATION 结构定义特定于 RSM 支持的机器人更换器类型的属性。 (ANSI)
NTMS_CHANGERTYPEINFORMATIONW NTMS_CHANGERTYPEINFORMATION 结构定义特定于 RSM 支持的机器人更换器类型的属性。 (Unicode)
NTMS_COMPUTERINFORMATION NTMS_COMPUTERINFORMATION 结构定义特定于 RSM 服务器的属性。
NTMS_DRIVEINFORMATIONA NTMS_DRIVEINFORMATION 结构定义特定于驱动器对象的属性。 (ANSI)
NTMS_DRIVEINFORMATIONW NTMS_DRIVEINFORMATION 结构定义特定于驱动器对象的属性。 (Unicode)
NTMS_DRIVETYPEINFORMATIONA NTMS_DRIVETYPEINFORMATION 结构定义特定于 RSM 支持的驱动器类型的属性。 (ANSI)
NTMS_DRIVETYPEINFORMATIONW NTMS_DRIVETYPEINFORMATION 结构定义特定于 RSM 支持的驱动器类型的属性。 (Unicode)
NTMS_IEDOORINFORMATION NTMS_IEDOORINFORMATION 结构定义特定于插入/弹出门对象的属性。
NTMS_IEPORTINFORMATION NTMS_IEPORTINFORMATION 结构定义特定于插入/弹出端口对象的属性。
NTMS_LIBRARYINFORMATION NTMS_LIBRARYINFORMATION 结构定义特定于库对象的属性。
NTMS_LIBREQUESTINFORMATIONA NTMS_LIBREQUESTINFORMATION 结构定义特定于工作请求的属性，这些属性已排队到 RSM。 (ANSI)
NTMS_LIBREQUESTINFORMATIONW NTMS_LIBREQUESTINFORMATION 结构定义特定于工作请求的属性，这些属性已排队到 RSM。 (Unicode)
NTMS_LMIDINFORMATION NTMS_LMIDINFORMATION 结构定义特定于逻辑媒体对象的属性。
NTMS_MEDIAPOOLINFORMATION NTMS_MEDIAPOOLINFORMATION 结构定义特定于媒体池对象的属性。
NTMS_MEDIATYPEINFORMATION NTMS_MEDIATYPEINFORMATION 结构定义特定于 RSM 支持的某种媒体类型的属性。
NTMS_NOTIFICATIONINFORMATION NTMS_NOTIFICATIONINFORMATION 结构定义 RSM 数据库中发生的对象和操作。
NTMS_OBJECTINFORMATIONA NTMS_OBJECTINFORMATION结构定义应用程序可为 RSM 设备、媒体和系统控件 (（如库、驱动器、媒体、操作员请求) ）获取和设置的属性。 这是 RSM 数据库中对象的常见结构。 (ANSI)
NTMS_OBJECTINFORMATIONW NTMS_OBJECTINFORMATION结构定义应用程序可为 RSM 设备、媒体和系统控件 (（如库、驱动器、媒体、操作员请求) ）获取和设置的属性。 这是 RSM 数据库中对象的常见结构。 (Unicode)
NTMS_OPREQUESTINFORMATIONA NTMS_OPREQUESTINFORMATION结构定义特定于 RSM 的操作员请求系统控件的属性。 (ANSI)
NTMS_OPREQUESTINFORMATIONW NTMS_OPREQUESTINFORMATION结构定义特定于 RSM 的操作员请求系统控件的属性。 (Unicode)
NTMS_PARTITIONINFORMATIONA NTMS_PARTITIONINFORMATION 结构定义特定于侧对象的属性。 (ANSI)
NTMS_PARTITIONINFORMATIONW NTMS_PARTITIONINFORMATION 结构定义特定于侧对象的属性。 (Unicode)
NTMS_PMIDINFORMATIONA NTMS_PMIDINFORMATION 结构定义特定于物理媒体对象的属性。 (ANSI)
NTMS_PMIDINFORMATIONW NTMS_PMIDINFORMATION 结构定义特定于物理媒体对象的属性。 (Unicode)
NTMS_STORAGESLOTINFORMATION NTMS_STORAGESLOTINFORMATION 结构定义特定于存储槽对象的属性。

枚举

NtmsObjectsTypes NtmsObjectsTypes 枚举类型指定 RSM 对象的类型。