NTMS_OBJECTINFORMATION

[This is preliminary documentation and subject to change.]

The NTMS_OBJECTINFORMATION data 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 structure defines the common structure of objects in the RSM database.

typedef struct _NTMS_OBJECTINFORMATION
{
    DWORD        dwSize;
    DWORD        dwType;
    SYSTEMTIME   Created;
    SYSTEMTIME   Modified;
    NTMS_GUID    ObjectGuid;
    BOOL         Enabled;
    DWORD        dwOperationalState;
    TCHAR        szName[NTMS_OBJECTNAME_LENGTH];
    TCHAR        szDescription[NTMS_DESCRIPTION_LENGTH];
    union {
    NTMS_LIBRARYINFORMATION Library; 
    NTMS_CHANGERINFORMATION Changer;
    NTMS_CHANGERTYPEINFORMATION ChangerType;
    NTMS_DRIVEINFORMATION Drive;
    NTMS_DRIVETYPEINFORMATION DriveType;
    NTMS_STORAGESLOTINFORMATION StorageSlot;
    NTMS_IEDOORINFORMATION IEDoor;
    NTMS_IEPORTINFORMATION IEPort;
    NTMS_LMIDINFORMATION LogicalMedia;
    NTMS_PARTITIONINFORMATION Partition;
    NTMS_PMIDINFORMATION PhysicalMedia;
    NTMS_MEDIAPOOLINFORMATION MediaPool;
    NTMS_MEDIATYPEINFORMATION MediaType;
    NTMS_OPREQUESTINFORMATION OpRequest;
    NTMS_LIBREQUESTINFORMATION LibRequest;
} Info;
} NTMS_OBJECTINFORMATION, *LPNTMS_OBJECTINFORMATION;
 

Members

dwSize

Size of the information structure. This member must be set to the correct size of the structure prior to using either the GetNtmsObjectInformation function or the SetNtmsObjectInformation function.

dwType

The type of device or system control for which to get/set information. This member must be set to one of the following values.

Value	Meaning
NTMS_CHANGER	A changer object represents the robotic element of an online library unit.
NTMS_CHANGER_TYPE	A changer type object is created for each unique changer device type attached to a system.
NTMS_COMPUTER	The current computer object. There is no structure for the computer object.
NTMS_DRIVE	A drive object represents a tape drive or disk drive.
NTMS_DRIVE_TYPE	A drive type object is created for each unique drive device type attached to a system.
NTMS_IEDOOR	An NTMS_IEDOOR object represents the door-access mechanism of an online library unit.
NTMS_IEPORT	An NTMS_IEPORT object represents the insert/eject port of an online library unit.
NTMS_LIBRARY	A library object represents an online or offline library.
NTMS_LIBREQUEST	A library request object is created for each request for an online library to perform an action. A list of library requests is maintained by RSM as a queue of work to be performed.
NTMS_LOGICAL_MEDIA	The primary handle used by applications to access the specified medium. In the case of multipartitioned media, each partition is treated as an individual piece of physical media.
NTMS_MEDIA_POOL	A media pool is a logical grouping of media. All media in a media pool must be the same media type.
NTMS_MEDIA_TYPE	A media type object is created for each unique media type in a system.
NTMS_OPREQUEST	An operator request object represents an RSM request for a user to get the information.
NTMS_PARTITION	A partition object represents a side of a piece of physical media.
NTMS_PHYSICAL_MEDIA	A physical media object represents a magnetic tape or removable disk. A piece of physical media can contain one or more partitions.
NTMS_STORAGESLOT	A storage slot object represents one of the slots that can hold the specified medium in an online library.

Created

A date/time stamp when the object was created.

Modified

A date/time stamp when the object was modified.

ObjectGuid

The GUID of the object.

Enabled

Indicates whether the device or system control object is enabled.

dwOperationalState

Defines the current operational state of the object. This can be one of the following values.

Value	Meaning
NTMS_NOT_PRESENT	This device or object is not currently present.
NTMS_READY	This device or object is available and ready.
NTMS_NEEDS_SERVICE	This device or object has failed and needs service.

szName

The name of the media, device, or system control object. Media pool and logical media names can be changed using the SetNtmsObjectInformation function. All other object names are read-only.

szDescription

A description of the device or system control object. The description of device and system control objects can be changed using the SetNtmsObjectInformation function. (Writable for all objects)

Info

Device or system control object-specific information.

Remarks

All members of the NTMS_OBJECTINFORMATION data structure are read-only at the RSM function-level unless specified as WRITABLE in the definition of the member.

QuickInfo

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

NTMS_ALLOCATION_INFORMATION