Defined Types

Beta documentation : This document has not received a full technical review and therefore might contain inaccuracies.



CFDictionaryApplierFunction

typedef void (*CFDictionaryApplierFunction)(const void *key,  void *val, void *context);

The type that the callback applier function passed into the CFDictionaryApplyFunction function must conform to.


CFDictionaryKeyCallBacks

struct  CFDictionaryKeyCallBacks  {
  CFIndex  version;
  CFDictionaryRetainCallBack  retain;
  CFDictionaryReleaseCallBack  release;
  CFDictionaryCopyDescriptionCallBack  copyDescription;
  CFDictionaryEqualCallBack  equal;
  CFDictionaryHashCallBack  hash;
};
typedef  struct  CFDictionaryKeyCallBacks  CFDictionaryKeyCallBacks;

A structure containing pointers to the callback functions for the keys of a CFDictionary object.

Fields

NameDescription
versionThe version number of the structure passed in as a parameter to a CFDictionary creation function. The current version is 0.
retainA pointer to the callback invoked to retain values as they are put into the dictionary. This callback returns the value to store in the dictionary, which is usually the value passed to this callback, but could be a different value if that is the value that should be stored in the array. The CFDictionary object's allocator is passed as the first parameter of the callback.
releaseA pointer to the callback function invoked to reverse the effect of the retain callback on keys as their values are removed from the dictionary.The CFDictionary obejct's allocator is passed as the first parameter of the callback.
copyDescriptionThe callback used to create a descriptive string representation of each key in the dictionary. This callback is invoked by the CFCopyDescription function.
equalA pointer to the callback function invoked to compare keys in the dictionary for equality.
hashA pointer to the callback function invoked to compute a hash code for keys as they are used to access, add, or remove values in the dictionary.

CFDictionaryRef

typedef  const  struct  __CFDictionary*  CFDictionaryRef;

Type of a reference to an immutable CFDictionary object.


CFDictionaryValueCallBacks

struct  CFDictionaryValueCallBacks  {
  CFIndex  version;
  CFDictionaryRetainCallBack  retain;
  CFDictionaryReleaseCallBack  release;
  CFDictionaryCopyDescriptionCallBack  copyDescription;
  CFDictionaryEqualCallBack  equal;
};
typedef  struct  CFDictionaryValueCallBacks  CFDictionaryValueCallBacks;

A structure that contains the callback functions for the values of a CFDictionary object.

Fields

NameDescription
versionThe version number of the structure passed in as a parameter to a CFArray creation function. The current version is 0.
retainA pointer to the callback invoked to retain keys as they are used to put values into the dictionary. This callback returns the value to store in the dictionary, which is usually the value passed to this callback, but could be a different value if that is the value that should be stored in the array. The CFDictionary object's allocator is passed as the first parameter of the callback.
releaseA pointer to the callback function invoked to reverse the effect of the retain callback on values are they are removed from the dictionary.The CFDictionary obejct's allocator is passed as the first parameter of the callback
copyDescriptionA pointer to the callback function invoked to create a descriptive string representation of each value in the dictionary. This function is invoked by the CFCopyDescription function.
equalA pointer to the callback function invoked to compare values in the dictionary for equality in some operations.

CFMutableDictionaryRef

typedef  struct  __CFDictionary*  CFMutableDictionaryRef;

The type of a reference to a mutable CFDictionary object.


© 1999 Apple Computer, Inc. — (Last Updated 9/17/99)