Contents

localizedReferenceDocumentation(forFilterName:)

Returns the location of the localized reference documentation that describes the filter.

Declaration

class func localizedReferenceDocumentation(forFilterName filterName: String) -> URL?

Parameters

  • filterName:

    The filter name.

Return Value

A URL that specifies the location of the localized documentation, or nil if the filter does not provide localized reference documentation.

Discussion

The URL can be a local file or a remote document on a web server. Because filters created prior to OS X v10.5 could return nil, you should be make sure that your code handles this case gracefully.

See Also

Getting localized information for registered filters