IOObjectGenericInfoDef

Returned by MM_ReturnObjectGenericInfo when an IO OBID is passed to it.

Syntax

  struct IOObjectGenericInfoDef 
  { 
      BYTE     name[MM_MAX_OBJECT_STRING_LEN]; 
      LONG     type; 
      LONG     status; 
      LONG     unitsize; 
      LONG     blocksize; 
      LONG     capacity; 
      LONG     preferredunitsize; 
      LONG     functionmask; 
      LONG     controlmask; 
      LONG     parentcount; 
      LONG     siblingcount; 
      LONG     childcount; 
      LONG     specificinfosize; 
      LONG     cartridgetype; 
      LONG     mediatype; 
      LONG     mediaslot; 
      struct   RemovableInfoDef mediainfo; 
      LONG     numberofcurrentreservations; 
      OBID     applicationid; 
      OBID     objectmanagerid; 
  };

Fields

name
The null-terminated name of the IO object. The length, including the null, will not be larger than MM_MAX_OBJECT_STRING_LEN. The name is required.
type
The type of IO object. See IO Object Types.
status
The IO object’s status as defined by Object Generic Status and IO Object Status.
unitsize
The size, in bytes, of an IO unit (or sector) for this object.
blocksize
The maximum number of units that can be read or written in a single IO request.
capacity
The logical capacity, in units, of this object. The logical capacity means the amount that is available to an application for IO.
preferredunitsize
The size that works most efficiently for the device. If the unitsize and this value are not the same, an application can use the attribute MM_PREFERRED_SIZE_ID (see Attribute IDs) to set the unit size to the preferred unit size.
functionmask
A bit map indicating which IO functions this IO object supports. Bit 0 maps to MM_RANDOM_READ, bit 1 maps to MM_RANDOM_WRITE, and so on, proceeding numerically as defined in IO Function Operations.
controlmask
A bit map indicating which IO Control Functions this IO object supports. Bit 0 maps to MM_FORMAT_MEDIA, bit 1 maps to MM_TAPE_CONTROL, and so on, proceeding numerically as defined in IO Function Operations.
parentcount
The number of parents this object is linked to.
siblingcount
The number of siblings linked to this object, including itself.
childcount
The number of children linked to this object.
specificinfosize
The size, in bytes, of this object’s specific information returned by MM_ReturnObjectSpecificInfo.
cartridgetype
Defines the cartridge the houses the removable media.
mediatype
The type of media this object is derived from. See Device and Media Types (as defined by the SCSI Specification).
mediaslot
For removable media, indicates the slot the media is currently in.
mediainfo
As defined by RemovableInfoDef.
numberofcurrentreservations
The number of concurrent reservations on the IO object.
applicationid
The OBID of the application that registered the IO object.
objectmanagerid
The OBID of the object manager responsible for this IO object.

See Also

IO Class

Object Manager Class