Function

CFBagGetValueIfPresent

Reports whether or not a value is in a bag, and returns that value indirectly if it exists.

Declaration

Boolean CFBagGetValueIfPresent(CFBagRef theBag, const void *candidate, const void **value);

Parameters

theBag

The bag to be searched.

candidate

The value for which to find matches in theBag. The equal callback provided when theBag was created is used to compare. If the equal callback was NULL, pointer equality (in C, ==) is used. If candidate, or any other value in theBag, is not understood by the equal callback, the behavior is undefined.

value

A 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 theBag, otherwise false.

Discussion

Depending on the implementation of the equal callback specified when creating theBag, the value returned in value may not have the same pointer equality as candidate.

See Also

Examining a Bag

CFBagContainsValue

Reports whether or not a value is in a bag.

CFBagGetCount

Returns the number of values currently in a bag.

CFBagGetCountOfValue

Returns the number of times a value occurs in a bag.

CFBagGetValue

Returns a requested value from a bag.

CFBagGetValues

Fills a buffer with values from a bag.