Top Description Inners Fields
com.sun.jna.platform.win32

public Interface WTypes

Imports
java.io.UnsupportedEncodingException, com.sun.jna.Memory, .Native, .Pointer, .PointerType, .Structure, com.sun.jna.platform.win32.WinDef.USHORT, com.sun.jna.ptr.ByReference
Constant defined in WTypes.h
Authors
scott.palmer, Tobias Wolf, [email protected]

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
WTypes.BSTR

BSTR wrapper.

public static class
WTypes.BSTRByReference

public static class
WTypes.LPOLESTR

public static class
WTypes.LPSTR

public static class
WTypes.LPWSTR

public static class
WTypes.VARTYPE

public static class
WTypes.VARTYPEByReference

Field Summary

Modifier and TypeField and Description
public static final int
CLSCTX_ACTIVATE_32_BIT_SERVER

public static final int
CLSCTX_ACTIVATE_64_BIT_SERVER

public static final int
CLSCTX_ACTIVATE_AAA_AS_IU

public static final int
CLSCTX_ALL

public static final int
CLSCTX_APPCONTAINER

public static final int
CLSCTX_DISABLE_AAA

public static final int
CLSCTX_ENABLE_AAA

public static final int
CLSCTX_ENABLE_CLOAKING

public static final int
CLSCTX_ENABLE_CODE_DOWNLOAD

public static final int
CLSCTX_FROM_DEFAULT_CONTEXT

public static final int
CLSCTX_INPROC_HANDLER

public static final int
CLSCTX_INPROC_HANDLER16

public static final int
CLSCTX_INPROC_SERVER

public static final int
CLSCTX_INPROC_SERVER16

public static final int
CLSCTX_LOCAL_SERVER

public static final int
CLSCTX_NO_CODE_DOWNLOAD

public static final int
CLSCTX_NO_CUSTOM_MARSHAL

public static final int
CLSCTX_NO_FAILURE_LOG

public static final int
CLSCTX_PS_DLL

public static final int
CLSCTX_REMOTE_SERVER

public static final int
CLSCTX_RESERVED1

public static final int
CLSCTX_RESERVED2

public static final int
CLSCTX_RESERVED3

public static final int
CLSCTX_RESERVED4

public static final int
CLSCTX_RESERVED5

public static final int
CLSCTX_SERVER

Field Detail

CLSCTX_ACTIVATE_32_BIT_SERVERback to summary
public static final int CLSCTX_ACTIVATE_32_BIT_SERVER
CLSCTX_ACTIVATE_64_BIT_SERVERback to summary
public static final int CLSCTX_ACTIVATE_64_BIT_SERVER
CLSCTX_ACTIVATE_AAA_AS_IUback to summary
public static final int CLSCTX_ACTIVATE_AAA_AS_IU
CLSCTX_ALLback to summary
public static final int CLSCTX_ALL
CLSCTX_APPCONTAINERback to summary
public static final int CLSCTX_APPCONTAINER
CLSCTX_DISABLE_AAAback to summary
public static final int CLSCTX_DISABLE_AAA
CLSCTX_ENABLE_AAAback to summary
public static final int CLSCTX_ENABLE_AAA
CLSCTX_ENABLE_CLOAKINGback to summary
public static final int CLSCTX_ENABLE_CLOAKING
CLSCTX_ENABLE_CODE_DOWNLOADback to summary
public static final int CLSCTX_ENABLE_CODE_DOWNLOAD
CLSCTX_FROM_DEFAULT_CONTEXTback to summary
public static final int CLSCTX_FROM_DEFAULT_CONTEXT
CLSCTX_INPROC_HANDLERback to summary
public static final int CLSCTX_INPROC_HANDLER
CLSCTX_INPROC_HANDLER16back to summary
public static final int CLSCTX_INPROC_HANDLER16
CLSCTX_INPROC_SERVERback to summary
public static final int CLSCTX_INPROC_SERVER
CLSCTX_INPROC_SERVER16back to summary
public static final int CLSCTX_INPROC_SERVER16
CLSCTX_LOCAL_SERVERback to summary
public static final int CLSCTX_LOCAL_SERVER
CLSCTX_NO_CODE_DOWNLOADback to summary
public static final int CLSCTX_NO_CODE_DOWNLOAD
CLSCTX_NO_CUSTOM_MARSHALback to summary
public static final int CLSCTX_NO_CUSTOM_MARSHAL
CLSCTX_NO_FAILURE_LOGback to summary
public static final int CLSCTX_NO_FAILURE_LOG
CLSCTX_PS_DLLback to summary
public static final int CLSCTX_PS_DLL
CLSCTX_REMOTE_SERVERback to summary
public static final int CLSCTX_REMOTE_SERVER
CLSCTX_RESERVED1back to summary
public static final int CLSCTX_RESERVED1
CLSCTX_RESERVED2back to summary
public static final int CLSCTX_RESERVED2
CLSCTX_RESERVED3back to summary
public static final int CLSCTX_RESERVED3
CLSCTX_RESERVED4back to summary
public static final int CLSCTX_RESERVED4
CLSCTX_RESERVED5back to summary
public static final int CLSCTX_RESERVED5
CLSCTX_SERVERback to summary
public static final int CLSCTX_SERVER
com.sun.jna.platform.win32 back to summary

public Class WTypes.BSTR

extends PointerType
Class Inheritance
BSTR wrapper.

From MSDN:

A BSTR (Basic string or binary string) is a string data type that is used by COM, Automation, and Interop functions. Use the BSTR data type in all interfaces that will be accessed from script.

The memory structure:

Length prefix
Length of the data array holding the string data and does not include the final two NULL characters.
Data string
UTF-16LE encoded bytes for the string.
Terminator
Two null characters

The "value" of the BSTR is the pointer to the start of the Data String, the length prefix is the four bytes before that.

The MSDN states, that a BSTR derived from a Nullpointer is treated as a string containing zero characters.

Constructor Summary

AccessConstructor and Description
public
BSTR()

public
BSTR(Pointer
A pointer to the string
pointer)

Instantiate a BSTR from a pointer.

public
BSTR(String value)

Deprecated Use OleAuto#SysAllocString(String) and OleAuto#SysFreeString(com.sun.jna.platform.win32.WTypes.BSTR)

Method Summary

Modifier and TypeMethod and Description
public String
getValue()

public void
setValue(String value)

Deprecated Users should not change the value of an allocated BSTR.
public String
toString()

Overrides com.sun.jna.PointerType.toString.

Returns a string representation of the object.
Inherited from com.sun.jna.PointerType:
equalsfromNativegetPointerhashCodenativeTypesetPointertoNative

Constructor Detail

BSTRback to summary
public BSTR()
BSTRback to summary
public BSTR(Pointer pointer)

Instantiate a BSTR from a pointer. The user is responsible for allocating and releasing memory for the BSTR, most commonly using OleAuto#SysAllocString(String) and OleAuto#SysFreeString(com.sun.jna.platform.win32.WTypes.BSTR)

Parameters
pointer:Pointer

A pointer to the string

BSTRback to summary
public BSTR(String value)

Deprecated

Use OleAuto#SysAllocString(String) and OleAuto#SysFreeString(com.sun.jna.platform.win32.WTypes.BSTR)

Annotations
@Deprecated

Method Detail

getValueback to summary
public String getValue()
setValueback to summary
public void setValue(String value)

Deprecated

Users should not change the value of an allocated BSTR.

Annotations
@Deprecated
toStringback 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
com.sun.jna.platform.win32 back to summary

public Class WTypes.BSTRByReference

extends ByReference
Class Inheritance

Constructor Summary

AccessConstructor and Description
public
BSTRByReference()

public
BSTRByReference(WTypes.BSTR
The BSTR to be referenced. Only the pointer is stored as a reference.
value)

Store a reference to the specified BSTR.

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the referenced String, if the reference is not null, null otherwise.
getString()

Returns the String represented by the referenced BSTR.

public WTypes.BSTR

Returns:

A new BSTR object corresponding to the memory referenced by this object.
getValue()

Returns a copy of the BSTR referenced by this object.

public void
setValue(WTypes.BSTR
The BSTR to be referenced. Only the pointer is stored as a reference.
value)

Store a reference to the specified BSTR.

Inherited from com.sun.jna.ptr.ByReference:
toString

Constructor Detail

BSTRByReferenceback to summary
public BSTRByReference()
BSTRByReferenceback to summary
public BSTRByReference(WTypes.BSTR value)

Store a reference to the specified BSTR. This method does not maintain a reference to the object passed as an argument. The user is responsible for allocating and freeing the memory associated with this BSTR.

Parameters
value:WTypes.BSTR

The BSTR to be referenced. Only the pointer is stored as a reference.

Method Detail

getStringback to summary
public String getString()

Returns the String represented by the referenced BSTR.

Returns:String

the referenced String, if the reference is not null, null otherwise.

getValueback to summary
public WTypes.BSTR getValue()

Returns a copy of the BSTR referenced by this object. The memory associated with the BSTR may be referenced by other objects/threads which may also free the underlying native memory.

Returns:WTypes.BSTR

A new BSTR object corresponding to the memory referenced by this object.

setValueback to summary
public void setValue(WTypes.BSTR value)

Store a reference to the specified BSTR. This method does not maintain a reference to the object passed as an argument. The user is responsible for allocating and freeing the memory associated with this BSTR.

Parameters
value:WTypes.BSTR

The BSTR to be referenced. Only the pointer is stored as a reference.

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

public Class WTypes.LPOLESTR

extends PointerType
Class Inheritance
Known Direct Subclasses
com.sun.jna.platform.win32.WTypes.LPOLESTR.ByReference

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
WTypes.LPOLESTR.ByReference

Constructor Summary

AccessConstructor and Description
public
LPOLESTR()

public
LPOLESTR(Pointer pointer)

public
LPOLESTR(String value)

Method Summary

Modifier and TypeMethod and Description
public String
getValue()

public void
setValue(String value)

public String
toString()

Overrides com.sun.jna.PointerType.toString.

Returns a string representation of the object.
Inherited from com.sun.jna.PointerType:
equalsfromNativegetPointerhashCodenativeTypesetPointertoNative

Constructor Detail

LPOLESTRback to summary
public LPOLESTR()
LPOLESTRback to summary
public LPOLESTR(Pointer pointer)
LPOLESTRback to summary
public LPOLESTR(String value)

Method Detail

getValueback to summary
public String getValue()
setValueback to summary
public void setValue(String value)
toStringback 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
com.sun.jna.platform.win32 back to summary

public Class WTypes.LPOLESTR.ByReference

extends LPOLESTR
implements ByReference
Class Inheritance
All Implemented Interfaces
com.sun.jna.Structure.ByReference

Constructor Summary

AccessConstructor and Description
public
ByReference()

Constructor Detail

ByReferenceback to summary
public ByReference()
com.sun.jna.platform.win32 back to summary

public Class WTypes.LPSTR

extends PointerType
Class Inheritance
Known Direct Subclasses
com.sun.jna.platform.win32.WTypes.LPSTR.ByReference

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
WTypes.LPSTR.ByReference

Constructor Summary

AccessConstructor and Description
public
LPSTR()

public
LPSTR(Pointer pointer)

public
LPSTR(String value)

Method Summary

Modifier and TypeMethod and Description
public String
getValue()

public void
setValue(String value)

public String
toString()

Overrides com.sun.jna.PointerType.toString.

Returns a string representation of the object.
Inherited from com.sun.jna.PointerType:
equalsfromNativegetPointerhashCodenativeTypesetPointertoNative

Constructor Detail

LPSTRback to summary
public LPSTR()
LPSTRback to summary
public LPSTR(Pointer pointer)
LPSTRback to summary
public LPSTR(String value)

Method Detail

getValueback to summary
public String getValue()
setValueback to summary
public void setValue(String value)
toStringback 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
com.sun.jna.platform.win32 back to summary

public Class WTypes.LPSTR.ByReference

extends LPSTR
implements ByReference
Class Inheritance
All Implemented Interfaces
com.sun.jna.Structure.ByReference

Constructor Summary

AccessConstructor and Description
public
ByReference()

Constructor Detail

ByReferenceback to summary
public ByReference()
com.sun.jna.platform.win32 back to summary

public Class WTypes.LPWSTR

extends PointerType
Class Inheritance
Known Direct Subclasses
com.sun.jna.platform.win32.WTypes.LPWSTR.ByReference

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static class
WTypes.LPWSTR.ByReference

Constructor Summary

AccessConstructor and Description
public
LPWSTR()

public
LPWSTR(Pointer pointer)

public
LPWSTR(String value)

Method Summary

Modifier and TypeMethod and Description
public String
getValue()

public void
setValue(String value)

public String
toString()

Overrides com.sun.jna.PointerType.toString.

Returns a string representation of the object.
Inherited from com.sun.jna.PointerType:
equalsfromNativegetPointerhashCodenativeTypesetPointertoNative

Constructor Detail

LPWSTRback to summary
public LPWSTR()
LPWSTRback to summary
public LPWSTR(Pointer pointer)
LPWSTRback to summary
public LPWSTR(String value)

Method Detail

getValueback to summary
public String getValue()
setValueback to summary
public void setValue(String value)
toStringback 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
com.sun.jna.platform.win32 back to summary

public Class WTypes.LPWSTR.ByReference

extends LPWSTR
implements ByReference
Class Inheritance
All Implemented Interfaces
com.sun.jna.Structure.ByReference

Constructor Summary

AccessConstructor and Description
public
ByReference()

Constructor Detail

ByReferenceback to summary
public ByReference()
com.sun.jna.platform.win32 back to summary

public Class WTypes.VARTYPE

extends USHORT
Class Inheritance

Field Summary

Modifier and TypeField and Description
private static final long
serialVersionUID

Hides com.sun.jna.IntegerType.serialVersionUID.

Inherited from com.sun.jna.platform.win32.WinDef.USHORT:
SIZE

Constructor Summary

AccessConstructor and Description
public
VARTYPE()

public
VARTYPE(int value)

Method Summary

Inherited from com.sun.jna.platform.win32.WinDef.USHORT:
compareTo

Field Detail

serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.sun.jna.IntegerType.serialVersionUID.

Constructor Detail

VARTYPEback to summary
public VARTYPE()
VARTYPEback to summary
public VARTYPE(int value)
com.sun.jna.platform.win32 back to summary

public Class WTypes.VARTYPEByReference

extends ByReference
Class Inheritance

Constructor Summary

AccessConstructor and Description
public
VARTYPEByReference()

public
VARTYPEByReference(WTypes.VARTYPE type)

public
VARTYPEByReference(short type)

Method Summary

Modifier and TypeMethod and Description
public WTypes.VARTYPE
getValue()

public void
setValue(WTypes.VARTYPE value)

Inherited from com.sun.jna.ptr.ByReference:
toString

Constructor Detail

VARTYPEByReferenceback to summary
public VARTYPEByReference()
VARTYPEByReferenceback to summary
public VARTYPEByReference(WTypes.VARTYPE type)
VARTYPEByReferenceback to summary
public VARTYPEByReference(short type)

Method Detail

getValueback to summary
public WTypes.VARTYPE getValue()
setValueback to summary
public void setValue(WTypes.VARTYPE value)