Java Native Access Platform 5.14.0 · com.sun.jna.platform.mac.CoreFoundation

Modifier and Type	Class and Description
public static class	CoreFoundation.CFAllocatorRef A reference type used in many Core Foundation parameters and function results.
public static class	CoreFoundation.CFArrayRef A reference to an immutable `CFArray` object.
public static class	CoreFoundation.CFBooleanRef A reference to a `CFBoolean` object.
public static class	CoreFoundation.CFDataRef A reference to an immutable `CFData` object.
public static class	CoreFoundation.CFDictionaryRef A reference to an immutable `CFDictionary` object.
public static class	CoreFoundation.CFIndex A wrapper for the `NativeLong` type, used for `CFNumberRef` types, `CFStringRef` lengths, and `CFArrayRef` sizes and indices.
public static class	CoreFoundation.CFMutableDictionaryRef A reference to a mutable `CFDictionary` object.
public static class	CoreFoundation.CFNumberRef A reference to a `CFNumber` object.
public static enum	CoreFoundation.CFNumberType Enum of values used for `CFNumberType` in `CFNumberGetValue` and `CFNumberGetType`.
public static class	CoreFoundation.CFStringRef A reference to a `CFString` object, which “encapsulates” a Unicode string along with its length.
public static class	CoreFoundation.CFTypeID A type for unique, constant integer values that identify particular Core Foundation opaque types.
public static class	CoreFoundation.CFTypeRef The `CFTypeRef` type is the base type defined in Core Foundation.

Modifier and Type	Field and Description
public static final CoreFoundation.CFTypeID	ARRAY_TYPE_ID
public static final CoreFoundation.CFTypeID	BOOLEAN_TYPE_ID
public static final CoreFoundation.CFTypeID	DATA_TYPE_ID
public static final CoreFoundation.CFTypeID	DATE_TYPE_ID
public static final CoreFoundation.CFTypeID	DICTIONARY_TYPE_ID
public static final CoreFoundation	INSTANCE
public static final int	kCFNotFound
public static final int	kCFStringEncodingASCII
public static final int	kCFStringEncodingUTF8
public static final CoreFoundation.CFTypeID	NUMBER_TYPE_ID
public static final CoreFoundation.CFTypeID	STRING_TYPE_ID

Method Summary

Modifier and Type	Method and Description
public CoreFoundation.CFAllocatorRef	Returns: A reference to the default allocator for the current thread. If none has been explicitly set, returns the generic system allocator. The default allocator can never be released, so it is not necessary to `CFRetain` this reference. CFAllocatorGetDefault() Gets the default allocator object for the current thread.
public CoreFoundation.CFArrayRef	Returns: A new immutable array containing `numValues` from `values`, or `null` if there was a problem creating the object. CFArrayCreate(CoreFoundation.CFAllocatorRef The allocator to use to allocate memory for the new array and its storage for values. Pass `null` or `kCFAllocatorDefault` to use the current default allocator. alloc, Pointer A C array of the pointer-sized values to be in the new array. The values in the new array are ordered in the same order in which they appear in this C array. This value may be `null` if `numValues` is 0. This C array is not changed or freed by this function. If `values` is not a valid pointer to a C array of at least `numValues` elements, the behavior is undefined. values, CoreFoundation.CFIndex The number of values to copy from the `values` C array into the new array. This number will be the count of the new array—it must not be negative or greater than the number of elements in values. numValues, Pointer A pointer to a `CFArrayCallBacks` structure initialized with the callbacks for the array to use on each value in the collection. The retain callback is used within this function, for example, to retain all of the new values from the `values` C array. A copy of the contents of the callbacks structure is made, so that a pointer to a structure on the stack can be passed in or can be reused for multiple collection creations. This value may be `null`, which is treated as if a valid structure of version 0 with all fields `null` had been passed in. callBacks) Creates a new immutable array with the given values.
public CoreFoundation.CFIndex	Returns: The number of values in `array`. CFArrayGetCount(CoreFoundation.CFArrayRef a `CFArrayRef` object. theArray) Returns the number of values currently in an array.
public CoreFoundation.CFTypeID	Returns: The type identifier for the `CFArray` opaque type. CFArrayGetTypeID()
public Pointer	Returns: The value at the `idx` index in `theArray`). CFArrayGetValueAtIndex(CoreFoundation.CFArrayRef The array to examine. theArray, CoreFoundation.CFIndex The index of the value to retrieve. If the index is outside the index space of `theArray` (0 to N-1 inclusive (where N is the count of `theArray`)), the behavior is undefined. idx) Retrieves a value at a given index.
public CoreFoundation.CFTypeID	Returns: The type identifier for the `CFBoolean` opaque type. CFBooleanGetTypeID()
public byte	Returns: 1 if the value of `bool` is `true`, 0 otherwise. CFBooleanGetValue(CoreFoundation.CFBooleanRef The boolean to examine. bool) Returns the value of a `CFBoolean` object.
public CoreFoundation.CFStringRef	Returns: A string that contains a description of `cf`. CFCopyDescription(CoreFoundation.CFTypeRef The `CFType` object (a generic reference of type `CFTypeRef`) from which to derive a description. cf) Returns a textual description of a Core Foundation object.
public CoreFoundation.CFDataRef	Returns: A new `CFData` object, or `null` if there was a problem creating the object. CFDataCreate(CoreFoundation.CFAllocatorRef The allocator to use to allocate memory for the new object. Pass `null` or `kCFAllocatorDefault` to use the current default allocator. alloc, Pointer A pointer to the byte buffer that contains the raw data to be copied into the Data. bytes, CoreFoundation.CFIndex The number of bytes in the buffer (`bytes`). length) Creates an immutable `CFData` object using data copied from a specified byte buffer.
public Pointer	Returns: A read-only pointer to the bytes associated with `theData`. CFDataGetBytePtr(CoreFoundation.CFDataRef The `CFData` object to examine. theData) Returns a read-only pointer to the bytes of a `CFData` object.
public CoreFoundation.CFIndex	Returns: An index that specifies the number of bytes in `theData`. CFDataGetLength(CoreFoundation.CFDataRef The `CFData` object to examine. theData) Returns the number of bytes contained by a `CFData` object.
public CoreFoundation.CFTypeID	Returns: The type identifier for the `CFData` opaque type. `CFMutableData` objects have the same type identifier as `CFData` objects. CFDataGetTypeID()
public CoreFoundation.CFTypeID	Returns: The type identifier for the `CFDate` opaque type. CFDateGetTypeID()
public CoreFoundation.CFMutableDictionaryRef	Returns: A new dictionary, or `null` if there was a problem creating the object. CFDictionaryCreateMutable(CoreFoundation.CFAllocatorRef The allocator to use to allocate memory for the new string. Pass `null` or `kCFAllocatorDefault` to use the current default allocator. alloc, CoreFoundation.CFIndex The maximum number of key-value pairs that can be contained by the new dictionary. The dictionary starts empty and can grow to this number of key-value pairs (and it can have less). Pass 0 to specify that the maximum capacity is not limited. The value must not be negative. capacity, Pointer A pointer to a `CFDictionaryKeyCallBacks` structure initialized with the callbacks to use to retain, release, describe, and compare keys in the dictionary. A copy of the contents of the callbacks structure is made, so that a pointer to a structure on the stack can be passed in or can be reused for multiple collection creations. This value may be `null`, which is treated as a valid structure of version 0 with all fields `null`. keyCallBacks, Pointer A pointer to a `CFDictionaryValueCallBacks` structure initialized with the callbacks to use to retain, release, describe, and compare values in the dictionary. A copy of the contents of the callbacks structure is made, so that a pointer to a structure on the stack can be passed in or can be reused for multiple collection creations. This value may be `null`, which is treated as a valid structure of version 0 with all fields `null`. valueCallBacks) Creates a new mutable dictionary.
public CoreFoundation.CFIndex	Returns: The number of key-value pairs in theDict. CFDictionaryGetCount(CoreFoundation.CFDictionaryRef The dictionary to examine. theDict) Returns the number of key-value pairs in a dictionary.
public CoreFoundation.CFTypeID	Returns: The type identifier for the `CFDictionary` opaque type. `CFMutableDictionary` objects have the same type identifier as `CFDictionary` objects. CFDictionaryGetTypeID()
public Pointer	Returns: The value associated with key in `theDict`, or `null` if no key-value pair matching key exists. Since `null` is also a valid value in some dictionaries, use `CFDictionaryGetValueIfPresent` to distinguish between a value that is not found, and a `null` value. CFDictionaryGetValue(CoreFoundation.CFDictionaryRef The dictionary to examine. theDict, PointerType The key for which to find a match in `theDict`. The key hash and equal callbacks provided when the dictionary was created are used to compare. If the hash callback was `null`, the key is treated as a pointer and converted to an integer. If the equal callback was `null`, pointer equality (in C, ==) is used. If `key`, or any of the keys in `theDict`, is not understood by the equal callback, the behavior is undefined. key) Returns the value associated with a given key.
public byte	Returns: 1 if a matching key was found, otherwise 0. CFDictionaryGetValueIfPresent(CoreFoundation.CFDictionaryRef The dictionary to examine. theDict, PointerType The key for which to find a match in `theDict`. The key hash and equal callbacks provided when the dictionary was created are used to compare. If the hash callback was `null`, the key is treated as a pointer and converted to an integer. If the equal callback was `null`, pointer equality (in C, ==) is used. If `key`, or any of the keys in `theDict`, is not understood by the equal callback, the behavior is undefined. key, PointerByReference A pointer to memory which, on return, is filled with the pointer-sized value if a matching key is found. If no key match is found, the contents of the storage pointed to by this parameter are undefined. This value may be `null`, in which case the value from the dictionary is not returned (but the return value of this function still indicates whether or not the key-value pair was present). value) Returns a boolean value that indicates whether a given value for a given key is in a dictionary, and returns that value indirectly if it exists.
public void	CFDictionarySetValue(CoreFoundation.CFMutableDictionaryRef The dictionary to modify. If this parameter is a fixed-capacity dictionary and it is full before this operation, and the key does not exist in the dictionary, the behavior is undefined. theDict, PointerType The key of the value to set in `theDict`. If a key which matches `key` is already present in the dictionary, only the value for the key is changed ("add if absent, replace if present"). If no key matches `key`, the key-value pair is added to the dictionary. If a key-value pair is added, both key and value are retained by the dictionary, using the retain callback provided when `theDict` was created. `key` must be of the type expected by the key retain callback. key, PointerType The value to add to or replace in `theDict`. `value` is retained using the value retain callback provided when `theDict` was created, and the previous value if any is released. `value` must be of the type expected by the retain and release callbacks. value) Sets the value corresponding to a given key.
public boolean	Returns: true if cf1 and cf2 are of the same type and considered equal, otherwise false. CFEqual(CoreFoundation.CFTypeRef A CFType object to compare to cf2. cf1, CoreFoundation.CFTypeRef A CFType object to compare to cf1. cf2) Determines whether two Core Foundation objects are considered equal.
public CoreFoundation.CFIndex	Returns: A number representing the reference count of {code cf}. CFGetRetainCount(CoreFoundation.CFTypeRef The `CFType` object to examine. cf) Returns the reference count of a Core Foundation object.
public CoreFoundation.CFTypeID	Returns: A value of type `CFTypeID` that identifies the opaque type of `cf`. CFGetTypeID(CoreFoundation.CFTypeRef The `CFData` object to examine. theObject) Returns the type of a `CFType` object.
public CoreFoundation.CFTypeID	Returns: A value of type `CFTypeID` that identifies the opaque type of `cf`. CFGetTypeID(Pointer The pointer to `CFData` object to examine. theObject) Returns the type of a `CFType` object presented as a pointer.
public CoreFoundation.CFNumberRef	Returns: A new number with the value specified by `valuePtr`. CFNumberCreate(CoreFoundation.CFAllocatorRef The allocator to use to allocate memory for the new object. Pass `null` or `kCFAllocatorDefault` to use the current default allocator. alloc, CoreFoundation.CFIndex A constant that specifies the data type of the value to convert. The ordinal value of the enum. The `theType` parameter is not necessarily preserved when creating a new `CFNumber` object. The `CFNumber` object will be created using whatever internal storage type the creation function deems appropriate. Use the function `CFNumberGetType` to find out what type the `CFNumber` object used to store your value. theType, ByReference A pointer to the value for the returned number object. valuePtr) Creates a `CFNumber` object using a specified value.
public CoreFoundation.CFIndex	Returns: A constant that indicates the data type of the value contained in number. See `CFNumberType` for a list of possible values. CFNumberGetType(CoreFoundation.CFNumberRef The `CFNumber` object to examine. number) Returns the type used by a `CFNumber` object to store its value.
public CoreFoundation.CFTypeID	Returns: The type identifier for the `CFNumber` opaque type. CFNumberGetTypeID()
public byte	Returns: 1 if the operation was successful, otherwise 0. CFNumberGetValue(CoreFoundation.CFNumberRef The `CFNumber` object to examine. number, CoreFoundation.CFIndex A constant that specifies the data type to return. See `CFNumberType` for a list of possible values. theType, ByReference On return, contains the value of `number`. valuePtr) Obtains the value of a `CFNumber` object cast to a specified type.
public void	CFRelease(CoreFoundation.CFTypeRef A `CFType` object to release. This value must not be `null`. cf) Releases a Core Foundation object.
public CoreFoundation.CFTypeRef	Returns: The input value, {code cf}. CFRetain(CoreFoundation.CFTypeRef The `CFType` object to retain. This value must not be `null`. cf) Retains a Core Foundation object.
public CoreFoundation.CFStringRef	Returns: An immutable string containing `chars`, or `null` if there was a problem creating the object. CFStringCreateWithCharacters(CoreFoundation.CFAllocatorRef The allocator to use to allocate memory for the new string. Pass `null` or `kCFAllocatorDefault` to use the current default allocator. alloc, char[] The buffer of Unicode characters to copy into the new string. chars, CoreFoundation.CFIndex The number of characters in the buffer pointed to by chars. Only this number of characters will be copied to internal storage. length) Creates a string from a buffer of Unicode characters.
public byte	Returns: 1 upon success or 0 if the conversion fails or the provided buffer is too small. CFStringGetCString(CoreFoundation.CFStringRef The string whose contents you wish to access. theString, Pointer The C string buffer into which to copy the string. On return, the buffer contains the converted characters. If there is an error in conversion, the buffer contains only partial results. The buffer must be large enough to contain the converted characters and a NUL terminator. bufferToFill, CoreFoundation.CFIndex The length of `buffer` in bytes. bufferSize, int The string encoding to which the character contents of `theString` should be converted. The encoding must specify an 8-bit encoding. encoding) Copies the character contents of a string to a local C string buffer after converting the characters to a given encoding.
public CoreFoundation.CFIndex	Returns: The number (in terms of UTF-16 code pairs) of characters stored in `theString`. CFStringGetLength(CoreFoundation.CFStringRef The string to examine. theString) Returns the number (in terms of UTF-16 code pairs) of Unicode characters in a string.
public CoreFoundation.CFIndex	Returns: The maximum number of bytes that could be needed to represent length number of Unicode characters with the string encoding encoding, or `kCFNotFound` if the number exceeds `Long#MAX_VALUE`. CFStringGetMaximumSizeForEncoding(CoreFoundation.CFIndex The number of Unicode characters to evaluate. length, int The string encoding for the number of characters specified by length. encoding) Returns the maximum number of bytes a string of a specified length (in Unicode characters) will take up if encoded in a specified encoding.
public CoreFoundation.CFTypeID	Returns: The type identifier for the `CFString` opaque type. CFStringGetTypeID()

public Interface CoreFoundation

Nested and Inner Type Summary

Field Summary

Method Summary