DRCoreErase.h Reference

Declared in
DRCoreErase.h

Overview

Erase object interfaces for Disc Recording.

Included Headers

  • <CoreServices/CoreServices.h>

  • <DiscRecording/DRCoreObject.h>

  • <DiscRecording/DRCoreDevice.h>

  • <AvailabilityMacros.h>

Functions

See the Overview section above for header-level documentation.

DREraseCopyStatus

Obtains the status of the erase process.

extern CFDictionaryRef DREraseCopyStatus(
   DREraseRef erase) ;
Parameters
erase

The eraser object that status is wanted on.

Return Value

Returns a reference to a CFDictionary object.

Discussion

This function obtains a reference to a CFDictionary object containing the status of the erase process, including the percentage complete and any errors reported. The reference is implicitly retained by the caller. This is the same dictionary sent to observers of kDREraseStatusChangedNotification .

Availability
  • Available in OS X v10.2 and later.
Declared In
DRCoreErase.h

DREraseCreate

Creates a new eraser.

extern DREraseRef DREraseCreate(
   DRDeviceRef device) ;
Parameters
device

A reference to the device to erase. If this parameter is not a valid DRDevice, the behavior is undefined.

Return Value

Returns a reference to a new DRErase opaque type.

Availability
  • Available in OS X v10.2 and later.
Declared In
DRCoreErase.h

DREraseGetDevice

Obtains a reference to the device containing the disc to erase.

extern DRDeviceRef DREraseGetDevice(
   DREraseRef erase) ;
Parameters
erase

The eraser containing a reference to the device. If this parameter is not a valid DRErase object, the behavior is undefined.

Return Value

Returns reference to the device containing the disc to erase.

Availability
  • Available in OS X v10.2 and later.
Declared In
DRCoreErase.h

DREraseGetProperties

Returns properties of the erase.

extern CFDictionaryRef DREraseGetProperties(
   DREraseRef erase) ;
Parameters
erase

The erase process to get the properties of. If this parameter is not a valid DRErase object, the behavior is undefined.

Return Value

Returns a CFDictionary object containing the erase properties.

Availability
  • Available in OS X v10.2 and later.
Declared In
DRCoreErase.h

DREraseGetTypeID

Obtains the type identifier of all DRErase instances.

extern CFTypeID DREraseGetTypeID(
   void) ;
Availability
  • Available in OS X v10.2 and later.
Declared In
DRCoreErase.h

DREraseSetProperties

Sets the properties of the erase process.

extern void DREraseSetProperties(
   DREraseRef erase,
   CFDictionaryRef properties) ;
Parameters
erase

The erase process to set the properties of. If this parameter is not a valid DRErase object, the behavior is undefined.

properties

A CFDictionary object containing the erase properties. If this parameter is not a valid CFDictionary object the behavior is undefined.

Availability
  • Available in OS X v10.2 and later.
Declared In
DRCoreErase.h

DREraseStart

Begin the erase process.

extern OSStatus DREraseStart(
   DREraseRef erase) ;
Parameters
erase

The eraser object that should be started. If this parameter is not a valid DRErase oject, the behavior is undefined.

Return Value

An error code indicating if the erase could be started.

Availability
  • Available in OS X v10.2 and later.
Declared In
DRCoreErase.h

Data Types

See the Overview section above for header-level documentation.

DREraseRef

typedef struct __DRErase* DREraseRef;
Discussion

This is the type of a reference to DRErases.

Availability
  • Available in OS X v10.2 and later.
Declared In
DRCoreErase.h

Constants

See the Overview section above for header-level documentation.

Global Constants

extern const CFStringRef kDREraseStatusChangedNotification ;
extern const CFStringRef kDREraseTypeComplete ;
extern const CFStringRef kDREraseTypeKey ;
extern const CFStringRef kDREraseTypeQuick ;
Constants
kDREraseStatusChangedNotification

The notification sent when a DRErase object has updated status.

Available in OS X v10.2 and later.

Declared in DRCoreErase.h.

kDREraseTypeComplete

A CFString object indicating the erase operation should erase every byte on the disc. This operation is slow, taking on the order of 30 minutes.

Available in OS X v10.2 and later.

Declared in DRCoreErase.h.

kDREraseTypeKey

This key points to a CFString object describing the type of erase to be performed. If this key is not present, a kDREraseTypeQuick erase type is assumed.

Available in OS X v10.2 and later.

Declared in DRCoreErase.h.

kDREraseTypeQuick

A CFString object indicating the erase operation should do the minimal amount of work to make the disc appear blank. This operation typically takes only a minute or two.

Available in OS X v10.2 and later.

Declared in DRCoreErase.h.