Reports whether or not a value is in a bag, and returns that value indirectly if it exists.
SDKs
- iOS 2.0+
- macOS 10.0+
- Mac Catalyst 13.0+
- tvOS 9.0+
- watchOS 2.0+
Framework
- Core Foundation
Declaration
Boolean CFBagGetValueIfPresent(CFBagParameters
theBagThe bag to be searched.
candidateThe value for which to find matches in
the. The equal callback provided whenBag thewas created is used to compare. If the equal callback wasBag NULL, pointer equality (in C, ==) is used. Ifcandidate, or any other value inthe, is not understood by the equal callback, the behavior is undefined.Bag valueA pointer to a value object. Set to the matching value if it exists in the bag, otherwise
NULL. If the value is a Core Foundation object, ownership follows the The Get Rule.
Return Value
true if value is present in the, otherwise false.
Discussion
Depending on the implementation of the equal callback specified when creating the, the value returned in value may not have the same pointer equality as candidate.