Platform SDK: Removable Storage Manager

Removable Storage Manager Function Reference

This section includes Removable Storage Manager (RSM) functions.

Note  These functions were defined before NTMS was renamed to Removable Storage Manager and as a result each function name contains the prefix "Ntms". Similarly, the "scratch" pool was renamed "free", and the "foreign" pool was renamed "unrecognized". The term "partition" was replaced with the term "side".

Cleaner Management Functions

RSM can automatically clean tape drives that become dirty through use. Use the following functions to control drive cleaning:

CleanNtmsDrive

EjectNtmsCleaner

InjectNtmsCleaner

ReleaseNtmsCleanerSlot

ReserveNtmsCleanerSlot

Database Backup and Recovery Functions

RSM uses a database to store information about the removable media devices and cartridges in a system. Like any system resource, this database should be backed up in case it becomes lost or corrupted. Use the following functions for RSM database backup and recovery:

ExportNtmsDatabase

ImportNtmsDatabase

Database Notification Functions

You can use the following functions to get notifications when RSM database objects change:

CloseNtmsNotification

OpenNtmsNotification

WaitForNtmsNotification

Session Management Functions

Before calling any other functions, an application must open an RSM session, and the session must be closed before the application exits. The following session management functions open and close RSM sessions:

CloseNtmsSession

OpenNtmsSession

Library Control Functions

Library control functions control:

You can use the following library control functions:

AccessNtmsLibraryDoor

CancelNtmsLibraryRequest

DeleteNtmsDrive

DeleteNtmsLibrary

DeleteNtmsRequest

DismountNtmsDrive

EjectNtmsMedia

GetNtmsRequestOrder

InjectNtmsMedia

InventoryNtmsLibrary

SetNtmsRequestOrder

Media Services Functions

Media services functions are used for:

You can use the following media services functions:

AddNtmsMediaType

AllocateNtmsMedia

ChangeNtmsMediaType

CreateNtmsMedia

CreateNtmsMediaPool

DeallocateNtmsMedia

DecommissionNtmsMedia

DeleteNtmsMedia

DeleteNtmsMediaPool

DeleteNtmsMediaType

DismountNtmsMedia

GetNtmsMediaPoolName

MountNtmsMedia

MoveToNtmsMediaPool

SetNtmsMediaComplete

SwapNtmsMedia

Object Management Functions

You can use the following functions to enumerate, get, and set information about RSM objects:

DisableNtmsObject

EnableNtmsObject

EnumerateNtmsObject

GetNtmsObjectAttribute

GetNtmsObjectInformation

GetNtmsObjectSecurity

SetNtmsObjectAttribute

SetNtmsObjectInformation

SetNtmsObjectSecurity

On-Media-Identifier Management Functions

RSM identifies media in a system by reading an on-media identifier (OMID) The following function updates the RSM database when a new OMID is written:

UpdateNtmsOmidInfo

Operator Request Functions

You can use the following functions to manage and control requests to system operators:

CancelNtmsOperatorRequest

SatisfyNtmsOperatorRequest

SubmitNtmsOperatorRequest

WaitForNtmsOperatorRequest

Change Detection Functions

RSM does not detect inject and eject operations on standalone drives unless requested to do so by the application. Although some RSM functions automatically begin change detection of certain devices, applications that require current information on the presence or absence of media in standalone drives must use these functions to request RSM to detect the changes. With change detection enabled, an application can use database notification functions to be notified when media is injected and ejected. You can use the following functions:

BeginNtmsDeviceChangeDetection

EndNtmsDeviceChangeDetection

SetNtmsDeviceChangeDetection