Java Native Access 5.14.0 · com.sun.jna.ptr.ByReference

Provides generic "pointer to type" functionality, often used in C code to return values to the caller in addition to a function result.

Derived classes must define setValue(<T>) and <T> getValue() methods which write to/read from the allocated memory.

This class derives from PointerType instead of Memory in order to restrict the API to only getValue/setValue.

Note

this class would ideally be replaced by a generic.

Constructor Summary

Access	Constructor and Description
protected	ByReference(int The number of bytes to allocate. Must match the byte size of `T` in the derived class `setValue(<T>)` and `<T> getValue()` methods. dataSize) Allocates memory at this pointer, to contain the pointed-to value.

Modifier and Type	Method and Description
public String	toString() Overrides com.sun.jna.PointerType.toString. Returns a string representation of the object.

Inherited from com.sun.jna.PointerType:: equals fromNative getPointer hashCode nativeType setPointer toNative

ByReference back to summary

ByReference	back to summary
protected ByReference(int dataSize) Allocates memory at this pointer, to contain the pointed-to value. Parameters dataSize:int The number of bytes to allocate. Must match the byte size of `T` in the derived class `setValue(<T>)` and `<T> getValue()` methods.

protected ByReference(int dataSize)

Allocates memory at this pointer, to contain the pointed-to value.

Parameters

dataSize:int: The number of bytes to allocate. Must match the byte size of T in the derived class setValue(<T>) and <T> getValue() methods.

toString	back to summary
public String toString() Overrides com.sun.jna.PointerType.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

public String toString()

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations