NTMS_MEDIAPOOLINFORMATION

[This is preliminary documentation and subject to change.]

The NTMS_MEDIAPOOLINFORMATION data structure defines the properties specific to a media pool object.

typedef struct _NTMS_MEDIAPOOLINFORMATION {
    DWORD       PoolType;
    NTMS_GUID   MediaType;
    NTMS_GUID   Parent;
    DWORD       AllocationPolicy;
    DWORD       DeallocationPolicy;
    DWORD       dwMaxAllocates;
    DWORD       dwNumberOfPhysicalMedia;
    DWORD       dwNumberOfLogicalMedia;
    DWORD       dwNumberOfMediaPools;
} NTMS_MEDIAPOOLINFORMATION;
 

Members

PoolType

NTMS supports the following media pool types.

Value	Meaning
NTMS_POOLTYPE_UNKNOWN	Unknown pool type.
NTMS_POOLTYPE_SCRATCH	Media that is available to other applications.
NTMS_POOLTYPE_FOREIGN	Media that has been written to and does not contain a recognizable on-media identifier label-type or label ID.
NTMS_POOLTYPE_IMPORT	Media that has been written to, has a recognizable on-media identifier label type but an unrecognizable label ID.
NTMS_POOLTYPE_APPLICATION	Media pool created by an application. One or more application media pools can be created per system.

MediaType

The single media type that makes up each media pool.

Parent

Parent media pool or NULL.

AllocationPolicy

Bit field indicating action at allocation time. This member is writable. This can be the following value.

Value	Meaning
NTMS_ALLOCATE_FROMSCRATCH	Draw media from scratch if none is available in the pool. The default is not to draw from scratch.

DeallocationPolicy

Bit field indicating action at deallocation time. This member is writable. This can be the following value.

Value	Meaning
NTMS_DEALLOCATE_TOSCRATCH	Return media to scratch when available. The default is not to return to scratch.

dwMaxAllocates

Number of times the medium can be allocated and deallocated. This member is writable.

DwNumberOfPhysicalMedia

Number of physical media in this media pool.

dwNumberOfLogicalMedia

Number of logical media in this media pool.

dwNumberOfMediaPools

Number of media pools in this media pool.

Remarks

The NTMS_MEDIAPOOLINFORMATION 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.