NTMS_PMIDINFORMATION

[This is preliminary documentation and subject to change.]

The NTMS_PMIDINFORMATION data structure defines the properties specific to a physical media object.

typedef struct _NTMS_PMIDINFORMATION {
    NTMS_GUID     CurrentLibrary,
    NTMS_GUID     MediaPool;
    NTMS_GUID     Location;
    DWORD         LocationType;
    NTMS_GUID     HomeSlot;
    NTMS_GUID     MediaType;
    TCHAR         szBarCode[NTMS_BARCODE_LENGTH];
    DWORD         BarCodeState;
    TCHAR         szSequenceNumber[NTMS_SEQUENCE_LENGTH];
    DWORD         MediaState;
    DWORD         dwNumberOfPartitions;
    DWORD         dwMediaTypeCode;
    DWORD        dwDensityCode;
} NTMS_PMIDINFORMATION;
 

Members

CurrentLibrary

Unique ID of the library in which the media is contained.

MediaPool

Unique ID of the media pool to which the media is assigned.

Location

Unique ID of the physical location object for the media.

LocationType

Current location type of a piece of physical media. The value of this member can be set to NTMS_STORAGESLOT, NTMS_DRIVE, NTMS_IEPORT. (Offline media are in slots.)

HomeSlot

Unique ID of the library storage slot in which media is stored.

MediaType

Unique ID of a media type object.

szBarCode

String that matches the bar-code value on a bar-code label of a piece of physical media.

BarCodeState

Current state of the bar code. This can be one of the following values.

Value	Meaning
NTMS_BARCODESTATE_OK	The media has a bar code and it is readable.
NTMS_BARCODESTATE_UNREADABLE	The media either does not have a bar code or the bar code is unreadable.

szSequenceNumber

A sequential number assigned to the specified medium as a human-readable value that must be transcribed by a user on the medium so that the medium can be located in an offline library.

MediaState

Current state for the piece of physical media. This can be one of the following values.

Value	Meaning
NTMS_MEDIASTATE_IDLE	The media is in a slot in the library, in a drive dismounted, or in an offline library.
NTMS_MEDIASTATE_INUSE	The media is marked as in use as soon as a request for an operation is successfully made to RSM.
NTMS_MEDIASTATE_LOADED	The state of the media when RSM has determined that the media is available for reading and writing.
NTMS_MEDIASTATE_MOUNTED	The state of a piece of physical media when the media is placed in a drive.
NTMS_MEDIASTATE_OP_ERROR	The physical media is in an error state that is recoverable. No operator intervention is required.
NTMS_MEDIASTATE_UNLOADED	The state of the media when it is ready to be removed from a drive. The drive state, DISMOUNTABLE, also indicates that a drive can be removed at any time.
NTMS_MEDIASTATE_OPREQ	Media is waiting for operator request.

dwNumberOfPartitions

Number of partitions on the medium.

dwMediaTypeCode

SCSI media type code.

dwDensityCode

SCSI density code.

Remarks

The NTMS_PMIDINFORMATION data structure is part of the NTMS_OBJECTINFORMATION structure and is not used separately.

QuickInfo

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