Also deprecate BSTR string constructors

java-native-access · Jan 29, 2021 · f6ed4e1 · f6ed4e1
1 parent 190bdcb
commit f6ed4e1
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 1 deletion.
diff --git a/contrib/platform/src/com/sun/jna/platform/win32/WTypes.java b/contrib/platform/src/com/sun/jna/platform/win32/WTypes.java
@@ -103,15 +103,33 @@ public BSTR() {
             super(Pointer.NULL);
         }
 
+        /**
+         * Instantiate a BSTR from a pointer. The user is responsible for allocating and
+         * releasing memory for the {@link BSTR}, most commonly using
+         * {@link OleAuto#SysAllocString(String)} and
+         * {@link OleAuto#SysFreeString(BSTR)}
+         *
+         * @param pointer
+         *            A pointer to the string
+         */
         public BSTR(Pointer pointer) {
             super(pointer);
         }
 
+        /**
+         * @deprecated Use {@link OleAuto#SysAllocString(String)} and
+         *             {@link OleAuto#SysFreeString(BSTR)}
+         */
+        @Deprecated
         public BSTR(String value) {
             super();
             this.setValue(value);
         }
 
+        /**
+         * @deprecated Users should not change the value of an allocated {@link BSTR}.
+         */
+        @Deprecated
         public void setValue(String value) {
             if(value == null) {
                 value = "";

diff --git a/contrib/platform/test/com/sun/jna/platform/ByReferencePlatformToStringTest.java b/contrib/platform/test/com/sun/jna/platform/ByReferencePlatformToStringTest.java
@@ -31,6 +31,7 @@
 import com.sun.jna.Pointer;
 import com.sun.jna.platform.unix.X11.AtomByReference;
 import com.sun.jna.platform.unix.X11.WindowByReference;
+import com.sun.jna.platform.win32.OleAuto;
 import com.sun.jna.platform.win32.BaseTSD.ULONG_PTR;
 import com.sun.jna.platform.win32.BaseTSD.ULONG_PTRByReference;
 import com.sun.jna.platform.win32.HighLevelMonitorConfigurationAPI.MC_COLOR_TEMPERATURE;
@@ -84,9 +85,10 @@ public void testPlatformToStrings() {
         BOOLByReference boolbr = new BOOLByReference(new BOOL(true));
         parseAndTest(boolbr.toString(), "BOOL", "true");
 
-        BSTR b = new BSTR("bstr");
+        BSTR b = OleAuto.INSTANCE.SysAllocString("bstr");
         BSTRByReference bstrbr = new BSTRByReference(b.getPointer());
         parseAndTest(bstrbr.toString(), "BSTR", "bstr");
+        OleAuto.INSTANCE.SysFreeString(b);
 
         CHARByReference cbr = new CHARByReference(new CHAR(42));
         parseAndTest(cbr.toString(), "CHAR", "42");