Mac Developer Library

Developer

DRCoreErase.h Reference

Options
Deployment Target:

On This Page

DRCoreErase.h Reference

Erase object interfaces for Disc Recording.

Included Headers

  • <CoreServices/CoreServices.h>

  • <DiscRecording/DRCoreObject.h>

  • <DiscRecording/DRCoreDevice.h>

  • <AvailabilityMacros.h>

Functions

  • Obtains the status of the erase process.

    Declaration

    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 .

  • Creates a new eraser.

    Declaration

    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.

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

    Declaration

    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.

  • Returns properties of the erase.

    Declaration

    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.

  • Obtains the type identifier of all DRErase instances.

    Declaration

    extern CFTypeID DREraseGetTypeID( void) ;

  • Sets the properties of the erase process.

    Declaration

    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.

  • Begin the erase process.

    Declaration

    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.

Data Types

See the Overview section above for header-level documentation.

  • Declaration

    typedef struct __DRErase* DREraseRef;

    Discussion

    This is the type of a reference to DRErases.

    Import Statement

Constants

See the Overview section above for header-level documentation.

  • Declaration

    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.

    • 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.

    • 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.

    • 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.