Spec-Zone .ru
спецификации, руководства, описания, API

Библиотека разработчика Mac

Разработчик

Ссылка платформы углерода ссылка справки Apple

Опции
Развертывание Target:

На этой странице
Язык:

Ссылка справки Apple

Справка Apple является обновлением и улучшением к предыдущим версиям системы справочной информации Mac OS. Это доступно в Mac OS 8.6 и позже, включая OS X.

Эта ссылка описывает прикладной программный интерфейс (API) для регистрации книг справки и вызова приложения Средства просмотра Справки.

Функции

Разные функции справки Apple
  • AHRegisterHelpBook (_:) AHRegisterHelpBook

    Регистрирует книгу справки.

    Объявление

    Swift

    func AHRegisterHelpBook(_ appBundleRef: UnsafePointer<FSRef>) -> OSStatus

    Objective C

    OSStatus AHRegisterHelpBook ( const FSRef *appBundleRef );

    Параметры

    appBundleRef

    Ссылка файловой системы для пакета, содержащего справку, бронирует Вас, хотят зарегистрироваться.

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

    Код результата. Посмотрите Коды Результата Справки Apple.

    Обсуждение

    Приложения углерода должны вызвать эту функцию для регистрации книги справки. Если Ваше приложение Какао обеспечивает надлежащие пары ключ/значение, указывающие единственную книгу справки в списке свойств Вашего приложения, как описано в Оказании Пользовательской Помощи со Справкой Apple, только необходимо вызвать AHRegisterHelpBook если Вы хотите вызвать функции Справки Apple для доступа к содержанию справки сами. Если Вы устанавливаете дополнительную книгу справки, не описанную в Вашем списке свойств, необходимо вызвать AHRegisterHelpBook функционируйте для имения новой книги, появляются в Справочном центре. Если Вы вызываете эту функцию и указываете книгу справки, уже регистрирующуюся, AHRegisterHelpBook функционируйте возвращает результат noErr.

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

    Objective C

    @import Carbon;

    Swift

    import Carbon

    Доступность

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

  • AHSearch (_: _:) AHSearch

    Говорит Средству просмотра Справки искать указанную строку в данной книге справки.

    Объявление

    Swift

    func AHSearch(_ bookname: CFString!, _ query: CFString!) -> OSStatus

    Objective C

    OSStatus AHSearch ( CFStringRef bookname, CFStringRef query );

    Параметры

    bookname

    Строка, указывающая имя справки, бронирует, чтобы искаться. Если имя книги справки (как указано AppleTitle метатег), Справка SurfWriter, например, Вы передаете строку, содержащую значение SurfWriter Help. Если Вы передаете NULL в этом параметре Средство просмотра Справки ищет все доступные книги справки.

    query

    Строка, содержащая текст для поиска.

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

    Код результата. Посмотрите Коды Результата Справки Apple.

    Обсуждение

    Эта функция синхронна. Вызывание этой функции открывает приложение Средства просмотра Справки при необходимости и выводит на экран результаты поиска.

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

    Objective C

    @import Carbon;

    Swift

    import Carbon

    Доступность

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

  • AHGotoMainTOC AHGotoMainTOC (OS X v10.4)

    Говорит Средству просмотра Справки загружать указанную основную страницу оглавления.

    Оператор осуждения

    Использовать AHGotoPage переходить к различным книгам или привязкам.

    Объявление

    Objective C

    OSStatus AHGotoMainTOC ( AHTOCType toctype );

    Параметры

    toctype

    Значение, указывающее, какая страница Help Center должна быть загружена. Если Вы передаете kAHTOCTypeUser постоянный, например, Средство просмотра Справки загружает страницу Help Center.

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

    Код результата. Посмотрите Коды Результата Справки Apple.

    Обсуждение

    Эта функция синхронна. Вызывание этой функции открывает приложение Средства просмотра Справки при необходимости и загружает указанную страницу Help Center.

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

    Objective C

    @import Carbon;

    Доступность

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

    Осуждаемый в OS X v10.4.

  • AHGotoPage (_: _: _:) AHGotoPage

    Говорит Средству просмотра Справки загружать указанную страницу HTML.

    Объявление

    Swift

    func AHGotoPage(_ bookname: CFString!, _ path: CFString!, _ anchor: CFString!) -> OSStatus

    Objective C

    OSStatus AHGotoPage ( CFStringRef bookname, CFStringRef path, CFStringRef anchor );

    Параметры

    bookname

    Строка, указывающая имя книги справки, содержащей страницу, которая будет загружена. Если имя книги справки (как указано AppleTitle метатег), Справка SurfWriter, например, Вы передаете строку, содержащую значение SurfWriter Help. Можно передать NULL в этом параметре.

    path

    Строка, указывающая путь для страницы, которая будет загружена. Укажите, что путь относительно справки бронирует поданный bookname параметр. Если Вы передаете NULL в этом параметре Средство просмотра Справки открывается к Вашему титульному листу книги справки. Если Вы передаете NULL в bookname параметр, необходимо указать, что значение передало в path параметр как полный URL в форме file://.

    anchor

    Дополнительная строка та, указывающая привязку, к который прокрутки Средства просмотра Справки после загрузки указанной страницы. Если Вы не указываете привязку, Средство просмотра Справки прокручивает к началу страницы.

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

    Код результата. Посмотрите Коды Результата Справки Apple.

    Обсуждение

    Эта функция синхронна. Вызывание этой функции открывает приложение Средства просмотра Справки при необходимости и загружает указанную страницу HTML.

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

    Objective C

    @import Carbon;

    Swift

    import Carbon

    Доступность

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

  • AHLookupAnchor (_: _:) AHLookupAnchor

    Говорит Средству просмотра Справки искать указанную привязку и загружать его.

    Объявление

    Swift

    func AHLookupAnchor(_ bookname: CFString!, _ anchor: CFString!) -> OSStatus

    Objective C

    OSStatus AHLookupAnchor ( CFStringRef bookname, CFStringRef anchor );

    Параметры

    bookname

    Строка, указывающая имя справки, бронирует для поиска желаемой привязки. Если имя книги справки (как указано AppleTitle метатег), Справка SurfWriter, например, Вы передаете строку, содержащую значение SurfWriter Help. Если Вы не указываете значение в этом параметре, Средство просмотра Справки ищет все доступные книги справки указанную привязку.

    anchor

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

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

    Код результата. Посмотрите Коды Результата Справки Apple.

    Обсуждение

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

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

    Objective C

    @import Carbon;

    Swift

    import Carbon

    Доступность

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

Константы

  • Константы спецификации TOC

    Переданный AHGotoMainTOC функция для идентификации страницы оглавления для открытия.

    Объявление

    Swift

    typealias AHTOCType = Int16

    Objective C

    typedef SInt16 AHTOCType; enum { kAHTOCTypeUser = 0, kAHTOCTypeDeveloper = 1 };

    Константы

    • kAHTOCTypeUser

      kAHTOCTypeUser

      Открывает справочный центр.

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

    • kAHTOCTypeDeveloper

      kAHTOCTypeDeveloper

      Открывает справочный центр разработчика.

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

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

    Objective C

    @import Carbon;

    Swift

    import Carbon

    Доступность

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

Коды результата

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

  • kAHInternalErr

    Требуемая работа не могла быть завершена.

    Значение

    - 10790

    Описание

    Требуемая работа не могла быть завершена.

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

  • kAHInternetConfigPrefErr

    Была ошибка при попытке считать интернет-настройки Config.

    Значение

    - 10791

    Описание

    Была ошибка при попытке считать интернет-настройки Config.

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