Package com.sun.jna.platform.win32

Class WTypes.BSTR

java.lang.Object

com.sun.jna.PointerType

com.sun.jna.platform.win32.WTypes.BSTR

All Implemented Interfaces:

NativeMapped

Direct Known Subclasses:

WTypes.BSTR.ByReference, WTypes.LPSTR.ByReference, WTypes.LPWSTR.ByReference

Enclosing interface:

WTypes

public static class WTypes.BSTR
extends PointerType

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WTypes.BSTR.ByReference

Constructor Summary

Constructors

Constructor	Description
BSTR()
BSTR(Pointer pointer)
BSTR(String value)

Method Summary

Modifier and Type	Method	Description
String	getValue()
void	setValue(String value)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from class com.sun.jna.PointerType

equals, fromNative, getPointer, hashCode, nativeType, setPointer, toNative

Constructor Detail

BSTR

public BSTR()

BSTR

public BSTR(Pointer pointer)

BSTR

public BSTR(String value)

Method Detail

setValue

public void setValue(String value)

getValue

public String getValue()

toString

public String toString()

Overrides:

toString in class PointerType