Function

SKSummaryCreateWithString(_:)

Creates a summary object based on a text string.

Declaration

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

Parameters

inString

The text string that you want to summarize.

Return Value

Returns a summarization object, or NULL on failure.

Discussion

The SKSummaryCreateWithString(_:) function creates a summarization object that pre-analyzes a text string to support fast summarization. When your application no longer needs the summarization object, dispose of it by calling CFRelease.

See Also

Working With Summarization

func SKSummaryGetSentenceSummaryInfo(SKSummary!, CFIndex, UnsafeMutablePointer<CFIndex>!, UnsafeMutablePointer<CFIndex>!, UnsafeMutablePointer<CFIndex>!)

Gets detailed information about a body of text for constructing a custom sentence-based summary string.

func SKSummaryGetParagraphSummaryInfo(SKSummary!, CFIndex, UnsafeMutablePointer<CFIndex>!, UnsafeMutablePointer<CFIndex>!)

Gets detailed information about a body of text for constructing a custom paragraph-based summary string.

func SKSummaryGetSentenceCount(SKSummary!)

Gets the number of sentences in a summarization object.

func SKSummaryGetParagraphCount(SKSummary!)

Gets the number of paragraphs in a summarization object.

func SKSummaryCopySentenceAtIndex(SKSummary!, CFIndex)

Gets a specified sentence from the text in a summarization object.

func SKSummaryCopyParagraphAtIndex(SKSummary!, CFIndex)

Gets a specified paragraph from the text in a summarization object.

func SKSummaryCopySentenceSummaryString(SKSummary!, CFIndex)

Gets a text string consisting of a summary with, at most, the requested number of sentences.

func SKSummaryCopyParagraphSummaryString(SKSummary!, CFIndex)

Gets a text string consisting of a summary with, at most, the requested number of paragraphs.

func SKSummaryGetTypeID()

Gets the type identifier for Search Kit summarization objects.