[svn-r25014] Purpose:

    Merge of r24937 from the trunk
    Adds H5free_memory to the API. This function should be used to free
    memory allocated by the library (e.g., returned values from
    H5Tget_tag, H5Pget_class_name, etc.).

    This is mainly to help Windows applications deal with multiple CRT 
    instances, but can also be helpful when a debug memory manager is
    being used or when the HDF5 API is being wrapped for managed languages
    like Python and Java.

Tested on:
    32-bit LE linux (jam) with fortran and C++
    64-bit BE linux (ostrich)
    64-bit LE linux (koala)

1 files changed, 25 insertions, 0 deletions

diff --git a/src/H5.c b/src/H5.c
index 1c6cae1..6354ad0 100644
--- a/src/H5.c
+++ b/src/H5.c
@@ -804,3 +804,28 @@ H5close(void)
     FUNC_LEAVE_API_NOFS(SUCCEED)
 } /* end H5close() */
 
+
+/*-------------------------------------------------------------------------
+ * Function:	H5free_memory
+ *
+ * Purpose:	Frees memory allocated by the library that it is the user's
+ *              responsibility to free.  Ensures that the same library
+ *              that was used to allocate the memory frees it.  Passing
+ *              NULL pointers is allowed.
+ *
+ * Return:	SUCCEED/FAIL
+ *
+ *-------------------------------------------------------------------------
+ */
+herr_t
+H5free_memory(void *mem)
+{
+    FUNC_ENTER_API_NOINIT
+    H5TRACE1("e", "*x", mem);
+
+    /* At this time, it is impossible for this to fail. */
+    HDfree(mem);
+
+    FUNC_LEAVE_API(SUCCEED)
+} /* end H5free_memory() */
+