Mercurial > hg > orthanc
diff Plugins/Include/orthanc/OrthancCPlugin.h @ 3584:75268c1ea309
Added note about metadata returned string lifetime
| author | Benjamin Golinvaux <bgo@osimis.io> |
|---|---|
| date | Sun, 01 Dec 2019 11:12:48 +0100 |
| parents | 5f1b1a8b2c28 |
| children | 7e303ba837d9 94f4a18a79cc |
line wrap: on
line diff
--- a/Plugins/Include/orthanc/OrthancCPlugin.h Mon Nov 25 05:41:28 2019 +0100 +++ b/Plugins/Include/orthanc/OrthancCPlugin.h Sun Dec 01 11:12:48 2019 +0100 @@ -2886,7 +2886,10 @@ * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). * @param instance The instance of interest. * @param metadata The metadata of interest. - * @return The metadata value if success, NULL if error. + * @return The metadata value if success, NULL if error. Please note that the + * returned string belongs to the instance object and must NOT be + * deallocated. Please make a copy of the string if you wish to access + * it later. * @ingroup Callbacks **/ ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceMetadata(