Function

CFBagGetValue

Returns a requested value from a bag.

Declaration

const void * CFBagGetValue(CFBagRef theBag, const void *value);

Parameters

theBag

The bag to examine.

value

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 value, or any other value in theBag, is not understood by the equal callback, the behavior is undefined.

Return Value

A pointer to value, or NULL if value is not in theBag. If the value is a Core Foundation object, ownership follows the The Get Rule.

Discussion

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

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.

CFBagGetValueIfPresent

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

CFBagGetValues

Fills a buffer with values from a bag.