de.qaware.seu.as.code.plugins.credentials.mac

Interface CoreFoundation

All Superinterfaces:

com.sun.jna.Library

public interface CoreFoundation
extends com.sun.jna.Library

The JNA interface to access the CoreFoundation library under MacOS.

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.jna.Library

com.sun.jna.Library.Handler

Field Summary

Fields

Modifier and Type	Field and Description
static int	kCFStringEncodingASCII
static int	kCFStringEncodingISOLatin1
static int	kCFStringEncodingMacRoman
static int	kCFStringEncodingNextStepLatin
static int	kCFStringEncodingNonLossyASCII
static int	kCFStringEncodingUnicode
static int	kCFStringEncodingUTF16
static int	kCFStringEncodingUTF16BE
static int	kCFStringEncodingUTF16LE
static int	kCFStringEncodingUTF32
static int	kCFStringEncodingUTF32BE
static int	kCFStringEncodingUTF32LE
static int	kCFStringEncodingUTF8
static int	kCFStringEncodingWindowsLatin1

Fields inherited from interface com.sun.jna.Library

OPTION_ALLOW_OBJECTS, OPTION_CALLING_CONVENTION, OPTION_FUNCTION_MAPPER, OPTION_INVOCATION_MAPPER, OPTION_STRUCTURE_ALIGNMENT, OPTION_TYPE_MAPPER

Method Summary

Modifier and Type	Method and Description
void	CFRelease(com.sun.jna.Pointer cf) Releases a Core Foundation object.
com.sun.jna.Pointer	CFStringGetCharactersPtr(com.sun.jna.Pointer theString) Quickly obtains a pointer to the contents of a string as a buffer of Unicode characters.
boolean	CFStringGetCString(com.sun.jna.Pointer theString, byte[] buffer, int bufferSize, int encoding) Copies the character contents of a string to a local C string buffer after converting the characters to a given encoding.
com.sun.jna.Pointer	CFStringGetCStringPtr(com.sun.jna.Pointer theString, int encoding) Quickly obtains a pointer to a C-string buffer containing the characters of a string in a given encoding.
int	CFStringGetLength(com.sun.jna.Pointer theString) Returns the number (in terms of UTF-16 code pairs) of Unicode characters in a string.

Field Detail

kCFStringEncodingMacRoman

static final int kCFStringEncodingMacRoman

See Also:

Constant Field Values

kCFStringEncodingWindowsLatin1

static final int kCFStringEncodingWindowsLatin1

See Also:

Constant Field Values

kCFStringEncodingISOLatin1

static final int kCFStringEncodingISOLatin1

See Also:

Constant Field Values

kCFStringEncodingNextStepLatin

static final int kCFStringEncodingNextStepLatin

See Also:

Constant Field Values

kCFStringEncodingASCII

static final int kCFStringEncodingASCII

See Also:

Constant Field Values

kCFStringEncodingUnicode

static final int kCFStringEncodingUnicode

See Also:

Constant Field Values

kCFStringEncodingUTF8

static final int kCFStringEncodingUTF8

See Also:

Constant Field Values

kCFStringEncodingNonLossyASCII

static final int kCFStringEncodingNonLossyASCII

See Also:

Constant Field Values

kCFStringEncodingUTF16

static final int kCFStringEncodingUTF16

See Also:

Constant Field Values

kCFStringEncodingUTF16BE

static final int kCFStringEncodingUTF16BE

See Also:

Constant Field Values

kCFStringEncodingUTF16LE

static final int kCFStringEncodingUTF16LE

See Also:

Constant Field Values

kCFStringEncodingUTF32

static final int kCFStringEncodingUTF32

See Also:

Constant Field Values

kCFStringEncodingUTF32BE

static final int kCFStringEncodingUTF32BE

See Also:

Constant Field Values

kCFStringEncodingUTF32LE

static final int kCFStringEncodingUTF32LE

See Also:

Constant Field Values

Method Detail

CFRelease

void CFRelease(com.sun.jna.Pointer cf)

Releases a Core Foundation object.
void CFRelease ( CFTypeRef cf );

Parameters:

cf - A CFType object to release. This value must not be NULL.

CFStringGetLength

int CFStringGetLength(com.sun.jna.Pointer theString)

Returns the number (in terms of UTF-16 code pairs) of Unicode characters in a string.
CFIndex CFStringGetLength ( CFStringRef theString );

Parameters:

theString - The string to examine.

Returns:

The number (in terms of UTF-16 code pairs) of characters stored in theString.

CFStringGetCharactersPtr

com.sun.jna.Pointer CFStringGetCharactersPtr(com.sun.jna.Pointer theString)

Quickly obtains a pointer to the contents of a string as a buffer of Unicode characters.
const UniChar * CFStringGetCharactersPtr ( CFStringRef theString );

Parameters:

theString - The string whose contents you wish to access.

Returns:

A pointer to a buffer of Unicode character, or NULL if the internal storage of theString does not allow this to be returned efficiently.

CFStringGetCString

boolean CFStringGetCString(com.sun.jna.Pointer theString,
                           byte[] buffer,
                           int bufferSize,
                           int encoding)

Copies the character contents of a string to a local C string buffer after converting the characters to a given encoding.
Boolean CFStringGetCString ( CFStringRef theString, char *buffer, CFIndex bufferSize, CFStringEncoding encoding );

Parameters:

theString - The string whose contents you wish to access.

buffer - 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. For example, if the string is Toby, the buffer must be at least 5 bytes long.

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:

true upon success or false if the conversion fails or the provided buffer is too small.

CFStringGetCStringPtr

com.sun.jna.Pointer CFStringGetCStringPtr(com.sun.jna.Pointer theString,
                                          int encoding)

Quickly obtains a pointer to a C-string buffer containing the characters of a string in a given encoding.
const char * CFStringGetCStringPtr ( CFStringRef theString, CFStringEncoding encoding );

Parameters:

theString - The string whose contents you wish to access.

encoding - The string encoding to which the character contents of theString should be converted. The encoding must specify an 8-bit encoding.

Returns:

A pointer to a C string or NULL if the internal storage of theString does not allow this to be returned efficiently.