changeset 3569:367a3afa05a7

note about OrthancPluginStorageRead()
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 13 Nov 2019 11:56:39 +0100
parents 589238dcd782
children f05887b1d1bf fa982a45062b
files Plugins/Include/orthanc/OrthancCPlugin.h
diffstat 1 files changed, 6 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/Plugins/Include/orthanc/OrthancCPlugin.h	Tue Nov 12 18:28:23 2019 +0100
+++ b/Plugins/Include/orthanc/OrthancCPlugin.h	Wed Nov 13 11:56:39 2019 +0100
@@ -1148,6 +1148,12 @@
    * @param type The content type corresponding to this file. 
    * @return 0 if success, other value if error.
    * @ingroup Callbacks
+   * 
+   * @warning The "content" buffer *must* have been allocated using
+   * the "malloc()" function of your C standard library (i.e. nor
+   * "new[]", neither a pointer to a buffer). The "free()" function of
+   * your C standard library will automatically be invoked on the
+   * "content" pointer.
    **/
   typedef OrthancPluginErrorCode (*OrthancPluginStorageRead) (
     void** content,