Mac Dev Center Right arrow

Mac OS X Reference Library Right arrow

Drivers, Kernel, & Hardware: User-Space Device Access Right arrow

Disc Recording Framework Reference

DRCoreErase.h

Includes:

Overview

Erase object interfaces for Disc Recording.

Functions

DREraseCopyStatus: Obtains the status of the erase process.
DREraseCreate: Creates a new eraser.
DREraseGetDevice: Obtains a reference to the device containing the disc to erase.
DREraseGetProperties: Returns properties of the erase.
DREraseGetTypeID: Obtains the type identifier of all DRErase instances.
DREraseSetProperties: Sets the properties of the erase process.
DREraseStart: Begin the erase process.

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: Introduced in Mac OS X v10.2

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: Introduced in Mac OS X v10.2

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: Introduced in Mac OS X v10.2

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: Introduced in Mac OS X v10.2

DREraseGetTypeID

Obtains the type identifier of all DRErase instances.

extern CFTypeID DREraseGetTypeID(
    void) ;

Availability: Introduced in Mac OS X v10.2

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: Introduced in Mac OS X v10.2

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: Introduced in Mac OS X v10.2

Constants

kDREraseStatusChangedNotification
kDREraseTypeComplete
kDREraseTypeKey
kDREraseTypeQuick

kDREraseStatusChangedNotification

extern const CFStringRef kDREraseStatusChangedNotification ;

Discussion

The notification sent when a DRErase object has updated status.

Availability: Introduced in Mac OS X v10.2

kDREraseTypeComplete

extern const CFStringRef kDREraseTypeComplete ;

Discussion

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.

Availability: Introduced in Mac OS X v10.2

kDREraseTypeKey

extern const CFStringRef kDREraseTypeKey ;

Discussion

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.

Availability: Introduced in Mac OS X v10.2

kDREraseTypeQuick

extern const CFStringRef kDREraseTypeQuick ;

Discussion

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.

Availability: Introduced in Mac OS X v10.2

Typedefs

DREraseRef

DREraseRef

typedef struct __DRErase* DREraseRef;

Discussion

This is the type of a reference to DRErases.

Last Updated: 2009-08-12