Mac Developer Library

Developer

DRCoreErase.h Reference

Options
Deployment Target:

On This Page
Language:

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

    Swift

    func DREraseCopyStatus(_ erase: DRErase!) -> Unmanaged<CFDictionary>!

    Objective-C

    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 .

    Import Statement

    import DiscRecording

    Availability

    Available in OS X v10.2 and later.

  • Creates a new eraser.

    Declaration

    Swift

    func DREraseCreate(_ device: DRDevice!) -> Unmanaged<DRErase>!

    Objective-C

    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.

    Import Statement

    import DiscRecording

    Availability

    Available in OS X v10.2 and later.

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

    Declaration

    Swift

    func DREraseGetDevice(_ erase: DRErase!) -> Unmanaged<DRDevice>!

    Objective-C

    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.

    Import Statement

    import DiscRecording

    Availability

    Available in OS X v10.2 and later.

  • Returns properties of the erase.

    Declaration

    Swift

    func DREraseGetProperties(_ erase: DRErase!) -> Unmanaged<CFDictionary>!

    Objective-C

    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.

    Import Statement

    import DiscRecording

    Availability

    Available in OS X v10.2 and later.

  • Obtains the type identifier of all DRErase instances.

    Declaration

    Swift

    func DREraseGetTypeID() -> CFTypeID

    Objective-C

    CFTypeID DREraseGetTypeID ( void );

    Import Statement

    import DiscRecording

    Availability

    Available in OS X v10.2 and later.

  • Sets the properties of the erase process.

    Declaration

    Swift

    func DREraseSetProperties(_ erase: DRErase!, _ properties: CFDictionary!)

    Objective-C

    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.

    Import Statement

    import DiscRecording

    Availability

    Available in OS X v10.2 and later.

  • Begin the erase process.

    Declaration

    Swift

    func DREraseStart(_ erase: DRErase!) -> OSStatus

    Objective-C

    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.

    Import Statement

    import DiscRecording

    Availability

    Available in OS X v10.2 and later.

Data Types

See the Overview section above for header-level documentation.

  • Declaration

    Swift

    typealias DREraseRef = DRErase

    Objective-C

    typedef struct __DRErase* DREraseRef;

    Discussion

    This is the type of a reference to DRErases.

    Import Statement

    import DiscRecording

    Availability

    Available in OS X v10.2 and later.

Constants

See the Overview section above for header-level documentation.

  • Declaration

    Swift

    let kDREraseStatusChangedNotification: CFString! let kDREraseTypeComplete: CFString! let kDREraseTypeKey: CFString! let kDREraseTypeQuick: CFString!

    Objective-C

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

    Constants

    • kDREraseStatusChangedNotification

      kDREraseStatusChangedNotification

      The notification sent when a DRErase object has updated status.

      Available in OS X v10.2 and later.

    • kDREraseTypeComplete

      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.

    • kDREraseTypeKey

      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.

    • kDREraseTypeQuick

      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.

    Import Statement