NTMS_LIBRARYINFORMATION

[This is preliminary documentation and subject to change.]

The NTMS_LIBRARYINFORMATION data structure defines properties specific to a library object.

typedef struct _NTMS_LIBRARYINFORMATION {
    DWORD      LibraryType;
    NTMS_GUID  CleanerSlot;
    NTMS_GUID  CleanerSlotDefault;
    BOOL       LibrarySupportsDriveCleaning;
    BOOL       BarCodeReaderInstalled;
    DWORD      InventoryMethod;
    DWORD      dwCleanerUsesRemaining;
    DWORD      FirstDriveNumber;
    DWORD      dwNumberOfDrives;
    DWORD      FirstSlotNumber;
    DWORD      dwNumberOfSlots;
    DWORD      FirstDoorNumber;
    DWORD      dwNumberOfDoors;
    DWORD      FirstPortNumber;
    DWORD      dwNumberOfPorts;
    DWORD      FirstChangerNumber;
    DWORD      dwNumberOfChangers;
    DWORD      dwNumberOfMedia;
    DWORD      dwNumberOfMediaTypes;
    DWORD      dwNumberOfLibRequests;
    GUID       Reserved;
    BOOL       AutoRecovery
} NTMS_LIBRARYINFORMATION;
 

Members

LibraryType

Library type object. This can be one of the following values.

Value	Meaning
NTMS_LIBRARYTYPE_ONLINE	A robotic element that automates the mounting and dismounting of media into one or more drives.
NTMS_LIBRARYTYPE_STANDALONE	A standalone drive that is modeled as a library with one drive in RSM.
NTMS_LIBRARYTYPE_OFFLINE	Media that is not in an online library is in an offline library. There is one offline library unit per RSM system.
NTMS_LIBRARYTYPE_UNKNOWN	Library type cannot be determined.

CleanerSlot

For each online library, this represents the slot that was assigned to the cleaner cartridge. If this member is NULL, there is no cleaner slot defined for this library.

CleanerSlotDefault

Represents a libraries' default or preferred cleaner slot. If NULL, there is not a preferred slot.

LibrarySupportsDriveCleaning

Used by drives that require cleaning under robotics control. If TRUE, automatic drive cleaning operations are enabled.

BarCodeReaderInstalled

Returns TRUE if a bar code reader is installed in a library; otherwise returns FALSE.

InventoryMethod

The default or user-selected method for performing inventory of this online library. (This member is writable.) This can be one of the following values.

Value	Meaning
NTMS_INVENTORY_FAST	If the library has a bar-code reader installed, this value causes a bar-code inventory to be performed. If the library does not have a bar-code reader, this flag causes a differential inventory to be performed (slots which transitioned from empty to full are classified).
NTMS_INVENTORY_OMID	A full inventory involves mounting each partition in a library and reading the on-media identification from the media. This type of inventory can be very time consuming for some library units.
NTMS_INVENTORY_NONE	After the library door is closed, no inventory is performed. Inventory might be required if a mount label-check fails.

dwCleanerUsesRemaining

Number of uses remaining on the cleaner in the library. This member is zero if no cleaner is present or if the library does not support cleaning.

FirstDriveNumber

Number of the first drive in the online library.

dwNumberOfDrives

Number of drives in the online library.

FirstSlotNumber

Number of the first slot in the online library.

dwNumberOfSlots

Number of slots in the online library.

FirstDoorNumber

Number of the first access door in the online library.

dwNumberOfDoors

Number of access doors in the online library.

FirstPortNumber

Number of the first insert/eject port in the online library.

dwNumberOfPorts

Number of insert/eject ports in the online library.

FirstChangerNumber

Number of the first changer in the online library.

dwNumberOfChangers

Number of changers in the online library.

dwNumberOfMedia

Number of media in the online or offline library.

dwNumberOfMediaTypes

Number of media types supported by the library.

dwNumberOfLibRequests

Number of current library requests.

Reserved

Reserved.

AutoRecovery

If set a full inventory will be performed if a mount fails. The failure may be either hardware or label mismatch. For ATAPI CD libraries, AutoRecovery cannot be disabled. The default is true. Large library owners should disable this feature.

Remarks

For offline libraries, only LibraryType and dwNumberOfMedia are reported. All other values should be ignored.

The NTMS_LIBRARYINFORMATION data structure is included in the NTMS_OBJECTINFORMATION structure used for the GetNtmsObjectInformation and SetNtmsObjectInformation functions.

QuickInfo

  Windows NT: Requires version 5.0 or later.
  Windows: Unsupported.
  Windows CE: Unsupported.
  Header: Declared in ntmsapi.h.
  Import Library: Use ntmsapi.lib.