Nested and Inner Type Summary

Modifier and Type	Class and Description
private static class	Function.NativeMappedArray
private static class	Function.PointerArray
public static interface	Function.PostCallRead Any argument which implements this interface will have the `read` method called immediately after function invocation.

Field Summary

Modifier and Type	Field and Description
public static final int	ALT_CONVENTION First alternate convention (currently used only for w32 stdcall).
public static final int	C_CONVENTION Standard C calling convention.
pack-priv final int	callFlags
pack-priv final String	encoding
private final String	functionName
pack-priv static final Integer	INTEGER_FALSE
pack-priv static final Integer	INTEGER_TRUE
private static final VarArgsChecker	IS_VARARGS For checking if methods declare varargs
private NativeLibrary	library
private static final int	MASK_CC
public static final int	MAX_NARGS Maximum number of arguments supported by a JNA function call.
pack-priv static final String	OPTION_INVOKING_METHOD For internal JNA use.
pack-priv final Map<String, ?>	options
public static final int	THROW_LAST_ERROR Whether to throw an exception if last error is non-zero after call.
public static final int	USE_VARARGS Mask for number of fixed args (max 255) for varargs calls.
private static final int	USE_VARARGS_SHIFT Offset of USE_VARARGS in call flags

Inherited from com.sun.jna.Pointer:: NULL peer

Constructor Summary

Access	Constructor and Description
pack-priv	Function(NativeLibrary `NativeLibrary` in which to find the function library, String Name of the native function to be linked with functionName, int Function call flags callFlags, String Encoding for conversion between Java and native strings. encoding) Create a new `Function` that is linked with a native function that follows the given calling convention.
pack-priv	Function(Pointer Address of the native function functionAddress, int Function call flags callFlags, String Encoding for conversion between Java and native strings. encoding) Create a new `Function` that is linked with a native function that follows the given calling convention.

Method Summary

Modifier and Type	Method and Description
private void	checkCallingConvention(int convention)
pack-priv static Object[]	concatenateVarArgs(Object[] inArgs) Concatenate varargs with normal args to obtain a simple argument array.
private Object	convertArgument(Object[] args, int index, Method invokingMethod, TypeMapper mapper, boolean allowObjects, Class<?> expectedType)
public boolean	equals(Object the reference object with which to compare. o) Overrides com.sun.jna.Pointer.equals. Two function pointers are equal if they share the same peer address and calling convention.
pack-priv static int	fixedArgs(Method m) Varargs are only supported on 1.5+.
public int	getCallingConvention()
public static Function	getFunction(String Library in which to find the native function libraryName, String Name of the native function to be linked with functionName) Obtain a `Function` representing a native function that follows the standard "C" calling convention.
public static Function	getFunction(String Library in which to find the function libraryName, String Name of the native function to be linked with functionName, int Function call flags callFlags) Obtain a `Function` representing a native function.
public static Function	getFunction(String Library in which to find the function libraryName, String Name of the native function to be linked with functionName, int Function call flags callFlags, String Encoding to use for conversion between Java and native strings. encoding) Obtain a `Function` representing a native function.
public static Function	getFunction(Pointer Native function pointer p) Obtain a `Function` representing a native function pointer.
public static Function	getFunction(Pointer Native function pointer p, int Function call flags callFlags) Obtain a `Function` representing a native function pointer.
public static Function	getFunction(Pointer Native function pointer p, int Function call flags callFlags, String Encoding to use for conversion between Java and native strings. encoding) Obtain a `Function` representing a native function pointer.
public String	getName()
public int	hashCode() Overrides com.sun.jna.Pointer.hashCode. Provide a unique hash code for `Function`s which are equivalent.
public Object	invoke(Class<?> returnType, Object[] inArgs) Invoke the native function with the given arguments, returning the native result as an Object.
public Object	invoke(Class<?> returnType, Object[] inArgs, Map<String, ?> options) Invoke the native function with the given arguments, returning the native result as an Object.
pack-priv Object	invoke(Method invokingMethod, Class<?>[] paramTypes, Class<?> returnType, Object[] inArgs, Map<String, ?> options) Invoke the native function with the given arguments, returning the native result as an Object.
pack-priv Object	invoke(Object[] args, Class<?> returnType, boolean allowObjects)
pack-priv Object	invoke(Object[] args, Class<?> returnType, boolean allowObjects, int fixedArgs)
public void	invoke(Object[] Arguments to pass to the native function args) Call the native function being represented by this object
public double	invokeDouble(Object[] args) Convenience method for `invoke(Double.class, args)`.
public float	invokeFloat(Object[] args) Convenience method for `invoke(Float.class, args)`.
public int	invokeInt(Object[] args) Convenience method for `invoke(Integer.class, args)`.
public long	invokeLong(Object[] args) Convenience method for `invoke(Long.class, args)`.
public Object	invokeObject(Object[] args) Convenience method for `invokeObject(Object.class, args)`.
private Pointer	invokePointer(int callFlags, Object[] args)
public Pointer	invokePointer(Object[] args) Convenience method for `invoke(Pointer.class, args)`.
private String	Returns: The value returned by the target native function, as a String invokeString(int calling convention to be used callFlags, Object[] Arguments to pass to the native function args, boolean whether the native string uses `wchar_t`; if false, `char` is assumed wide) Call the native function being represented by this object
public String	invokeString(Object[] Arguments passed to native function args, boolean Whether the return value is of type `wchar_t`; if false, the return value is of type `char`. wide) Convenience method for `invoke(String.class, args)` or `invoke(WString.class, args)`
public void	invokeVoid(Object[] args) Convenience method for `invoke(Void.class, args)`.
private boolean	isPrimitiveArray(Class<?> argClass)
pack-priv static boolean	isVarArgs(Method m) Varargs are only supported on 1.5+.
public String	toString() Overrides com.sun.jna.Pointer.toString. Provide a human-readable representation of this object.
pack-priv static Boolean	valueOf(boolean b) Implementation of Boolean.valueOf for older VMs.

Field Detail

ALT_CONVENTION	back to summary
public static final int ALT_CONVENTION First alternate convention (currently used only for w32 stdcall). Annotations @Native

C_CONVENTION	back to summary
public static final int C_CONVENTION Standard C calling convention. Annotations @Native

callFlags	back to summary
pack-priv final int callFlags

encoding	back to summary
pack-priv final String encoding

functionName	back to summary
private final String functionName

INTEGER_FALSE	back to summary
pack-priv static final Integer INTEGER_FALSE

INTEGER_TRUE	back to summary
pack-priv static final Integer INTEGER_TRUE

IS_VARARGS	back to summary
private static final VarArgsChecker IS_VARARGS For checking if methods declare varargs

library	back to summary
private NativeLibrary library

MASK_CC	back to summary
private static final int MASK_CC Annotations @Native

MAX_NARGS	back to summary
public static final int MAX_NARGS Maximum number of arguments supported by a JNA function call. Annotations @Native

OPTION_INVOKING_METHOD	back to summary
pack-priv static final String OPTION_INVOKING_METHOD For internal JNA use.

options	back to summary
pack-priv final Map<String, ?> options

THROW_LAST_ERROR	back to summary
public static final int THROW_LAST_ERROR Whether to throw an exception if last error is non-zero after call. Annotations @Native

USE_VARARGS	back to summary
public static final int USE_VARARGS Mask for number of fixed args (max 255) for varargs calls. Annotations @Native

USE_VARARGS_SHIFT	back to summary
private static final int USE_VARARGS_SHIFT Offset of USE_VARARGS in call flags Annotations @Native

Constructor Detail

Function back to summary

Function	back to summary
pack-priv Function(NativeLibrary library, String functionName, int callFlags, String encoding) Create a new `Function` that is linked with a native function that follows the given calling convention. The allocated instance represents a pointer to the named native function from the supplied library, called with the given calling convention. Parameters library:NativeLibrary `NativeLibrary` in which to find the function functionName:String Name of the native function to be linked with callFlags:int Function call flags encoding:String Encoding for conversion between Java and native strings. Exceptions UnsatisfiedLinkError: if the given function name is not found within the library.

pack-priv Function(NativeLibrary library, String functionName, int callFlags, String encoding)

Create a new Function that is linked with a native function that follows the given calling convention.

The allocated instance represents a pointer to the named native function from the supplied library, called with the given calling convention.

Parameters

library:NativeLibrary: NativeLibrary in which to find the function
functionName:String: Name of the native function to be linked with
callFlags:int: Function call flags
encoding:String: Encoding for conversion between Java and native strings.

Exceptions

UnsatisfiedLinkError:: if the given function name is not found within the library.

Function back to summary

Function	back to summary
pack-priv Function(Pointer functionAddress, int callFlags, String encoding) Create a new `Function` that is linked with a native function that follows the given calling convention. The allocated instance represents a pointer to the given function address, called with the given calling convention. Parameters functionAddress:Pointer Address of the native function callFlags:int Function call flags encoding:String Encoding for conversion between Java and native strings.

pack-priv Function(Pointer functionAddress, int callFlags, String encoding)

Create a new Function that is linked with a native function that follows the given calling convention.

The allocated instance represents a pointer to the given function address, called with the given calling convention.

Parameters

functionAddress:Pointer: Address of the native function
callFlags:int: Function call flags
encoding:String: Encoding for conversion between Java and native strings.

Method Detail

checkCallingConvention	back to summary
private void checkCallingConvention(int convention) throws IllegalArgumentException

concatenateVarArgs	back to summary
pack-priv static Object[] concatenateVarArgs(Object[] inArgs) Concatenate varargs with normal args to obtain a simple argument array.

convertArgument	back to summary
private Object convertArgument(Object[] args, int index, Method invokingMethod, TypeMapper mapper, boolean allowObjects, Class<?> expectedType)

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides com.sun.jna.Pointer.equals. Two function pointers are equal if they share the same peer address and calling convention. Parameters o:Object Doc from java.lang.Object.equals. the reference object with which to compare. Returns:boolean Doc from java.lang.Object.equals. `true` if this object is the same as the obj argument; `false` otherwise. Annotations @Override

public boolean equals(Object o)

Overrides com.sun.jna.Pointer.equals.

Two function pointers are equal if they share the same peer address and calling convention.

Parameters

o:Object

Doc from java.lang.Object.equals.

the reference object with which to compare.

Returns:boolean

Doc from java.lang.Object.equals.

true if this object is the same as the obj argument; false otherwise.

Annotations

@Override

fixedArgs	back to summary
pack-priv static int fixedArgs(Method m) Varargs are only supported on 1.5+.

getCallingConvention	back to summary
public int getCallingConvention()

getFunction back to summary

getFunction	back to summary
public static Function getFunction(String libraryName, String functionName) Obtain a `Function` representing a native function that follows the standard "C" calling convention. The allocated instance represents a pointer to the named native function from the named library, called with the standard "C" calling convention. Parameters libraryName:String Library in which to find the native function functionName:String Name of the native function to be linked with Exceptions UnsatisfiedLinkError: if the library is not found or the given function name is not found within the library.

public static Function getFunction(String libraryName, String functionName)

Obtain a Function representing a native function that follows the standard "C" calling convention.

The allocated instance represents a pointer to the named native function from the named library, called with the standard "C" calling convention.

Parameters

libraryName:String: Library in which to find the native function
functionName:String: Name of the native function to be linked with

Exceptions

UnsatisfiedLinkError:: if the library is not found or the given function name is not found within the library.

getFunction back to summary

getFunction	back to summary
public static Function getFunction(String libraryName, String functionName, int callFlags) Obtain a `Function` representing a native function. The allocated instance represents a pointer to the named native function from the named library. Parameters libraryName:String Library in which to find the function functionName:String Name of the native function to be linked with callFlags:int Function call flags Exceptions UnsatisfiedLinkError: if the library is not found or the given function name is not found within the library.

public static Function getFunction(String libraryName, String functionName, int callFlags)

Obtain a Function representing a native function.

The allocated instance represents a pointer to the named native function from the named library.

Parameters

libraryName:String: Library in which to find the function
functionName:String: Name of the native function to be linked with
callFlags:int: Function call flags

Exceptions

UnsatisfiedLinkError:: if the library is not found or the given function name is not found within the library.

getFunction back to summary

getFunction	back to summary
public static Function getFunction(String libraryName, String functionName, int callFlags, String encoding) Obtain a `Function` representing a native function. The allocated instance represents a pointer to the named native function from the named library. Parameters libraryName:String Library in which to find the function functionName:String Name of the native function to be linked with callFlags:int Function call flags encoding:String Encoding to use for conversion between Java and native strings. Exceptions UnsatisfiedLinkError: if the library is not found or the given function name is not found within the library.

public static Function getFunction(String libraryName, String functionName, int callFlags, String encoding)

Obtain a Function representing a native function.

The allocated instance represents a pointer to the named native function from the named library.

Parameters

libraryName:String: Library in which to find the function
functionName:String: Name of the native function to be linked with
callFlags:int: Function call flags
encoding:String: Encoding to use for conversion between Java and native strings.

Exceptions

UnsatisfiedLinkError:: if the library is not found or the given function name is not found within the library.

getFunction back to summary

getFunction	back to summary
public static Function getFunction(Pointer p) Obtain a `Function` representing a native function pointer. In general, this function should be used by dynamic languages; Java code should allow JNA to bind to a specific Callback interface instead by defining a return type or Structure field type. The allocated instance represents a pointer to the native function pointer. Parameters p:Pointer Native function pointer

public static Function getFunction(Pointer p)

Obtain a Function representing a native function pointer. In general, this function should be used by dynamic languages; Java code should allow JNA to bind to a specific Callback interface instead by defining a return type or Structure field type.

The allocated instance represents a pointer to the native function pointer.

Parameters

p:Pointer: Native function pointer

getFunction back to summary

getFunction	back to summary
public static Function getFunction(Pointer p, int callFlags) Obtain a `Function` representing a native function pointer. In general, this function should be used by dynamic languages; Java code should allow JNA to bind to a specific Callback interface instead by defining a return type or Structure field type. The allocated instance represents a pointer to the native function pointer. Parameters p:Pointer Native function pointer callFlags:int Function call flags

public static Function getFunction(Pointer p, int callFlags)

The allocated instance represents a pointer to the native function pointer.

Parameters

p:Pointer: Native function pointer
callFlags:int: Function call flags

getFunction back to summary

getFunction	back to summary
public static Function getFunction(Pointer p, int callFlags, String encoding) Obtain a `Function` representing a native function pointer. In general, this function should be used by dynamic languages; Java code should allow JNA to bind to a specific Callback interface instead by defining a return type or Structure field type. The allocated instance represents a pointer to the native function pointer. Parameters p:Pointer Native function pointer callFlags:int Function call flags encoding:String Encoding to use for conversion between Java and native strings.

public static Function getFunction(Pointer p, int callFlags, String encoding)

The allocated instance represents a pointer to the native function pointer.

Parameters

p:Pointer: Native function pointer
callFlags:int: Function call flags
encoding:String: Encoding to use for conversion between Java and native strings.

getName	back to summary
public String getName()

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides com.sun.jna.Pointer.hashCode. Provide a unique hash code for `Function`s which are equivalent. Returns:int Doc from java.lang.Object.hashCode. a hash code value for this object. Annotations @Override

public int hashCode()

Overrides com.sun.jna.Pointer.hashCode.

Provide a unique hash code for Functions which are equivalent.

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object.

Annotations

@Override

invoke	back to summary
public Object invoke(Class<?> returnType, Object[] inArgs) Invoke the native function with the given arguments, returning the native result as an Object.

invoke	back to summary
public Object invoke(Class<?> returnType, Object[] inArgs, Map<String, ?> options) Invoke the native function with the given arguments, returning the native result as an Object.

invoke back to summary

invoke	back to summary
pack-priv Object invoke(Method invokingMethod, Class<?>[] paramTypes, Class<?> returnType, Object[] inArgs, Map<String, ?> options) Invoke the native function with the given arguments, returning the native result as an Object. This method can be called if invoking method and parameter types are already at hand. When calling `Function#invoke(Class, Object[], Map)`, the method has to be in the options under key `Function#OPTION_INVOKING_METHOD`.

pack-priv Object invoke(Method invokingMethod, Class<?>[] paramTypes, Class<?> returnType, Object[] inArgs, Map<String, ?> options)

Invoke the native function with the given arguments, returning the native result as an Object. This method can be called if invoking method and parameter types are already at hand. When calling Function#invoke(Class, Object[], Map), the method has to be in the options under key Function#OPTION_INVOKING_METHOD.

invoke	back to summary
pack-priv Object invoke(Object[] args, Class<?> returnType, boolean allowObjects)

invoke	back to summary
pack-priv Object invoke(Object[] args, Class<?> returnType, boolean allowObjects, int fixedArgs)

invoke	back to summary
public void invoke(Object[] args) Call the native function being represented by this object Parameters args:Object[] Arguments to pass to the native function

invoke

back to summary

public void invoke(Object[] args)

Call the native function being represented by this object

Parameters

args:Object[]: Arguments to pass to the native function

invokeDouble	back to summary
public double invokeDouble(Object[] args) Convenience method for `invoke(Double.class, args)`.

invokeFloat	back to summary
public float invokeFloat(Object[] args) Convenience method for `invoke(Float.class, args)`.

invokeInt	back to summary
public int invokeInt(Object[] args) Convenience method for `invoke(Integer.class, args)`.

invokeLong	back to summary
public long invokeLong(Object[] args) Convenience method for `invoke(Long.class, args)`.

invokeObject	back to summary
public Object invokeObject(Object[] args) Convenience method for `invokeObject(Object.class, args)`.

invokePointer	back to summary
private Pointer invokePointer(int callFlags, Object[] args)

invokePointer	back to summary
public Pointer invokePointer(Object[] args) Convenience method for `invoke(Pointer.class, args)`.

invokeString back to summary

invokeString	back to summary
private String invokeString(int callFlags, Object[] args, boolean wide) Call the native function being represented by this object Parameters callFlags:int calling convention to be used args:Object[] Arguments to pass to the native function wide:boolean whether the native string uses `wchar_t`; if false, `char` is assumed Returns:String The value returned by the target native function, as a String

private String invokeString(int callFlags, Object[] args, boolean wide)

Call the native function being represented by this object

Parameters

callFlags:int: calling convention to be used
args:Object[]: Arguments to pass to the native function
wide:boolean: whether the native string uses wchar_t; if false, char is assumed

Returns:String

The value returned by the target native function, as a String

invokeString back to summary

public String invokeString(Object[] args, boolean wide)

Convenience method for invoke(String.class, args) or invoke(WString.class, args)

Parameters

args:Object[]: Arguments passed to native function
wide:boolean: Whether the return value is of type wchar_t*; if false, the return value is of type char*.

invokeVoid	back to summary
public void invokeVoid(Object[] args) Convenience method for `invoke(Void.class, args)`.

isPrimitiveArray	back to summary
private boolean isPrimitiveArray(Class<?> argClass)

isVarArgs	back to summary
pack-priv static boolean isVarArgs(Method m) Varargs are only supported on 1.5+.

toString

back to summary

public String toString()

Overrides com.sun.jna.Pointer.toString.

Provide a human-readable representation of this object.

Returns:String

Doc from java.lang.Object.toString.

a string representation of the object.

Annotations

@Override

valueOf	back to summary
pack-priv static Boolean valueOf(boolean b) Implementation of Boolean.valueOf for older VMs.

com.sun.jna back to summary

private Class Function.NativeMappedArray

Class Inheritance

extends Memory
implements PostCallRead

java.lang.Object
com.sun.jna.Pointer
com.sun.jna.Memory
com.sun.jna.Function.NativeMappedArray

All Implemented Interfaces

com.sun.jna.Function.PostCallRead

Field Summary

Modifier and Type	Field and Description
private final NativeMapped[]	original

Inherited from com.sun.jna.Memory:: size

Constructor Summary

Access	Constructor and Description
public	NativeMappedArray(NativeMapped[] arg)

Method Summary

Modifier and Type	Method and Description
public void	read() Implements com.sun.jna.Function.PostCallRead.read. Perform any necessary post-call synchronization.

Field Detail

original	back to summary
private final NativeMapped[] original

Constructor Detail

NativeMappedArray	back to summary
public NativeMappedArray(NativeMapped[] arg)

Method Detail

read

back to summary

public void read()

Implements com.sun.jna.Function.PostCallRead.read.

Doc from com.sun.jna.Function.PostCallRead.read.

Perform any necessary post-call synchronization. Normally this just means reading from native memory any changes made by the native function call.

Annotations

@Override

com.sun.jna back to summary

private Class Function.PointerArray

Class Inheritance

extends Memory
implements PostCallRead

java.lang.Object
com.sun.jna.Pointer
com.sun.jna.Memory
com.sun.jna.Function.PointerArray

All Implemented Interfaces

com.sun.jna.Function.PostCallRead

Field Summary

Modifier and Type	Field and Description
private final Pointer[]	original

Inherited from com.sun.jna.Memory:: size

Constructor Summary

Access	Constructor and Description
public	PointerArray(Pointer[] arg)

Method Summary

Modifier and Type	Method and Description
public void	read() Implements com.sun.jna.Function.PostCallRead.read. Perform any necessary post-call synchronization.

Field Detail

original	back to summary
private final Pointer[] original

Constructor Detail

PointerArray	back to summary
public PointerArray(Pointer[] arg)

Method Detail

read

back to summary

public void read()

Implements com.sun.jna.Function.PostCallRead.read.

Doc from com.sun.jna.Function.PostCallRead.read.

Perform any necessary post-call synchronization. Normally this just means reading from native memory any changes made by the native function call.

Annotations

@Override

com.sun.jna back to summary

public Interface Function.PostCallRead

Known Direct Implementers: com.sun.jna.Function.NativeMappedArray, com.sun.jna.Function.PointerArray, com.sun.jna.StringArray

Any argument which implements this interface will have the read method called immediately after function invocation.

Method Summary

Modifier and Type	Method and Description
public void	read() Perform any necessary post-call synchronization.

Method Detail

read	back to summary
public void read() Perform any necessary post-call synchronization. Normally this just means reading from native memory any changes made by the native function call.

public Class Function

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Function.NativeMappedArray

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class Function.PointerArray

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Interface Function.PostCallRead

Method Summary

Method Detail