ntmsapi.h header
This header is used by Data Access and Storage. For more information, see:
ntmsapi.h contains the following programming interfaces:
Functions
| AccessNtmsLibraryDoor The AccessNtmsLibraryDoor function unlocks the door of the specified library. If the library is busy, RSM queues the request and returns successfully. |
| AddNtmsMediaType The AddNtmsMediaType function adds the specified media type to the specified library if there is not currently a relation in the library object. The function then creates the system media pools if they do not exist. |
| AllocateNtmsMedia The AllocateNtmsMedia function allocates a piece of available media. |
| BeginNtmsDeviceChangeDetection The BeginNtmsDeviceChangeDetection function allows the application to begin a device change detection session. |
| CancelNtmsLibraryRequest The CancelNtmsLibraryRequest function cancels outstanding RSM requests, such as calls to the CleanNtmsDrive function. If the library is busy, RSM queues the cancellation and returns success. |
| CancelNtmsOperatorRequest The CancelNtmsOperatorRequest function cancels the specified RSM operator request. |
| ChangeNtmsMediaType The ChangeNtmsMediaType function moves the specified PMID to the specified target media pool and sets the PMID's media type identifier to the media type of the target media pool. |
| CleanNtmsDrive The CleanNtmsDrive function queues a cleaning request for the specified drive for cleaning. |
| CloseNtmsNotification The CloseNtmsNotification function closes the specified open notification channel. |
| CloseNtmsSession The CloseNtmsSession function closes the specified RSM session. |
| CreateNtmsMediaA The CreateNtmsMedia function creates a PMID and side (or sides) for a new piece of offline media. The media is placed in the media pool specified for lpPhysicalMedia. (ANSI) |
| CreateNtmsMediaPool The CreateNtmsMediaPool function creates a new application media pool. (CreateNtmsMediaPool) |
| CreateNtmsMediaPoolA The CreateNtmsMediaPool function creates a new application media pool. (CreateNtmsMediaPoolA) |
| CreateNtmsMediaPoolW The CreateNtmsMediaPoolW (Unicode) function creates a new application media pool. (CreateNtmsMediaPoolW) |
| CreateNtmsMediaW The CreateNtmsMedia function creates a PMID and side (or sides) for a new piece of offline media. The media is placed in the media pool specified for lpPhysicalMedia. (Unicode) |
| DeallocateNtmsMedia The DeallocateNtmsMedia function deallocates the side associated with the specified logical media. |
| DecommissionNtmsMedia The DecommissionNtmsMedia function moves a side from the Available state to the Decommissioned state. |
| DeleteNtmsDrive The DeleteNtmsDrive function deletes a drive from the RSM database. The drive must have a dwOperationalState of NTMS_NOT_PRESENT. |
| DeleteNtmsLibrary The DeleteNtmsLibrary function deletes a library, and all the devices contained in the library, from the RSM database. All media in the library is moved to the offline library. |
| DeleteNtmsMedia The DeleteNtmsMedia function deletes a physical piece of offline media from RSM by removing all references to the specified media from the database. |
| DeleteNtmsMediaPool The DeleteNtmsMediaPool function deletes the specified application media pool. |
| DeleteNtmsMediaType The DeleteNtmsMediaType function deletes the specified media type relation from the specified library, provided that the library does not contain any physical media objects of the specified media type. |
| DeleteNtmsRequests The DeleteNtmsRequests function deletes a request or a list of requests from the RSM database. |
| DisableNtmsObject The DisableNtmsObject function disables the specified RSM object. |
| DismountNtmsDrive The DismountNtmsDrive function queues a command to move the media in the specified drive to its storage slot. This function should be paired with the MountNtmsMedia function. |
| DismountNtmsMedia The DismountNtmsMedia function queues a command to move the specified media in a drive to its storage. This function should be paired with the MountNtmsMedia function. |
| EjectDiskFromSADriveA The EjectDiskFromSADrive function ejects the media that is in a standalone removable drive. (ANSI) |
| EjectDiskFromSADriveW The EjectDiskFromSADrive function ejects the media that is in a standalone removable drive. (Unicode) |
| EjectNtmsCleaner The EjectNtmsCleaner function ejects the cleaning cartridge from the currently reserved cleaner slot. |
| EjectNtmsMedia The EjectNtmsMedia function ejects the specified medium from the port of the current library. If the library is busy, RSM queues EjectNtmsMedia and returns success. |
| EnableNtmsObject The EnableNtmsObject function enables the specified object. |
| EndNtmsDeviceChangeDetection The EndNtmsDeviceChangeDetection function ends device change detection for any target devices specified using the SetNtmsDeviceChangeDetection function and closes the change detection handle. |
| EnumerateNtmsObject The EnumerateNtmsObject function enumerates the RSM objects contained in the lpContainerId parameter. |
| ExportNtmsDatabase The ExportNtmsDatabase function creates a consistent set of database files in the RSM database directory. |
| GetNtmsMediaPoolNameA The GetNtmsMediaPoolName function retrieves the specified media pool's full name hierarchy. (ANSI) |
| GetNtmsMediaPoolNameW The GetNtmsMediaPoolName function retrieves the specified media pool's full name hierarchy. (Unicode) |
| GetNtmsObjectAttributeA The GetNtmsObjectAttribute function retrieves the extended attribute (named private data) from the specified RSM object. (ANSI) |
| GetNtmsObjectAttributeW The GetNtmsObjectAttribute function retrieves the extended attribute (named private data) from the specified RSM object. (Unicode) |
| GetNtmsObjectInformation The GetNtmsObjectInformation function returns an object's information structure for the specified object. (GetNtmsObjectInformation) |
| GetNtmsObjectInformationA The GetNtmsObjectInformation function returns an object's information structure for the specified object. (GetNtmsObjectInformationA) |
| GetNtmsObjectInformationW The GetNtmsObjectInformationW (Unicode) function returns an object's information structure for the specified object. (GetNtmsObjectInformationW) |
| GetNtmsObjectSecurity The GetNtmsObjectSecurity function reads the security descriptor for the specified RSM object. |
| GetNtmsRequestOrder The GetNtmsRequestOrder function gets the order that the specified request will be processed in the library queue. |
| GetNtmsUIOptionsA The GetNtmsUIOptions function obtains the list of computer names to which the specified type of user interface is being directed for the given object. (ANSI) |
| GetNtmsUIOptionsW The GetNtmsUIOptions function obtains the list of computer names to which the specified type of user interface is being directed for the given object. (Unicode) |
| GetVolumesFromDriveA The GetVolumesFromDrive function retrieves the volume and drive letter for a given removable storage media drive. (ANSI) |
| GetVolumesFromDriveW The GetVolumesFromDrive function retrieves the volume and drive letter for a given removable storage media drive. (Unicode) |
| IdentifyNtmsSlot The IdentifyNtmsSlot function identifies the media in the specified slot in a library. The command returns when the identification is complete. |
| ImportNtmsDatabase The ImportNtmsDatabase function causes RSM to import the database files from the database Export directory at the next restart of the RSM. |
| InjectNtmsCleaner The InjectNtmsCleaner function allows a cleaner cartridge to be inserted into the specified library unit. |
| InjectNtmsMedia The InjectNtmsMedia function allows media to be inserted into the port of the specified library. If the library is busy, RSM queues InjectNtmsMedia and returns success. |
| InventoryNtmsLibrary The InventoryNtmsLibrary function queues an inventory of the specified library. If the library is busy, RSM queues InventoryNtmsLibrary and returns success. |
| MountNtmsMedia The MountNtmsMedia function synchronously mounts one or more pieces of media. |
| MoveToNtmsMediaPool The MoveToNtmsMediaPool function moves the specified medium from its current media pool to the specified media pool. |
| OpenNtmsNotification The OpenNtmsNotification function opens a channel to receive RSM object change notifications for objects of the specified type. |
| OpenNtmsSessionA The OpenNtmsSession function sets up a session with a RSM server. (ANSI) |
| OpenNtmsSessionW The OpenNtmsSession function sets up a session with a RSM server. (Unicode) |
| ReleaseNtmsCleanerSlot The ReleaseNtmsCleanerSlot function removes an existing slot reservation for a cleaning cartridge. The slot can then be used for data cartridges. |
| ReserveNtmsCleanerSlot The ReserveNtmsCleanerSlot function reserves a single slot in a library unit for a drive cleaner cartridge. |
| SatisfyNtmsOperatorRequest The SatisfyNtmsOperatorRequest function completes the specified RSM operator request. |
| SetNtmsDeviceChangeDetection The SetNtmsDeviceChangeDetection function sets one or more target devices for change detection. |
| SetNtmsMediaComplete The SetNtmsMediaComplete function marks a piece of logical media as complete. |
| SetNtmsObjectAttributeA The SetNtmsObjectAttribute function creates an extended attribute (named private data) in the specified RSM object. (ANSI) |
| SetNtmsObjectAttributeW The SetNtmsObjectAttribute function creates an extended attribute (named private data) in the specified RSM object. (Unicode) |
| SetNtmsObjectInformation The SetNtmsObjectInformation function changes the information structure of the specified object. (SetNtmsObjectInformation) |
| SetNtmsObjectInformationA The SetNtmsObjectInformation function changes the information structure of the specified object. (SetNtmsObjectInformationA) |
| SetNtmsObjectInformationW The SetNtmsObjectInformationW (Unicode) function changes the information structure of the specified object. (SetNtmsObjectInformationW) |
| SetNtmsObjectSecurity The SetNtmsObjectSecurity function writes the security descriptor for the specified RSM object. |
| SetNtmsRequestOrder The SetNtmsRequestOrder function sets the order that the specified request will be processed in the library queue. |
| SetNtmsUIOptionsA The SetNtmsUIOptions function modifies the list of computer names to which the specified type of UI is being directed for the given object. (ANSI) |
| SetNtmsUIOptionsW The SetNtmsUIOptions function modifies the list of computer names to which the specified type of UI is being directed for the given object. (Unicode) |
| SubmitNtmsOperatorRequestA The SubmitNtmsOperatorRequest function submits an RSM operator request. (ANSI) |
| SubmitNtmsOperatorRequestW The SubmitNtmsOperatorRequest function submits an RSM operator request. (Unicode) |
| SwapNtmsMedia The SwapNtmsMedia function swaps the sides associated with the two specified LMIDs. The specified LMIDs must be in the same media pool. |
| UpdateNtmsOmidInfo The UpdateNtmsOmidInfo function updates the RSM database with label information immediately after writing to the newly allocated medium. |
| WaitForNtmsNotification The WaitForNtmsNotification function waits for the next object change notification. |
| WaitForNtmsOperatorRequest The WaitForNtmsOperatorRequest function waits for the specified RSM operator request. |
Structures
| NTMS_ALLOCATION_INFORMATION The NTMS_ALLOCATION_INFORMATION structure contains information about the source media pool from which a medium was taken. |
| NTMS_CHANGERINFORMATIONA The NTMS_CHANGERINFORMATION structure defines properties specific to a robotic changer object. (ANSI) |
| NTMS_CHANGERINFORMATIONW The NTMS_CHANGERINFORMATION structure defines properties specific to a robotic changer object. (Unicode) |
| NTMS_CHANGERTYPEINFORMATIONA The NTMS_CHANGERTYPEINFORMATION structure defines the properties specific to a type of robotic changer supported by RSM. (ANSI) |
| NTMS_CHANGERTYPEINFORMATIONW The NTMS_CHANGERTYPEINFORMATION structure defines the properties specific to a type of robotic changer supported by RSM. (Unicode) |
| NTMS_COMPUTERINFORMATION The NTMS_COMPUTERINFORMATION structure defines the properties specific to the RSM server. |
| NTMS_DRIVEINFORMATIONA The NTMS_DRIVEINFORMATION structure defines properties specific to a drive object. (ANSI) |
| NTMS_DRIVEINFORMATIONW The NTMS_DRIVEINFORMATION structure defines properties specific to a drive object. (Unicode) |
| NTMS_DRIVETYPEINFORMATIONA The NTMS_DRIVETYPEINFORMATION structure defines the properties specific to a type of drive supported by RSM. (ANSI) |
| NTMS_DRIVETYPEINFORMATIONW The NTMS_DRIVETYPEINFORMATION structure defines the properties specific to a type of drive supported by RSM. (Unicode) |
| NTMS_IEDOORINFORMATION The NTMS_IEDOORINFORMATION structure defines properties specific to an insert/eject door object. |
| NTMS_IEPORTINFORMATION The NTMS_IEPORTINFORMATION structure defines properties specific to an insert/eject port object. |
| NTMS_LIBRARYINFORMATION The NTMS_LIBRARYINFORMATION structure defines properties specific to a library object. |
| NTMS_LIBREQUESTINFORMATIONA The NTMS_LIBREQUESTINFORMATION structure defines the properties specific to a work request, which are queued to RSM. (ANSI) |
| NTMS_LIBREQUESTINFORMATIONW The NTMS_LIBREQUESTINFORMATION structure defines the properties specific to a work request, which are queued to RSM. (Unicode) |
| NTMS_LMIDINFORMATION The NTMS_LMIDINFORMATION structure defines the properties specific to a logical media object. |
| NTMS_MEDIAPOOLINFORMATION The NTMS_MEDIAPOOLINFORMATION structure defines the properties specific to a media pool object. |
| NTMS_MEDIATYPEINFORMATION The NTMS_MEDIATYPEINFORMATION structure defines the properties specific to a type of media supported by RSM. |
| NTMS_NOTIFICATIONINFORMATION The NTMS_NOTIFICATIONINFORMATION structure defines an object and operation that occurred in the RSM database. |
| NTMS_OBJECTINFORMATIONA The NTMS_OBJECTINFORMATION structure defines the properties that an application can get and set for RSM devices, media and system controls (such as libraries, drives, media, operator requests). This is the common structure of objects in the RSM database. (ANSI) |
| NTMS_OBJECTINFORMATIONW The NTMS_OBJECTINFORMATION structure defines the properties that an application can get and set for RSM devices, media and system controls (such as libraries, drives, media, operator requests). This is the common structure of objects in the RSM database. (Unicode) |
| NTMS_OPREQUESTINFORMATIONA The NTMS_OPREQUESTINFORMATION structure defines the properties specific to operator-request system control for RSM. (ANSI) |
| NTMS_OPREQUESTINFORMATIONW The NTMS_OPREQUESTINFORMATION structure defines the properties specific to operator-request system control for RSM. (Unicode) |
| NTMS_PARTITIONINFORMATIONA The NTMS_PARTITIONINFORMATION structure defines the properties specific to the side object. (ANSI) |
| NTMS_PARTITIONINFORMATIONW The NTMS_PARTITIONINFORMATION structure defines the properties specific to the side object. (Unicode) |
| NTMS_PMIDINFORMATIONA The NTMS_PMIDINFORMATION structure defines the properties specific to a physical media object. (ANSI) |
| NTMS_PMIDINFORMATIONW The NTMS_PMIDINFORMATION structure defines the properties specific to a physical media object. (Unicode) |
| NTMS_STORAGESLOTINFORMATION The NTMS_STORAGESLOTINFORMATION structure defines properties specific to a storage slot object. |
Enumerations
| NtmsObjectsTypes The NtmsObjectsTypes enumeration type specifies the types of RSM objects. |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for