Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	Guid.CLSID The Class CLSID.
public static class	Guid.GUID The Class GUID.
public static class	Guid.IID The Class IID.
public static class	Guid.REFIID REFIID is a pointer to an IID.

Field Summary

Modifier and Type	Field and Description
public static final Guid.IID	IID_NULL The Constant IID_NULL.

Field Detail

IID_NULL	back to summary
public static final Guid.IID IID_NULL The Constant IID_NULL.

com.sun.jna.platform.win32 back to summary

public Class Guid.CLSID

Class Inheritance

extends GUID

The Class CLSID.

Author: Tobias Wolf, [email protected]

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	Guid.CLSID.ByReference The Class ByReference.

Field Summary

Inherited from com.sun.jna.platform.win32.Guid.GUID:: Data1 Data2 Data3 Data4

Constructor Summary

Access	Constructor and Description
public	CLSID() Instantiates a new clsid.
public	CLSID(String the guid guid) Instantiates a new clsid.
public	CLSID(Guid.GUID the guid guid) Instantiates a new clsid.

Method Summary

Inherited from com.sun.jna.platform.win32.Guid.GUID:: equals fromBinary fromString hashCode newGuid toByteArray toGuidString writeFieldsToMemory

Constructor Detail

CLSID	back to summary
public CLSID() Instantiates a new clsid.

CLSID	back to summary
public CLSID(String guid) Instantiates a new clsid. Parameters guid:String the guid

CLSID

back to summary

public CLSID(String guid)

Instantiates a new clsid.

Parameters

guid:String: the guid

CLSID	back to summary
public CLSID(Guid.GUID guid) Instantiates a new clsid. Parameters guid:Guid.GUID the guid

CLSID

back to summary

public CLSID(Guid.GUID guid)

Instantiates a new clsid.

Parameters

guid:Guid.GUID: the guid

com.sun.jna.platform.win32 back to summary

public Class Guid.CLSID.ByReference

Class Inheritance

extends GUID

java.lang.Object
com.sun.jna.Structure
com.sun.jna.platform.win32.Guid.GUID
com.sun.jna.platform.win32.Guid.CLSID.ByReference

The Class ByReference.

Author: Tobias Wolf, [email protected]

Field Summary

Inherited from com.sun.jna.platform.win32.Guid.GUID:: Data1 Data2 Data3 Data4

Constructor Summary

Access	Constructor and Description
public	ByReference() Instantiates a new by reference.
public	ByReference(Guid.GUID the guid guid) Instantiates a new by reference.
public	ByReference(Pointer the memory memory) Instantiates a new by reference.

Method Summary

Inherited from com.sun.jna.platform.win32.Guid.GUID:: equals fromBinary fromString hashCode newGuid toByteArray toGuidString writeFieldsToMemory

Constructor Detail

ByReference	back to summary
public ByReference() Instantiates a new by reference.

ByReference	back to summary
public ByReference(Guid.GUID guid) Instantiates a new by reference. Parameters guid:Guid.GUID the guid

ByReference

back to summary

public ByReference(Guid.GUID guid)

Instantiates a new by reference.

Parameters

guid:Guid.GUID: the guid

ByReference	back to summary
public ByReference(Pointer memory) Instantiates a new by reference. Parameters memory:Pointer the memory

ByReference

back to summary

public ByReference(Pointer memory)

Instantiates a new by reference.

Parameters

memory:Pointer: the memory

com.sun.jna.platform.win32 back to summary

public Class Guid.GUID

Class Inheritance

extends Structure

java.lang.Object
com.sun.jna.Structure
com.sun.jna.platform.win32.Guid.GUID

Known Direct Subclasses

com.sun.jna.platform.win32.Guid.GUID.ByValue, com.sun.jna.platform.win32.Guid.GUID.ByReference, com.sun.jna.platform.win32.Guid.CLSID, com.sun.jna.platform.win32.Guid.CLSID.ByReference, com.sun.jna.platform.win32.Guid.IID

Annotations

@FieldOrder:Data1, Data2, Data3, Data4

The Class GUID.

Author: Tobias Wolf, [email protected]

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static class	Guid.GUID.ByReference The Class ByReference.
public static class	Guid.GUID.ByValue

Field Summary

Modifier and Type	Field and Description
public int	Data1 The Data1.
public short	Data2 The Data2.
public short	Data3 The Data3.
public byte[]	Data4 The Data4.

Inherited from com.sun.jna.Structure:: ALIGN_DEFAULT ALIGN_GNUC ALIGN_MSVC ALIGN_NONE CALCULATE_SIZE

Constructor Summary

Access	Constructor and Description
public	GUID() Instantiates a new guid.
public	GUID(Guid.GUID the guid guid) Instantiates a new guid.
public	GUID(String the guid guid) Instantiates a new guid.
public	GUID(byte[] the data data) Instantiates a new guid.
public	GUID(Pointer the memory memory) Instantiates a new guid.

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. o) Overrides com.sun.jna.Structure.equals. Indicates whether some other object is "equal to" this one.
public static Guid.GUID	Returns: the guid fromBinary(byte[] the data data) From binary.
public static Guid.GUID	Returns: the guid fromString(String the guid guid) From string.
public int	hashCode() Overrides com.sun.jna.Structure.hashCode. Returns a hash code value for the object.
public static Guid.GUID	Returns: the guid newGuid() Generates a new guid.
public byte[]	Returns: the byte[] toByteArray() To byte array.
public String	Returns: the string toGuidString() The value of this Guid, formatted as follows: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.
protected void	writeFieldsToMemory() Write fields to backing memory.

Field Detail

Data1	back to summary
public int Data1 The Data1.

Data2	back to summary
public short Data2 The Data2.

Data3	back to summary
public short Data3 The Data3.

Data4	back to summary
public byte[] Data4 The Data4.

Constructor Detail

GUID	back to summary
public GUID() Instantiates a new guid.

GUID	back to summary
public GUID(Guid.GUID guid) Instantiates a new guid. Parameters guid:Guid.GUID the guid

GUID

back to summary

public GUID(Guid.GUID guid)

Instantiates a new guid.

Parameters

guid:Guid.GUID: the guid

GUID	back to summary
public GUID(String guid) Instantiates a new guid. Parameters guid:String the guid

GUID

back to summary

public GUID(String guid)

Instantiates a new guid.

Parameters

guid:String: the guid

GUID	back to summary
public GUID(byte[] data) Instantiates a new guid. Parameters data:byte[] the data

GUID

back to summary

public GUID(byte[] data)

Instantiates a new guid.

Parameters

data:byte[]: the data

GUID	back to summary
public GUID(Pointer memory) Instantiates a new guid. Parameters memory:Pointer the memory

GUID

back to summary

public GUID(Pointer memory)

Instantiates a new guid.

Parameters

memory:Pointer: the memory

Method Detail

equals back to summary

equals	back to summary
public boolean equals(Object o) Overrides com.sun.jna.Structure.equals. Doc from java.lang.Object.equals. Indicates whether some other object is "equal to" this one. The `equals` method implements an equivalence relation on non-null object references: It is reflexive: for any non-null reference value `x`, `x.equals(x)` should return `true`. It is symmetric: for any non-null reference values `x` and `y`, `x.equals(y)` should return `true` if and only if `y.equals(x)` returns `true`. It is transitive: for any non-null reference values `x`, `y`, and `z`, if `x.equals(y)` returns `true` and `y.equals(z)` returns `true`, then `x.equals(z)` should return `true`. It is consistent: for any non-null reference values `x` and `y`, multiple invocations of `x.equals(y)` consistently return `true` or consistently return `false`, provided no information used in `equals` comparisons on the objects is modified. For any non-null reference value `x`, `x.equals(null)` should return `false`. An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes. Parameters o:Object the reference object with which to compare. Returns:boolean Doc from com.sun.jna.Structure.equals. whether the given structure's type and pointer match. Annotations @Override

public boolean equals(Object o)

Overrides com.sun.jna.Structure.equals.

Doc from java.lang.Object.equals.

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

It is reflexive: for any non-null reference value x, x.equals(x) should return true.
It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

Parameters

o:Object: the reference object with which to compare.

Returns:boolean

Doc from com.sun.jna.Structure.equals.

whether the given structure's type and pointer match.

Annotations

@Override

fromBinary	back to summary
public static Guid.GUID fromBinary(byte[] data) From binary. Parameters data:byte[] the data Returns:Guid.GUID the guid

fromBinary

back to summary

public static Guid.GUID fromBinary(byte[] data)

From binary.

Parameters

data:byte[]: the data

Returns:Guid.GUID

the guid

fromString	back to summary
public static Guid.GUID fromString(String guid) From string. Parameters guid:String the guid Returns:Guid.GUID the guid

fromString

back to summary

public static Guid.GUID fromString(String guid)

From string.

Parameters

guid:String: the guid

Returns:Guid.GUID

the guid

hashCode back to summary

hashCode	back to summary
public int hashCode() Overrides com.sun.jna.Structure.hashCode. Doc from java.lang.Object.hashCode. Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by `java.util.HashMap`. The general contract of `hashCode` is: Whenever it is invoked on the same object more than once during an execution of a Java application, the `hashCode` method must consistently return the same integer, provided no information used in `equals` comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application. If two objects are equal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce the same integer result. It is not required that if two objects are unequal according to the `equals` method, then calling the `hashCode` method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables. Returns:int Doc from com.sun.jna.Structure.hashCode. hash code for this structure's pointer. Annotations @Override

public int hashCode()

Overrides com.sun.jna.Structure.hashCode.

Doc from java.lang.Object.hashCode.

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

Returns:int

Doc from com.sun.jna.Structure.hashCode.

hash code for this structure's pointer.

Annotations

@Override

newGuid	back to summary
public static Guid.GUID newGuid() Generates a new guid. Code taken from the standard jdk implementation (see UUID class). Returns:Guid.GUID the guid

newGuid

back to summary

public static Guid.GUID newGuid()

Generates a new guid. Code taken from the standard jdk implementation (see UUID class).

Returns:Guid.GUID: the guid

toByteArray	back to summary
public byte[] toByteArray() To byte array. Returns:byte[] the byte[]

toByteArray

back to summary

public byte[] toByteArray()

To byte array.

Returns:byte[]: the byte[]

toGuidString	back to summary
public String toGuidString() The value of this Guid, formatted as follows: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx. Returns:String the string

toGuidString

back to summary

public String toGuidString()

The value of this Guid, formatted as follows: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx.

Returns:String: the string

writeFieldsToMemory	back to summary
protected void writeFieldsToMemory() Write fields to backing memory.

com.sun.jna.platform.win32 back to summary

public Class Guid.GUID.ByReference

Class Inheritance

extends GUID
implements ByReference

java.lang.Object
com.sun.jna.Structure
com.sun.jna.platform.win32.Guid.GUID
com.sun.jna.platform.win32.Guid.GUID.ByReference

All Implemented Interfaces

com.sun.jna.Structure.ByReference

The Class ByReference.

Author: Tobias Wolf, [email protected]

Field Summary

Inherited from com.sun.jna.platform.win32.Guid.GUID:: Data1 Data2 Data3 Data4

Constructor Summary

Access	Constructor and Description
public	ByReference() Instantiates a new by reference.
public	ByReference(Guid.GUID the guid guid) Instantiates a new by reference.
public	ByReference(Pointer the memory memory) Instantiates a new by reference.

Method Summary

Inherited from com.sun.jna.platform.win32.Guid.GUID:: equals fromBinary fromString hashCode newGuid toByteArray toGuidString writeFieldsToMemory

Constructor Detail

ByReference	back to summary
public ByReference() Instantiates a new by reference.

ByReference	back to summary
public ByReference(Guid.GUID guid) Instantiates a new by reference. Parameters guid:Guid.GUID the guid

ByReference

back to summary

public ByReference(Guid.GUID guid)

Instantiates a new by reference.

Parameters

guid:Guid.GUID: the guid

ByReference	back to summary
public ByReference(Pointer memory) Instantiates a new by reference. Parameters memory:Pointer the memory

ByReference

back to summary

public ByReference(Pointer memory)

Instantiates a new by reference.

Parameters

memory:Pointer: the memory

com.sun.jna.platform.win32 back to summary

public Class Guid.GUID.ByValue

Class Inheritance

extends GUID
implements ByValue

java.lang.Object
com.sun.jna.Structure
com.sun.jna.platform.win32.Guid.GUID
com.sun.jna.platform.win32.Guid.GUID.ByValue

All Implemented Interfaces

com.sun.jna.Structure.ByValue

Field Summary

Inherited from com.sun.jna.platform.win32.Guid.GUID:: Data1 Data2 Data3 Data4

Constructor Summary

Access	Constructor and Description
public	ByValue()
public	ByValue(Guid.GUID guid)
public	ByValue(Pointer memory)

Method Summary

Inherited from com.sun.jna.platform.win32.Guid.GUID:: equals fromBinary fromString hashCode newGuid toByteArray toGuidString writeFieldsToMemory

Constructor Detail

ByValue	back to summary
public ByValue()

ByValue	back to summary
public ByValue(Guid.GUID guid)

ByValue	back to summary
public ByValue(Pointer memory)

com.sun.jna.platform.win32 back to summary

public Class Guid.IID

Class Inheritance

extends GUID

The Class IID.

Author: Tobias Wolf, [email protected]

Field Summary

Inherited from com.sun.jna.platform.win32.Guid.GUID:: Data1 Data2 Data3 Data4

Constructor Summary

Access	Constructor and Description
public	IID() Instantiates a new iid.
public	IID(Pointer the memory memory) Instantiates a new iid.
public	IID(String the iid iid) Instantiates a new iid.
public	IID(byte[] the data data) Instantiates a new iid.
public	IID(Guid.GUID guid)

Method Summary

Inherited from com.sun.jna.platform.win32.Guid.GUID:: equals fromBinary fromString hashCode newGuid toByteArray toGuidString writeFieldsToMemory

Constructor Detail

IID	back to summary
public IID() Instantiates a new iid.

IID	back to summary
public IID(Pointer memory) Instantiates a new iid. Parameters memory:Pointer the memory

IID

back to summary

public IID(Pointer memory)

Instantiates a new iid.

Parameters

memory:Pointer: the memory

IID	back to summary
public IID(String iid) Instantiates a new iid. Parameters iid:String the iid

IID

back to summary

public IID(String iid)

Instantiates a new iid.

Parameters

iid:String: the iid

IID	back to summary
public IID(byte[] data) Instantiates a new iid. Parameters data:byte[] the data

IID

back to summary

public IID(byte[] data)

Instantiates a new iid.

Parameters

data:byte[]: the data

IID	back to summary
public IID(Guid.GUID guid)

com.sun.jna.platform.win32 back to summary

public Class Guid.REFIID

Class Inheritance

extends PointerType

java.lang.Object
com.sun.jna.PointerType
com.sun.jna.platform.win32.Guid.REFIID

REFIID is a pointer to an IID.

This type needs to be seperate from IID, as the REFIID can be passed in from external code, that does not allow writes to memory.

With the normal JNA behaviour a structure, that crosses the native<-%gt;Java border will be autowritten, which causes a fault when written. Observed was this behaviour in COM-Callbacks, which get the REFIID passed into Invoke-method.

So a IID can't be used directly, although the typedef of REFIID (from MSDN):

typedef IID* REFIID;

and the jna behaviour is described as:

"When a function requires a pointer to a struct, a Java Structure should be used."

Constructor Summary

Access	Constructor and Description
public	REFIID() Instantiates a new refiid.
public	REFIID(Pointer the memory memory) Instantiates a new refiid.
public	REFIID(Guid.IID guid)

Method Summary

Modifier and Type	Method and Description
public boolean	equals(Object the reference object with which to compare. o) Overrides com.sun.jna.PointerType.equals. Instances of `PointerType` with identical pointers compare equal by default.
public Guid.IID	getValue()
public int	hashCode() Overrides com.sun.jna.PointerType.hashCode. The hash code for a `PointerType` is the same as that for its pointer.
public void	setValue(Guid.IID value)

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

Constructor Detail

REFIID	back to summary
public REFIID() Instantiates a new refiid.

REFIID

back to summary

public REFIID(Pointer memory)

Instantiates a new refiid.

Parameters

memory:Pointer: the memory

REFIID	back to summary
public REFIID(Guid.IID guid)

Method Detail

equals back to summary

public boolean equals(Object o)

Overrides com.sun.jna.PointerType.equals.

Doc from com.sun.jna.PointerType.equals.

Instances of PointerType with identical pointers compare equal by default.

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

getValue	back to summary
public Guid.IID getValue()

hashCode back to summary

public int hashCode()

Overrides com.sun.jna.PointerType.hashCode.

Doc from com.sun.jna.PointerType.hashCode.

The hash code for a PointerType is the same as that for its pointer.

Returns:int

Doc from java.lang.Object.hashCode.

a hash code value for this object.

Annotations

@Override

setValue	back to summary
public void setValue(Guid.IID value)

public Interface Guid

Nested and Inner Type Summary

Field Summary

Field Detail

public Class Guid.CLSID

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Constructor Detail

public Class Guid.CLSID.ByReference

Field Summary

Constructor Summary

Method Summary

Constructor Detail

public Class Guid.GUID

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

public Class Guid.GUID.ByReference

Field Summary

Constructor Summary

Method Summary

Constructor Detail

public Class Guid.GUID.ByValue

Field Summary

Constructor Summary

Method Summary

Constructor Detail

public Class Guid.IID

Field Summary

Constructor Summary

Method Summary

Constructor Detail

public Class Guid.REFIID

Constructor Summary

Method Summary

Constructor Detail

Method Detail