Library
Core Foundation is a framework that provides fundamental software services useful to application services, application environments, and to applications themselves. Core Foundation also provides abstractions for common data types.
Core Foundation functions have names that indicate when you own a returned object: Object-creation functions have “Create” embedded in the name, and Object-duplication functions that have “Copy” embedded in the name. If you own an object, it is your responsibility to relinquish ownership (using CFRelease(com.sun.jna.platform.mac.CoreFoundation.CFTypeRef)
) when you have finished with it.
If you receive an object from any Core Foundation function other than a creation or copy function—such as a Get function—you do not own it and cannot be certain of the object’s life span. If you want to ensure that such an object is not disposed of while you are using it, you must claim ownership (with the CFRetain(com.sun.jna.platform.mac.CoreFoundation.CFTypeRef)
function).
Verschachtelte Klassen
static class
A reference type used in many Core Foundation parameters and function results.
static class
A reference to an immutable CFArray
object.
static class
A reference to a CFBoolean
object.
static class
A reference to an immutable CFData
object.
static class
A reference to an immutable CFDictionary
object.
static class
static class
A reference to a mutable CFDictionary
object.
static class
A reference to a CFNumber
object.
static enum
static class
A reference to a CFString
object, which “encapsulates” a Unicode string along with its length.
static class
A type for unique, constant integer values that identify particular Core Foundation opaque types.
static class
The CFTypeRef
type is the base type defined in Core Foundation.
Felder
static final int
static final int
static final int
Gets the default allocator object for the current thread.
Creates a new immutable array with the given values.
Returns the number of values currently in an array.
Retrieves a value at a given index.
byte
Returns the value of a CFBoolean
object.
Returns a textual description of a Core Foundation object.
Creates an immutable CFData
object using data copied from a specified byte buffer.
Returns a read-only pointer to the bytes of a CFData
object.
Returns the number of bytes contained by a CFData
object.
Creates a new mutable dictionary.
Returns the number of key-value pairs in a dictionary.
Returns the value associated with a given key.
byte
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.
void
Sets the value corresponding to a given key.
boolean
Determines whether two Core Foundation objects are considered equal.
Returns the reference count of a Core Foundation object.
Returns the type of a CFType
object.
Returns the type of a CFType
object presented as a pointer.
Creates a CFNumber
object using a specified value.
Returns the type used by a CFNumber
object to store its value.
byte
Obtains the value of a CFNumber
object cast to a specified type.
void
Releases a Core Foundation object.
Retains a Core Foundation object.
Creates a string from a buffer of Unicode characters.
byte
Copies the character contents of a string to a local C string buffer after converting the characters to a given encoding.
Returns the number (in terms of UTF-16 code pairs) of Unicode characters in a string.
Returns the maximum number of bytes a string of a specified length (in Unicode characters) will take up if encoded in a specified encoding.
static final int kCFNotFound
static final int kCFStringEncodingASCII
static final int kCFStringEncodingUTF8
This reference must be released with CFRelease(com.sun.jna.platform.mac.CoreFoundation.CFTypeRef)
to avoid leaking references.
alloc
- The allocator to use to allocate memory for the new string. Pass null
or kCFAllocatorDefault
to use the current default allocator.
chars
- The buffer of Unicode characters to copy into the new string.
length
- The number of characters in the buffer pointed to by chars. Only this number of characters will be copied to internal storage.
chars
, or null
if there was a problem creating the object.
alloc
- The allocator to use to allocate memory for the new object. Pass null
or kCFAllocatorDefault
to use the current default allocator.
theType
- 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(com.sun.jna.platform.mac.CoreFoundation.CFNumberRef)
to find out what type the CFNumber
object used to store your value.
valuePtr
- A pointer to the value for the returned number object.
valuePtr
.
This reference must be released with CFRelease(com.sun.jna.platform.mac.CoreFoundation.CFTypeRef)
to avoid leaking references.
alloc
- 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.
values
- 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.
numValues
- 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.
callBacks
- 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.
numValues
from values
, or null
if there was a problem creating the object.
alloc
- The allocator to use to allocate memory for the new object. Pass null
or kCFAllocatorDefault
to use the current default allocator.
bytes
- A pointer to the byte buffer that contains the raw data to be copied into the Data.
length
- The number of bytes in the buffer (bytes
).
CFData
object, or null
if there was a problem creating the object.
This reference must be released with CFRelease(com.sun.jna.platform.mac.CoreFoundation.CFTypeRef)
to avoid leaking references.
alloc
- The allocator to use to allocate memory for the new string. Pass null
or kCFAllocatorDefault
to use the current default allocator.
capacity
- 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.
keyCallBacks
- 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
.
valueCallBacks
- 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
.
null
if there was a problem creating the object.
Returns a textual description of a Core Foundation object.
The nature of the description differs by object. For example, a description of a CFArray object would include descriptions of each of the elements in the collection.
You can use this function for debugging Core Foundation objects in your code. Note, however, that the description for a given object may be different in different releases of the operating system. Do not create dependencies in your code on the content or format of the information returned by this function.
cf
- The CFType
object (a generic reference of type CFTypeRef
) from which to derive a description.
cf
.
If the retain count of cf
becomes zero the memory allocated to the object is deallocated and the object is destroyed. If you create, copy, or explicitly retain (see the CFRetain(com.sun.jna.platform.mac.CoreFoundation.CFTypeRef)
function) a Core Foundation object, you are responsible for releasing it when you no longer need it.
cf
- A CFType
object to release. This value must not be null
.
If you retain a Core Foundation object you are responsible for releasing it with CFRelease(com.sun.jna.platform.mac.CoreFoundation.CFTypeRef)
.
cf
- The CFType
object to retain. This value must not be null
.
Returns the reference count of a Core Foundation object.
cf
- The CFType
object to examine.
Returns the number of key-value pairs in a dictionary.
theDict
- The dictionary to examine.
Returns the value associated with a given key.
theDict
- The dictionary to examine.
key
- 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.
theDict
, or null
if no key-value pair matching key exists. Since null
is also a valid value in some dictionaries, use CFDictionaryGetValueIfPresent(com.sun.jna.platform.mac.CoreFoundation.CFDictionaryRef, com.sun.jna.PointerType, com.sun.jna.ptr.PointerByReference)
to distinguish between a value that is not found, and a null
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.
theDict
- The dictionary to examine.
key
- 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.
value
- 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).
Sets the value corresponding to a given key.
theDict
- 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.
key
- 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.
value
- 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.
Copies the character contents of a string to a local C string buffer after converting the characters to a given encoding.
theString
- The string whose contents you wish to access.
bufferToFill
- 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.
bufferSize
- The length of buffer
in bytes.
encoding
- The string encoding to which the character contents of theString
should be converted. The encoding must specify an 8-bit encoding.
Returns the value of a CFBoolean
object.
bool
- The boolean to examine.
bool
is true
, 0 otherwise.
Returns the number of values currently in an array.
theArray
- a CoreFoundation.CFArrayRef
object.
array
.
Retrieves a value at a given index.
theArray
- The array to examine.
idx
- 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
index in theArray
).
Returns the type used by a CFNumber
object to store its value.
number
- The CFNumber
object to examine.
CoreFoundation.CFNumberType
for a list of possible values.
Obtains the value of a CFNumber
object cast to a specified type.
number
- The CFNumber
object to examine.
theType
- A constant that specifies the data type to return. See CoreFoundation.CFNumberType
for a list of possible values.
valuePtr
- On return, contains the value of number
.
Returns the number (in terms of UTF-16 code pairs) of Unicode characters in a string.
theString
- The string to examine.
theString
.
Returns the maximum number of bytes a string of a specified length (in Unicode characters) will take up if encoded in a specified encoding.
length
- The number of Unicode characters to evaluate.
encoding
- The string encoding for the number of characters specified by length.
kCFNotFound
if the number exceeds Long.MAX_VALUE
.
Determines whether two Core Foundation objects are considered equal.
cf1
- A CFType object to compare to cf2.
cf2
- A CFType object to compare to cf1.
Gets the default allocator object for the current thread.
The default allocator can never be released, so it is not necessary to CFRetain(com.sun.jna.platform.mac.CoreFoundation.CFTypeRef)
this reference.
Returns the number of bytes contained by a CFData
object.
theData
- The CFData
object to examine.
theData
.
Returns a read-only pointer to the bytes of a CFData
object.
theData
- The CFData
object to examine.
theData
.
Returns the type of a CFType
object.
theObject
- The CFData
object to examine.
CoreFoundation.CFTypeID
that identifies the opaque type of cf
.
Returns the type of a
CFType
object presented as a pointer. Allows to inspect object type without creating a
CoreFoundation.CFTypeRef
wrapper.
theObject
- The pointer to CFData
object to examine.
CoreFoundation.CFTypeID
that identifies the opaque type of cf
.
CFArray
opaque type.
CFBoolean
opaque type.
CFDate
opaque type.
CFData
opaque type.
CFMutableData
objects have the same type identifier as CFData
objects.
CFDictionary
opaque type.
CFMutableDictionary
objects have the same type identifier as CFDictionary
objects.
CFNumber
opaque type.
CFString
opaque type.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4