Ссылка DREraseSession.h

Конфигурация стирания и пользовательский интерфейс прогресса для приложений Углерода

Включенные заголовки

<DiscRecording/DiscRecording.h>
<Carbon/Carbon.h>
<AvailabilityMacros.h>

Функции

Прочие условия


    
    DREraseSessionBeginProgressDialog (_: _: _:)
    DREraseSessionBeginProgressDialog

Представляет интерфейс прогресса как немодальное диалоговое окно.

Объявление

Swift

func DREraseSessionBeginProgressDialog(_ eraseSession: DREraseSession!, _ options: UnsafeMutablePointer<DREraseSessionProgressDialogOptions>, _ progressCallbacks: UnsafeMutablePointer<DREraseSessionProgressCallbacks>)

Objective C

void DREraseSessionBeginProgressDialog ( DREraseSessionRef eraseSession, DREraseSessionProgressDialogOptions *options, DREraseSessionProgressCallbacks *progressCallbacks );

Параметры

`eraseSession`	Объект сеанса стирания
`options`	Указатель на структуру типа DREraseSessionSetupDialogOptions.
`progressCallbacks`	Указатель на структуру типа DREraseSessionProgressCallbacks. Если никакое пользовательское поведение не желаемо, этим указателем может быть NULL.

Обсуждение

Эта функция дарит пользователю немодальное диалоговое окно, показывающее прогресс стирания.

Оператор импорта

Objective C

@import DiscRecordingUI;

Swift

import DiscRecordingUI

Доступность

Доступный в OS X v10.3 и позже.

DREraseSessionCreate () DREraseSessionCreate

Создает новый сеанс стирания.

Объявление

Swift

func DREraseSessionCreate() -> Unmanaged<DREraseSession>!

Objective C

DREraseSessionRef DREraseSessionCreate ( void );

Возвращаемое значение

Ссылка на новый DREraseSession.

Оператор импорта

Objective C

@import DiscRecordingUI;

Swift

import DiscRecordingUI

Доступность

Доступный в OS X v10.3 и позже.


    
    DREraseSessionGetErase (_:)
    DREraseSessionGetErase

Возвращает объект стирания для этого сеанса.

Объявление

Swift

func DREraseSessionGetErase(_ eraseSession: DREraseSession!) -> Unmanaged<DRErase>!

Objective C

DREraseRef DREraseSessionGetErase ( DREraseSessionRef eraseSession );

Параметры


      eraseSession

Сеанс стирания. Если этим параметром не является допустимый DREraseSessionRef, поведение не определено.

Возвращаемое значение

Ссылка на стирание возражает для сеанса. Если диалоговое окно установки не было выполнено, или объект записи не был установлен с DREraseSessionSetErase, эта функция возвращает NULL.

Оператор импорта

Objective C

@import DiscRecordingUI;

Swift

import DiscRecordingUI

Доступность

Доступный в OS X v10.3 и позже.

DREraseSessionGetTypeID () DREraseSessionGetTypeID

Возвращает идентификатор типа всех экземпляров DREraseSession.

Объявление

Swift

func DREraseSessionGetTypeID() -> CFTypeID

Objective C

CFTypeID DREraseSessionGetTypeID ( void );

Возвращаемое значение

Базовый идентификатор типа Основы.

Оператор импорта

Objective C

@import DiscRecordingUI;

Swift

import DiscRecordingUI

Доступность

Доступный в OS X v10.3 и позже.


    
    DREraseSessionSetErase (_: _:)
    DREraseSessionSetErase

Устанавливает объект стирания для этого сеанса.

Объявление

Swift

func DREraseSessionSetErase(_ eraseSession: DREraseSession!, _ erase: DRErase!)

Objective C

void DREraseSessionSetErase ( DREraseSessionRef eraseSession, DREraseRef erase );

Параметры

`eraseSession`	Сеанс стирания. Если этим параметром не является допустимый DREraseSessionRef, поведение не определено.
`erase`	Стирание для использования для сеанса. Если этим параметром не является допустимый DREraseRef, поведение не определено.

Оператор импорта

Objective C

@import DiscRecordingUI;

Swift

import DiscRecordingUI

Доступность

Доступный в OS X v10.3 и позже.


    
    DREraseSessionSetupDialog (_: _: _:)
    DREraseSessionSetupDialog

Представляет интерфейс установки как модальное диалоговое окно.

Объявление

Swift

func DREraseSessionSetupDialog(_ eraseSession: DREraseSession!, _ options: UnsafeMutablePointer<DREraseSessionSetupDialogOptions>, _ setupCallbacks: UnsafeMutablePointer<DREraseSessionSetupCallbacks>) -> Int8

Objective C

SInt8 DREraseSessionSetupDialog ( DREraseSessionRef eraseSession, DREraseSessionSetupDialogOptions *options, DREraseSessionSetupCallbacks *setupCallbacks );

Параметры

`eraseSession`	Объект сеанса стирания
`options`	Указатель на структуру типа DREraseSessionSetupDialogOptions. Если никакая пользовательская конфигурация не требуется, этим указателем может быть NULL.
`setupCallbacks`	Указатель на структуру типа DREraseSessionSetupCallbacks. Если никакое пользовательское поведение не желаемо, этим указателем может быть NULL.

Возвращаемое значение

Возвраты одна из констант определяются Диалоговыми Кодами Результата Сеанса Стирания.

Обсуждение

Эта функция дарит пользователю модальное диалоговое окно, позволяющее им конфигурировать стирание к своим пользовательским настройкам. Они включают: устройство для использования и тип стирания для выполнения. и другие. Функция не возвращается, пока пользователь не отклонил диалоговое окно.

Оператор импорта

Objective C

@import DiscRecordingUI;

Swift

import DiscRecordingUI

Доступность

Доступный в OS X v10.3 и позже.

Обратные вызовы

Прочие условия


    
    DREraseSessionDeviceCheckProcPtr
    DREraseSessionDeviceCheckProcPtr

Обратный вызов, используемый для проверки пригодности устройства.

Объявление

Swift

typealias DREraseSessionDeviceCheckProcPtr = CFunctionPointer<((DREraseSession!, DRDevice!) -> Boolean)>

Objective C

typedef Boolean ( *DREraseSessionDeviceCheckProcPtr )( DREraseSessionRef eraseSession, DRDeviceRef device);

Параметры

`eraseSession`	Объект сеанса стирания.
`device`	Устройство для исследования.

Возвращаемое значение

Булево значение, указывающее пригодность устройства.

Обсуждение

Этот обратный вызов вызывают каждый раз, когда появляется новое устройство. Это - цель, должен позволить приложению фильтровать устройства вывода, не поддерживающие работу, которая будет выполняться. например, устройство может отфильтровать наш CD-R/Ws, если это - создание DVD appliacation.

Оператор импорта

Objective C

@import DiscRecordingUI;

Swift

import DiscRecordingUI

Доступность

Доступный в OS X v10.3 и позже.


    
    DREraseSessionDeviceSelectionNotificationProcPtr
    DREraseSessionDeviceSelectionNotificationProcPtr

Обратный вызов раньше уведомлял применение нового выбранного устройства.

Объявление

Swift

typealias DREraseSessionDeviceSelectionNotificationProcPtr = CFunctionPointer<((DREraseSession!, DRDevice!) -> Void)>

Objective C

typedef void ( *DREraseSessionDeviceSelectionNotificationProcPtr )( DREraseSessionRef eraseSession, DRDeviceRef selectedDevice);

Параметры

`eraseSession`	Объект сеанса стирания.
`selectedDevice`	Недавно выбранное устройство.

Оператор импорта

Objective C

@import DiscRecordingUI;

Swift

import DiscRecordingUI

Доступность

Доступный в OS X v10.3 и позже.


    
    DREraseSessionEraseCompleteProcPtr
    DREraseSessionEraseCompleteProcPtr

Обратный вызов, уведомляющий приложение стирание, закончился.

Объявление

Swift

typealias DREraseSessionEraseCompleteProcPtr = CFunctionPointer<((DREraseSession!, DRErase!) -> Boolean)>

Objective C

typedef Boolean ( *DREraseSessionEraseCompleteProcPtr )( DREraseSessionRef eraseSession, DREraseRef erase);

Параметры

`eraseSession`	Объект сеанса стирания.
`erase`	Только что закончившийся экземпляр стирания.

Возвращаемое значение

Булево значение, управляющее дисплеем ошибочного диалогового окна сеанса стирания.

Обсуждение

Когда операция стирания завершается, или успешно или с ошибкой, этот обратный вызов вызывают. Эта функция может использоваться приложением для представления своей собственной пользовательской обработки конца стирания. Если приложение хочет представить свое собственное уведомление конца стирания, оно может сделать так от этого обратного вызова. Если это делает, это может возвратить ложное возвращаемое значение, чтобы препятствовать тому, чтобы сеанс стирания представил свое собственное уведомление.

Оператор импорта

Objective C

@import DiscRecordingUI;

Swift

import DiscRecordingUI

Доступность

Доступный в OS X v10.3 и позже.


    
    DREraseSessionMediaCheckProcPtr
    DREraseSessionMediaCheckProcPtr

Обратный вызов, используемый для проверки пригодности носителей в устройстве.

Объявление

Swift

typealias DREraseSessionMediaCheckProcPtr = CFunctionPointer<((DREraseSession!, DRDevice!, UnsafeMutablePointer<Unmanaged<CFString>?>) -> Boolean)>

Objective C

typedef Boolean ( *DREraseSessionMediaCheckProcPtr )( DREraseSessionRef eraseSession, DRDeviceRef device, CFStringRef *prompt);

Параметры

`eraseSession`	Объект сеанса стирания.
`device`	Устройство, содержащее носители для исследования.
`prompt`	Указатель на CFStringRef. Приложение может возвратить пользовательское сообщение для отображения в диалоговом окне установки.

Возвращаемое значение

Булево значение, указывающее пригодность носителей.

Обсуждение

Этот обратный вызов вызывают каждый раз, когда изменилось состояние носителей. Это - цель, должен позволить приложению определять, подходят ли носители для работы, которая будет выполняться. Например, приложение проверка, чтобы видеть, существует ли достаточно пространства на носителях для данных, которые будут записаны.

Оператор импорта

Objective C

@import DiscRecordingUI;

Swift

import DiscRecordingUI

Доступность

Доступный в OS X v10.3 и позже.

DREraseSessionProgressBeginNotificationProcPtr DREraseSessionProgressBeginNotificationProcPtr

Обратный вызов, уведомляющий приложение прогресс стирания, собирается начаться.

Объявление

Swift

typealias DREraseSessionProgressBeginNotificationProcPtr = CFunctionPointer<((DREraseSession!) -> Void)>

Objective C

typedef void ( *DREraseSessionProgressBeginNotificationProcPtr )( DREraseSessionRef eraseSession);

Параметры

eraseSession

Объект сеанса стирания.

Обсуждение

Когда прогресс стирания собирается быть выведенным на экран, этот обратный вызов вызывают. Это позволяет приложению делать вещи те, которые отключают пункт меню выхода или близкое меню для окна документа.

Оператор импорта

Objective C

@import DiscRecordingUI;

Swift

import DiscRecordingUI

Доступность

Доступный в OS X v10.3 и позже.
DREraseSessionProgressFinishNotificationProcPtr DREraseSessionProgressFinishNotificationProcPtr

Обратный вызов, уведомляющий приложение прогресс стирания, закончился.

Объявление

Swift

typealias DREraseSessionProgressFinishNotificationProcPtr = CFunctionPointer<((DREraseSession!) -> Void)>

Objective C

typedef void ( *DREraseSessionProgressFinishNotificationProcPtr )( DREraseSessionRef eraseSession);

Параметры

eraseSession

Объект сеанса стирания.

Обсуждение

Когда прогресс стирания был удален из представления, этот обратный вызов вызывают. Это позволяет приложению делать вещи те, которые повторно включают пункт меню выхода или близкое меню для окна документа.

Оператор импорта

Objective C

@import DiscRecordingUI;

Swift

import DiscRecordingUI

Доступность

Доступный в OS X v10.3 и позже.

Типы данных

См. Обзор для документации уровня заголовка.

DREraseSessionProgressDialogOptionFlags DREraseSessionProgressDialogOptionFlags

Указывает диалоговые параметры конфигурации прогресса.

Объявление

Swift

typealias DREraseSessionProgressDialogOptionFlags = UInt32

Objective C

typedef UInt32 DREraseSessionProgressDialogOptionFlags;

Оператор импорта

Objective C

@import DiscRecordingUI;

Swift

import DiscRecordingUI

Доступность

Доступный в OS X v10.3 и позже.
DREraseSessionRef DREraseSessionRef

Объявление

Swift

typealias DREraseSessionRef = DREraseSession

Objective C

typedef struct __DREraseSession* DREraseSessionRef;

Обсуждение

Это - тип ссылки на экземпляры DREraseSession.

Оператор импорта

Objective C

@import DiscRecordingUI;

Swift

import DiscRecordingUI

Доступность

Доступный в OS X v10.3 и позже.
DREraseSessionSetupDialogOptionFlags DREraseSessionSetupDialogOptionFlags

Указывает диалоговые параметры конфигурации установки.

Объявление

Swift

typealias DREraseSessionSetupDialogOptionFlags = UInt32

Objective C

typedef UInt32 DREraseSessionSetupDialogOptionFlags;

Оператор импорта

Objective C

@import DiscRecordingUI;

Swift

import DiscRecordingUI

Доступность

Доступный в OS X v10.3 и позже.


      
      DREraseSessionProgressCallbacks

Функции обратного вызова передали диалоговому окну прогресса.

Объявление

Objective C

struct DREraseSessionProgressCallbacks { UInt32 version; DREraseSessionProgressBeginNotificationProcPtr progressWillBegin; DREraseSessionProgressFinishNotificationProcPtr progressDidFinish; DREraseSessionEraseCompleteProcPtr eraseDidFinish; };

Поля

`version`	Идентифицирует версию этой структуры.
`progressWillBegin`	Указатель на DREraseSessionProgressBeginNotificationProcPtr. Значением этого поля может быть NULL.
`progressDidFinish`	Указатель на DREraseSessionProgressFinishNotificationProcPtr. Значением этого поля может быть NULL.
`eraseDidFinish`	Указатель на DREraseSessionEraseCompleteProcPtr. Значением этого поля может быть NULL.


      
      DREraseSessionProgressDialogOptions

Опции передали в диалоговое окно прогресса для конфигурирования его.

Объявление

Objective C

struct DREraseSessionProgressDialogOptions { UInt32 version; DREraseSessionProgressDialogOptionFlags dialogOptionFlags; /* option flags for affecting the dialog's behavior */ CFStringRef description; /* optional description of the erase */ };

Поля

`version`	Идентифицирует версию этой структуры.
`dialogOptionFlags`	Одна из нескольких констант, определенных типом данных DREraseSessionProgressDialogOptionFlags, как описано в Диалоговых Флагах Опции Прогресса Стирания.
`description`	CFStringRef, определяющий пользовательское описание, которое будет использоваться для диалогового окна. Если Вы не обеспечиваете эту строку (передающий NULL), нормальное описание используется.


      
      DREraseSessionSetupCallbacks

Функции обратного вызова передали диалоговому окну установки.

Объявление

Objective C

struct DREraseSessionSetupCallbacks { UInt32 version; DREraseSessionDeviceCheckProcPtr deviceShouldBeTarget; DREraseSessionMediaCheckProcPtr containsSuitableMedia; DREraseSessionDeviceSelectionNotificationProcPtr deviceSelectionChanged; };

Поля

`version`	Идентифицирует версию этой структуры.
`deviceShouldBeTarget`	Указатель на DREraseSessionDeviceCheckProcPtr. Значением этого поля может быть NULL.
`containsSuitableMedia`	Указатель на DREraseSessionMediaCheckProcPtr. Значением этого поля может быть NULL.
`deviceSelectionChanged`	Указатель на DREraseSessionDeviceSelectionNotificationProcPtr. Значением этого поля может быть NULL.


      
      DREraseSessionSetupDialogOptions

Опции передали в диалоговое окно установки для конфигурирования его.

Объявление

Objective C

struct DREraseSessionSetupDialogOptions { UInt32 version; DREraseSessionSetupDialogOptionFlags dialogOptionFlags; /* option flags for affecting the dialog' s behavior */ };

Поля

`version`	Идентифицирует версию этой структуры.
`dialogOptionFlags`	Одна из нескольких констант, определенных типом данных DREraseSessionSetupDialogOptionFlags, как описано в Диалоговых Флагах Опции Установки Стирания.

Константы

См. Обзор для документации уровня заголовка.

Версия структуры DREraseSessionProgressDialogOptions

Объявление

Objective C

enum { kEraseSessionProgressDialogOptionsCurrentVersion = 1 };
Версия структуры DREraseSessionSetupCallbacks

Объявление

Objective C

enum { kDREraseSessionSetupCallbacksCurrentVersion = 1 };
Версия структуры DREraseSessionSetupDialogOptions

Объявление

Objective C

enum { kEraseSessionSetupDialogOptionsCurrentVersion = 1 };
Диалоговые флаги опции прогресса стирания
Объявление

Swift

var kEraseSessionProgressDialogDefaultOptions: Int { get }

Objective C

enum { kEraseSessionProgressDialogDefaultOptions = 0x00000000 /* use defaults for all the options */ };

Константы
- kEraseSessionProgressDialogDefaultOptions
  
  kEraseSessionProgressDialogDefaultOptions
  
  Используйте значения по умолчанию для всех опций
  
  Доступный в OS X v10.3 и позже.
Обсуждение

Флаги раньше конфигурировали прогресс стирания диалоговое поведение
Диалоговые коды результата сеанса стирания
Объявление

Swift

var kDREraseSessionOK: Int { get } var kDREraseSessionCancel: Int { get }

Objective C

enum { kDREraseSessionOK = 1, kDREraseSessionCancel = 0 };

Константы
- kDREraseSessionOK
  
  kDREraseSessionOK
  
  Значение, возвращенное диалоговым окном установки, когда пользователь подтвердил установку стирания.
  
  Доступный в OS X v10.3 и позже.
- kDREraseSessionCancel
  
  kDREraseSessionCancel
  
  Значение, возвращенное диалоговым окном установки, когда пользователь отменил установку стирания.
  
  Доступный в OS X v10.3 и позже.
Обсуждение

Коды возврата для сеанса стирания устанавливают диалоговое окно.
Диалоговые флаги опции установки стирания
Объявление

Swift

var kEraseSessionSetupDialogDefaultOptions: Int { get } var kEraseSessionSetupDialogDontHandleReservations: Int { get }

Objective C

enum { kEraseSessionSetupDialogDefaultOptions = 0x00000000 , /* use defaults for all the options */ kEraseSessionSetupDialogDontHandleReservations = 0x00000001 , /* Don't handle media reservations. Application handles them itself */ };

Константы
- kEraseSessionSetupDialogDefaultOptions
  
  kEraseSessionSetupDialogDefaultOptions
  
  Используйте значения по умолчанию для всех опций
  
  Доступный в OS X v10.3 и позже.
- kEraseSessionSetupDialogDontHandleReservations
  
  kEraseSessionSetupDialogDontHandleReservations
  
  Сеанс не обрабатывает резервирование носителей. Приложение обрабатывает их само
  
  Доступный в OS X v10.3 и позже.
Обсуждение

Флаги раньше конфигурировали диалоговое поведение установки стирания
версия структуры kDREraseProgressSetupCallbacksCurrentVersion

Объявление

Objective C

enum { kDREraseProgressSetupCallbacksCurrentVersion = 1 };