2.2.1.11 NTMS_LIBRARYINFORMATION Structure

Article
10/30/2020

The NTMS_LIBRARYINFORMATION 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;
   DWORD dwFlags;
 } NTMS_LIBRARYINFORMATION;

LibraryType: The library type object. This MUST be one of the following values.

Value	Meaning
NTMS_LIBRARYTYPE_UNKNOWN 0x00000000	The library type cannot be determined.
NTMS_LIBRARYTYPE_OFFLINE 0x00000001	The library is not accessible.
NTMS_LIBRARYTYPE_ONLINE 0x00000002	A robotic element that automates the mounting and dismounting of media into one or more drives.
NTMS_LIBRARYTYPE_STANDALONE 0x00000003	A stand-alone drive that is modeled as a library with one drive in RSM.

CleanerSlot: Specifies, for each library, the slot that was assigned to the cleaner cartridge. If no cleaner slot is defined for this library, this member MUST be NULL.

CleanerSlotDefault: Specifies a library's default or preferred cleaner slot. If there is no preferred slot, this MUST be NULL.

LibrarySupportsDriveCleaning: Used by drives requiring cleaning under automated control. If TRUE, automatic drive cleaning operations are enabled; otherwise, cleaning operations are not enabled.

BarCodeReaderInstalled: This MUST return TRUE if a bar code reader is installed in a library; otherwise, it MUST return FALSE.

InventoryMethod: A default or user-selected method for performing an inventory of this library. This MUST be one of the following values.

Value	Meaning
NTMS_INVENTORY_NONE 0x00000000	An inventory MUST NOT be performed after the library door is closed. An inventory might be required if a mount label check fails.
NTMS_INVENTORY_FAST 0x00000001	If the library has a bar code reader installed, a bar code inventory MUST be performed. If the library does not have a bar code reader, a differential inventory MUST be performed (slots that transitioned from empty to full are added).
NTMS_INVENTORY_OMID 0x00000002	A full inventory MUST be performed. A full inventory involves mounting each side in a library and reading the on-media identification from the media.

Value

Meaning

NTMS_INVENTORY_NONE

0x00000000

An inventory MUST NOT be performed after the library door is closed. An inventory might be required if a mount label check fails.

NTMS_INVENTORY_FAST

0x00000001

If the library has a bar code reader installed, a bar code inventory MUST be performed. If the library does not have a bar code reader, a differential inventory MUST be performed (slots that transitioned from empty to full are added).

NTMS_INVENTORY_OMID

0x00000002

A full inventory MUST be performed. A full inventory involves mounting each side in a library and reading the on-media identification from the media.

dwCleanerUsesRemaining: The number of uses remaining on the cleaner in the library. This member MUST be 0 if no cleaner is present, or if the library does not support cleaning.

FirstDriveNumber: The number of the first drive in the library.

dwNumberOfDrives: The number of drives in the library.

FirstSlotNumber: The number of the first slot in the library.

dwNumberOfSlots: The number of slots in the library.

FirstDoorNumber: The number of the first access door in the library.

dwNumberOfDoors: The number of access doors in the library.

FirstPortNumber: The number of the first IE port in the library.

dwNumberOfPorts: The number of IE ports in the library.

FirstChangerNumber: The number of the first changer in the library.

dwNumberOfChangers: The number of changers in the library.

dwNumberOfMedia: The number of media in the online or offline library.

dwNumberOfMediaTypes: The number of media types that the library supports.

dwNumberOfLibRequests: The number of current library requests.

Reserved: This MUST be 0 and MUST be ignored on receipt.

AutoRecovery: If the mount operation fails and this member is TRUE, a full inventory MUST be performed. If this member is FALSE, a full inventory MUST NOT be performed. The failure can be either a hardware or a label mismatch. For ATAPI CD libraries, this member MUST NOT be set to FALSE. The default value is TRUE.

dwFlags: This member MUST be one or more of the following values.

Value	Meaning
NTMS_LIBRARYFLAG_FIXEDOFFLINE 0x01	The library is an offline library, not a library that is not present.
NTMS_LIBRARYFLAG_CLEANERPRESENT 0x02	A cleaner is present in the changer.
NTMS_LIBRARYFLAG_IGNORECLEANERUSESREMAINING 0x08	The cleaner cartridge MUST be used until it no longer cleans the drive, instead of keeping track of the number of cleanings left. This flag MUST NOT be set by the client. The server MUST set the flag if dwCleanerUsesRemaining is 0xFFFFFFFF, and the server MUST clear the flag otherwise.
NTMS_LIBRARYFLAG_RECOGNIZECLEANERBARCODE 0x10	Bar-coded cartridges that have CLN as a prefix MUST be treated as cleaner cartridges, instead of mounting them in the drive to identify them.

The NTMS_LIBRARYINFORMATION structure defines properties specific to a library object.

Share via

2.2.1.11 NTMS_LIBRARYINFORMATION Structure

Additional resources