Contents

ABPersonCreateSearchElement(_:_:_:_:_:)

Returns a search element object that specifies a query for records of this type.

Declaration

func ABPersonCreateSearchElement(_ property: CFString!, _ label: CFString!, _ key: CFString!, _ value: CFTypeRef!, _ comparison: ABSearchComparison) -> Unmanaged<ABSearchElementRef>!

Parameters

  • property:

    The name of the property to search on. It cannot be NULL. For a full list of the properties, see Person Properties and Common Properties in ABRecord.

  • label:

    The label name for a multi-value list. If property does not have multiple values, pass NULL. If property does have multiple values, pass NULL to search all the values.

  • key:

    The key name for a dictionary. If property is not a dictionary, pass NULL. If property is a dictionary, pass NULL to search all keys.

  • value:

    The value you are searching for. It cannot be NULL

  • comparison:

    Specifies the type of comparison to perform, such as Kabequal or Kabprefixmatchcaseinsensitive. For a full list, see Absearchcomparison.

Return Value

A search element object that specifies a query according to the above parameters. You are responsible for releasing this object.

Discussion

Use the ABAddressBook ABCopyArrayOfMatchingRecords(_:_:) function to actually perform the query. Also, see ABSearchElement C for more functions that create compound queries.

See Also

People