Ссылка SearchKit

Поисковый Набор является мощной и оптимизированной платформой языка C для индексации и поиска текста на наиболее естественных языках. Это обеспечивает быстрый информационный поиск в Установках системы, Адресной книге, Средстве просмотра Справки и XCode. Технология Центра внимания Apple создается поверх Поискового Набора для обеспечения довольный поиск в Средстве поиска, Почте и меню Spotlight.

Можно использовать Поисковый Набор или Центр внимания для обеспечения схожей функциональности и мощных возможностей доступа к информации в приложении Mac. Поисковый Набор является надлежащим, когда Вы хотите, чтобы Ваше приложение имело полный контроль над индексацией и поиском, и когда Вашим фокусом является содержание файла. Поисковый Набор ориентирован на многопотоковое исполнение и работает с инструментами командной строки и Какао.

Поисковый Набор поддерживает фразовые поиски, поиски префикса/суффикса/подстроки, Поиски с использованием булевых операторов, реферирование и ранжирование уместности. Поисковый Набор использует средства импорта метаданных Центра внимания при индексации документов и использует в своих интересах любые дополнительные средства импорта, доступные в системе.

Функции

Создание, открываясь и закрывая индексы

Поисковый Набор выполняет свои поиски не на документах, а на его индексах документов. Функции в этой группе позволяют Вашему приложению создать основанные на памяти и персистентные индексы. Индексы первоначально пусты. Функции в Управлении Индексами позволяют Вам добавить содержание документа к этим индексам.


    
    SKIndexCreateWithURL (_: _: _: _:)
    SKIndexCreateWithURL

Создает именованный индекс в файле, расположение которого указано с объектом CFURL.

Объявление

Swift

func SKIndexCreateWithURL(_ inURL: CFURL!, _ inIndexName: CFString!, _ inIndexType: SKIndexType, _ inAnalysisProperties: CFDictionary!) -> Unmanaged<SKIndex>!

Objective C

SKIndexRef SKIndexCreateWithURL ( CFURLRef inURL, CFStringRef inIndexName, SKIndexType inIndexType, CFDictionaryRef inAnalysisProperties );

Параметры

`inURL`	Расположение индекса.
`inIndexName`	Имя индекса. Если Вы вызываете эту функцию с `inIndexName` набор к `NULL`, Поисковый Набор присваивает индекс имя индекса по умолчанию `IADefaultIndex`. Если Вы тогда пытаетесь создать второй индекс в том же файле, не присваивая имя, никакой второй индекс не создается и эта функция возвраты `NULL`. Поисковый Набор в настоящее время не поддерживает имена индексов получения от индекса.
`inIndexType`	Индексный тип. Посмотрите `“SKIndexType”`.
`inAnalysisProperties`	Словарь свойств анализа текста, дополнительно устанавливающий длину минимального срока, стоп-слова, замены срока, максимальные уникальные условия для индексации, и поддержка близости (для основанных на фразе поисков) при создании индекса. Посмотрите `“Text Analysis Keys”`. Для получения аналитических свойств индекса используйте `SKIndexGetAnalysisProperties` функция. `inAnalysisProperties` параметр может быть `NULL`, когда Поисковый Набор применяет словарь по умолчанию, который является `NULL`.

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

Уникальная ссылка на недавно создаваемый индекс.

Обсуждение

SKIndexCreateWithURL создает индекс в файле. Поисковые индексы Набора первоначально пусты. Используйте эту функцию, когда для Вашего приложения будет нужно персистентное хранение индекса. Для создания основанного на памяти, нестойкого индекса использовать SKIndexCreateWithMutableData.

Файл может содержать больше чем один индекс. Для добавления нового индекса к существующему файлу используйте то же значение для inURL и предоставьте новое имя для inIndexName.

Поисковый Набор ориентирован на многопотоковое исполнение. Можно использовать отдельную индексацию и поиск потоков. Ваше приложение ответственно за обеспечение, что не больше, чем один процесс открыт за один раз для записи в индекс.

Когда для Вашего приложения больше не будет нужен индекс, избавьтесь от него путем вызова SKIndexClose.

Специальные замечания

Вы не можете использовать CFMakeCollectable с SKIndexRef объекты.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKIndexCreateWithMutableData (_: _: _: _:)
    SKIndexCreateWithMutableData

Создает именованный индекс, сохраненный в a CFMutableDataRef объект.

Объявление

Swift

func SKIndexCreateWithMutableData(_ inData: CFMutableData!, _ inIndexName: CFString!, _ inIndexType: SKIndexType, _ inAnalysisProperties: CFDictionary!) -> Unmanaged<SKIndex>!

Objective C

SKIndexRef SKIndexCreateWithMutableData ( CFMutableDataRef inData, CFStringRef inIndexName, SKIndexType inIndexType, CFDictionaryRef inAnalysisProperties );

Параметры

`inData`	Пустое `CFMutableDataRef` объект содержать создаваемый индекс.
`inIndexName`	Имя индекса. Если Вы вызываете эту функцию с `inIndexName` набор к `NULL`, Поисковый Набор присваивает индекс имя индекса по умолчанию `IADefaultIndex`. Если Вы тогда пытаетесь создать второй индекс в том же файле, не присваивая имя, никакой второй индекс не создается и эта функция возвраты `NULL`. Поисковый Набор не поддерживает имена индексов получения от индекса.
`inIndexType`	Индексный тип. Посмотрите `“SKIndexType”`.
`inAnalysisProperties`	Словарь свойств анализа текста, дополнительно устанавливающий длину минимального срока, стоп-слова, замены срока, максимальные уникальные условия для индексации, и поддержка близости (для основанных на фразе поисков) при создании индекса. Посмотрите `“Text Analysis Keys”`. `inAnalysisProperties` параметр может быть `NULL`, когда Поисковый Набор применяет словарь по умолчанию, который является `NULL`.

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

Недавно создаваемый индекс.

Обсуждение

SKIndexCreateWithMutableData создает индекс в памяти как a CFMutableDataRef объект. Поисковые индексы Набора первоначально пусты. Когда для Вашего приложения не нужно персистентное хранение, основанный на памяти индекс полезен для быстрого поиска и. Для создания находящегося на диске, персистентного индекса используйте SKIndexCreateWithURL функция.

Эта функция сохраняет объект данных, который Вы обеспечиваете в inData параметр.

Когда для Вашего приложения больше не будет нужен индекс, избавьтесь от него путем вызова SKIndexClose.

Специальные замечания

Вы не можете использовать CFMakeCollectable с SKIndexRef объекты.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKIndexOpenWithData (_: _:)
    SKIndexOpenWithData

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

Объявление

Swift

func SKIndexOpenWithData(_ inData: CFData!, _ inIndexName: CFString!) -> Unmanaged<SKIndex>!

Objective C

SKIndexRef SKIndexOpenWithData ( CFDataRef inData, CFStringRef inIndexName );

Параметры

`inData`	Индекс для открытия.
`inIndexName`	Имя индекса. Может быть `NULL`, когда эта функция пытается открыть индекс с именем по умолчанию `IADefaultIndex`.

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

Именованный индекс, или NULL при отказе.

Обсуждение

Индекс, открытый SKIndexOpenWithData может искаться, но не обновляться. Для открытия индекса для обновления использовать SKIndexOpenWithMutableData.

Если inIndexName NULL и inData не содержит индекс с именем по умолчанию, эта функция возвраты NULL.

Вызов к SKIndexOpenWithData сохраняет открытый индекс. Когда для Вашего приложения больше не будет нужен индекс, избавьтесь от него путем вызова SKIndexClose.

Специальные замечания

Вы не можете использовать CFMakeCollectable с SKIndexRef объекты.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKIndexOpenWithMutableData (_: _:)
    SKIndexOpenWithMutableData

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

Объявление

Swift

func SKIndexOpenWithMutableData(_ inData: CFMutableData!, _ inIndexName: CFString!) -> Unmanaged<SKIndex>!

Objective C

SKIndexRef SKIndexOpenWithMutableData ( CFMutableDataRef inData, CFStringRef inIndexName );

Параметры

`inData`	Индекс для открытия.
`inIndexName`	Имя индекса. Может быть `NULL`, когда эта функция пытается открыть индекс с именем по умолчанию `IADefaultIndex`.

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

Именованный индекс, или NULL при отказе.

Обсуждение

Индекс, открытый SKIndexOpenWithMutableData может искаться или обновляться. Для открытия индекса для поиска только используйте SKIndexOpenWithData функция.

Если inIndexName NULL и inData не содержит индекс с именем по умолчанию, эта функция возвраты NULL.

Вызов к SKIndexOpenWithMutableData сохраняет открытый индекс. Когда для Вашего приложения больше не будет нужен индекс, избавьтесь от него путем вызова SKIndexClose.

Специальные замечания

Вы не можете использовать CFMakeCollectable с SKIndexRef объекты.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKIndexOpenWithURL (_: _: _:)
    SKIndexOpenWithURL

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

Объявление

Swift

func SKIndexOpenWithURL(_ inURL: CFURL!, _ inIndexName: CFString!, _ inWriteAccess: Boolean) -> Unmanaged<SKIndex>!

Objective C

SKIndexRef SKIndexOpenWithURL ( CFURLRef inURL, CFStringRef inIndexName, Boolean inWriteAccess );

Параметры

`inURL`	Расположение индекса.
`inIndexName`	Имя индекса. Может быть `NULL`, когда эта функция пытается открыть индекс с именем по умолчанию `IADefaultIndex`.
`inWriteAccess`	Булево значение, указывающее, открыт ли индекс для обновления. Открыть индекс для поиска только, передачи `false` (`0` или `kCFBoolenFalse`). Открыть его для поиска и обновления, передачи `true` (`1` или `kCFBooleanTrue`).

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

Именованный индекс, или NULL при отказе.

Обсуждение

Если inIndexName NULL и inData не содержит индекс с именем по умолчанию, эта функция возвраты NULL.

Вызов к SKIndexOpenWithURL сохраняет открытый индекс. Когда для Вашего приложения больше не будет нужен индекс, избавьтесь от него путем вызова SKIndexClose.

Специальные замечания

Вы не можете использовать CFMakeCollectable с SKIndexRef объекты.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

SKIndexClose (_:) SKIndexClose

Закрывает индекс.

Объявление

Swift

func SKIndexClose(_ inIndex: SKIndex!)

Objective C

void SKIndexClose ( SKIndexRef inIndex );

Параметры

inIndex

Индекс для закрытия.

Обсуждение

Когда для Вашего приложения больше не нужен индекс, который оно открыло или создало, вызвать SKIndexClose. Вызывание этой функции эквивалентно вызову CFRelease на индексе.

Поисковый Набор ориентирован на многопотоковое исполнение. Можно использовать отдельную индексацию и поиск потоков. Ваше приложение ответственно за обеспечение, что не больше, чем один процесс открыт за один раз для записи в индекс.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

Доступный в OS X v10.4 и позже.
SKIndexGetIndexType (_:) SKIndexGetIndexType

Получает категорию индекса.

Объявление

Swift

func SKIndexGetIndexType(_ inIndex: SKIndex!) -> SKIndexType

Objective C

SKIndexType SKIndexGetIndexType ( SKIndexRef inIndex );

Параметры

inIndex

Индекс, категорию которого Вы хотите знать.

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

Категория индекса. Посмотрите “SKIndexType” перечисление для списка различных индексных категорий. При отказе, возвращает значение kSKIndexUnknown.

Обсуждение

Как описано в “SKIndexType”, Поисковый Набор предлагает четыре категории индекса, каждый оптимизированный для одного или более типов поиска.

Поисковый Набор ориентирован на многопотоковое исполнение. Можно использовать отдельную индексацию и поиск потоков. Ваше приложение ответственно за обеспечение, что не больше, чем один процесс открыт за один раз для записи в индекс.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

Получает идентификатор типа для Поисковых индексов Набора.

Объявление

Swift

func SKIndexGetTypeID() -> CFTypeID

Objective C

CFTypeID SKIndexGetTypeID ( void );

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

A CFTypeID объект, содержащий идентификатор типа для SKIndexRef непрозрачный тип.

Обсуждение

Поисковый Набор представляет индексы с SKIndexRef непрозрачный тип. Если Ваш код должен определить, является ли определенный тип данных индексом, можно использовать эту функцию вместе с CFGetTypeID функционируйте и выполните сравнение.

Никогда твердый код индексный идентификатор типа, потому что это может измениться от одного выпуска OS X другому.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

Управление индексами

Функции в этом разделе позволяют Вашему приложению добавить содержание документа к (и удалите содержание документа из), индексы, работа с памятью - и находящиеся на диске индексы, и получают метаданные от индексов.


    
    SKIndexAddDocumentWithText (_: _: _: _:)
    SKIndexAddDocumentWithText

Добавляет документ URL (SKDocumentRef) объект и текстовое содержание ассоциированного документа, к индексу.

Объявление

Swift

func SKIndexAddDocumentWithText(_ inIndex: SKIndex!, _ inDocument: SKDocument!, _ inDocumentText: CFString!, _ inCanReplace: Boolean) -> Boolean

Objective C

Boolean SKIndexAddDocumentWithText ( SKIndexRef inIndex, SKDocumentRef inDocument, CFStringRef inDocumentText, Boolean inCanReplace );

Параметры

`inIndex`	Индекс, к которому Вы добавляете документ объект URL (`SKDocumentRef`) .
`inDocument`	Документ URL (`SKDocumentRef`) объект добавить.
`inDocumentText`	Текст документа. Может быть `NULL`.
`inCanReplace`	Булево значение, указывающее, перезапишет ли Поисковый Набор элемент индекса документа (`true`, обозначенный `1` или `kCFBooleanTrue`), или сохраните запись, если она существует (`false`, обозначенный `0` или `kCFBoolenFalse`).

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

Булево значение true на успехе, или false при отказе. Также возвраты false если документ имеет запись в индексе и inCanReplace установлен в false.

Обсуждение

Используйте эту функцию для добавления текстового содержания произвольных типов документов к индексу. С этой функцией Ваше приложение берет на себя ответственность за получение текстового содержания и вручение его к индексу как A CFStringRef объект. Из-за этого Ваше приложение может определить то, что оно считает документом — запись базы данных, маркированное поле в XML-документе, объект в памяти, текстовом файле, и т.д.

Поисковый Набор индексирует любую текстовую строку размера, что Вы даете его до ее предела размера индексного файла на 4 ГБ.

Для добавления текстового содержания основанных на файле документов Поисковому индексу Набора можно использовать эту функцию или использовать в своих интересах возможность Поискового Набора расположиться и читать, определенные дисковые, основанные на файле типы документов — видят SKIndexAddDocument.

Единственный Поисковый индексный файл Набора может составить до 4 ГБ в размере.

Специальные замечания

В OS X v10.3, некоторые функции не обеспечивают ожидаемые результаты, если Вы не следуете за вызовом к SKIndexAddDocumentWithText с вызовом к SKIndexFlush. Затронутые функции включают SKIndexGetDocumentCount, SKIndexGetDocumentTermCount, SKIndexGetDocumentTermFrequency, и SKIndexGetTermDocumentCount. Однако в типичном использовании это не будет проблемой, потому что приложения вызывают эти функции после поиска, и необходимо вызвать SKIndexFlush перед поиском.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKIndexAddDocument (_: _: _: _:)
    SKIndexAddDocument

Добавляют информация о расположении для основанного на файле документа и текстовое содержание документа, к индексу.

Объявление

Swift

func SKIndexAddDocument(_ inIndex: SKIndex!, _ inDocument: SKDocument!, _ inMIMETypeHint: CFString!, _ inCanReplace: Boolean) -> Boolean

Objective C

Boolean SKIndexAddDocument ( SKIndexRef inIndex, SKDocumentRef inDocument, CFStringRef inMIMETypeHint, Boolean inCanReplace );

Параметры

`inIndex`	Индекс, к которому Вы добавляете документ объект URL (`SKDocumentRef`).
`inDocument`	Документ объект URL (типа `SKDocumentRef`), содержа информацию о расположении основанного на файле документа, для добавления к индексу. Можно выпустить документ объект URL сразу после добавления его к индексу.
`inMIMETypeHint`	MIME вводит подсказку для указанного основанного на файле документа. Может быть `NULL`. В Поисковом Наборе общие подсказки типа MIME включают `text/plain`, `text/rtf`, `text/html`, `text/pdf`, и `application/msword`. Укажите, что тип MIME подсказывает, чтобы помочь Высветить, определяют, какое из его средств импорта метаданных для использования, когда Поисковый Набор индексирует основанный на файле документ. Поисковый Набор использует расширения файла и коды типа/создателя в попытке определить типы файлов при индексации файлов. Посмотрите `SKLoadDefaultExtractorPlugIns`. Можно обойти процесс определения типа файла Поискового Набора или переопределить его, при помощи подсказки типа MIME.
`inCanReplace`	Булево значение, указывающее, перезапишет ли Поисковый Набор элемент индекса документа (`true`, обозначенный `1` или `kCFBooleanTrue`), или сохраните запись, если она существует (`false`, обозначенный `0` или `kCFBoolenFalse`).

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

Обсуждение

Схема документа должна иметь тип “file” для использования этой функции. Если это не, вызвать SKIndexAddDocumentWithText вместо этого. Для получения дополнительной информации о схемах посмотрите http://www .iana.org/assignments/uri-schemes.html.

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

Поисковый Набор индексирует любой неисполнимый файл, связанный с документом объект URL (типа SKDocumentRef) то, что Вы вручаете этой функции, даже нетекстовые файлы, такие как изображения. Ваше приложение берет на себя ответственность за обеспечение, чтобы документ, URL возражает Вам, передал SKIndexAddDocument фактически расположения файлов, которые Вы хотите индексировать.

Если Ваше приложение не вызывало SKLoadDefaultExtractorPlugIns, Поисковый Набор индексирует первые 10 МБ документа. Иначе, Поисковый Набор индексирует весь документ до предела размера индексного файла 4 ГБ.

Единственный Поисковый индекс Набора может содержать до 4 миллиардов документов объекты URL и их связанное текстовое содержание.

Специальные замечания

В текущей реализации Поискового Набора некоторые функции не обеспечивают ожидаемые результаты, если Вы не следуете SKIndexAddDocument с вызовом к SKIndexFlush. Затронутые функции включают SKIndexGetDocumentCount, SKIndexGetDocumentTermCount, SKIndexGetDocumentTermFrequency, и SKIndexGetTermDocumentCount. Однако в типичном использовании это не будет проблемой, потому что приложения вызывают эти функции после поиска, и необходимо вызвать SKIndexFlush перед поиском.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

SKIndexFlush (_:) SKIndexFlush

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

Объявление

Swift

func SKIndexFlush(_ inIndex: SKIndex!) -> Boolean

Objective C

Boolean SKIndexFlush ( SKIndexRef inIndex );

Параметры

inIndex

Индекс Вы хотите обновить и передать запоминающее устройство.

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

Булево значение true на успехе, или false при отказе.

Обсуждение

Дисковый или основанный на памяти индекс становится устаревшим когда Ваши обновления приложения это путем добавления или удаления записи документа. Поиск на индексе в таком состоянии не будет иметь доступа к невспыхнувшим обновлениям. Решение состоит в том, чтобы вызвать эту функцию перед поиском. SKIndexFlush информация об индексном обновлении сбросов и передает основанные на памяти индексные кэши диску, в случае дискового индекса, или к объекту памяти, в случае основанного на памяти индекса. В обоих случаях вызывание этой функции делает состояние индекса непротиворечивым.

Прежде, чем искать индекс, всегда вызывайте SKIndexFlush, даже при том, что процесс сброса может взять до нескольких секунд. Если нет никаких обновлений для фиксации, вызов к SKIndexFlush ничего не делает и занимает время.

Новый Поисковый индекс Набора не имеет срока IDs, пока это не сбрасывается.

Поисковый Набор ориентирован на многопотоковое исполнение. Можно использовать отдельную индексацию и поиск потоков. Ваше приложение ответственно за обеспечение, что не больше, чем один процесс открыт за один раз для записи в индекс.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

Доступный в OS X v10.3 и позже.
SKIndexCompact (_:) SKIndexCompact

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

Объявление

Swift

func SKIndexCompact(_ inIndex: SKIndex!) -> Boolean

Objective C

Boolean SKIndexCompact ( SKIndexRef inIndex );

Параметры

inIndex

Индекс Вы хотите уплотнить.

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

Булево значение true на успехе, или false при отказе.

Обсуждение

В течение долгого времени, как документ объекты URL (типа SKDocumentRef) и связанное содержание добавляется к и удалило из индекса, диск индекса или объем потребляемой памяти могут расти вследствие фрагментации.

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

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

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

Доступный в OS X v10.3 и позже.
SKIndexGetDocumentCount (_:) SKIndexGetDocumentCount

Получает общее количество документов, представленных в индексе.

Объявление

Swift

func SKIndexGetDocumentCount(_ inIndex: SKIndex!) -> CFIndex

Objective C

CFIndex SKIndexGetDocumentCount ( SKIndexRef inIndex );

Параметры

inIndex

Индекс, чей документ объекты URL (типа SKDocumentRef) Вы хотите рассчитать.

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

A CFIndex объект, содержащий число документа объекты URL (типа SKDocumentRef) в индексе. При отказе, возвраты 0.

Обсуждение

Документ объекты URL (типа SKDocumentRef) добавленный к индексу имеют состояние индексации kSKDocumentStateIndexed. Посмотрите “SKDocumentIndexState” перечисление.

Поисковый Набор ориентирован на многопотоковое исполнение. Можно использовать отдельную индексацию и поиск потоков. Ваше приложение ответственно за обеспечение, что не больше, чем один процесс открыт за один раз для записи в индекс.

Специальные замечания

В текущей реализации Поискового Набора, SKIndexGetDocumentCount возвращает число документов, представленных в дисковом индексе. Если Ваше приложение добавило документ, URL возражает против индекса, но еще не вызвал SKIndexFlush, количество документа может не быть корректным.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

Доступный в OS X v10.3 и позже.
SKIndexGetMaximumDocumentID (_:) SKIndexGetMaximumDocumentID

Получает документ с самым высоким номером ID в индексе.

Объявление

Swift

func SKIndexGetMaximumDocumentID(_ inIndex: SKIndex!) -> SKDocumentID

Objective C

SKDocumentID SKIndexGetMaximumDocumentID ( SKIndexRef inIndex );

Параметры

inIndex

Индекс.

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

Документ объект ID, содержащий документ с самым высоким номером ID в индексе.

Обсуждение

Используйте эту функцию с SKIndexGetDocumentCount определить, фрагментируется ли индекс и нуждающийся в уплотнении. Посмотрите SKIndexCompact.

Поисковый Набор ориентирован на многопотоковое исполнение. Можно использовать отдельную индексацию и поиск потоков. Ваше приложение ответственно за обеспечение, что не больше, чем один процесс открыт за один раз для записи в индекс.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

Доступный в OS X v10.3 и позже.
SKIndexGetMaximumTermID (_:) SKIndexGetMaximumTermID

Получает срок с самым высоким номером ID в индексе.

Объявление

Swift

func SKIndexGetMaximumTermID(_ inIndex: SKIndex!) -> CFIndex

Objective C

CFIndex SKIndexGetMaximumTermID ( SKIndexRef inIndex );

Параметры

inIndex

Индекс.

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

Объект CFIndex, содержащий срок с самым высоким номером ID в индексе.

Обсуждение

Новый Поисковый индекс Набора не имеет срока IDs, пока это не сбрасывается.

Поисковый Набор ориентирован на многопотоковое исполнение. Можно использовать отдельную индексацию и поиск потоков. Ваше приложение ответственно за обеспечение, что не больше, чем один процесс открыт за один раз для записи в индекс.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKIndexDocumentIteratorCreate (_: _:)
    SKIndexDocumentIteratorCreate

Создает основанный на индексе итератор для документа объекты URL (типа SKDocumentRef) принадлежавший родительскому документу объект URL.

Объявление

Swift

func SKIndexDocumentIteratorCreate(_ inIndex: SKIndex!, _ inParentDocument: SKDocument!) -> Unmanaged<SKIndexDocumentIterator>!

Objective C

SKIndexDocumentIteratorRef SKIndexDocumentIteratorCreate ( SKIndexRef inIndex, SKDocumentRef inParentDocument );

Параметры


      inIndex

Индекс Вы хотите выполнить итерации через.


      inParentDocument

Документ объект URL, который является родителем документа URL, возражает Вам, хочет исследовать. Передача NULL получить главный элемент в индексе. Посмотрите SKDocumentRef для обсуждения того, как получить полный URL для документа объект URL.

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

Основанный на индексе итератор документа.

Обсуждение

Когда Вы захотите выполнить итерации через все документы, представленные в индексе, используйте эту функцию, чтобы создать итератор и затем вызвать SKIndexDocumentIteratorCopyNext поочередно для каждого документа объект URL (типа SKDocumentRef) в индексе.

Итераторы документа выполняют итерации по единственному уровню индекса. Ваш код ответственен за убывание через иерархию документов в индексе.

Когда для Вашего приложения больше не будет нужен итератор, избавьтесь от него путем вызова CFRelease.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKIndexDocumentIteratorCopyNext (_:)
    SKIndexDocumentIteratorCopyNext

Получает следующий документ объект URL (типа SKDocumentRef) от индекса с помощью итератора документа.

Объявление

Swift

func SKIndexDocumentIteratorCopyNext(_ inIterator: SKIndexDocumentIterator!) -> Unmanaged<SKDocument>!

Objective C

SKDocumentRef SKIndexDocumentIteratorCopyNext ( SKIndexDocumentIteratorRef inIterator );

Параметры


      inIterator

Основанный на индексе итератор документа. Посмотрите SKIndexDocumentIteratorCreate для получения информации о создании итератора документа, и SKIndexDocumentIteratorRef для больше об итераторах.

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

Следующий документ URL возражает в индексе.

Обсуждение

Эта функция возвраты NULL когда больше нет документа объектов URL (типа SKDocumentRef) в индексе. Когда закончено выполняя итерации, Ваше приложение должно вызвать CFRelease на всем полученном документе объекты URL, которые являются не -NULL.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

SKIndexDocumentIteratorGetTypeID () SKIndexDocumentIteratorGetTypeID

Получает идентификатор типа для Поисковых итераторов документа Набора.

Объявление

Swift

func SKIndexDocumentIteratorGetTypeID() -> CFTypeID

Objective C

CFTypeID SKIndexDocumentIteratorGetTypeID ( void );

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

Объект CFTypeID, содержащий идентификатор типа для SKIndexDocumentIterator непрозрачный тип.

Обсуждение

Поисковый Набор представляет итераторы документа с SKIndexDocumentIteratorRef непрозрачный тип. Если Ваш код должен определить, является ли определенный тип данных итератором документа, можно использовать эту функцию вместе с CFGetTypeID функционируйте и выполните сравнение.

Поисковый Набор ориентирован на многопотоковое исполнение. Можно использовать отдельную индексацию и поиск потоков. Ваше приложение ответственно за обеспечение, что не больше, чем один процесс открыт за один раз для записи в индекс.

Никогда твердый код идентификатор типа итератора документа, потому что это может измениться от одного выпуска OS X другому.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

Доступный в OS X v10.3 и позже.
SKIndexGetAnalysisProperties (_:) SKIndexGetAnalysisProperties

Получает свойства анализа текста индекса.

Объявление

Swift

func SKIndexGetAnalysisProperties(_ inIndex: SKIndex!) -> Unmanaged<CFDictionary>!

Objective C

CFDictionaryRef SKIndexGetAnalysisProperties ( SKIndexRef inIndex );

Параметры

inIndex

Индекс, свойства анализа текста которого Вы хотите получить.

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

Объект CFDictionary, содержащий свойства анализа текста индекса. При отказе, возвратах NULL.

Обсуждение

Свойства анализа текста индекса определяют, как поиски ведут себя при запросах индекса. Вы устанавливаете аналитические свойства при создании индекса с SKIndexCreateWithURL или SKIndexCreateWithMutableData функции. Для получения дополнительной информации о свойствах анализа текста посмотрите “Text Analysis Keys”.

Поисковый Набор ориентирован на многопотоковое исполнение. Можно использовать отдельную индексацию и поиск потоков. Ваше приложение ответственно за обеспечение, что не больше, чем один процесс открыт за один раз для записи в индекс.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKIndexMoveDocument (_: _: _:)
    SKIndexMoveDocument

Изменяет родителя документа объект URL (типа SKDocumentRef) в индексе.

Объявление

Swift

func SKIndexMoveDocument(_ inIndex: SKIndex!, _ inDocument: SKDocument!, _ inNewParent: SKDocument!) -> Boolean

Objective C

Boolean SKIndexMoveDocument ( SKIndexRef inIndex, SKDocumentRef inDocument, SKDocumentRef inNewParent );

Параметры

`inIndex`	Индекс, содержащий документ, URL возражает Вам, хочет переместиться.
`inDocument`	Документ URL возражает Вам, хочет переместиться.
`inNewParent`	Новый родительский документ объект URL для документа, URL возражает Вам, хочет переместиться.

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

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

Обсуждение

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

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKIndexRemoveDocument (_: _:)
    SKIndexRemoveDocument

Удаляет документ объект URL (типа SKDocumentRef) и его дочерние элементы, если таковые имеются, от индекса.

Объявление

Swift

func SKIndexRemoveDocument(_ inIndex: SKIndex!, _ inDocument: SKDocument!) -> Boolean

Objective C

Boolean SKIndexRemoveDocument ( SKIndexRef inIndex, SKDocumentRef inDocument );

Параметры

`inIndex`	Индекс, из которого Вы хотите удалить документ объект URL (SKDocumentRef).
`inDocument`	Документ URL возражает для удаления.

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

Булево значение true на успехе, или false при отказе.

Обсуждение

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

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKIndexRenameDocument (_: _: _:)
    SKIndexRenameDocument

Изменяет имя документа объект URL (типа SKDocumentRef) в индексе.

Объявление

Swift

func SKIndexRenameDocument(_ inIndex: SKIndex!, _ inDocument: SKDocument!, _ inNewName: CFString!) -> Boolean

Objective C

Boolean SKIndexRenameDocument ( SKIndexRef inIndex, SKDocumentRef inDocument, CFStringRef inNewName );

Параметры

`inIndex`	Индекс, содержащий документ, которому возражает URL, чье имя Вы хотите изменить.
`inDocument`	URL документа возражает, чье имя Вы хотите изменить.
`inNewName`	Новое имя для документа объект URL.

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

Булево значение true если документ имя объекта URL был успешно изменен, или false при отказе.

Обсуждение

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

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

SKIndexSetMaximumBytesBeforeFlush (_: _:) SKIndexSetMaximumBytesBeforeFlush

Не рекомендуемый. Устанавливает предел емкости памяти для обновлений к индексу, измеренному в байтах.

Объявление

Swift

func SKIndexSetMaximumBytesBeforeFlush(_ inIndex: SKIndex!, _ inBytesForUpdate: CFIndex)

Objective C

void SKIndexSetMaximumBytesBeforeFlush ( SKIndexRef inIndex, CFIndex inBytesForUpdate );

Обсуждение

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

Специальные замечания

Apple рекомендует использование SKIndexFlush функция вместо SKIndexSetMaximumBytesBeforeFlush.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

Доступный в OS X v10.3 и позже.
SKIndexGetMaximumBytesBeforeFlush (_:) SKIndexGetMaximumBytesBeforeFlush

Не рекомендуемый. Получает предел емкости памяти для обновлений к индексу, измеренному в байтах.

Объявление

Swift

func SKIndexGetMaximumBytesBeforeFlush(_ inIndex: SKIndex!) -> CFIndex

Objective C

CFIndex SKIndexGetMaximumBytesBeforeFlush ( SKIndexRef inIndex );

Специальные замечания

Эта функция редко необходима и, вероятно, будет осуждена. Apple рекомендует использовать SKIndexFlush функция вместе с емкостью памяти по умолчанию ограничивает для индексных обновлений. Обратитесь к SKIndexSetMaximumBytesBeforeFlush функция для получения дополнительной информации.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

Работа с текстовыми средствами импорта

Поисковый Набор может импортировать текстовое содержание основанных на файле документов в индексы с помощью средств импорта метаданных Центра внимания.

SKLoadDefaultExtractorPlugIns () SKLoadDefaultExtractorPlugIns

Говорит Поисковому Набору использовать средства импорта метаданных Центра внимания.

Объявление

Swift

func SKLoadDefaultExtractorPlugIns()

Objective C

void SKLoadDefaultExtractorPlugIns ( void );

Обсуждение

Средства импорта метаданных Центра внимания определяют kMDItemTextContent свойство для каждого документа передало SKIndexAddDocument функция.

Вызовите SKLoadDefaultExtractorPlugIns функционируйте один раз в запуске приложения, чтобы сказать Поисковому Набору использовать средства импорта метаданных Центра внимания. Функция SKIndexAddDocument будет тогда использовать средства импорта Центра внимания для извлечения текста из поддерживаемых файлов и места что текст в индекс, оставляя разметку.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

Работа с документами и условиями

С точки зрения Поискового Набора документ - что-либо, что содержит текст — документ RTF, файл PDF, Сообщение электронной почты, запись Адресной книги, Интернет URL, результат запроса базы данных, и т.д.

Функции в этом разделе позволяют Вашему приложению создать новый документ объекты URL (SKDocumentRefs), получить метаданные из документов, получить информацию об иерархиях документа и работу с документами и их условиями в контексте Поисковых индексов Набора.


    
    SKDocumentCreateWithURL (_:)
    SKDocumentCreateWithURL

Создает документ объект URL (типа SKDocumentRef) от a CFURLRef объект.

Объявление

Swift

func SKDocumentCreateWithURL(_ inURL: CFURL!) -> Unmanaged<SKDocument>!

Objective C

SKDocumentRef SKDocumentCreateWithURL ( CFURLRef inURL );

Параметры


      inURL

URL для документа объект URL (типа SKDocumentRef) Вы создаете. Схема документа объект URL установлена в схему используемого URL. Только URLs со схемой “file” может использоваться с SKIndexAddDocument функция, но схема URL может быть чем-либо, что Вы любите, если Вы используете SKIndexAddDocumentWithText функция. Для получения дополнительной информации о схемах посмотрите http://www .iana.org/assignments/uri-schemes.html.

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

Новый документ объект URL, или NULL если не мог бы быть создан документ объект URL.

Обсуждение

Использовать SKDocumentCreateWithURL создать уникальную ссылку на файл или другому, произвольный URL, что Ваше приложение будет использовать в качестве документа объект URL (типа SKDocumentRef). Когда для Вашего приложения больше не будет нужен документ объект URL, избавьтесь от него путем вызова CFRelease.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKDocumentCreate (_: _: _:)
    SKDocumentCreate

Создает документ объект URL (типа SKDocumentRef) на основе схемы, родителя и имени.

Объявление

Swift

func SKDocumentCreate(_ inScheme: CFString!, _ inParent: SKDocument!, _ inName: CFString!) -> Unmanaged<SKDocument>!

Objective C

SKDocumentRef SKDocumentCreate ( CFStringRef inScheme, SKDocumentRef inParent, CFStringRef inName );

Параметры

`inScheme`	Схема использовать — аналогичный схеме URL. Только документы, на которые ссылаются с “`file`” схема может быть считана `SKIndexAddDocument` функция. Схема может быть чем-либо, что Вы любите, если Вы используете `SKIndexAddDocumentWithText` функция. Схема может быть `NULL`, когда это будет установлено быть той же схемой как документ родитель объекта URL. Для получения дополнительной информации о схемах посмотрите http://www .iana.org/assignments/uri-schemes.html.
`inParent`	URL документа возражает, что каждый повышается в иерархии документа. Может быть `NULL`.
`inName`	Имя документа, для которого Вы создаете документ объект URL. Для “`file`” схема, это - имя файла или контейнера, не его пути. Путь может быть создан путем хождения по родительским ссылкам. Максимальная длина для названия документа составляет 256 байтов.

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

Новый документ объект URL, или NULL при отказе.

Обсуждение

Новый документ родитель объекта URL может быть NULL, но необходимо указать или схему или родителя. Когда для Вашего приложения больше не будет нужен документ объект URL, избавьтесь от него путем вызова CFRelease.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

SKDocumentCopyURL (_:) SKDocumentCopyURL

Сборки a CFURLRef объект из документа объект URL (типа SKDocumentRef).

Объявление

Swift

func SKDocumentCopyURL(_ inDocument: SKDocument!) -> Unmanaged<CFURL>!

Objective C

CFURLRef SKDocumentCopyURL ( SKDocumentRef inDocument );

Параметры

inDocument

URL документа возражает желанию a CFURLRef объект для.

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

A CFURLRef объект, представляющий расположение документа, или NULL при отказе.

Обсуждение

Можно использовать эту функцию для создания a CFURLRef объект представлять расположение документа. Сделайте это для получения доступа к Базовой функциональности Основы, предоставленной CFURLRef. Эта функциональность включает части доступа строки URL, получение свойств URL и преобразования URL к другим представлениям.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

Доступный в OS X v10.3 и позже.
SKDocumentGetName (_:) SKDocumentGetName

Получает имя документа объект URL (типа SKDocumentRef).

Объявление

Swift

func SKDocumentGetName(_ inDocument: SKDocument!) -> Unmanaged<CFString>!

Objective C

CFStringRef SKDocumentGetName ( SKDocumentRef inDocument );

Параметры

inDocument

URL документа возражает, чье имя Вы хотите получить.

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

A CFStringRef объект, содержащий документ имя объекта URL, или NULL при отказе.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

Доступный в OS X v10.3 и позже.
SKDocumentGetParent (_:) SKDocumentGetParent

Получает родителя документа объект URL (типа SKDocumentRef).

Объявление

Swift

func SKDocumentGetParent(_ inDocument: SKDocument!) -> Unmanaged<SKDocument>!

Objective C

SKDocumentRef SKDocumentGetParent ( SKDocumentRef inDocument );

Параметры

inDocument

URL документа возражает, чьего родителя Вы хотите получить.

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

Родительский документ объект URL, или NULL при отказе.

Обсуждение

Поисковый Набор управляет расположениями документа с точки зрения URLs как Документ объекты URL (типа SKDocumentRef). Родительский документ объект URL обычно содержит URL документа до, но не включая название документа.

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

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

Доступный в OS X v10.3 и позже.
SKDocumentGetSchemeName (_:) SKDocumentGetSchemeName

Получает имя схемы для документа объект URL (типа SKDocumentRef).

Объявление

Swift

func SKDocumentGetSchemeName(_ inDocument: SKDocument!) -> Unmanaged<CFString>!

Objective C

CFStringRef SKDocumentGetSchemeName ( SKDocumentRef inDocument );

Параметры

inDocument

Документ объект URL (типа SKDocumentRef) чью схему Вы хотите получить.

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

A CFStringRef объект, содержащий документ имя схемы объекта URL, или NULL при отказе.

Обсуждение

Схема документа объект URL (типа SKDocumentRef), который представляет, как к этому можно получить доступ, может быть любой символьной строкой, но обычно “file” или “http”. Схема является одним из Поискового документа Набора объект URL, который видят три свойства — SKDocumentRef для подробных данных.

Для получения дополнительной информации о схемах посмотрите http://www .iana.org/assignments/uri-schemes.html

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

Получает идентификатор типа для Поискового документа Набора объекты URL.

Объявление

Swift

func SKDocumentGetTypeID() -> CFTypeID

Objective C

CFTypeID SKDocumentGetTypeID ( void );

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

A CFTypeID объект, содержащий идентификатор типа для документа объект URL (типа SKDocumentRef).

Обсуждение

Поисковый Набор представляет документ объекты URL с SKDocumentRef непрозрачный тип. Если Ваш код должен определить, является ли определенный тип данных документом объект URL, можно использовать эту функцию вместе с CFGetTypeID функционируйте и выполните сравнение.

Никогда твердый код документ тип объекта URL ID, потому что это может измениться от одного выпуска OS X другому.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKIndexCopyDocumentForDocumentID (_: _:)
    SKIndexCopyDocumentForDocumentID

Получает документ объект URL (типа SKDocumentRef) от индекса.

Объявление

Swift

func SKIndexCopyDocumentForDocumentID(_ inIndex: SKIndex!, _ inDocumentID: SKDocumentID) -> Unmanaged<SKDocument>!

Objective C

SKDocumentRef SKIndexCopyDocumentForDocumentID ( SKIndexRef inIndex, SKDocumentID inDocumentID );

Параметры

`inIndex`	Индекс, содержащий документ объект URL.
`inDocumentID`	ID документа, URL возражает Вам, хочет скопировать.

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

Поисковый документ Набора объект URL.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKIndexCopyInfoForDocumentIDs (_: _: _: _: _:)
    SKIndexCopyInfoForDocumentIDs

Получает названия документа и родительский IDs на основе документа IDs.

Объявление

Swift

func SKIndexCopyInfoForDocumentIDs(_ inIndex: SKIndex!, _ inCount: CFIndex, _ inDocumentIDsArray: UnsafeMutablePointer<SKDocumentID>, _ outNamesArray: UnsafeMutablePointer<Unmanaged<CFString>?>, _ outParentIDsArray: UnsafeMutablePointer<SKDocumentID>)

Objective C

void SKIndexCopyInfoForDocumentIDs ( SKIndexRef inIndex, CFIndex inCount, SKDocumentID *inDocumentIDsArray, CFStringRef *outNamesArray, SKDocumentID *outParentIDsArray );

Параметры

`inIndex`	Индекс, содержащий информацию о документе.
`inCount`	Число документа IDs в `inDocumentIDsArray`.
`inDocumentIDsArray`	Точки к массиву документа IDs, представляющий документы, имена которых и родительский IDs Вы хотите.
`outNamesArray`	На вводе, указателе на массив для названий документа. На выводе, точках к ранее выделенному массиву, теперь содержащему названия документа, соответствующие документу IDs в `inDocumentIDsArray`. Может быть `NULL` на вводе, если Вы не хотите получать названия документа. По окончании с массивом names, избавьтесь от него путем вызова `CFRelease` на каждом элементе матрицы.
`outParentIDsArray`	На вводе, указателе на массив для родительского документа IDs. На выводе, точках к ранее выделенному массиву, теперь содержащему документ IDs, представляющий родителей документов, IDs которых находится в `inDocumentIDsArray`. Может быть `NULL` на вводе, если Вы не хотите получать родительский документ IDs.

Обсуждение

SKIndexCopyInfoForDocumentIDs функция позволяет Вам получить пакет названий документа и породить документ IDs за один шаг, на основе списка документа IDs.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKIndexCopyDocumentRefsForDocumentIDs (_: _: _: _:)
    SKIndexCopyDocumentRefsForDocumentIDs

Получает документ объекты URL (типа SKDocumentRef) на основе документа IDs.

Объявление

Swift

func SKIndexCopyDocumentRefsForDocumentIDs(_ inIndex: SKIndex!, _ inCount: CFIndex, _ inDocumentIDsArray: UnsafeMutablePointer<SKDocumentID>, _ outDocumentRefsArray: UnsafeMutablePointer<Unmanaged<SKDocument>?>)

Objective C

void SKIndexCopyDocumentRefsForDocumentIDs ( SKIndexRef inIndex, CFIndex inCount, SKDocumentID *inDocumentIDsArray, SKDocumentRef *outDocumentRefsArray );

Параметры

`inIndex`	Индекс, содержащий информацию о документе.
`inCount`	Число документа IDs в `inDocumentIDsArray`.
`inDocumentIDsArray`	Точки к массиву документа IDs, соответствующий документу объекты URL (типа `SKDocumentRef`) Вы хотите.
`outDocumentRefsArray`	На вводе, указателе на массив для документа объекты URL. На выводе, точках к ранее выделенному массиву, теперь содержащему документ объекты URL, соответствующие документу IDs в `inDocumentIDsArray`. По окончании с документом массив объектов URL, избавьтесь от него путем вызова `CFRelease` на каждом элементе матрицы.

Обсуждение

SKIndexCopyDocumentRefsForDocumentIDs функция позволяет Вам получить пакет документа объекты URL (типа SKDocumentRef) за один шаг, на основе списка документа IDs.

Если Вы хотите получить легкий URLs в форме объектов CFURL вместо этого, использовать SKIndexCopyDocumentURLsForDocumentIDs.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKIndexCopyDocumentURLsForDocumentIDs (_: _: _: _:)
    SKIndexCopyDocumentURLsForDocumentIDs

Получает документ URLs на основе документа IDs.

Объявление

Swift

func SKIndexCopyDocumentURLsForDocumentIDs(_ inIndex: SKIndex!, _ inCount: CFIndex, _ inDocumentIDsArray: UnsafeMutablePointer<SKDocumentID>, _ outDocumentURLsArray: UnsafeMutablePointer<Unmanaged<CFURL>?>)

Objective C

void SKIndexCopyDocumentURLsForDocumentIDs ( SKIndexRef inIndex, CFIndex inCount, SKDocumentID *inDocumentIDsArray, CFURLRef *outDocumentURLsArray );

Параметры

`inIndex`	Индекс, содержащий информацию о документе.
`inCount`	Число документа IDs в `inDocumentIDsArray`.
`inDocumentIDsArray`	Точки к массиву документа IDs, соответствующий документу URLs (объекты CFURL), Вы хотите.
`outDocumentURLsArray`	На вводе, указателе на массив для документа URLs (объекты CFURL). На выводе, точках к ранее выделенному массиву, теперь содержащему документ URLs, соответствующий документу IDs в `inDocumentIDArray`. По окончании с документом массив URL, избавьтесь от него путем вызова `CFRelease` на каждом элементе матрицы.

Обсуждение

SKIndexCopyDocumentURLsForDocumentIDs функция позволяет Вам получить пакет документа URLs (объекты CFURL) за один шаг, на основе списка документа IDs.

Если Вы хотите получить Поисковый Документ Набора объекты URL (SKDocumentRefs) вместо этого, использовать SKIndexCopyDocumentRefsForDocumentIDs.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

SKIndexCopyDocumentIDArrayForTermID (_: _:) SKIndexCopyDocumentIDArrayForTermID

Получает документ IDs для документов, содержащих данный срок.

Объявление

Swift

func SKIndexCopyDocumentIDArrayForTermID(_ inIndex: SKIndex!, _ inTermID: CFIndex) -> Unmanaged<CFArray>!

Objective C

CFArrayRef SKIndexCopyDocumentIDArrayForTermID ( SKIndexRef inIndex, CFIndex inTermID );

Параметры

inIndex

Индекс для поиска.

inTermID

ID срока для поиска.

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

Массив CFNumbers, каждый ID для документа URL возражает что точки против документа, содержащего критерий поиска.

Обсуждение

SKIndexCopyDocumentIDArrayForTermID ищет единственный индекс документы, содержащие данный срок. Поиск использует термин ID, не строка срока. Для получения ID срока использовать SKIndexGetTermIDForTermString.

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

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKIndexCopyTermIDArrayForDocumentID (_: _:)
    SKIndexCopyTermIDArrayForDocumentID

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

Объявление

Swift

func SKIndexCopyTermIDArrayForDocumentID(_ inIndex: SKIndex!, _ inDocumentID: SKDocumentID) -> Unmanaged<CFArray>!

Objective C

CFArrayRef SKIndexCopyTermIDArrayForDocumentID ( SKIndexRef inIndex, SKDocumentID inDocumentID );

Параметры

`inIndex`	Индекс, содержащий документ объект URL (SKDocumentRef) и связанное текстовое содержание.
`inDocumentID`	ID документа, срок которого IDs Вы копируете.

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

CFArray, содержащий CFNumbers, каждый из которых представляет ID для срока в документе.

Обсуждение

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

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKIndexCopyTermStringForTermID (_: _:)
    SKIndexCopyTermStringForTermID

Получает срок, указанный ID, от индекса.

Объявление

Swift

func SKIndexCopyTermStringForTermID(_ inIndex: SKIndex!, _ inTermID: CFIndex) -> Unmanaged<CFString>!

Objective C

CFStringRef SKIndexCopyTermStringForTermID ( SKIndexRef inIndex, CFIndex inTermID );

Параметры

`inIndex`	Индекс, слова которого Вы ищете.
`inTermID`	ID срока, строку которого Вы хотите.

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

CFString, содержащий срок, указанный inTermID.

Обсуждение

Когда Ваше приложение имеет ID срока, возможно в результате вызова SKIndexCopyTermIDArrayForDocumentID, используйте эту функцию для получения текстовой строки срока.

Для выполнения обратной работы получения срока ID от строки срока в данном индексе использовать SKIndexGetTermIDForTermString.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKIndexGetTermIDForTermString (_: _:)
    SKIndexGetTermIDForTermString

Получает ID для срока в индексе.

Объявление

Swift

func SKIndexGetTermIDForTermString(_ inIndex: SKIndex!, _ inTermString: CFString!) -> CFIndex

Objective C

CFIndex SKIndexGetTermIDForTermString ( SKIndexRef inIndex, CFStringRef inTermString );

Параметры

`inIndex`	Индекс Вы хотите исследовать.
`inTermString`	Термин представляет в виде строки, чей соответствующий ID Вы хотите.

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

Объект CFIndex, содержащий термин ID для данного срока в индексе. Если срок не найден, эта функция возвращает значение kCFNotFound.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKIndexSetDocumentProperties (_: _: _:)
    SKIndexSetDocumentProperties

Устанавливает определенные с помощью приложения свойства документа объект URL (типа SKDocumentRef).

Объявление

Swift

func SKIndexSetDocumentProperties(_ inIndex: SKIndex!, _ inDocument: SKDocument!, _ inProperties: CFDictionary!)

Objective C

void SKIndexSetDocumentProperties ( SKIndexRef inIndex, SKDocumentRef inDocument, CFDictionaryRef inProperties );

Параметры

`inIndex`	Индекс, содержащий документ, которому возражает URL, чьи свойства Вы хотите установить.
`inDocument`	URL документа возражает, чьи свойства Вы хотите установить.
`inProperties`	Объект CFDictionary, содержащий свойства для применения к документу объект URL.

Обсуждение

Поисковый документ Набора объекты URL (типа SKDocumentRef) может иметь дополнительный, определенный с помощью приложения словарь свойств для содержания любой информации, требуется связать с документом, представленным документом объект URL — такой как метка времени, ключевые слова, и т.д.

Использовать SKIndexSetDocumentProperties для персистентной установки определенных с помощью приложения свойств для документа, URL возражает в индексе. Эта функция заменяет документ существующий словарь свойств объекта URL новым. Для получения копии документа словарь свойств объекта URL использовать SKIndexCopyDocumentProperties.

Специальные замечания

Необходимо установить любые желаемые свойства на документе объект URL после добавления документа объект URL к индексу. При добавлении документа объект URL к индексу очищает существующие ранее свойства объекта.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKIndexCopyDocumentProperties (_: _:)
    SKIndexCopyDocumentProperties

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

Объявление

Swift

func SKIndexCopyDocumentProperties(_ inIndex: SKIndex!, _ inDocument: SKDocument!) -> Unmanaged<CFDictionary>!

Objective C

CFDictionaryRef SKIndexCopyDocumentProperties ( SKIndexRef inIndex, SKDocumentRef inDocument );

Параметры

`inIndex`	Индекс, содержащий документ, которому возражает URL, чьи свойства Вы хотите скопировать.
`inDocument`	URL документа возражает, чьи свойства Вы хотите скопировать.

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

Объект CFDictionary, содержащий документ объект URL свойства (SKDOCUMENTREF), или NULL при отказе.

Обсуждение

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKIndexGetDocumentState (_: _:)
    SKIndexGetDocumentState

Получает текущее состояние индексации документа объект URL (типа SKDocumentRef) в индексе.

Объявление

Swift

func SKIndexGetDocumentState(_ inIndex: SKIndex!, _ inDocument: SKDocument!) -> SKDocumentIndexState

Objective C

SKDocumentIndexState SKIndexGetDocumentState ( SKIndexRef inIndex, SKDocumentRef inDocument );

Параметры

`inIndex`	Индекс, содержащий документ, которому возражает URL, чью индексацию состояния Вы хотите.
`inDocument`	URL документа возражает, чью индексацию состояния Вы хотите.

Параметры

`inIndex`	Индекс, содержащий текст документов, Вы хотите исследовать.
`inTermID`	Условия, случаи которых Вы хотите знать.

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

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

Обсуждение

Если Вы хотите знать, в котором документирует срок, появляется через многократные индексы, вызовите эту функцию отдельно на каждом индексе. Прежде, чем запросить каждый индекс, получите специфичный для индекса срок использование ID SKIndexGetTermIDForTermString.

Гарантировать, что эта функция принимает во внимание документ объекты URL (типа SKDocumentRef) недавно добавленный к индексам, вызвать SKIndexFlush на каждом индексе прежде, чем вызвать эту функцию.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKIndexGetDocumentID (_: _:)
    SKIndexGetDocumentID

Получает ID документа объект URL (типа SKDocumentRef) в индексе.

Объявление

Swift

func SKIndexGetDocumentID(_ inIndex: SKIndex!, _ inDocument: SKDocument!) -> SKDocumentID

Objective C

SKDocumentID SKIndexGetDocumentID ( SKIndexRef inIndex, SKDocumentRef inDocument );

Параметры

`inIndex`	Индекс, содержащий текст документа, документ которого идентификатор объекта URL Вы хотите.
`inDocument`	URL документа возражает, чей ID Вы хотите.

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

Документ объект ID.

Обсуждение

Документ ID идентифицирует документ объект URL (типа SKDocumentRef) в индексе. ID доступен, как только Вы добавляете документ объект URL к индексному использованию SKIndexAddDocumentWithText или SKIndexAddDocument.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

Быстро асинхронный поиск


    
    SKSearchCreate (_: _: _:)
    SKSearchCreate

Создает асинхронный поисковый объект для запросов индекса и инициирует поиск.

Объявление

Swift

func SKSearchCreate(_ inIndex: SKIndex!, _ inQuery: CFString!, _ inSearchOptions: SKSearchOptions) -> Unmanaged<SKSearch>!

Objective C

SKSearchRef SKSearchCreate ( SKIndexRef inIndex, CFStringRef inQuery, SKSearchOptions inSearchOptions );

Параметры

`inIndex`	Индекс для запросов.
`inQuery`	Строка запроса для поиска.
`inSearchOptions`	Параметры поиска. Может быть `NULL`. Посмотрите `“SKSearchOptions”` перечисление для описания доступных параметров.

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

Поисковый объект.

Обсуждение

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

После создания поискового объекта вызвать SKSearchFindMatches получать результаты. Можно вызвать SKSearchFindMatches сразу. Для отмены поиска вызвать SKSearchCancel.

Для нормального не подобие базировало запросы, Поисковый Набор различает тип запроса — булевской переменной, префикса, фразы, и т.д. — от синтаксиса самого запроса. Кроме того, Поисковый Набор поддерживает многократные типы запроса в единственном поиске. Например, следующий запрос включает булевскую переменную, префикс и суффиксный поиск:

      appl* OR *ing

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

Для поисков подобия, указанных с kSKSearchOptionFindSimilar флаг в inSearchOptions параметр, SKSearchCreate игнорирует всех операторов запроса.

Операторы запроса это SKSearchCreate распознает для поиска неподобия:

**Табличный 1Search** Набор запрашивает операторов для поисков неподобия
Оператор	значение
`AND`	Булевская переменная `AND`
`&`	Булевская переменная `AND`
`<space>`	Булевская переменная `AND` по умолчанию, когда никакой другой оператор не присутствует, или булевская переменная `OR` если указано `kSKSearchOptionSpaceMeansOR`.
`OR`	Булевская переменная включительно `OR`
`\|`	Булевская переменная включительно `OR`
`NOT`	Булевская переменная `NOT` (см. специальные замечания),
`!`	Булевская переменная `NOT` (см. специальные замечания),
*	Подстановочный знак для префикса или суффикса; окружите срок подстановочными символами для поиска подстроки. Проигнорированный в поиске фразы.
(	Начните логическую группировку
)	Закончите логическую группировку
"	разделитель для поиска фразы

Операторы AND, OR, и NOT чувствительны к регистру.

Поисковый Набор выполняет нормализацию Unicode на строках запроса и на тексте, помещенном в индексы. Это использует Форму нормализации Unicode KC (NFKC, разложение совместимости, сопровождаемое каноническим составом), как задокументировано в Приложение № 15 Стандарта Unicode. Например, серьезный символ, ‘à’, может быть записан как два символа Unicode (0x0061, 0x0300) или как единственный символ Unicode 0x00E0. Поисковый Набор нормализует (0x0061, 0x0300) к 0x00E0. Для получения дополнительной информации о нормализации Unicode посмотрите http://unicode.org/reports/tr15.

Поисковый Набор далее нормализует строки запроса и индексы путем разделения диакритических знаков и путем принуждения символов к нижнему регистру. Например, Поисковый Набор нормализует каждый из следующих символов к ‘a’: ‘à’, и ‘À’.

Когда для Вашего приложения больше не будет нужен поисковый объект, избавьтесь от него путем вызова CFRelease.

Специальные замечания

Поисковый Набор поддерживает логическое исключение. NOT и ! операторы ведут себя, как будто они были EXCLUDE операторы. Например, поиск ‘красного NOT синие’ возвраты все документы, содержащие 'красное' слово и не содержащие 'синее' слово.

Унарные булевы операторы, однако, в настоящее время не реализуются в Поисковом Наборе. Поиск, например, для‘NOT синий’, нулевые документы возвратов независимо от того, что их содержание.

Вы не можете использовать CFMakeCollectable с объектами SKSearch. В собравшей «мусор» среде необходимо использовать CFRelease избавляться от объекта SKSearch.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKSearchFindMatches (_: _: _: _: _: _:)
    SKSearchFindMatches

Информация о результате поиска выдержек от поискового объекта.

Объявление

Swift

func SKSearchFindMatches(_ inSearch: SKSearch!, _ inMaximumCount: CFIndex, _ outDocumentIDsArray: UnsafeMutablePointer<SKDocumentID>, _ outScoresArray: UnsafeMutablePointer<Float>, _ maximumTime: CFTimeInterval, _ outFoundCount: UnsafeMutablePointer<CFIndex>) -> Boolean

Objective C

Boolean SKSearchFindMatches ( SKSearchRef inSearch, CFIndex inMaximumCount, SKDocumentID *outDocumentIDsArray, float *outScoresArray, CFTimeInterval maximumTime, CFIndex *outFoundCount );

Параметры

`inSearch`	Ссылка на поисковый объект (SKSearchRef), ранее создаваемый с `SKSearchCreate`.
`inMaximumCount`	Максимальное количество элементов для нахождения. Для каждого найденного элемента, `SKSearchFindMatches` помещает ассоциированный документ ID в `outDocumentIDsArray` массив. Укажите `inMaximumCount` из 0 для нахождения как можно большего количества элементов в `maximumTime`.
`outDocumentIDsArray`	На вводе, указателе на массив для документа IDs. На выводе, точках к точкам к ранее выделенному массиву, теперь содержащему найденный документ IDs. Размер этого массива должен быть равен `inMaximumCount`.
`outScoresArray`	На вводе, указателе на массив для очков. На выводе, точках к ранее выделенному массиву, теперь содержащему музыку уместности к найденным элементам. Размер этого массива, если нет `NULL`, должно быть равно `inMaximumCount`. Может быть `NULL` на вводе, при условии, что для Вашего приложения не нужна эта информация. Поисковый Набор не нормализует очки уместности, таким образом, они могут быть очень большими.
`maximumTime`	Максимальное количество секунд перед этой функцией возвраты, действительно ли `inMaximumCount` элементы были найдены. Установка maximumTime к 0 говорит поиску возвращаться быстро
`outFoundCount`	На вводе, указателе на объект CFIndex, который будет содержать число найденных элементов. На выводе, точках к объекту CFIndex, теперь содержащему фактическое число найденных элементов.

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

Логическое значение, указывающее, происходит ли поиск все еще. Когда поиск исчерпывается, возвращает false.

Обсуждение

SKSearchFindMatches выдержки следуют из работы находки, инициируемой поисковым объектом (SKSearchRef).

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

Можно вызвать эту функцию на поисковом объекте неоднократно для получения дополнительных наборов результатов поиска. Например, если Вы вызываете эту функцию дважды с inMaximumCount значение 10, первый вызов поместит первые 10 элементов, найденных в выходные массивы, и второй вызов поместит вторые 10 элементов, найденных в выходные массивы.

Приложения являются бесплатными вывести на экран очки уместности любым надлежащим способом. Один простой путь состоит в том, чтобы разделиться, каждый счет уместности наибольшим числом возвратился для масштабирования чисел уместности линейно от 0,0 до 1,0. Поисковый Набор не масштабирует музыку уместности к Вам, потому что можно хотеть объединить очки от нескольких запросов к поисковому объекту или очкам от вызовов больше чем до одного поискового объекта.

Прежде, чем вызвать поиск, вызвать SKIndexFlush на всех индексах Вы запросите, чтобы гарантировать, что обновления к индексам были сброшены к диску.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKSearchCancel (_:)
    SKSearchCancel

Отменяет асинхронный поисковый запрос.

Объявление

Swift

func SKSearchCancel(_ inSearch: SKSearch!)

Objective C

void SKSearchCancel ( SKSearchRef inSearch );

Параметры


      inSearch

Поисковый объект, связанный асинхронный поиск которого Вы хотите отменить.

Обсуждение

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

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

SKSearchGetTypeID () SKSearchGetTypeID

Получает идентификатор типа для Поисковых объектов поиска Набора.

Объявление

Swift

func SKSearchGetTypeID() -> CFTypeID

Objective C

CFTypeID SKSearchGetTypeID ( void );

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

Объект CFTypeID, содержащий идентификатор типа для непрозрачного типа SKSearch.

Обсуждение

Поисковый Набор представляет поиски с поисковыми объектами (SKSearchRef непрозрачные типы). Если Ваш код должен определить, является ли определенный тип данных поисковым объектом, можно использовать эту функцию вместе с CFGetTypeID функционируйте и выполните сравнение.

Никогда твердый код поисковый идентификатор типа, потому что это может измениться от одного выпуска OS X другому.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

Работа с реферированием

Ищите функции Реферирования Набора вытесняют тех в Находке Apple Содержанием API.

SKSummaryCreateWithString (_:) SKSummaryCreateWithString

Создает сводку, основанную на объектах на текстовой строке.

Объявление

Swift

func SKSummaryCreateWithString(_ inString: CFString!) -> Unmanaged<SKSummary>!

Objective C

SKSummaryRef SKSummaryCreateWithString ( CFStringRef inString );

Параметры

inString

Текстовая строка, которую Вы хотите суммировать.

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

Возвращает объект реферирования, или NULL при отказе.

Обсуждение

SKSummaryCreateWithString функция создает объект реферирования, предварительно анализирующий текстовую строку для поддержки быстрого реферирования. Когда для Вашего приложения больше не будет нужен объект реферирования, избавьтесь от него путем вызова CFRelease.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKSummaryGetSentenceSummaryInfo (_: _: _: _: _:)
    SKSummaryGetSentenceSummaryInfo

Получает подробную информацию об организации текста для построения пользовательской основанной на предложении сводной строки.

Объявление

Swift

func SKSummaryGetSentenceSummaryInfo(_ summary: SKSummary!, _ numSentencesInSummary: CFIndex, _ outRankOrderOfSentences: UnsafeMutablePointer<CFIndex>, _ outSentenceIndexOfSentences: UnsafeMutablePointer<CFIndex>, _ outParagraphIndexOfSentences: UnsafeMutablePointer<CFIndex>) -> CFIndex

Objective C

CFIndex SKSummaryGetSentenceSummaryInfo ( SKSummaryRef summary, CFIndex numSentencesInSummary, CFIndex *outRankOrderOfSentences, CFIndex *outSentenceIndexOfSentences, CFIndex *outParagraphIndexOfSentences );

Параметры

`summary`	Объект реферирования, содержащий текст, из которого Вы хотите создать сводку.
`numSentencesInSummary`	Максимальное количество предложений Вы хотите в сводке.
`outRankOrderOfSentences`	На вводе, указателе на массив объектов CFIndex. На выводе, точках к ранее выделенному массиву, теперь перечисляющему разряд уместности реферирования каждого предложения в оригинальном тексте. Самое важное предложение получает разряд 1. Размер массива должен равняться `numSentencesInSummary`, или иначе быть `NULL` если Вы не хотите получать заказы разряда.
`outSentenceIndexOfSentences`	На вводе, указателе на массив объектов CFIndex. На выводе, точках к ранее выделенному массиву, теперь содержащему порядковое число для каждого предложения в оригинальном тексте. Используйте `SKSummaryCopySentenceAtIndex` функция с одним из этих чисел для получения соответствующего предложения. Размер массива должен равняться `numSentencesInSummary`, или иначе быть `NULL` если Вы не хотите получать порядковые числа предложений.
`outParagraphIndexOfSentences`	На вводе, указателе на массив объектов CFIndex. На выводе точки к ранее выделенному массиву, теперь содержащему порядковое число для абзаца, что каждое соответствующее предложение, сослались в `outSentenceIndexOfSentences`, появляется в. Размер массива должен равняться `numSentencesInSummary`, или иначе быть `NULL` если Вы не хотите получать порядковые числа предложений.

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

Число предложений в сводке.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKSummaryGetParagraphSummaryInfo (_: _: _: _:)
    SKSummaryGetParagraphSummaryInfo

Получает подробную информацию об организации текста для построения пользовательской основанной на абзаце сводной строки.

Объявление

Swift

func SKSummaryGetParagraphSummaryInfo(_ summary: SKSummary!, _ numParagraphsInSummary: CFIndex, _ outRankOrderOfParagraphs: UnsafeMutablePointer<CFIndex>, _ outParagraphIndexOfParagraphs: UnsafeMutablePointer<CFIndex>) -> CFIndex

Objective C

CFIndex SKSummaryGetParagraphSummaryInfo ( SKSummaryRef summary, CFIndex numParagraphsInSummary, CFIndex *outRankOrderOfParagraphs, CFIndex *outParagraphIndexOfParagraphs );

Параметры

`summary`	Объект реферирования, содержащий текст, из которого Вы хотите создать сводку.
`numParagraphsInSummary`	Максимальное количество абзацев Вы хотите в сводке.
`outRankOrderOfParagraphs`	На вводе, указателе на массив объектов CFIndex. На выводе, точках к ранее выделенному массиву, теперь перечисляющему разряд уместности реферирования каждого абзаца в оригинальном тексте. Самый важный абзац получает разряд 1. Размер массива должен равняться `numParagraphsInSummary`, или иначе быть `NULL` если Вы не хотите получать разряды уместности.
`outParagraphIndexOfParagraphs`	На выводе, точках к массиву, содержащему порядковое число для каждого абзаца в оригинальном тексте. Используйте `SKSummaryCopyParagraphAtIndex` функция с одним из этих чисел для получения соответствующего абзаца. Размер массива должен равняться `numParagraphsInSummary`, или иначе быть `NULL` если Вы не хотите получать порядковые числа абзацев.

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

Число абзацев в сводке.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

SKSummaryGetSentenceCount (_:) SKSummaryGetSentenceCount

Получает число предложений в объекте реферирования.

Объявление

Swift

func SKSummaryGetSentenceCount(_ summary: SKSummary!) -> CFIndex

Objective C

CFIndex SKSummaryGetSentenceCount ( SKSummaryRef summary );

Параметры

summary

Объект реферирования, предложения которого Вы хотите считать.

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

Объект CFIndex, содержащий число предложений в объекте реферирования.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

Доступный в OS X v10.4 и позже.
SKSummaryGetParagraphCount (_:) SKSummaryGetParagraphCount

Получает число абзацев в объекте реферирования.

Объявление

Swift

func SKSummaryGetParagraphCount(_ summary: SKSummary!) -> CFIndex

Objective C

CFIndex SKSummaryGetParagraphCount ( SKSummaryRef summary );

Параметры

summary

Объект реферирования, абзацы которого Вы хотите считать.

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

Объект CFIndex, содержащий число абзацев в объекте реферирования.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKSummaryCopySentenceAtIndex (_: _:)
    SKSummaryCopySentenceAtIndex

Получает указанное предложение из текста в объекте реферирования.

Объявление

Swift

func SKSummaryCopySentenceAtIndex(_ summary: SKSummary!, _ i: CFIndex) -> Unmanaged<CFString>!

Objective C

CFStringRef SKSummaryCopySentenceAtIndex ( SKSummaryRef summary, CFIndex i );

Параметры

`summary`	Объект реферирования, содержащий текст, от которого Вы хотите предложение.
`i`	Порядковое число предложения в оригинальном тексте, с первым предложением, определяемым нулем (эта функция использует основанную на нуле индексацию).

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

A CFStringRef объект, содержащий указанное предложение, или NULL при отказе.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKSummaryCopyParagraphAtIndex (_: _:)
    SKSummaryCopyParagraphAtIndex

Получает указанный абзац из текста в объекте реферирования.

Объявление

Swift

func SKSummaryCopyParagraphAtIndex(_ summary: SKSummary!, _ i: CFIndex) -> Unmanaged<CFString>!

Objective C

CFStringRef SKSummaryCopyParagraphAtIndex ( SKSummaryRef summary, CFIndex i );

Параметры

`summary`	Объект реферирования, содержащий текст, от которого Вы хотите абзац.
`i`	Порядковое число абзаца в оригинальном тексте, с первым абзацем, определяемым нулем (эта функция использует основанную на нуле индексацию).

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

A CFStringRef объект, содержащий указанный абзац, или NULL при отказе.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKSummaryCopySentenceSummaryString (_: _:)
    SKSummaryCopySentenceSummaryString

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

Объявление

Swift

func SKSummaryCopySentenceSummaryString(_ summary: SKSummary!, _ numSentences: CFIndex) -> Unmanaged<CFString>!

Objective C

CFStringRef SKSummaryCopySentenceSummaryString ( SKSummaryRef summary, CFIndex numSentences );

Параметры

`summary`	Объект реферирования, содержащий текст, от которого Вы хотите реферирование.
`numSentences`	Максимальное количество предложений Вы хотите в сводке.

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

A CFStringRef объект, содержащий требуемую сводку.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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


    
    SKSummaryCopyParagraphSummaryString (_: _:)
    SKSummaryCopyParagraphSummaryString

Получает текстовую строку, состоящую из сводки с, самое большее, требуемое число абзацев.

Объявление

Swift

func SKSummaryCopyParagraphSummaryString(_ summary: SKSummary!, _ numParagraphs: CFIndex) -> Unmanaged<CFString>!

Objective C

CFStringRef SKSummaryCopyParagraphSummaryString ( SKSummaryRef summary, CFIndex numParagraphs );

Параметры

`summary`	Объект реферирования, содержащий текст, от которого Вы хотите реферирование.
`numParagraphs`	Максимальное количество абзацев Вы хотите в сводке.

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

A CFStringRef объект, содержащий требуемую сводку.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

SKSummaryGetTypeID () SKSummaryGetTypeID

Получает идентификатор типа для Поисковых объектов реферирования Набора.

Объявление

Swift

func SKSummaryGetTypeID() -> CFTypeID

Objective C

CFTypeID SKSummaryGetTypeID ( void );

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

Объект CFTypeID, или NULL при отказе.

Обсуждение

Поисковый Набор представляет результаты реферирования с объектами реферирования (SKSummaryRef непрозрачные типы). Если Ваш код должен определить, является ли определенный тип данных сводкой, можно использовать эту функцию вместе с CFGetTypeID функционируйте и выполните сравнение.

Никогда твердый код идентификатор типа реферирования, потому что это может измениться от одного выпуска OS X другому.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

Устаревшая поддержка синхронного поиска

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


    
    SKSearchGroupCreate
    SKSearchGroupCreate

(OS X v10.4)

Создает поисковую группу как массив ссылок на индексы.

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

Используйте асинхронный поиск с SKSearchCreate вместо этого, не нанимающим поисковые группы.

Объявление

Objective C

SKSearchGroupRef SKSearchGroupCreate ( CFArrayRef inArrayOfInIndexes );

Параметры


      inArrayOfInIndexes

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

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

SKSearchGroup непрозрачный тип.

Обсуждение

Создает поисковую группу как массив ссылок на индексы.

Вы создаете поисковую группу, чтобы искать один или несколько индексов, и затем обычно использовать получающееся SKSearchGroupRef непрозрачный тип с SKSearchResultsCreateWithQuery или SKSearchResultsCreateWithDocuments.

Когда для Вашего приложения больше не будет нужна поисковая группа, избавьтесь от него путем вызова CFRelease.

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

Objective C

@import CoreServices;

Доступность

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

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

SKSearchGroupCopyIndexes SKSearchGroupCopyIndexes (OS X v10.4)

Получает индексы для поисковой группы.

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

Используйте асинхронный поиск с SKSearchCreate вместо этого, не нанимающим поисковые группы.

Объявление

Objective C

CFArrayRef SKSearchGroupCopyIndexes ( SKSearchGroupRef inSearchGroup );

Параметры

inSearchGroup

Поисковая группа, индексы которой Вы хотите скопировать.

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

Объект CFArray, содержащий индексы в поисковой группе.

Обсуждение

Несмотря на то, что функционирует поиск SKSearchResultsCreateWithQuery и SKSearchResultsCreateWithDocuments воздействуйте непосредственно на поисковые группы, много Поисковых функций Набора, такой как SKIndexCompact, воздействуйте на один индекс за один раз. Когда Вы захотите исследовать или управлять всеми индексами в поисковой группе, использовать SKSearchGroupCopyIndexes получить список поисковой группы индексов.

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

Objective C

@import CoreServices;

Доступность

Доступный в OS X v10.3 и позже.
Осуждаемый в OS X v10.4.
SKSearchGroupGetTypeID SKSearchGroupGetTypeID (OS X v10.4)

Осуждаемый. Используйте асинхронный поиск с SKSearchCreate вместо этого, не нанимающим поисковые группы.

Объявление

Objective C

CFTypeID SKSearchGroupGetTypeID ( void );

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

Объект CFTypeID, содержащий идентификатор типа для SKSearchGroup непрозрачный тип.

Обсуждение

Получает идентификатор типа для Поисковых групп поиска Набора.

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

Никогда твердый код поисковый идентификатор типа группы, потому что это может измениться от одного выпуска OS X другому.

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

Objective C

@import CoreServices;

Доступность

Доступный в OS X v10.3 и позже.
Осуждаемый в OS X v10.4.


    
    SKSearchResultsCreateWithDocuments
    SKSearchResultsCreateWithDocuments

(OS X v10.4)

Считает документы подобными данным документам в качестве примера.

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

Использовать SKSearchCreate вместо этого.

Объявление

Objective C

SKSearchResultsRef SKSearchResultsCreateWithDocuments ( SKSearchGroupRef inSearchGroup, CFArrayRef inExampleDocuments, CFIndex inMaxFoundDocuments, void *inContext, SKSearchResultsFilterCallBack inFilterCallBack );

Параметры

`inSearchGroup`	Поисковая группа, содержащая индексы, который, в свою очередь, содержите документ объекты URL (SKDocumentRefs) представление документов, которые Вы хотите искать подобием. Поисковая группа должна также содержать индексы, содержащие текстовое содержание документов в качестве примера.
`inExampleDocuments`	Массив документа объекты URL (SKDocumentRefs), каждый представляющий документ в качестве примера.
`inMaxFoundDocuments`	Максимальное количество найденных элементов для возврата. Ваше приложение должно передать в положительном значении.
`inContext`	Указанный приложением контекст для использования `SKSearchResultsFilterCallBack` функция обратного вызова. Может быть `NULL`.
`inFilterCallBack`	Функция обратного вызова для тестирования хита во время поиска — видит `SKSearchResultsFilterCallBack`. В поиске подобия Ваше приложение обычно использовало бы эту функцию для исключения документов в качестве примера из результатов поиска. Этот параметр может быть `NULL`, когда Ваше приложение получает возвращенные результаты непосредственно и без любой пользовательской постобработки.

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

Объект результатов поиска, содержащий список документа объекты URL (SKDocumentRefs) представление документов, подобных документам в качестве примера.

Обсуждение

Эта функция ищет дисковые индексы в поисковой группе для документа объекты URL (SKDocumentRefs) представление документов, подобных предоставленным как примеры. Создайте поисковую группу на трех шагах:

Соберите индекс IDs у поисковых групп, которые Вы хотите искать: для каждой поисковой группы вызовите SKSearchGroupCopyIndexes функция.
Добавьте документ объекты URL, представляющие документы в качестве примера основанному на памяти индексу (если они уже не находятся в индексе) путем вызова SKIndexCreateWithMutableData, и получите ID того индекса.
Создайте новую поисковую группу, содержащую индексы для поиска, и также содержащий индекс документов в качестве примера, с помощью SKSearchGroupCreate.

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

Как только Вы получили результаты поиска, получите специфические особенности — включая который документы соответствуют запрос подобия пользователя и занимающую место музыку к каждому документу — путем вызова SKSearchResultsGetInfoInRange.

Когда для Вашего приложения больше не будет нужен результат поиска, избавьтесь от него путем вызова CFRelease.

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

Objective C

@import CoreServices;

Доступность

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

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


    
    SKSearchResultsGetInfoInRange
    SKSearchResultsGetInfoInRange

(OS X v10.4)

Информация о выдержках от Поискового результата запроса Набора.

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

Использовать SKSearchCreate вместо этого.

Объявление

Objective C

CFIndex SKSearchResultsGetInfoInRange ( SKSearchResultsRef inSearchResults, CFRange inRange, SKDocumentRef *outDocumentsArray, SKIndexRef *outIndexesArray, float *outScoresArray );

Параметры

`inSearchResults`	Результаты поиска, информацию которых Вы хотите извлечь.
`inRange`	Начальное ранжирование и общее количество найденных элементов для получения, указанный как `(Location, Length)`. 'Расположение' указывает стартовый элемент путем ранжирования с находящимся на вершине рейтинга элементом, имеющим расположение 0. 'Длина' указывает общее количество элементов для включения в результаты. Например, (0,1) указывает первый элемент, который является также элементом высшего ранга. (1,1) указывает второй элемент, который является также вторым самым высокопоставленным элементом. (0,5) средние значения для получения первых 5 элементов.
`outDocumentsArray`	На выводе, точках к массиву найденного документа объекты URL (SKDocumentRefs).
`outIndexesArray`	На выводе, точках к массиву индексов, в которых найденный документ находятся объекты URL. Может быть `NULL` на вводе, при условии, что для Вашего приложения не нужна эта информация.
`outScoresArray`	На выводе, точках к массиву музыки корреспонденции к найденным элементам. Может быть `NULL` на вводе, при условии, что для Вашего приложения не нужна эта информация.

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

Число элементов возвратилось — обычно то же число, как указано элементом длины в inRange параметр.

Обсуждение

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

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

Objective C

@import CoreServices;

Доступность

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

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


    
    SKSearchResultsCopyMatchingTerms
    SKSearchResultsCopyMatchingTerms

(OS X v10.4)

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

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

Использовать SKSearchCreate вместо этого.

Объявление

Objective C

CFArrayRef SKSearchResultsCopyMatchingTerms ( SKSearchResultsRef inSearchResults, CFIndex inItem );

Параметры


      inSearchResults

Результаты поиска исследовать.


      inItem

Целое число, соответствующее документу объект URL (SKDocumentRef) в результатах поиска. Значение ‘1’ идентифицирует первый документ объект URL в результатах поиска, значение ‘2’ идентифицирует второе и т.д.

Если Вы создали использование результатов поиска SKSearchResultsCreateWithQuery, документ объекты URL сортируется в занимающем место порядке с находящимся на вершине рейтинга сначала. Посмотрите SKSearchResultsGetInfoInRange для описания того, как получить определенный документ объект URL или набор их, от результата поиска.

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

Объект CFArray, содержащий срок IDs.

Обсуждение

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

Например, пользователь мог ввести 'Приложение' при выполнении префиксного поиска. Если документ, представленный в поисковой группе, содержит слова 'Apple', 'приложение' и 'удаление аппендицита', IDs для всех этих условий тогда появился бы в объекте CFArray это SKSearchResultsCopyMatchingTerms возвраты.

Посмотрите SKSearchResultsCreateWithQuery для описания того, как выполнить поиск и получить результаты поиска. Посмотрите SKSearchResultsGetInfoInRange поскольку, как извлечь информацию, включая документ объекты URL, от результата поиска. Посмотрите “Deprecated Search Keys” для описания различных категорий поиска.

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

Objective C

@import CoreServices;

Доступность

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

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

SKSearchResultsGetCount SKSearchResultsGetCount (OS X v10.4)

Получает общее количество найденных элементов в поиске.

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

Использовать SKSearchCreate вместо этого.

Объявление

Objective C

CFIndex SKSearchResultsGetCount ( SKSearchResultsRef inSearchResults );

Параметры

inSearchResults

Объект результатов поиска, содержащий результаты запроса.

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

Объект CFIndex, содержащий общее количество найденных элементов в поиске.

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

Objective C

@import CoreServices;

Доступность

Доступный в OS X v10.3 и позже.
Осуждаемый в OS X v10.4.
SKSearchResultsGetTypeID SKSearchResultsGetTypeID (OS X v10.4)

Получает идентификатор типа для Поисковых результатов поиска Набора.

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

Использовать SKSearchCreate вместо этого.

Объявление

Objective C

CFTypeID SKSearchResultsGetTypeID ( void );

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

Объект CFTypeID, содержащий идентификатор типа для SKSearchResults непрозрачный тип.

Обсуждение

Поисковый Набор представляет результаты поиска с объектами результатов поиска (SKSearchResultsRef непрозрачные типы). Если Ваш код должен определить, является ли определенный тип данных результатом поиска, можно использовать эту функцию вместе с CFGetTypeID функционируйте и выполните сравнение.

Никогда твердый код идентификатор типа результата поиска, потому что это может измениться от одного выпуска OS X другому.

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

Objective C

@import CoreServices;

Доступность

Доступный в OS X v10.3 и позже.
Осуждаемый в OS X v10.4.


    
    SKSearchResultsCreateWithQuery
    SKSearchResultsCreateWithQuery

(OS X v10.4)

Запрашивает индексы в поисковой группе.

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

Использовать SKSearchCreate вместо этого.

Объявление

Objective C

SKSearchResultsRef SKSearchResultsCreateWithQuery ( SKSearchGroupRef inSearchGroup, CFStringRef inQuery, SKSearchType inSearchType, CFIndex inMaxFoundDocuments, void *inContext, SKSearchResultsFilterCallBack inFilterCallBack );

Параметры

`inSearchGroup`	Поисковая группа для запросов.
`inQuery`	Строка запроса для поиска.
`inSearchType`	Категория поиска для выполнения. Посмотрите `“Deprecated Search Keys”` перечисление для опций.
`inMaxFoundDocuments`	Максимальное количество найденных элементов для возврата. Ваше приложение должно передать в положительном целочисленном значении.
`inContext`	Указанный приложением контекст для использования `SKSearchResultsFilterCallBack`. Может быть `NULL`, но если Вы хотите использовать обратный вызов, необходимо предоставить контекст.
`inFilterCallBack`	Функция обратного вызова для тестирования хита во время поиска. Может быть `NULL`, когда Ваше приложение получает возвращенные результаты непосредственно и без любой пользовательской постобработки. Если не -`NULL`, необходимо предоставить контекст. Посмотрите `SKSearchResultsFilterCallBack`.

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

Объект результатов поиска.

Обсуждение

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

Как только Вы получили результаты поиска, получите специфические особенности — включая который документы соответствуют запрос пользователя и занимающую место музыку к каждому документу — путем вызова SKSearchResultsGetInfoInRange. Можно извлечь другую информацию путем вызова SKSearchResultsCopyMatchingTerms и SKSearchResultsGetCount.

Когда для Вашего приложения больше не будет нужен результат поиска, избавьтесь от него путем вызова CFRelease.

Специальные замечания

Эта осуждаемая функция выполняет поиски синхронно. Apple рекомендует использовать асинхронное SKSearchCreate функция вместо этого.

В текущей реализации Поискового Набора не реализованы унарные булевы операторы. Поиск, например, для ‘не синий’, возвращает нулевые документы независимо от того что их содержание.

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

Objective C

@import CoreServices;

Доступность

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

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

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

Поисковые разные обратные вызовы набора


    
    SKSearchResultsFilterCallBack
    SKSearchResultsFilterCallBack

Осуждаемый. Использовать SKSearchCreate и SKSearchFindMatches вместо этого, которые не используют обратный вызов.

Объявление

Swift

typealias SKSearchResultsFilterCallBack = CFunctionPointer<((SKIndex!, SKDocument!, UnsafeMutablePointer<Void>) -> Boolean)>

Objective C

typedef Boolean (SKSearchResultsFilterCallBack) ( SKIndexRef inIndex, SKDocumentRef inDocument, void *inContext

Параметры

`inIndex`	Индекс Вы ищете.
`inDocument`	URL документа возражает в индексе, который что Вы ищете.
`inContext`	Указанный приложением контекст, который Вы устанавливаете при вызове `SKSearchResultsCreateWithQuery` или `SKSearchResultsCreateWithDocuments`.

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

Булево значение true для успешного поискового хита, или false иначе.

Обсуждение

Осуждаемый. Определяет указатель на результаты поиска, фильтрующие функцию обратного вызова для тестирования хита и обработки во время поиска. Используйте эту функцию обратного вызова для выполнения пользовательской фильтрации на поисковых хитах, возвращенных SKSearchResultsCreateWithQuery и SKSearchResultsCreateWithDocuments функции. Возвратиться true сохранить этот документ объектом URL (SKDocumentRef) в результатах, false фильтровать его.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

Типы данных

SKDocumentRef SKDocumentRef

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

Объявление

Swift

typealias SKDocumentRef = SKDocument

Objective C

typedef struct __SKDocument *SKDocumentRef;

Обсуждение

Документ объект URL является универсальной спецификацией расположения для документа. Это создается из схемы документа, родительского документа и названия документа. Можно преобразовать назад и вперед между документом объекты URL и CFURL объекты с помощью Поискового Набора SKDocumentCreateWithURL и SKDocumentCopyURL функции.

Для создания Поискового документа Набора объект URL использовать SKDocumentCreateWithURL когда можно обеспечить полный URL или использование SKDocumentCreate когда Вы хотите указать расположение документа косвенно с помощью родительского документа объект URL. Для других операций на документах посмотрите Работу с Документами и Условиями.

При создании документа, URL возражает с косвенными расположениями с помощью SKDocumentCreate функция, можно разрешить расположения путем сборки их часть частью, начиная с документа объект URL и восстановления работоспособности шаг за шагом, родитель к родителю.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

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

Объявление

Swift

typealias SKIndexDocumentIteratorRef = SKIndexDocumentIterator

Objective C

typedef struct __SKIndexDocumentIterator *SKIndexDocumentIteratorRef;

Обсуждение

Поисковый итератор документа Набора позволяет Вашему циклу приложения через весь документ объекты URL, принадлежавшие данному родительскому документу объект URL. Для создания итератора использовать SKIndexDocumentIteratorCreate. Для получения копии следующего документа в наборе, принадлежавшем итератору, использовать SKIndexDocumentIteratorCopyNext.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

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

Объявление

Swift

typealias SKIndexRef = SKIndex

Objective C

typedef struct __SKIndex *SKIndexRef;

Обсуждение

Поисковый индексный объект Набора содержит текстовое содержание одного или более документов, а также документа объекты URL (SKDocumentRefs), представляющий расположения тех документов.

Для создания нового находящегося на диске Поискового индексного объекта Набора использовать SKIndexCreateWithURL. Для создания основанного на памяти индекса использовать SKIndexCreateWithMutableData. Для других операций на индексах посмотрите Создание, Открытие, и Закрытие Индексов и Управление Индексами. Также seeFast Асинхронный Поиск.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

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

Объявление

Swift

typealias SKSearchRef = SKSearch

Objective C

typedef struct __SKSearch *SKSearchRef;

Обсуждение

Когда Вы вызываете, создается поисковый объект SKSearchCreate функция.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

Определяет непрозрачный тип данных, представляющий информацию о реферировании.

Объявление

Swift

typealias SKSummaryRef = SKSummary

Objective C

typedef struct __SKSummary *SKSummaryRef;

Обсуждение

Объект реферирования содержит информацию о реферировании, включая сводный текст.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

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

Объявление

Swift

typealias SKDocumentID = CFIndex

Objective C

typedef CFIndex SKDocumentID;

Обсуждение

Используйте документ IDs, а не документ объекты URL (SKDocumentRefs), когда это возможно. Используя документ IDs приводит к более быстрому поиску.

Можно работать с документом IDs с помощью множества Поисковых функций Набора. Посмотрите SKIndexGetMaximumDocumentID, SKIndexCopyDocumentForDocumentID, SKIndexCopyInfoForDocumentIDs, SKIndexCopyDocumentRefsForDocumentIDs, SKIndexCopyDocumentURLsForDocumentIDs, SKIndexCopyDocumentIDArrayForTermID, и SKIndexCopyTermIDArrayForDocumentID.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

Осуждаемый. Используйте асинхронный поиск с SKSearchCreate вместо этого, не нанимающим поисковые группы.

Объявление

Swift

typealias SKSearchResultsRef = SKSearchResults

Objective C

typedef struct __SKSearchResults *SKSearchResultsRef;

Обсуждение

Определяет непрозрачный тип данных, представляющий результат поиска. Чтобы выполнить запрос и генерировать результаты поиска, использовать SKSearchResultsCreateWithQuery или SKSearchResultsCreateWithDocuments. Для исследования результата поиска использовать SKSearchResultsGetInfoInRange. Для других операций на результатах поиска посмотрите Устаревшую Поддержку Синхронного Поиска.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

Осуждаемый. Используйте асинхронный поиск с SKSearchCreate вместо этого, не нанимающим поисковые группы.

Объявление

Swift

typealias SKSearchGroupRef = SKSearchGroup

Objective C

typedef struct __SKSearchGroup *SKSearchGroupRef;

Обсуждение

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

Поисковая группа является группой из одного или более индексов, которые будут искаться. Для создания поисковой группы использовать SKSearchGroupCreate. Для других операций с поисковыми группами посмотрите Быстро Асинхронный Поиск.

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

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

Константы

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

Объявление

Swift

let kSKMinTermLength: CFString! let kSKStopWords: CFString! let kSKSubstitutions: CFString! let kSKMaximumTerms: CFString! let kSKProximityIndexing: CFString! let kSKTermChars: CFString! let kSKStartTermChars: CFString! let kSKEndTermChars: CFString!

Objective C

const CFStringRef kSKMinTermLength; const CFStringRef kSKStopWords; const CFStringRef kSKSubstitutions; const CFStringRef kSKMaximumTerms; const CFStringRef kSKProximityIndexing; const CFStringRef kSKTermChars; const CFStringRef kSKStartTermChars; const CFStringRef kSKEndTermChars;

Константы
- kSKMinTermLength
  
  kSKMinTermLength
  
  Длина минимального срока для индексации. Указанный как объект CFNumber. Если этот дополнительный ключ не является существующими, Поисковыми значениями по умолчанию индексации Набора к длине минимального срока 1.
  
  Доступный в OS X v10.3 и позже.
- kSKStopWords
  
  kSKStopWords
  
  Ряд стоп-слов — слова для не индексации. Указанный как объект CFSet. Нет никакого списка стоп-слова по умолчанию. Необходимо предоставить собственное.
  
  Доступный в OS X v10.3 и позже.
- kSKSubstitutions
  
  kSKSubstitutions
  
  Словарь замен срока — условия, отличающиеся по их символьным строкам, но тому соответствию во время поиска. Указанный как объект CFDictionary.
  
  Доступный в OS X v10.3 и позже.
- kSKMaximumTerms
  
  kSKMaximumTerms
  
  Максимальное количество числа уникальные условия для индексации в каждом документе. Указанный как объект CFNumber.
  
  Поисковый Набор индексирует с начала документа. Когда это индексировало первые n уникальные условия, это останавливается.
  
  Число по умолчанию максимальных сроков, применяющееся, если Вы не обеспечиваете число, является 2000.
  
  Чтобы сказать Поисковому Набору индексировать все условия в каждом документе без предела, укажите значение 0.
  
  Доступный в OS X v10.4 и позже.
- kSKProximityIndexing
  
  kSKProximityIndexing
  
  Булев флаг, указывающий, должен ли Поисковый Набор использовать индексацию близости. Флаг может быть a 0 или kCFBoolenFalse значение (для лжи) или a 1 или kCFBooleanTrue значение (для истины). Индексация близости доступна только для инвертированных индексов — т.е. индексы типа kSKIndexInverted.
  
  Используйте индексацию близости для поддержки поиска фразы. Если этот ключ не присутствует в словаре свойств анализа текста индекса, Поисковых значениях по умолчанию Набора к не добавляющей информации о близости к индексу.
  
  Доступный в OS X v10.4 и позже.
- kSKTermChars
  
  kSKTermChars
  
  Дополнительные допустимые символы «слова» стартовой позиции для индексации и запросов. Соответствующее значение, объект CFString, указывает дополнительные допустимые символы «слова», которыми Вы хотите быть рассмотренными как допустимые начальные символы условий для индексации и запросов. Символы «Word» контрастируются с несловесными символами, такими как пробелы.
  
  Значение kSKStartTermChars, если этот ключ присутствует, переопределяет значение kSKTermChars для первого символа срока.
  
  По умолчанию Поиск Кит рассматривает алфавитно-цифровые символы как допустимые начальные символы для условий и полагает, что все другие (включая символ подчеркивания) несловесные символы.
  
  Доступный в OS X v10.4 и позже.
- kSKStartTermChars
  
  kSKStartTermChars
  
  Дополнительные допустимые символы «слова» стартовой позиции для индексации и запросов. Соответствующее значение, объект CFString, указывает дополнительные допустимые символы «слова», которыми Вы хотите быть рассмотренными как допустимые начальные символы условий для индексации и запросов. Символы «Word» контрастируются с несловесными символами, такими как пробелы.
  
  Значение kSKStartTermChars, если этот ключ присутствует, переопределяет значение kSKTermChars для первого символа срока.
  
  По умолчанию Поиск Кит рассматривает алфавитно-цифровые символы как допустимые начальные символы для условий и полагает, что все другие (включая символ подчеркивания) несловесные символы.
  
  Доступный в OS X v10.4 и позже.
- kSKEndTermChars
  
  kSKEndTermChars
  
  Дополнительные допустимые последние позиционные символы «слова» для индексации и запросов. Соответствующее значение, объект CFString, указывает дополнительные допустимые символы «слова», которыми Вы хотите быть рассмотренными как допустимые конечные символы условий для индексации и запросов. Символы «Word» контрастируются с несловесными символами, такими как пробелы.
  
  Значение kSKEndTermChars, если этот ключ присутствует, переопределяет значение kSKTermChars для последнего знака срока.
  
  По умолчанию Поиск Кит рассматривает алфавитно-цифровые символы как допустимые конечные символы для условий и полагает, что все другие (включая символ подчеркивания) несловесные символы.
  
  Доступный в OS X v10.4 и позже.
SKDocumentIndexState
Состояние индексации документа.

Объявление

Swift

struct SKDocumentIndexState { init(_ value: UInt32) var value: UInt32 }

Objective C

enum SKDocumentIndexState { kSKDocumentStateNotIndexed = 0, kSKDocumentStateIndexed = 1, kSKDocumentStateAddPending = 2, kSKDocumentStateDeletePending = 3 };

Константы
- kSKDocumentStateNotIndexed
  
  kSKDocumentStateNotIndexed
  
  Указывает, что не индексируется документ.
  
  Доступный в OS X v10.3 и позже.
- kSKDocumentStateIndexed
  
  kSKDocumentStateIndexed
  
  Указывает, что индексируется документ.
  
  Доступный в OS X v10.3 и позже.
- kSKDocumentStateAddPending
  
  kSKDocumentStateAddPending
  
  Указывает, что документ не находится в индексе, но будет добавлен после того, как индекс сбрасывается или закрывается.
  
  Доступный в OS X v10.3 и позже.
- kSKDocumentStateDeletePending
  
  kSKDocumentStateDeletePending
  
  Указывает, что документ находится в индексе, но будет удален после того, как индекс сбрасывается или закрывается.
  
  Доступный в OS X v10.3 и позже.
Оператор импорта

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

Доступный в OS X v10.3 и позже.
SKSearchOptions
Указывает параметры поиска, доступные для SKSearchCreate функция.

Объявление

Swift

typealias SKSearchOptions = UInt32

Objective C

typedef UInt32 SKSearchOptions; enum SKSearchType { kSKSearchOptionDefault = 0, kSKSearchOptionNoRelevanceScores = 1L << 0, kSKSearchOptionSpaceMeansOR = 1L << 1 kSKSearchOptionFindSimilar = 1L << 2 };

Константы
- kSKSearchOptionDefault
  
  kSKSearchOptionDefault
  Параметры поиска по умолчанию включают:
  
  Очки уместности будут вычислены
  
  Пробелы в запросе интерпретируются как булевская переменная AND операторы.
  
  Не используйте поиск подобия.
  Доступный в OS X v10.4 и позже.
- kSKSearchOptionNoRelevanceScores
  
  kSKSearchOptionNoRelevanceScores
  
  Эта опция экономит время во время поиска путем подавления вычисления очков уместности.
  
  Доступный в OS X v10.4 и позже.
- kSKSearchOptionSpaceMeansOR
  
  kSKSearchOptionSpaceMeansOR
  
  Эта опция изменяет поведение запроса так, чтобы пробелы были интерпретированы как булевская переменная OR операторы.
  
  Доступный в OS X v10.4 и позже.
- kSKSearchOptionFindSimilar
  
  kSKSearchOptionFindSimilar
  
  Эта опция изменяет поведение запроса так, чтобы Поисковый Набор возвратил ссылки на документы, которые подобны текстовой строке в качестве примера. Когда эта опция указана, Поисковый Набор игнорирует всех операторов запроса.
  
  Доступный в OS X v10.4 и позже.
Оператор импорта

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

Доступный в OS X v10.4 и позже.
SKIndexType
Указывает категорию индекса.

Объявление

Swift

struct SKIndexType { init(_ value: UInt32) var value: UInt32 }

Objective C

enum SKIndexType { kSKIndexUnknown = 0, kSKIndexInverted = 1, kSKIndexVector = 2, kSKIndexInvertedVector = 3 };

Константы
- kSKIndexUnknown
  
  kSKIndexUnknown
  
  Указывает неизвестный индексный тип.
  
  Доступный в OS X v10.3 и позже.
- kSKIndexInverted
  
  kSKIndexInverted
  
  Указывает инвертированный индекс, отображая условия на документы.
  
  Доступный в OS X v10.3 и позже.
- kSKIndexVector
  
  kSKIndexVector
  
  Указывает векторный индекс, отображая документы условиям.
  
  Доступный в OS X v10.3 и позже.
- kSKIndexInvertedVector
  
  kSKIndexInvertedVector
  
  Указывает индексный тип со всеми возможностями инвертированного и векторного индекса.
  
  Доступный в OS X v10.3 и позже.
Оператор импорта

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

Доступный в OS X v10.3 и позже.
Аналитические ключи устаревшего текста
Поисковый Набор игнорирует kSKLanguageTypes постоянный. Это определяет язык непосредственно содержанием документа.

Объявление

Objective C

const CFStringRef kSKLanguageTypes;

Константы
- kSKLanguageTypes
  
  kSKLanguageTypes
  
  Осуждаемый — Поисковый Набор игнорирует эту константу.
  
  В выпусках OS X до версии 10.4 каждая строка в соответствующем значении этого ключа указывает язык для использования для индексации. Каждая такая строка является двумя символами ISO код 639-1. Например, 'en' для английского языка, 'ja' для японского языка, и т.д. Если этот ключ не существует, Поисковый Набор использует предпочтительную систему OS X для определения основного языка от локали пользователя.
  
  Доступный в OS X v10.3 и позже.
  Осуждаемый в OS X v10.4.
устаревшие (deprecated) ключи поиска
Поисковый Набор игнорирует константы в этой группе. Используйте асинхронный поиск с SKSearchCreate вместо этого, который использует синтаксис запроса для определения поискового типа.

Объявление

Swift

struct SKSearchType { init(_ value: UInt32) var value: UInt32 }

Objective C

enum SKSearchType { kSKSearchRanked = 0, kSKSearchBooleanRanked = 1, kSKSearchRequiredRanked = 2, kSKSearchPrefixRanked = 3 };

Константы
- kSKSearchRanked
  
  kSKSearchRanked
  
  Осуждаемый. Указывает основной оцениваемый поиск.
  
  Доступный в OS X v10.3 и позже.
- kSKSearchBooleanRanked
  
  kSKSearchBooleanRanked
  
  Осуждаемый. Указывает запрос, который может включать булевы операторы включая '|', '&', '!', '(', и ')'.
  
  Доступный в OS X v10.3 и позже.
- kSKSearchRequiredRanked
  
  kSKSearchRequiredRanked
  
  Осуждаемый. Указывает запрос, который может включать требуемый ('+') или исключенный ('-') условия.
  
  Доступный в OS X v10.3 и позже.
- kSKSearchPrefixRanked
  
  kSKSearchPrefixRanked
  
  Осуждаемый. Указывает основанный на префиксе поиск, соответствующий условия, начинающиеся со строки запроса.
  
  Доступный в OS X v10.3 и позже.
Оператор импорта

Objective C

@import CoreServices;

Swift

import CoreServices

Доступность

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

`inIndex`	Индекс для поиска.
`inTermID`	ID срока для поиска.