Edit

IMAPI_FORMAT2_DATA_MEDIA_STATE enumeration (imapi2.h)

  • Article

Defines values for the possible media states.

Syntax

typedef enum _IMAPI_FORMAT2_DATA_MEDIA_STATE {
  IMAPI_FORMAT2_DATA_MEDIA_STATE_UNKNOWN = 0,
  IMAPI_FORMAT2_DATA_MEDIA_STATE_INFORMATIONAL_MASK = 0xf,
  IMAPI_FORMAT2_DATA_MEDIA_STATE_UNSUPPORTED_MASK = 0xfc00,
  IMAPI_FORMAT2_DATA_MEDIA_STATE_OVERWRITE_ONLY = 0x1,
  IMAPI_FORMAT2_DATA_MEDIA_STATE_RANDOMLY_WRITABLE = 0x1,
  IMAPI_FORMAT2_DATA_MEDIA_STATE_BLANK = 0x2,
  IMAPI_FORMAT2_DATA_MEDIA_STATE_APPENDABLE = 0x4,
  IMAPI_FORMAT2_DATA_MEDIA_STATE_FINAL_SESSION = 0x8,
  IMAPI_FORMAT2_DATA_MEDIA_STATE_DAMAGED = 0x400,
  IMAPI_FORMAT2_DATA_MEDIA_STATE_ERASE_REQUIRED = 0x800,
  IMAPI_FORMAT2_DATA_MEDIA_STATE_NON_EMPTY_SESSION = 0x1000,
  IMAPI_FORMAT2_DATA_MEDIA_STATE_WRITE_PROTECTED = 0x2000,
  IMAPI_FORMAT2_DATA_MEDIA_STATE_FINALIZED = 0x4000,
  IMAPI_FORMAT2_DATA_MEDIA_STATE_UNSUPPORTED_MEDIA = 0x8000
} IMAPI_FORMAT2_DATA_MEDIA_STATE, *PIMAPI_FORMAT2_DATA_MEDIA_STATE;

Constants

 
IMAPI_FORMAT2_DATA_MEDIA_STATE_UNKNOWN
Value: 0
Indicates that the interface does not know the media state.
IMAPI_FORMAT2_DATA_MEDIA_STATE_INFORMATIONAL_MASK
Value: 0xf
Reports information (but not errors) about the media state.
IMAPI_FORMAT2_DATA_MEDIA_STATE_UNSUPPORTED_MASK
Value: 0xfc00
Reports an unsupported media state.
IMAPI_FORMAT2_DATA_MEDIA_STATE_OVERWRITE_ONLY
Value: 0x1
Write operations can occur on used portions of the disc.
IMAPI_FORMAT2_DATA_MEDIA_STATE_RANDOMLY_WRITABLE
Value: 0x1
Media is randomly writable. This indicates that a single session can be written to this disc.

Note  This value is deprecated and superseded by IMAPI_FORMAT2_DATA_MEDIA_STATE_OVERWRITE_ONLY.

 
IMAPI_FORMAT2_DATA_MEDIA_STATE_BLANK
Value: 0x2
Media has never been used, or has been erased.
IMAPI_FORMAT2_DATA_MEDIA_STATE_APPENDABLE
Value: 0x4
Media is appendable (supports multiple sessions).
IMAPI_FORMAT2_DATA_MEDIA_STATE_FINAL_SESSION
Value: 0x8
Media can have only one additional session added to it, or the media does not support multiple sessions.
IMAPI_FORMAT2_DATA_MEDIA_STATE_DAMAGED
Value: 0x400
Media is not usable by this interface. The media might require an erase or other recovery.
IMAPI_FORMAT2_DATA_MEDIA_STATE_ERASE_REQUIRED
Value: 0x800
Media must be erased prior to use by this interface.
IMAPI_FORMAT2_DATA_MEDIA_STATE_NON_EMPTY_SESSION
Value: 0x1000
Media has a partially written last session, which is not supported by this interface.
IMAPI_FORMAT2_DATA_MEDIA_STATE_WRITE_PROTECTED
Value: 0x2000
Media or drive is write-protected.
IMAPI_FORMAT2_DATA_MEDIA_STATE_FINALIZED
Value: 0x4000
Media cannot be written to (finalized).
IMAPI_FORMAT2_DATA_MEDIA_STATE_UNSUPPORTED_MEDIA
Value: 0x8000
Media is not supported by this interface.

Remarks

This enumeration should be treated as a bitmask. Nearly all of the values set one bit set to one and the other bits to zero. Three exceptions to this rule were added: unknown, unsupported media mask, and informational mask. For example, to test for unsupported media, check the value against IMAPI_FORMAT2_DATA_MEDIA_STATE_UNSUPPORTED_MASK.

Requirements

Requirement Value
Minimum supported client Windows Vista, Windows XP with SP2 [desktop apps only]
Minimum supported server Windows Server 2003 [desktop apps only]
Header imapi2.h

See also

IDiscFormat2Data::get_CurrentMediaStatus