orthanc: Plugins/Include/orthanc/OrthancCPlugin.h annotate

annotate Plugins/Include/orthanc/OrthancCPlugin.h @ 1608:adc6a5704cdb

OrthancPluginConvertPixelFormat

author	Sebastien Jodogne <s.jodogne@gmail.com>
date	Wed, 02 Sep 2015 13:58:08 +0200
parents	31f4adefb88f
children	c74495267acf

rev	line source
906 cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	1 /**
cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	2 * \mainpage
cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	3 *
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	4 * This C/C++ SDK allows external developers to create plugins that
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	5 * can be loaded into Orthanc to extend its functionality. Each
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	6 * Orthanc plugin must expose 4 public functions with the following
906 cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	7 * signatures:
cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	8 *
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	9 * -# <tt>int32_t OrthancPluginInitialize(const OrthancPluginContext* context)</tt>:
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	10 * This function is invoked by Orthanc when it loads the plugin on startup.
1041 2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	11 * The plugin must:
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	12 * - Check its compatibility with the Orthanc version using
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	13 * ::OrthancPluginCheckVersion().
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	14 * - Store the context pointer so that it can use the plugin
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	15 * services of Orthanc.
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	16 * - Register all its REST callbacks using ::OrthancPluginRegisterRestCallback().
1466 0cd0f2ad3599 Fix potential deadlock in the callbacks of plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1430 diff changeset	17 * - Possibly register its callback for received DICOM instances using ::OrthancPluginRegisterOnStoredInstanceCallback().
0cd0f2ad3599 Fix potential deadlock in the callbacks of plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1430 diff changeset	18 * - Possibly register its callback for changes to the DICOM store using ::OrthancPluginRegisterOnChangeCallback().
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	19 * - Possibly register a custom storage area using ::OrthancPluginRegisterStorageArea().
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	20 * - Possibly register a custom database back-end area using OrthancPluginRegisterDatabaseBackend().
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	21 * -# <tt>void OrthancPluginFinalize()</tt>:
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	22 * This function is invoked by Orthanc during its shutdown. The plugin
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	23 * must free all its memory.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	24 * -# <tt>const char* OrthancPluginGetName()</tt>:
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	25 * The plugin must return a short string to identify itself.
1041 2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	26 * -# <tt>const char* OrthancPluginGetVersion()</tt>:
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	27 * The plugin must return a string containing its version number.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	28 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	29 * The name and the version of a plugin is only used to prevent it
1602 292bce3f54ed JpegWriter Sebastien Jodogne <s.jodogne@gmail.com> parents: 1601 diff changeset	30 * from being loaded twice. Note that, in C++, it is mandatory to
292bce3f54ed JpegWriter Sebastien Jodogne <s.jodogne@gmail.com> parents: 1601 diff changeset	31 * declare these functions within an <tt>extern "C"</tt> section.
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	32 *
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	33 * To ensure multi-threading safety, the various REST callbacks are
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	34 * guaranteed to be executed in mutual exclusion since Orthanc
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	35 * 0.8.5. If this feature is undesired (notably when developing
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	36 * high-performance plugins handling simultaneous requests), use
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	37 * ::OrthancPluginRegisterRestCallbackNoLock().
906 cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	38 **/
cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	39
cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	40
cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	41
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	42 /**
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	43 * @defgroup Compression Compression
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	44 * @brief Functions to deal with images and compressed buffers.
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	45 *
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	46 * @defgroup REST REST
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	47 * @brief Functions to answer REST requests in a callback.
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	48 *
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	49 * @defgroup Callbacks Callbacks
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	50 * @brief Functions to register and manage callbacks by the plugins.
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	51 *
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	52 * @defgroup Orthanc Orthanc
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	53 * @brief Functions to access the content of the Orthanc server.
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	54 **/
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	55
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	56
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	57
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	58 /**
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	59 * @defgroup Toolbox Toolbox
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	60 * @brief Generic functions to help with the creation of plugins.
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	61 **/
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	62
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	63
906 cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	64
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	65 /**
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	66 * Orthanc - A Lightweight, RESTful DICOM Store
1288 6e7e5ed91c2d upgrade to year 2015 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1282 diff changeset	67 * Copyright (C) 2012-2015 Sebastien Jodogne, Medical Physics
6e7e5ed91c2d upgrade to year 2015 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1282 diff changeset	68 * Department, University Hospital of Liege, Belgium
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	69 *
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	70 * This program is free software: you can redistribute it and/or
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	71 * modify it under the terms of the GNU General Public License as
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	72 * published by the Free Software Foundation, either version 3 of the
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	73 * License, or (at your option) any later version.
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	74 *
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	75 * In addition, as a special exception, the copyright holders of this
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	76 * program give permission to link the code of its release with the
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	77 * OpenSSL project's "OpenSSL" library (or with modified versions of it
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	78 * that use the same license as the "OpenSSL" library), and distribute
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	79 * the linked executables. You must obey the GNU General Public License
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	80 * in all respects for all of the code used other than "OpenSSL". If you
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	81 * modify file(s) with this exception, you may extend this exception to
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	82 * your version of the file(s), but you are not obligated to do so. If
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	83 * you do not wish to do so, delete this exception statement from your
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	84 * version. If you delete this exception statement from all source files
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	85 * in the program, then also delete it here.
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	86 *
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	87 * This program is distributed in the hope that it will be useful, but
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	88 * WITHOUT ANY WARRANTY; without even the implied warranty of
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	89 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	90 * General Public License for more details.
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	91 *
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	92 * You should have received a copy of the GNU General Public License
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	93 * along with this program. If not, see <http://www.gnu.org/licenses/>.
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	94 **/
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	95
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	96
906 cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	97
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	98 #pragma once
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	99
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	100
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	101 #include <stdio.h>
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	102 #include <string.h>
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	103
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	104 #ifdef WIN32
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	105 #define ORTHANC_PLUGINS_API __declspec(dllexport)
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	106 #else
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	107 #define ORTHANC_PLUGINS_API
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	108 #endif
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	109
1039 5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	110 #define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 0
1407 d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	111 #define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 9
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	112 #define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 4
1039 5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	113
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	114
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	115
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	116 /********************************************************************
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	117 ** Check that function inlining is properly supported. The use of
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	118 ** inlining is required, to avoid the duplication of object code
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	119 ** between two compilation modules that would use the Orthanc Plugin
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	120 ** API.
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	121 ********************************************************************/
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	122
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	123 /* If the auto-detection of the "inline" keyword below does not work
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	124 automatically and that your compiler is known to properly support
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	125 inlining, uncomment the following #define and adapt the definition
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	126 of "static inline". */
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	127
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	128 /* #define ORTHANC_PLUGIN_INLINE static inline */
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	129
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	130 #ifndef ORTHANC_PLUGIN_INLINE
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	131 # if __STDC_VERSION__ >= 199901L
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	132 /* This is C99 or above: http://predef.sourceforge.net/prestd.html */
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	133 # define ORTHANC_PLUGIN_INLINE static inline
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	134 # elif defined(__cplusplus)
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	135 /* This is C++ */
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	136 # define ORTHANC_PLUGIN_INLINE static inline
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	137 # elif defined(__GNUC__)
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	138 /* This is GCC running in C89 mode */
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	139 # define ORTHANC_PLUGIN_INLINE static __inline
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	140 # elif defined(_MSC_VER)
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	141 /* This is Visual Studio running in C89 mode */
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	142 # define ORTHANC_PLUGIN_INLINE static __inline
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	143 # else
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	144 # error Your compiler is not known to support the "inline" keyword
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	145 # endif
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	146 #endif
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	147
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	148
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	149
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	150 /********************************************************************
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	151 ** Inclusion of standard libraries.
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	152 ********************************************************************/
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	153
1322 f497a72d9f71 fixes to the sample plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1313 diff changeset	154 /**
f497a72d9f71 fixes to the sample plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1313 diff changeset	155 * For Microsoft Visual Studio, a compatibility "stdint.h" can be
f497a72d9f71 fixes to the sample plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1313 diff changeset	156 * downloaded at the following URL:
f497a72d9f71 fixes to the sample plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1313 diff changeset	157 * https://orthanc.googlecode.com/hg/Resources/ThirdParty/VisualStudio/stdint.h
f497a72d9f71 fixes to the sample plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1313 diff changeset	158 **/
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	159 #include <stdint.h>
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	160
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	161 #include <stdlib.h>
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	162
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	163
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	164
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	165 /********************************************************************
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	166 ** Definition of the Orthanc Plugin API.
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	167 ********************************************************************/
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	168
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	169 /** @{ */
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	170
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	171 #ifdef __cplusplus
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	172 extern "C"
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	173 {
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	174 #endif
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	175
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	176 /**
1578 09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	177 * The various error codes that can be returned by the Orthanc core.
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	178 **/
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	179 typedef enum
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	180 {
1579 b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	181 OrthancPluginErrorCode_InternalError = -1 /!< Internal error /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	182 OrthancPluginErrorCode_Success = 0 /!< Success /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	183 OrthancPluginErrorCode_Plugin = 1 /!< Error encountered within the plugin engine /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	184 OrthancPluginErrorCode_NotImplemented = 2 /!< Not implemented yet /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	185 OrthancPluginErrorCode_ParameterOutOfRange = 3 /!< Parameter out of range /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	186 OrthancPluginErrorCode_NotEnoughMemory = 4 /!< Not enough memory /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	187 OrthancPluginErrorCode_BadParameterType = 5 /!< Bad type for a parameter /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	188 OrthancPluginErrorCode_BadSequenceOfCalls = 6 /!< Bad sequence of calls /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	189 OrthancPluginErrorCode_InexistentItem = 7 /!< Accessing an inexistent item /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	190 OrthancPluginErrorCode_BadRequest = 8 /!< Bad request /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	191 OrthancPluginErrorCode_NetworkProtocol = 9 /!< Error in the network protocol /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	192 OrthancPluginErrorCode_SystemCommand = 10 /!< Error while calling a system command /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	193 OrthancPluginErrorCode_Database = 11 /!< Error with the database engine /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	194 OrthancPluginErrorCode_UriSyntax = 12 /!< Badly formatted URI /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	195 OrthancPluginErrorCode_InexistentFile = 13 /!< Inexistent file /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	196 OrthancPluginErrorCode_CannotWriteFile = 14 /!< Cannot write to file /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	197 OrthancPluginErrorCode_BadFileFormat = 15 /!< Bad file format /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	198 OrthancPluginErrorCode_Timeout = 16 /!< Timeout /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	199 OrthancPluginErrorCode_UnknownResource = 17 /!< Unknown resource /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	200 OrthancPluginErrorCode_IncompatibleDatabaseVersion = 18 /!< Incompatible version of the database /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	201 OrthancPluginErrorCode_FullStorage = 19 /!< The file storage is full /,
1582 bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	202 OrthancPluginErrorCode_CorruptedFile = 20 /!< Corrupted file (e.g. inconsistent MD5 hash) /,
1579 b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	203 OrthancPluginErrorCode_InexistentTag = 21 /!< Inexistent tag /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	204 OrthancPluginErrorCode_ReadOnly = 22 /!< Cannot modify a read-only data structure /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	205 OrthancPluginErrorCode_IncompatibleImageFormat = 23 /!< Incompatible format of the images /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	206 OrthancPluginErrorCode_IncompatibleImageSize = 24 /!< Incompatible size of the images /,
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	207 OrthancPluginErrorCode_SharedLibrary = 25 /!< Error while using a shared library (plugin) /,
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	208 OrthancPluginErrorCode_UnknownPluginService = 26 /!< Plugin invoking an unknown service /,
1582 bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	209 OrthancPluginErrorCode_UnknownDicomTag = 27 /!< Unknown DICOM tag /,
1596 f2e3d030ea59 BadJson error code Sebastien Jodogne <s.jodogne@gmail.com> parents: 1595 diff changeset	210 OrthancPluginErrorCode_BadJson = 28 /!< Cannot parse a JSON document /,
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	211 OrthancPluginErrorCode_Unauthorized = 29 /!< Bad credentials were provided to an HTTP request /,
1582 bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	212 OrthancPluginErrorCode_SQLiteNotOpened = 1000 /!< SQLite: The database is not opened /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	213 OrthancPluginErrorCode_SQLiteAlreadyOpened = 1001 /!< SQLite: Connection is already open /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	214 OrthancPluginErrorCode_SQLiteCannotOpen = 1002 /!< SQLite: Unable to open the database /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	215 OrthancPluginErrorCode_SQLiteStatementAlreadyUsed = 1003 /!< SQLite: This cached statement is already being referred to /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	216 OrthancPluginErrorCode_SQLiteExecute = 1004 /!< SQLite: Cannot execute a command /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	217 OrthancPluginErrorCode_SQLiteRollbackWithoutTransaction = 1005 /!< SQLite: Rolling back a nonexistent transaction (have you called Begin()?) /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	218 OrthancPluginErrorCode_SQLiteCommitWithoutTransaction = 1006 /!< SQLite: Committing a nonexistent transaction /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	219 OrthancPluginErrorCode_SQLiteRegisterFunction = 1007 /!< SQLite: Unable to register a function /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	220 OrthancPluginErrorCode_SQLiteFlush = 1008 /!< SQLite: Unable to flush the database /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	221 OrthancPluginErrorCode_SQLiteCannotRun = 1009 /!< SQLite: Cannot run a cached statement /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	222 OrthancPluginErrorCode_SQLiteCannotStep = 1010 /!< SQLite: Cannot step over a cached statement /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	223 OrthancPluginErrorCode_SQLiteBindOutOfRange = 1011 /!< SQLite: Bing a value while out of range (serious error) /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	224 OrthancPluginErrorCode_SQLitePrepareStatement = 1012 /!< SQLite: Cannot prepare a cached statement /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	225 OrthancPluginErrorCode_SQLiteTransactionAlreadyStarted = 1013 /!< SQLite: Beginning the same transaction twice /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	226 OrthancPluginErrorCode_SQLiteTransactionCommit = 1014 /!< SQLite: Failure when committing the transaction /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	227 OrthancPluginErrorCode_SQLiteTransactionBegin = 1015 /!< SQLite: Cannot start a transaction /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	228 OrthancPluginErrorCode_DirectoryOverFile = 2000 /!< The directory to be created is already occupied by a regular file /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	229 OrthancPluginErrorCode_FileStorageCannotWrite = 2001 /!< Unable to create a subdirectory or a file in the file storage /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	230 OrthancPluginErrorCode_DirectoryExpected = 2002 /!< The specified path does not point to a directory /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	231 OrthancPluginErrorCode_HttpPortInUse = 2003 /!< The TCP port of the HTTP server is already in use /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	232 OrthancPluginErrorCode_DicomPortInUse = 2004 /!< The TCP port of the DICOM server is already in use /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	233 OrthancPluginErrorCode_BadHttpStatusInRest = 2005 /!< This HTTP status is not allowed in a REST API /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	234 OrthancPluginErrorCode_RegularFileExpected = 2006 /!< The specified path does not point to a regular file /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	235 OrthancPluginErrorCode_PathToExecutable = 2007 /!< Unable to get the path to the executable /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	236 OrthancPluginErrorCode_MakeDirectory = 2008 /!< Cannot create a directory /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	237 OrthancPluginErrorCode_BadApplicationEntityTitle = 2009 /!< An application entity title (AET) cannot be empty or be longer than 16 characters /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	238 OrthancPluginErrorCode_NoCFindHandler = 2010 /!< No request handler factory for DICOM C-FIND SCP /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	239 OrthancPluginErrorCode_NoCMoveHandler = 2011 /!< No request handler factory for DICOM C-MOVE SCP /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	240 OrthancPluginErrorCode_NoCStoreHandler = 2012 /!< No request handler factory for DICOM C-STORE SCP /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	241 OrthancPluginErrorCode_NoApplicationEntityFilter = 2013 /!< No application entity filter /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	242 OrthancPluginErrorCode_NoSopClassOrInstance = 2014 /!< DicomUserConnection: Unable to find the SOP class and instance /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	243 OrthancPluginErrorCode_NoPresentationContext = 2015 /!< DicomUserConnection: No acceptable presentation context for modality /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	244 OrthancPluginErrorCode_DicomFindUnavailable = 2016 /!< DicomUserConnection: The C-FIND command is not supported by the remote SCP /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	245 OrthancPluginErrorCode_DicomMoveUnavailable = 2017 /!< DicomUserConnection: The C-MOVE command is not supported by the remote SCP /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	246 OrthancPluginErrorCode_CannotStoreInstance = 2018 /!< Cannot store an instance /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	247 OrthancPluginErrorCode_CreateDicomNotString = 2019 /!< Only string values are supported when creating DICOM instances /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	248 OrthancPluginErrorCode_CreateDicomOverrideTag = 2020 /!< Trying to override a value inherited from a parent module /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	249 OrthancPluginErrorCode_CreateDicomUseContent = 2021 /!< Use \"Content\" to inject an image into a new DICOM instance /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	250 OrthancPluginErrorCode_CreateDicomNoPayload = 2022 /!< No payload is present for one instance in the series /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	251 OrthancPluginErrorCode_CreateDicomUseDataUriScheme = 2023 /!< The payload of the DICOM instance must be specified according to Data URI scheme /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	252 OrthancPluginErrorCode_CreateDicomBadParent = 2024 /!< Trying to attach a new DICOM instance to an inexistent resource /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	253 OrthancPluginErrorCode_CreateDicomParentIsInstance = 2025 /!< Trying to attach a new DICOM instance to an instance (must be a series, study or patient) /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	254 OrthancPluginErrorCode_CreateDicomParentEncoding = 2026 /!< Unable to get the encoding of the parent resource /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	255 OrthancPluginErrorCode_UnknownModality = 2027 /!< Unknown modality /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	256 OrthancPluginErrorCode_BadJobOrdering = 2028 /!< Bad ordering of filters in a job /,
1583 9ea3d082b064 got rid of custom exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1582 diff changeset	257 OrthancPluginErrorCode_JsonToLuaTable = 2029 /!< Cannot convert the given JSON object to a Lua table /,
9ea3d082b064 got rid of custom exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1582 diff changeset	258 OrthancPluginErrorCode_CannotCreateLua = 2030 /!< Cannot create the Lua context /,
9ea3d082b064 got rid of custom exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1582 diff changeset	259 OrthancPluginErrorCode_CannotExecuteLua = 2031 /!< Cannot execute a Lua command /,
9ea3d082b064 got rid of custom exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1582 diff changeset	260 OrthancPluginErrorCode_LuaAlreadyExecuted = 2032 /!< Arguments cannot be pushed after the Lua function is executed /,
9ea3d082b064 got rid of custom exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1582 diff changeset	261 OrthancPluginErrorCode_LuaBadOutput = 2033 /!< The Lua function does not give the expected number of outputs /,
9ea3d082b064 got rid of custom exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1582 diff changeset	262 OrthancPluginErrorCode_NotLuaPredicate = 2034 /!< The Lua function is not a predicate (only true/false outputs allowed) /,
9ea3d082b064 got rid of custom exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1582 diff changeset	263 OrthancPluginErrorCode_LuaReturnsNoString = 2035 /!< The Lua function does not return a string /,
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	264
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	265 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
1578 09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	266 } OrthancPluginErrorCode;
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	267
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	268
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	269 /**
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	270 * Forward declaration of one of the mandatory functions for Orthanc
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	271 * plugins.
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	272 **/
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	273 ORTHANC_PLUGINS_API const char* OrthancPluginGetName();
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	274
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	275
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	276 /**
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	277 * The various HTTP methods for a REST call.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	278 **/
894 690aeb4cb899 REST callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 888 diff changeset	279 typedef enum
690aeb4cb899 REST callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 888 diff changeset	280 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	281 OrthancPluginHttpMethod_Get = 1, /!< GET request /
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	282 OrthancPluginHttpMethod_Post = 2, /!< POST request /
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	283 OrthancPluginHttpMethod_Put = 3, /!< PUT request /
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	284 OrthancPluginHttpMethod_Delete = 4, /!< DELETE request /
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	285
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	286 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
896 c4053ac5db04 better plugni api Sebastien Jodogne <s.jodogne@gmail.com> parents: 894 diff changeset	287 } OrthancPluginHttpMethod;
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	288
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	289
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	290 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	291 * @brief The parameters of a REST request.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	292 * @ingroup Callbacks
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	293 **/
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	294 typedef struct
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	295 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	296 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	297 * @brief The HTTP method.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	298 **/
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	299 OrthancPluginHttpMethod method;
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	300
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	301 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	302 * @brief The number of groups of the regular expression.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	303 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	304 uint32_t groupsCount;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	305
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	306 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	307 * @brief The matched values for the groups of the regular expression.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	308 **/
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	309 const char* const* groups;
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	310
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	311 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	312 * @brief For a GET request, the number of GET parameters.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	313 **/
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	314 uint32_t getCount;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	315
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	316 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	317 * @brief For a GET request, the keys of the GET parameters.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	318 **/
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	319 const char* const* getKeys;
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	320
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	321 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	322 * @brief For a GET request, the values of the GET parameters.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	323 **/
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	324 const char* const* getValues;
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	325
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	326 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	327 * @brief For a PUT or POST request, the content of the body.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	328 **/
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	329 const char* body;
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	330
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	331 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	332 * @brief For a PUT or POST request, the number of bytes of the body.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	333 **/
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	334 uint32_t bodySize;
1041 2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	335
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	336
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	337 /* --------------------------------------------------
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	338 New in version 0.8.1
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	339 -------------------------------------------------- */
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	340
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	341 /**
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	342 * @brief The number of HTTP headers.
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	343 **/
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	344 uint32_t headersCount;
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	345
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	346 /**
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	347 * @brief The keys of the HTTP headers (always converted to low-case).
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	348 **/
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	349 const char* const* headersKeys;
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	350
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	351 /**
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	352 * @brief The values of the HTTP headers.
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	353 **/
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	354 const char* const* headersValues;
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	355
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	356 } OrthancPluginHttpRequest;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	357
1041 2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	358
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	359 typedef enum
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	360 {
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	361 /* Generic services */
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	362 _OrthancPluginService_LogInfo = 1,
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	363 _OrthancPluginService_LogWarning = 2,
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	364 _OrthancPluginService_LogError = 3,
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	365 _OrthancPluginService_GetOrthancPath = 4,
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	366 _OrthancPluginService_GetOrthancDirectory = 5,
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	367 _OrthancPluginService_GetConfigurationPath = 6,
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	368 _OrthancPluginService_SetPluginProperty = 7,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	369 _OrthancPluginService_GetGlobalProperty = 8,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	370 _OrthancPluginService_SetGlobalProperty = 9,
1280 d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	371 _OrthancPluginService_GetCommandLineArgumentsCount = 10,
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	372 _OrthancPluginService_GetCommandLineArgument = 11,
1407 d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	373 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
1424 fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	374 _OrthancPluginService_GetConfiguration = 13,
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	375 _OrthancPluginService_BufferCompression = 14,
1588 b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	376 _OrthancPluginService_ReadFile = 15,
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	377 _OrthancPluginService_WriteFile = 16,
1593 235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	378 _OrthancPluginService_GetErrorDescription = 17,
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	379 _OrthancPluginService_CallHttpClient = 18,
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	380
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	381 /* Registration of callbacks */
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	382 _OrthancPluginService_RegisterRestCallback = 1000,
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	383 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	384 _OrthancPluginService_RegisterStorageArea = 1002,
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	385 _OrthancPluginService_RegisterOnChangeCallback = 1003,
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	386 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	387
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	388 /* Sending answers to REST calls */
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	389 _OrthancPluginService_AnswerBuffer = 2000,
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	390 _OrthancPluginService_CompressAndAnswerPngImage = 2001, /* Unused as of Orthanc 0.9.4 */
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	391 _OrthancPluginService_Redirect = 2002,
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	392 _OrthancPluginService_SendHttpStatusCode = 2003,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	393 _OrthancPluginService_SendUnauthorized = 2004,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	394 _OrthancPluginService_SendMethodNotAllowed = 2005,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	395 _OrthancPluginService_SetCookie = 2006,
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	396 _OrthancPluginService_SetHttpHeader = 2007,
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	397 _OrthancPluginService_StartMultipartAnswer = 2008,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	398 _OrthancPluginService_SendMultipartItem = 2009,
1593 235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	399 _OrthancPluginService_SendHttpStatus = 2010,
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	400 _OrthancPluginService_CompressAndAnswerImage = 2011,
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	401
912 dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	402 /* Access to the Orthanc database and API */
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	403 _OrthancPluginService_GetDicomForInstance = 3000,
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	404 _OrthancPluginService_RestApiGet = 3001,
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	405 _OrthancPluginService_RestApiPost = 3002,
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	406 _OrthancPluginService_RestApiDelete = 3003,
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	407 _OrthancPluginService_RestApiPut = 3004,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	408 _OrthancPluginService_LookupPatient = 3005,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	409 _OrthancPluginService_LookupStudy = 3006,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	410 _OrthancPluginService_LookupSeries = 3007,
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	411 _OrthancPluginService_LookupInstance = 3008,
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	412 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	413 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	414 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	415 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	416 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	417
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	418 /* Access to DICOM instances */
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	419 _OrthancPluginService_GetInstanceRemoteAet = 4000,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	420 _OrthancPluginService_GetInstanceSize = 4001,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	421 _OrthancPluginService_GetInstanceData = 4002,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	422 _OrthancPluginService_GetInstanceJson = 4003,
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	423 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	424 _OrthancPluginService_HasInstanceMetadata = 4005,
1309 8f4487d8f79e new files for custom database back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 diff changeset	425 _OrthancPluginService_GetInstanceMetadata = 4006,
8f4487d8f79e new files for custom database back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 diff changeset	426
8f4487d8f79e new files for custom database back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 diff changeset	427 /* Services for plugins implementing a database back-end */
8f4487d8f79e new files for custom database back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 diff changeset	428 _OrthancPluginService_RegisterDatabaseBackend = 5000,
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	429 _OrthancPluginService_DatabaseAnswer = 5001,
1309 8f4487d8f79e new files for custom database back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 diff changeset	430
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	431 /* Primitives for handling images */
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	432 _OrthancPluginService_GetImagePixelFormat = 6000,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	433 _OrthancPluginService_GetImageWidth = 6001,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	434 _OrthancPluginService_GetImageHeight = 6002,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	435 _OrthancPluginService_GetImagePitch = 6003,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	436 _OrthancPluginService_GetImageBuffer = 6004,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	437 _OrthancPluginService_UncompressImage = 6005,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	438 _OrthancPluginService_FreeImage = 6006,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	439 _OrthancPluginService_CompressImage = 6007,
1608 adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	440 _OrthancPluginService_ConvertPixelFormat = 6008,
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	441
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	442 _OrthancPluginService_INTERNAL = 0x7fffffff
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	443 } _OrthancPluginService;
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	444
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	445
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	446 typedef enum
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	447 {
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	448 _OrthancPluginProperty_Description = 1,
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	449 _OrthancPluginProperty_RootUri = 2,
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	450 _OrthancPluginProperty_OrthancExplorer = 3,
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	451
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	452 _OrthancPluginProperty_INTERNAL = 0x7fffffff
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	453 } _OrthancPluginProperty;
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	454
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	455
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	456
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	457 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	458 * The memory layout of the pixels of an image.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	459 * @ingroup Compression
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	460 **/
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	461 typedef enum
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	462 {
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	463 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	464 * @brief Graylevel 8bpp image.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	465 *
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	466 * The image is graylevel. Each pixel is unsigned and stored in
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	467 * one byte.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	468 **/
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	469 OrthancPluginPixelFormat_Grayscale8 = 1,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	470
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	471 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	472 * @brief Graylevel, unsigned 16bpp image.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	473 *
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	474 * The image is graylevel. Each pixel is unsigned and stored in
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	475 * two bytes.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	476 **/
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	477 OrthancPluginPixelFormat_Grayscale16 = 2,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	478
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	479 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	480 * @brief Graylevel, signed 16bpp image.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	481 *
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	482 * The image is graylevel. Each pixel is signed and stored in two
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	483 * bytes.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	484 **/
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	485 OrthancPluginPixelFormat_SignedGrayscale16 = 3,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	486
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	487 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	488 * @brief Color image in RGB24 format.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	489 *
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	490 * This format describes a color image. The pixels are stored in 3
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	491 * consecutive bytes. The memory layout is RGB.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	492 **/
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	493 OrthancPluginPixelFormat_RGB24 = 4,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	494
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	495 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	496 * @brief Color image in RGBA32 format.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	497 *
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	498 * This format describes a color image. The pixels are stored in 4
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	499 * consecutive bytes. The memory layout is RGBA.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	500 **/
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	501 OrthancPluginPixelFormat_RGBA32 = 5,
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	502
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	503 OrthancPluginPixelFormat_Unknown = 6, /!< Unknown pixel format /
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	504
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	505 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	506 } OrthancPluginPixelFormat;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	507
894 690aeb4cb899 REST callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 888 diff changeset	508
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	509
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	510 /**
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	511 * The content types that are supported by Orthanc plugins.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	512 **/
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	513 typedef enum
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	514 {
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	515 OrthancPluginContentType_Unknown = 0, /!< Unknown content type /
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	516 OrthancPluginContentType_Dicom = 1, /!< DICOM /
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	517 OrthancPluginContentType_DicomAsJson = 2, /!< JSON summary of a DICOM file /
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	518
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	519 _OrthancPluginContentType_INTERNAL = 0x7fffffff
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	520 } OrthancPluginContentType;
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	521
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	522
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	523
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	524 /**
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	525 * The supported types of DICOM resources.
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	526 **/
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	527 typedef enum
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	528 {
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	529 OrthancPluginResourceType_Patient = 0, /!< Patient /
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	530 OrthancPluginResourceType_Study = 1, /!< Study /
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	531 OrthancPluginResourceType_Series = 2, /!< Series /
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	532 OrthancPluginResourceType_Instance = 3, /!< Instance /
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	533
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	534 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	535 } OrthancPluginResourceType;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	536
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	537
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	538
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	539 /**
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	540 * The supported types of changes that can happen to DICOM resources.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	541 * @ingroup Callbacks
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	542 **/
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	543 typedef enum
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	544 {
1198 1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	545 OrthancPluginChangeType_CompletedSeries = 0, /!< Series is now complete /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	546 OrthancPluginChangeType_Deleted = 1, /!< Deleted resource /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	547 OrthancPluginChangeType_NewChildInstance = 2, /!< A new instance was added to this resource /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	548 OrthancPluginChangeType_NewInstance = 3, /!< New instance received /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	549 OrthancPluginChangeType_NewPatient = 4, /!< New patient created /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	550 OrthancPluginChangeType_NewSeries = 5, /!< New series created /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	551 OrthancPluginChangeType_NewStudy = 6, /!< New study created /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	552 OrthancPluginChangeType_StablePatient = 7, /!< Timeout: No new instance in this patient /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	553 OrthancPluginChangeType_StableSeries = 8, /!< Timeout: No new instance in this series /
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	554 OrthancPluginChangeType_StableStudy = 9, /!< Timeout: No new instance in this study /
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	555
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	556 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	557 } OrthancPluginChangeType;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	558
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	559
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	560 /**
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	561 * The compression algorithms that are supported by the Orthanc core.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	562 * @ingroup Compression
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	563 **/
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	564 typedef enum
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	565 {
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	566 OrthancPluginCompressionType_Zlib = 0, /!< Standard zlib compression /
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	567 OrthancPluginCompressionType_ZlibWithSize = 1, /!< zlib, prefixed with uncompressed size (uint64_t) /
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	568 OrthancPluginCompressionType_Gzip = 2, /!< Standard gzip compression /
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	569 OrthancPluginCompressionType_GzipWithSize = 3, /!< gzip, prefixed with uncompressed size (uint64_t) /
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	570
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	571 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	572 } OrthancPluginCompressionType;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	573
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	574
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	575 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	576 * The image formats that are supported by the Orthanc core.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	577 * @ingroup Compression
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	578 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	579 typedef enum
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	580 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	581 OrthancPluginImageFormat_Png = 0, /!< Image compressed using PNG /
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	582 OrthancPluginImageFormat_Jpeg = 1, /!< Image compressed using JPEG /
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	583
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	584 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	585 } OrthancPluginImageFormat;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	586
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	587
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	588
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	589 /**
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	590 * @brief A memory buffer allocated by the core system of Orthanc.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	591 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	592 * A memory buffer allocated by the core system of Orthanc. When the
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	593 * content of the buffer is not useful anymore, it must be free by a
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	594 * call to ::OrthancPluginFreeMemoryBuffer().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	595 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	596 typedef struct
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	597 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	598 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	599 * @brief The content of the buffer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	600 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	601 void* data;
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	602
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	603 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	604 * @brief The number of bytes in the buffer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	605 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	606 uint32_t size;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	607 } OrthancPluginMemoryBuffer;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	608
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	609
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	610
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	611
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	612 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	613 * @brief Opaque structure that represents the HTTP connection to the client application.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	614 * @ingroup Callback
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	615 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	616 typedef struct _OrthancPluginRestOutput_t OrthancPluginRestOutput;
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	617
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	618
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	619
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	620 /**
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	621 * @brief Opaque structure that represents a DICOM instance received by Orthanc.
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	622 **/
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	623 typedef struct _OrthancPluginDicomInstance_t OrthancPluginDicomInstance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	624
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	625
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	626
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	627 /**
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	628 * @brief Opaque structure that represents a uncompressed image in memory.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	629 * @ingroup Compression
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	630 **/
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	631 typedef struct _OrthancPluginImage_t OrthancPluginImage;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	632
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	633
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	634
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	635 /**
908 e078ea944089 refactoring HttpOutput Sebastien Jodogne <s.jodogne@gmail.com> parents: 907 diff changeset	636 * @brief Signature of a callback function that answers to a REST request.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	637 * @ingroup Callbacks
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	638 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	639 typedef int32_t (*OrthancPluginRestCallback) (
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	640 OrthancPluginRestOutput* output,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	641 const char* url,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	642 const OrthancPluginHttpRequest* request);
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	643
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	644
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	645
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	646 /**
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	647 * @brief Signature of a callback function that is triggered when Orthanc receives a DICOM instance.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	648 * @ingroup Callbacks
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	649 **/
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	650 typedef int32_t (*OrthancPluginOnStoredInstanceCallback) (
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	651 OrthancPluginDicomInstance* instance,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	652 const char* instanceId);
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	653
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	654
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	655
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	656 /**
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	657 * @brief Signature of a callback function that is triggered when a change happens to some DICOM resource.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	658 * @ingroup Callbacks
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	659 **/
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	660 typedef int32_t (*OrthancPluginOnChangeCallback) (
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	661 OrthancPluginChangeType changeType,
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	662 OrthancPluginResourceType resourceType,
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	663 const char* resourceId);
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	664
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	665
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	666
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	667 /**
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	668 * @brief Signature of a function to free dynamic memory.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	669 **/
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	670 typedef void (OrthancPluginFree) (void buffer);
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	671
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	672
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	673
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	674 /**
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	675 * @brief Callback for writing to the storage area.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	676 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	677 * Signature of a callback function that is triggered when Orthanc writes a file to the storage area.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	678 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	679 * @param uuid The UUID of the file.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	680 * @param content The content of the file.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	681 * @param size The size of the file.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	682 * @param type The content type corresponding to this file.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	683 * @return 0 if success, other value if error.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	684 * @ingroup Callbacks
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	685 **/
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	686 typedef int32_t (*OrthancPluginStorageCreate) (
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	687 const char* uuid,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	688 const void* content,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	689 int64_t size,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	690 OrthancPluginContentType type);
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	691
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	692
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	693
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	694 /**
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	695 * @brief Callback for reading from the storage area.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	696 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	697 * Signature of a callback function that is triggered when Orthanc reads a file from the storage area.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	698 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	699 * @param content The content of the file (output).
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	700 * @param size The size of the file (output).
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	701 * @param uuid The UUID of the file of interest.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	702 * @param type The content type corresponding to this file.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	703 * @return 0 if success, other value if error.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	704 * @ingroup Callbacks
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	705 **/
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	706 typedef int32_t (*OrthancPluginStorageRead) (
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	707 void** content,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	708 int64_t* size,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	709 const char* uuid,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	710 OrthancPluginContentType type);
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	711
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	712
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	713
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	714 /**
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	715 * @brief Callback for removing a file from the storage area.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	716 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	717 * Signature of a callback function that is triggered when Orthanc deletes a file from the storage area.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	718 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	719 * @param uuid The UUID of the file to be removed.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	720 * @param type The content type corresponding to this file.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	721 * @return 0 if success, other value if error.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	722 * @ingroup Callbacks
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	723 **/
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	724 typedef int32_t (*OrthancPluginStorageRemove) (
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	725 const char* uuid,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	726 OrthancPluginContentType type);
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	727
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	728
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	729
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	730 /**
1297 501432928727 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1295 diff changeset	731 * @brief Data structure that contains information about the Orthanc core.
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	732 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	733 typedef struct _OrthancPluginContext_t
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	734 {
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	735 void* pluginsManager;
357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	736 const char* orthancVersion;
357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	737 OrthancPluginFree Free;
357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	738 OrthancPluginErrorCode (InvokeService) (struct _OrthancPluginContext_t context,
357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	739 _OrthancPluginService service,
357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	740 const void* params);
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	741 } OrthancPluginContext;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	742
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	743
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	744
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	745 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	746 * @brief Free a string.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	747 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	748 * Free a string that was allocated by the core system of Orthanc.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	749 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	750 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	751 * @param str The string to be freed.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	752 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	753 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeString(
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	754 OrthancPluginContext* context,
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	755 char* str)
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	756 {
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	757 if (str != NULL)
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	758 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	759 context->Free(str);
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	760 }
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	761 }
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	762
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	763
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	764 /**
1041 2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	765 * @brief Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
1039 5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	766 *
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	767 * This function checks whether the version of this C header is
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	768 * compatible with the current version of Orthanc. The result of
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	769 * this function should always be checked in the
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	770 * OrthancPluginInitialize() entry point of the plugin.
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	771 *
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	772 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	773 * @return 1 if and only if the versions are compatible. If the
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	774 * result is 0, the initialization of the plugin should fail.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	775 * @ingroup Callbacks
1039 5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	776 **/
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	777 ORTHANC_PLUGIN_INLINE int OrthancPluginCheckVersion(
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	778 OrthancPluginContext* context)
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	779 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	780 int major, minor, revision;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	781
1579 b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	782 if (sizeof(int32_t) != sizeof(OrthancPluginErrorCode) \|\|
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	783 sizeof(int32_t) != sizeof(OrthancPluginHttpMethod) \|\|
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	784 sizeof(int32_t) != sizeof(_OrthancPluginService) \|\|
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	785 sizeof(int32_t) != sizeof(_OrthancPluginProperty) \|\|
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	786 sizeof(int32_t) != sizeof(OrthancPluginPixelFormat) \|\|
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	787 sizeof(int32_t) != sizeof(OrthancPluginContentType) \|\|
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	788 sizeof(int32_t) != sizeof(OrthancPluginResourceType) \|\|
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	789 sizeof(int32_t) != sizeof(OrthancPluginChangeType) \|\|
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	790 sizeof(int32_t) != sizeof(OrthancPluginCompressionType) \|\|
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	791 sizeof(int32_t) != sizeof(OrthancPluginImageFormat))
1578 09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	792 {
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	793 /* Mismatch in the size of the enumerations */
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	794 return 0;
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	795 }
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	796
1039 5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	797 /* Assume compatibility with the mainline */
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	798 if (!strcmp(context->orthancVersion, "mainline"))
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	799 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	800 return 1;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	801 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	802
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	803 /* Parse the version of the Orthanc core */
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	804 if (
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	805 #ifdef _MSC_VER
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	806 sscanf_s
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	807 #else
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	808 sscanf
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	809 #endif
1303 bba8a47922d1 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1297 diff changeset	810 (context->orthancVersion, "%4d.%4d.%4d", &major, &minor, &revision) != 3)
1039 5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	811 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	812 return 0;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	813 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	814
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	815 /* Check the major number of the version */
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	816
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	817 if (major > ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	818 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	819 return 1;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	820 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	821
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	822 if (major < ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	823 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	824 return 0;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	825 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	826
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	827 /* Check the minor number of the version */
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	828
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	829 if (minor > ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	830 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	831 return 1;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	832 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	833
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	834 if (minor < ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	835 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	836 return 0;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	837 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	838
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	839 /* Check the revision number of the version */
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	840
1040 d06186cdc502 check plugin version in samples Sebastien Jodogne <s.jodogne@gmail.com> parents: 1039 diff changeset	841 if (revision >= ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER)
1039 5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	842 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	843 return 1;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	844 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	845 else
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	846 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	847 return 0;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	848 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	849 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	850
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	851
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	852 /**
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	853 * @brief Free a memory buffer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	854 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	855 * Free a memory buffer that was allocated by the core system of Orthanc.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	856 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	857 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	858 * @param buffer The memory buffer to release.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	859 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	860 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeMemoryBuffer(
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	861 OrthancPluginContext* context,
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	862 OrthancPluginMemoryBuffer* buffer)
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	863 {
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	864 context->Free(buffer->data);
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	865 }
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	866
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	867
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	868 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	869 * @brief Log an error.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	870 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	871 * Log an error message using the Orthanc logging system.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	872 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	873 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	874 * @param message The message to be logged.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	875 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	876 ORTHANC_PLUGIN_INLINE void OrthancPluginLogError(
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	877 OrthancPluginContext* context,
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	878 const char* message)
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	879 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	880 context->InvokeService(context, _OrthancPluginService_LogError, message);
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	881 }
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	882
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	883
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	884 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	885 * @brief Log a warning.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	886 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	887 * Log a warning message using the Orthanc logging system.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	888 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	889 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	890 * @param message The message to be logged.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	891 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	892 ORTHANC_PLUGIN_INLINE void OrthancPluginLogWarning(
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	893 OrthancPluginContext* context,
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	894 const char* message)
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	895 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	896 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	897 }
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	898
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	899
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	900 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	901 * @brief Log an information.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	902 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	903 * Log an information message using the Orthanc logging system.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	904 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	905 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	906 * @param message The message to be logged.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	907 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	908 ORTHANC_PLUGIN_INLINE void OrthancPluginLogInfo(
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	909 OrthancPluginContext* context,
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	910 const char* message)
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	911 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	912 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	913 }
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	914
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	915
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	916
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	917 typedef struct
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	918 {
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	919 const char* pathRegularExpression;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	920 OrthancPluginRestCallback callback;
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	921 } _OrthancPluginRestCallback;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	922
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	923 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	924 * @brief Register a REST callback.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	925 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	926 * This function registers a REST callback against a regular
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	927 * expression for a URI. This function must be called during the
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	928 * initialization of the plugin, i.e. inside the
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	929 * OrthancPluginInitialize() public function.
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	930 *
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	931 * Each REST callback is guaranteed to run in mutual exclusion.
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	932 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	933 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	934 * @param pathRegularExpression Regular expression for the URI. May contain groups.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	935 * @param callback The callback function to handle the REST call.
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	936 * @see OrthancPluginRegisterRestCallbackNoLock()
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	937 * @ingroup Callbacks
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	938 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	939 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterRestCallback(
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	940 OrthancPluginContext* context,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	941 const char* pathRegularExpression,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	942 OrthancPluginRestCallback callback)
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	943 {
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	944 _OrthancPluginRestCallback params;
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	945 params.pathRegularExpression = pathRegularExpression;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	946 params.callback = callback;
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	947 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, &params);
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	948 }
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	949
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	950
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	951
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	952 /**
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	953 * @brief Register a REST callback, without locking.
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	954 *
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	955 * This function registers a REST callback against a regular
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	956 * expression for a URI. This function must be called during the
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	957 * initialization of the plugin, i.e. inside the
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	958 * OrthancPluginInitialize() public function.
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	959 *
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	960 * Contrarily to OrthancPluginRegisterRestCallback(), the callback
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	961 * will NOT be invoked in mutual exclusion. This can be useful for
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	962 * high-performance plugins that must handle concurrent requests
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	963 * (Orthanc uses a pool of threads, one thread being assigned to
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	964 * each incoming HTTP request). Of course, it is up to the plugin to
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	965 * implement the required locking mechanisms.
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	966 *
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	967 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	968 * @param pathRegularExpression Regular expression for the URI. May contain groups.
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	969 * @param callback The callback function to handle the REST call.
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	970 * @see OrthancPluginRegisterRestCallback()
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	971 * @ingroup Callbacks
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	972 **/
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	973 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterRestCallbackNoLock(
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	974 OrthancPluginContext* context,
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	975 const char* pathRegularExpression,
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	976 OrthancPluginRestCallback callback)
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	977 {
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	978 _OrthancPluginRestCallback params;
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	979 params.pathRegularExpression = pathRegularExpression;
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	980 params.callback = callback;
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	981 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, &params);
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	982 }
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	983
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	984
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	985
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	986 typedef struct
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	987 {
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	988 OrthancPluginOnStoredInstanceCallback callback;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	989 } _OrthancPluginOnStoredInstanceCallback;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	990
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	991 /**
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	992 * @brief Register a callback for received instances.
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	993 *
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	994 * This function registers a callback function that is called
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	995 * whenever a new DICOM instance is stored into the Orthanc core.
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	996 *
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	997 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	998 * @param callback The callback function.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	999 * @ingroup Callbacks
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1000 **/
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1001 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterOnStoredInstanceCallback(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1002 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1003 OrthancPluginOnStoredInstanceCallback callback)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1004 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1005 _OrthancPluginOnStoredInstanceCallback params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1006 params.callback = callback;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1007
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1008 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, &params);
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1009 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1010
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1011
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1012
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1013 typedef struct
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1014 {
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1015 OrthancPluginRestOutput* output;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1016 const char* answer;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1017 uint32_t answerSize;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1018 const char* mimeType;
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1019 } _OrthancPluginAnswerBuffer;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1020
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1021 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1022 * @brief Answer to a REST request.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1023 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1024 * This function answers to a REST request with the content of a memory buffer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1025 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1026 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1027 * @param output The HTTP connection to the client application.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1028 * @param answer Pointer to the memory buffer containing the answer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1029 * @param answerSize Number of bytes of the answer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1030 * @param mimeType The MIME type of the answer.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1031 * @ingroup REST
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1032 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1033 ORTHANC_PLUGIN_INLINE void OrthancPluginAnswerBuffer(
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1034 OrthancPluginContext* context,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1035 OrthancPluginRestOutput* output,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1036 const char* answer,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1037 uint32_t answerSize,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1038 const char* mimeType)
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1039 {
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1040 _OrthancPluginAnswerBuffer params;
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1041 params.output = output;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1042 params.answer = answer;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1043 params.answerSize = answerSize;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1044 params.mimeType = mimeType;
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1045 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, &params);
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1046 }
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1047
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1048
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1049 typedef struct
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1050 {
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1051 OrthancPluginRestOutput* output;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1052 OrthancPluginPixelFormat format;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1053 uint32_t width;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1054 uint32_t height;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1055 uint32_t pitch;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1056 const void* buffer;
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1057 } _OrthancPluginCompressAndAnswerPngImage;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1058
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1059 typedef struct
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1060 {
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1061 OrthancPluginRestOutput* output;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1062 OrthancPluginImageFormat imageFormat;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1063 OrthancPluginPixelFormat pixelFormat;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1064 uint32_t width;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1065 uint32_t height;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1066 uint32_t pitch;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1067 const void* buffer;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1068 uint8_t quality;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1069 } _OrthancPluginCompressAndAnswerImage;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1070
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1071
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1072 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1073 * @brief Answer to a REST request with a PNG image.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1074 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1075 * This function answers to a REST request with a PNG image. The
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1076 * parameters of this function describe a memory buffer that
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1077 * contains an uncompressed image. The image will be automatically compressed
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1078 * as a PNG image by the core system of Orthanc.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1079 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1080 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1081 * @param output The HTTP connection to the client application.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1082 * @param format The memory layout of the uncompressed image.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1083 * @param width The width of the image.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1084 * @param height The height of the image.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1085 * @param pitch The pitch of the image (i.e. the number of bytes
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1086 * between 2 successive lines of the image in the memory buffer).
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1087 * @param buffer The memory buffer containing the uncompressed image.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1088 * @ingroup REST
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1089 **/
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1090 ORTHANC_PLUGIN_INLINE void OrthancPluginCompressAndAnswerPngImage(
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1091 OrthancPluginContext* context,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1092 OrthancPluginRestOutput* output,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1093 OrthancPluginPixelFormat format,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1094 uint32_t width,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1095 uint32_t height,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1096 uint32_t pitch,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1097 const void* buffer)
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1098 {
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1099 _OrthancPluginCompressAndAnswerImage params;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1100 params.output = output;
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1101 params.imageFormat = OrthancPluginImageFormat_Png;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1102 params.pixelFormat = format;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1103 params.width = width;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1104 params.height = height;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1105 params.pitch = pitch;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1106 params.buffer = buffer;
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1107 params.quality = 0; /* No quality for PNG */
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1108 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, &params);
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1109 }
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1110
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1111
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1112
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1113 typedef struct
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1114 {
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1115 OrthancPluginMemoryBuffer* target;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1116 const char* instanceId;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1117 } _OrthancPluginGetDicomForInstance;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1118
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1119 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1120 * @brief Retrieve a DICOM instance using its Orthanc identifier.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1121 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1122 * Retrieve a DICOM instance using its Orthanc identifier. The DICOM
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1123 * file is stored into a newly allocated memory buffer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1124 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1125 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1126 * @param target The target memory buffer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1127 * @param instanceId The Orthanc identifier of the DICOM instance of interest.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1128 * @return 0 if success, or the error code if failure.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1129 * @ingroup Orthanc
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1130 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1131 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginGetDicomForInstance(
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1132 OrthancPluginContext* context,
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1133 OrthancPluginMemoryBuffer* target,
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1134 const char* instanceId)
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1135 {
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1136 _OrthancPluginGetDicomForInstance params;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1137 params.target = target;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1138 params.instanceId = instanceId;
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1139 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, &params);
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1140 }
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1141
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	1142
912 dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1143
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1144 typedef struct
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1145 {
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1146 OrthancPluginMemoryBuffer* target;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1147 const char* uri;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1148 } _OrthancPluginRestApiGet;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1149
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1150 /**
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1151 * @brief Make a GET call to the built-in Orthanc REST API.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1152 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1153 * Make a GET call to the built-in Orthanc REST API. The result to
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1154 * the query is stored into a newly allocated memory buffer.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1155 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1156 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1157 * @param target The target memory buffer.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1158 * @param uri The URI in the built-in Orthanc API.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1159 * @return 0 if success, or the error code if failure.
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	1160 * @see OrthancPluginRestApiGetAfterPlugins
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1161 * @ingroup Orthanc
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1162 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1163 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiGet(
912 dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1164 OrthancPluginContext* context,
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1165 OrthancPluginMemoryBuffer* target,
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1166 const char* uri)
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1167 {
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1168 _OrthancPluginRestApiGet params;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1169 params.target = target;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1170 params.uri = uri;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1171 return context->InvokeService(context, _OrthancPluginService_RestApiGet, &params);
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1172 }
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1173
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1174
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1175
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1176 /**
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1177 * @brief Make a GET call to the REST API, as tainted by the plugins.
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1178 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1179 * Make a GET call to the Orthanc REST API, after all the plugins
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1180 * are applied. In other words, if some plugin overrides or adds the
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1181 * called URI to the built-in Orthanc REST API, this call will
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1182 * return the result provided by this plugin. The result to the
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1183 * query is stored into a newly allocated memory buffer.
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1184 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1185 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1186 * @param target The target memory buffer.
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1187 * @param uri The URI in the built-in Orthanc API.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1188 * @return 0 if success, or the error code if failure.
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	1189 * @see OrthancPluginRestApiGet
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1190 * @ingroup Orthanc
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1191 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1192 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiGetAfterPlugins(
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1193 OrthancPluginContext* context,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1194 OrthancPluginMemoryBuffer* target,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1195 const char* uri)
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1196 {
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1197 _OrthancPluginRestApiGet params;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1198 params.target = target;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1199 params.uri = uri;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1200 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, &params);
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1201 }
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1202
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1203
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1204
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1205 typedef struct
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1206 {
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1207 OrthancPluginMemoryBuffer* target;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1208 const char* uri;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1209 const char* body;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1210 uint32_t bodySize;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1211 } _OrthancPluginRestApiPostPut;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1212
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1213 /**
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1214 * @brief Make a POST call to the built-in Orthanc REST API.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1215 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1216 * Make a POST call to the built-in Orthanc REST API. The result to
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1217 * the query is stored into a newly allocated memory buffer.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1218 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1219 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1220 * @param target The target memory buffer.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1221 * @param uri The URI in the built-in Orthanc API.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1222 * @param body The body of the POST request.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1223 * @param bodySize The size of the body.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1224 * @return 0 if success, or the error code if failure.
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	1225 * @see OrthancPluginRestApiPostAfterPlugins
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1226 * @ingroup Orthanc
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1227 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1228 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPost(
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1229 OrthancPluginContext* context,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1230 OrthancPluginMemoryBuffer* target,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1231 const char* uri,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1232 const char* body,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1233 uint32_t bodySize)
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1234 {
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1235 _OrthancPluginRestApiPostPut params;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1236 params.target = target;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1237 params.uri = uri;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1238 params.body = body;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1239 params.bodySize = bodySize;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1240 return context->InvokeService(context, _OrthancPluginService_RestApiPost, &params);
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1241 }
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1242
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1243
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1244 /**
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1245 * @brief Make a POST call to the REST API, as tainted by the plugins.
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1246 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1247 * Make a POST call to the Orthanc REST API, after all the plugins
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1248 * are applied. In other words, if some plugin overrides or adds the
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1249 * called URI to the built-in Orthanc REST API, this call will
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1250 * return the result provided by this plugin. The result to the
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1251 * query is stored into a newly allocated memory buffer.
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1252 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1253 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1254 * @param target The target memory buffer.
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1255 * @param uri The URI in the built-in Orthanc API.
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1256 * @param body The body of the POST request.
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1257 * @param bodySize The size of the body.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1258 * @return 0 if success, or the error code if failure.
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	1259 * @see OrthancPluginRestApiPost
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1260 * @ingroup Orthanc
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1261 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1262 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPostAfterPlugins(
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1263 OrthancPluginContext* context,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1264 OrthancPluginMemoryBuffer* target,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1265 const char* uri,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1266 const char* body,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1267 uint32_t bodySize)
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1268 {
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1269 _OrthancPluginRestApiPostPut params;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1270 params.target = target;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1271 params.uri = uri;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1272 params.body = body;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1273 params.bodySize = bodySize;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1274 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, &params);
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1275 }
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1276
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1277
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1278
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1279 /**
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1280 * @brief Make a DELETE call to the built-in Orthanc REST API.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1281 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1282 * Make a DELETE call to the built-in Orthanc REST API.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1283 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1284 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1285 * @param uri The URI to delete in the built-in Orthanc API.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1286 * @return 0 if success, or the error code if failure.
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	1287 * @see OrthancPluginRestApiDeleteAfterPlugins
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1288 * @ingroup Orthanc
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1289 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1290 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiDelete(
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1291 OrthancPluginContext* context,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1292 const char* uri)
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1293 {
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1294 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1295 }
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1296
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1297
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1298 /**
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1299 * @brief Make a DELETE call to the REST API, as tainted by the plugins.
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1300 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1301 * Make a DELETE call to the Orthanc REST API, after all the plugins
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1302 * are applied. In other words, if some plugin overrides or adds the
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1303 * called URI to the built-in Orthanc REST API, this call will
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1304 * return the result provided by this plugin.
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1305 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1306 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1307 * @param uri The URI to delete in the built-in Orthanc API.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1308 * @return 0 if success, or the error code if failure.
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	1309 * @see OrthancPluginRestApiDelete
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1310 * @ingroup Orthanc
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1311 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1312 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1313 OrthancPluginContext* context,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1314 const char* uri)
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1315 {
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1316 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1317 }
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1318
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1319
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1320
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1321 /**
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1322 * @brief Make a PUT call to the built-in Orthanc REST API.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1323 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1324 * Make a PUT call to the built-in Orthanc REST API. The result to
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1325 * the query is stored into a newly allocated memory buffer.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1326 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1327 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1328 * @param target The target memory buffer.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1329 * @param uri The URI in the built-in Orthanc API.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1330 * @param body The body of the PUT request.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1331 * @param bodySize The size of the body.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1332 * @return 0 if success, or the error code if failure.
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	1333 * @see OrthancPluginRestApiPutAfterPlugins
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1334 * @ingroup Orthanc
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1335 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1336 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPut(
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1337 OrthancPluginContext* context,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1338 OrthancPluginMemoryBuffer* target,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1339 const char* uri,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1340 const char* body,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1341 uint32_t bodySize)
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1342 {
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1343 _OrthancPluginRestApiPostPut params;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1344 params.target = target;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1345 params.uri = uri;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1346 params.body = body;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1347 params.bodySize = bodySize;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1348 return context->InvokeService(context, _OrthancPluginService_RestApiPut, &params);
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1349 }
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1350
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1351
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1352
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1353 /**
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1354 * @brief Make a PUT call to the REST API, as tainted by the plugins.
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1355 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1356 * Make a PUT call to the Orthanc REST API, after all the plugins
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1357 * are applied. In other words, if some plugin overrides or adds the
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1358 * called URI to the built-in Orthanc REST API, this call will
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1359 * return the result provided by this plugin. The result to the
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1360 * query is stored into a newly allocated memory buffer.
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1361 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1362 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1363 * @param target The target memory buffer.
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1364 * @param uri The URI in the built-in Orthanc API.
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1365 * @param body The body of the PUT request.
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1366 * @param bodySize The size of the body.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1367 * @return 0 if success, or the error code if failure.
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	1368 * @see OrthancPluginRestApiPut
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1369 * @ingroup Orthanc
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1370 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1371 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPutAfterPlugins(
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1372 OrthancPluginContext* context,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1373 OrthancPluginMemoryBuffer* target,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1374 const char* uri,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1375 const char* body,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1376 uint32_t bodySize)
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1377 {
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1378 _OrthancPluginRestApiPostPut params;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1379 params.target = target;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1380 params.uri = uri;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1381 params.body = body;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1382 params.bodySize = bodySize;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1383 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, &params);
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1384 }
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1385
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1386
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1387
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1388 typedef struct
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1389 {
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1390 OrthancPluginRestOutput* output;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1391 const char* argument;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1392 } _OrthancPluginOutputPlusArgument;
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1393
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1394 /**
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1395 * @brief Redirect a REST request.
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1396 *
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1397 * This function answers to a REST request by redirecting the user
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1398 * to another URI using HTTP status 301.
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1399 *
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1400 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1401 * @param output The HTTP connection to the client application.
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1402 * @param redirection Where to redirect.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1403 * @ingroup REST
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1404 **/
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1405 ORTHANC_PLUGIN_INLINE void OrthancPluginRedirect(
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1406 OrthancPluginContext* context,
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1407 OrthancPluginRestOutput* output,
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1408 const char* redirection)
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1409 {
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1410 _OrthancPluginOutputPlusArgument params;
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1411 params.output = output;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1412 params.argument = redirection;
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1413 context->InvokeService(context, _OrthancPluginService_Redirect, &params);
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1414 }
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1415
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1416
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1417
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1418 typedef struct
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1419 {
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1420 char** result;
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1421 const char* argument;
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1422 } _OrthancPluginRetrieveDynamicString;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1423
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1424 /**
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1425 * @brief Look for a patient.
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1426 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1427 * Look for a patient stored in Orthanc, using its Patient ID tag (0x0010, 0x0020).
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1428 * This function uses the database index to run as fast as possible (it does not loop
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1429 * over all the stored patients).
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1430 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1431 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1432 * @param patientID The Patient ID of interest.
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1433 * @return The NULL value if the patient is non-existent, or a string containing the
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1434 * Orthanc ID of the patient. This string must be freed by OrthancPluginFreeString().
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1435 * @ingroup Orthanc
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1436 **/
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1437 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupPatient(
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1438 OrthancPluginContext* context,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1439 const char* patientID)
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1440 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1441 char* result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1442
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1443 _OrthancPluginRetrieveDynamicString params;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1444 params.result = &result;
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1445 params.argument = patientID;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1446
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1447 if (context->InvokeService(context, _OrthancPluginService_LookupPatient, &params) != OrthancPluginErrorCode_Success)
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1448 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1449 /* Error */
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1450 return NULL;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1451 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1452 else
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1453 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1454 return result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1455 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1456 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1457
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1458
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1459 /**
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1460 * @brief Look for a study.
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1461 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1462 * Look for a study stored in Orthanc, using its Study Instance UID tag (0x0020, 0x000d).
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1463 * This function uses the database index to run as fast as possible (it does not loop
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1464 * over all the stored studies).
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1465 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1466 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1467 * @param studyUID The Study Instance UID of interest.
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1468 * @return The NULL value if the study is non-existent, or a string containing the
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1469 * Orthanc ID of the study. This string must be freed by OrthancPluginFreeString().
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1470 * @ingroup Orthanc
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1471 **/
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1472 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupStudy(
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1473 OrthancPluginContext* context,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1474 const char* studyUID)
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1475 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1476 char* result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1477
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1478 _OrthancPluginRetrieveDynamicString params;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1479 params.result = &result;
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1480 params.argument = studyUID;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1481
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1482 if (context->InvokeService(context, _OrthancPluginService_LookupStudy, &params) != OrthancPluginErrorCode_Success)
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1483 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1484 /* Error */
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1485 return NULL;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1486 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1487 else
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1488 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1489 return result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1490 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1491 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1492
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1493
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1494 /**
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1495 * @brief Look for a study, using the accession number.
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1496 *
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1497 * Look for a study stored in Orthanc, using its Accession Number tag (0x0008, 0x0050).
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1498 * This function uses the database index to run as fast as possible (it does not loop
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1499 * over all the stored studies).
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1500 *
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1501 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1502 * @param accessionNumber The Accession Number of interest.
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1503 * @return The NULL value if the study is non-existent, or a string containing the
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1504 * Orthanc ID of the study. This string must be freed by OrthancPluginFreeString().
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1505 * @ingroup Orthanc
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1506 **/
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1507 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupStudyWithAccessionNumber(
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1508 OrthancPluginContext* context,
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1509 const char* accessionNumber)
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1510 {
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1511 char* result;
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1512
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1513 _OrthancPluginRetrieveDynamicString params;
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1514 params.result = &result;
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1515 params.argument = accessionNumber;
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1516
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1517 if (context->InvokeService(context, _OrthancPluginService_LookupStudyWithAccessionNumber, &params) != OrthancPluginErrorCode_Success)
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1518 {
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1519 /* Error */
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1520 return NULL;
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1521 }
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1522 else
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1523 {
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1524 return result;
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1525 }
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1526 }
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1527
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1528
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1529 /**
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1530 * @brief Look for a series.
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1531 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1532 * Look for a series stored in Orthanc, using its Series Instance UID tag (0x0020, 0x000e).
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1533 * This function uses the database index to run as fast as possible (it does not loop
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1534 * over all the stored series).
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1535 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1536 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1537 * @param seriesUID The Series Instance UID of interest.
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1538 * @return The NULL value if the series is non-existent, or a string containing the
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1539 * Orthanc ID of the series. This string must be freed by OrthancPluginFreeString().
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1540 * @ingroup Orthanc
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1541 **/
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1542 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupSeries(
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1543 OrthancPluginContext* context,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1544 const char* seriesUID)
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1545 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1546 char* result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1547
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1548 _OrthancPluginRetrieveDynamicString params;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1549 params.result = &result;
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1550 params.argument = seriesUID;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1551
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1552 if (context->InvokeService(context, _OrthancPluginService_LookupSeries, &params) != OrthancPluginErrorCode_Success)
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1553 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1554 /* Error */
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1555 return NULL;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1556 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1557 else
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1558 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1559 return result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1560 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1561 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1562
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1563
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1564 /**
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1565 * @brief Look for an instance.
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1566 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1567 * Look for an instance stored in Orthanc, using its SOP Instance UID tag (0x0008, 0x0018).
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1568 * This function uses the database index to run as fast as possible (it does not loop
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1569 * over all the stored instances).
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1570 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1571 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1572 * @param sopInstanceUID The SOP Instance UID of interest.
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1573 * @return The NULL value if the instance is non-existent, or a string containing the
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1574 * Orthanc ID of the instance. This string must be freed by OrthancPluginFreeString().
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1575 * @ingroup Orthanc
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1576 **/
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1577 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupInstance(
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1578 OrthancPluginContext* context,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1579 const char* sopInstanceUID)
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1580 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1581 char* result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1582
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1583 _OrthancPluginRetrieveDynamicString params;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1584 params.result = &result;
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1585 params.argument = sopInstanceUID;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1586
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1587 if (context->InvokeService(context, _OrthancPluginService_LookupInstance, &params) != OrthancPluginErrorCode_Success)
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1588 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1589 /* Error */
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1590 return NULL;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1591 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1592 else
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1593 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1594 return result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1595 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1596 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1597
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1598
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1599
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1600 typedef struct
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1601 {
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1602 OrthancPluginRestOutput* output;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1603 uint16_t status;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1604 } _OrthancPluginSendHttpStatusCode;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1605
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1606 /**
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1607 * @brief Send a HTTP status code.
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1608 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1609 * This function answers to a REST request by sending a HTTP status
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1610 * code (such as "400 - Bad Request"). Note that:
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1611 * - Successful requests (status 200) must use ::OrthancPluginAnswerBuffer().
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1612 * - Redirections (status 301) must use ::OrthancPluginRedirect().
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1613 * - Unauthorized access (status 401) must use ::OrthancPluginSendUnauthorized().
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1614 * - Methods not allowed (status 405) must use ::OrthancPluginSendMethodNotAllowed().
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1615 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1616 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1617 * @param output The HTTP connection to the client application.
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1618 * @param status The HTTP status code to be sent.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1619 * @ingroup REST
1594 2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	1620 * @see OrthancPluginSendHttpStatus()
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1621 **/
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1622 ORTHANC_PLUGIN_INLINE void OrthancPluginSendHttpStatusCode(
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1623 OrthancPluginContext* context,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1624 OrthancPluginRestOutput* output,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1625 uint16_t status)
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1626 {
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1627 _OrthancPluginSendHttpStatusCode params;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1628 params.output = output;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1629 params.status = status;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1630 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, &params);
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1631 }
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1632
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1633
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1634 /**
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1635 * @brief Signal that a REST request is not authorized.
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1636 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1637 * This function answers to a REST request by signaling that it is
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1638 * not authorized.
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1639 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1640 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1641 * @param output The HTTP connection to the client application.
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1642 * @param realm The realm for the authorization process.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1643 * @ingroup REST
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1644 **/
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1645 ORTHANC_PLUGIN_INLINE void OrthancPluginSendUnauthorized(
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1646 OrthancPluginContext* context,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1647 OrthancPluginRestOutput* output,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1648 const char* realm)
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1649 {
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1650 _OrthancPluginOutputPlusArgument params;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1651 params.output = output;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1652 params.argument = realm;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1653 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, &params);
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1654 }
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1655
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1656
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1657 /**
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1658 * @brief Signal that this URI does not support this HTTP method.
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1659 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1660 * This function answers to a REST request by signaling that the
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1661 * queried URI does not support this method.
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1662 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1663 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1664 * @param output The HTTP connection to the client application.
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1665 * @param allowedMethods The allowed methods for this URI (e.g. "GET,POST" after a PUT or a POST request).
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1666 * @ingroup REST
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1667 **/
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1668 ORTHANC_PLUGIN_INLINE void OrthancPluginSendMethodNotAllowed(
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1669 OrthancPluginContext* context,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1670 OrthancPluginRestOutput* output,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1671 const char* allowedMethods)
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1672 {
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1673 _OrthancPluginOutputPlusArgument params;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1674 params.output = output;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1675 params.argument = allowedMethods;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1676 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, &params);
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1677 }
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1678
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1679
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1680 typedef struct
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1681 {
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1682 OrthancPluginRestOutput* output;
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1683 const char* key;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1684 const char* value;
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1685 } _OrthancPluginSetHttpHeader;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1686
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1687 /**
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1688 * @brief Set a cookie.
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1689 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1690 * This function sets a cookie in the HTTP client.
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1691 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1692 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1693 * @param output The HTTP connection to the client application.
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1694 * @param cookie The cookie to be set.
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1695 * @param value The value of the cookie.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1696 * @ingroup REST
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1697 **/
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1698 ORTHANC_PLUGIN_INLINE void OrthancPluginSetCookie(
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1699 OrthancPluginContext* context,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1700 OrthancPluginRestOutput* output,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1701 const char* cookie,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1702 const char* value)
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1703 {
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1704 _OrthancPluginSetHttpHeader params;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1705 params.output = output;
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1706 params.key = cookie;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1707 params.value = value;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1708 context->InvokeService(context, _OrthancPluginService_SetCookie, &params);
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1709 }
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1710
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1711
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1712 /**
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1713 * @brief Set some HTTP header.
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1714 *
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1715 * This function sets a HTTP header in the HTTP answer.
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1716 *
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1717 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1718 * @param output The HTTP connection to the client application.
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1719 * @param key The HTTP header to be set.
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1720 * @param value The value of the HTTP header.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1721 * @ingroup REST
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1722 **/
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1723 ORTHANC_PLUGIN_INLINE void OrthancPluginSetHttpHeader(
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1724 OrthancPluginContext* context,
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1725 OrthancPluginRestOutput* output,
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1726 const char* key,
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1727 const char* value)
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1728 {
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1729 _OrthancPluginSetHttpHeader params;
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1730 params.output = output;
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1731 params.key = key;
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1732 params.value = value;
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1733 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, &params);
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1734 }
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1735
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1736
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1737 typedef struct
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1738 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1739 char** resultStringToFree;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1740 const char** resultString;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1741 int64_t* resultInt64;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1742 const char* key;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1743 OrthancPluginDicomInstance* instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1744 } _OrthancPluginAccessDicomInstance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1745
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1746
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1747 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1748 * @brief Get the AET of a DICOM instance.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1749 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1750 * This function returns the Application Entity Title (AET) of the
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1751 * DICOM modality from which a DICOM instance originates.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1752 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1753 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1754 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1755 * @return The AET if success, NULL if error.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1756 * @ingroup Callbacks
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1757 **/
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1758 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceRemoteAet(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1759 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1760 OrthancPluginDicomInstance* instance)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1761 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1762 const char* result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1763
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1764 _OrthancPluginAccessDicomInstance params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1765 memset(&params, 0, sizeof(params));
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1766 params.resultString = &result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1767 params.instance = instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1768
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1769 if (context->InvokeService(context, _OrthancPluginService_GetInstanceRemoteAet, &params) != OrthancPluginErrorCode_Success)
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1770 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1771 /* Error */
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1772 return NULL;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1773 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1774 else
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1775 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1776 return result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1777 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1778 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1779
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1780
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1781 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1782 * @brief Get the size of a DICOM file.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1783 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1784 * This function returns the number of bytes of the given DICOM instance.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1785 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1786 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1787 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1788 * @return The size of the file, -1 in case of error.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1789 * @ingroup Callbacks
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1790 **/
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1791 ORTHANC_PLUGIN_INLINE int64_t OrthancPluginGetInstanceSize(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1792 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1793 OrthancPluginDicomInstance* instance)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1794 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1795 int64_t size;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1796
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1797 _OrthancPluginAccessDicomInstance params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1798 memset(&params, 0, sizeof(params));
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1799 params.resultInt64 = &size;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1800 params.instance = instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1801
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1802 if (context->InvokeService(context, _OrthancPluginService_GetInstanceSize, &params) != OrthancPluginErrorCode_Success)
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1803 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1804 /* Error */
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1805 return -1;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1806 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1807 else
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1808 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1809 return size;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1810 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1811 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1812
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1813
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1814 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1815 * @brief Get the data of a DICOM file.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1816 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1817 * This function returns a pointer to the content of the given DICOM instance.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1818 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1819 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1820 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1821 * @return The pointer to the DICOM data, NULL in case of error.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1822 * @ingroup Callbacks
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1823 **/
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1824 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceData(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1825 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1826 OrthancPluginDicomInstance* instance)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1827 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1828 const char* result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1829
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1830 _OrthancPluginAccessDicomInstance params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1831 memset(&params, 0, sizeof(params));
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1832 params.resultString = &result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1833 params.instance = instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1834
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1835 if (context->InvokeService(context, _OrthancPluginService_GetInstanceData, &params) != OrthancPluginErrorCode_Success)
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1836 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1837 /* Error */
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1838 return NULL;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1839 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1840 else
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1841 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1842 return result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1843 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1844 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1845
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1846
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1847 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1848 * @brief Get the DICOM tag hierarchy as a JSON file.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1849 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1850 * This function returns a pointer to a newly created string
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1851 * containing a JSON file. This JSON file encodes the tag hierarchy
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1852 * of the given DICOM instance.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1853 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1854 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1855 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1856 * @return The NULL value in case of error, or a string containing the JSON file.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1857 * This string must be freed by OrthancPluginFreeString().
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1858 * @ingroup Callbacks
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1859 **/
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1860 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceJson(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1861 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1862 OrthancPluginDicomInstance* instance)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1863 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1864 char* result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1865
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1866 _OrthancPluginAccessDicomInstance params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1867 memset(&params, 0, sizeof(params));
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1868 params.resultStringToFree = &result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1869 params.instance = instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1870
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1871 if (context->InvokeService(context, _OrthancPluginService_GetInstanceJson, &params) != OrthancPluginErrorCode_Success)
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1872 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1873 /* Error */
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1874 return NULL;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1875 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1876 else
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1877 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1878 return result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1879 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1880 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1881
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1882
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1883 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1884 * @brief Get the DICOM tag hierarchy as a JSON file (with simplification).
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1885 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1886 * This function returns a pointer to a newly created string
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1887 * containing a JSON file. This JSON file encodes the tag hierarchy
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1888 * of the given DICOM instance. In contrast with
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1889 * ::OrthancPluginGetInstanceJson(), the returned JSON file is in
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1890 * its simplified version.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1891 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1892 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1893 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1894 * @return The NULL value in case of error, or a string containing the JSON file.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1895 * This string must be freed by OrthancPluginFreeString().
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1896 * @ingroup Callbacks
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1897 **/
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1898 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceSimplifiedJson(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1899 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1900 OrthancPluginDicomInstance* instance)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1901 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1902 char* result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1903
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1904 _OrthancPluginAccessDicomInstance params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1905 memset(&params, 0, sizeof(params));
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1906 params.resultStringToFree = &result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1907 params.instance = instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1908
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1909 if (context->InvokeService(context, _OrthancPluginService_GetInstanceSimplifiedJson, &params) != OrthancPluginErrorCode_Success)
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1910 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1911 /* Error */
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1912 return NULL;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1913 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1914 else
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1915 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1916 return result;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1917 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1918 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1919
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1920
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1921 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1922 * @brief Check whether a DICOM instance is associated with some metadata.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1923 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1924 * This function checks whether the DICOM instance of interest is
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1925 * associated with some metadata. As of Orthanc 0.8.1, in the
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1926 * callbacks registered by
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1927 * ::OrthancPluginRegisterOnStoredInstanceCallback(), the only
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1928 * possibly available metadata are "ReceptionDate", "RemoteAET" and
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1929 * "IndexInSeries".
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1930 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1931 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1932 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1933 * @param metadata The metadata of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1934 * @return 1 if the metadata is present, 0 if it is absent, -1 in case of error.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1935 * @ingroup Callbacks
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1936 **/
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1937 ORTHANC_PLUGIN_INLINE int OrthancPluginHasInstanceMetadata(
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1938 OrthancPluginContext* context,
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1939 OrthancPluginDicomInstance* instance,
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1940 const char* metadata)
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1941 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1942 int64_t result;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1943
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1944 _OrthancPluginAccessDicomInstance params;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1945 memset(&params, 0, sizeof(params));
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1946 params.resultInt64 = &result;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1947 params.instance = instance;
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1948 params.key = metadata;
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1949
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1950 if (context->InvokeService(context, _OrthancPluginService_HasInstanceMetadata, &params) != OrthancPluginErrorCode_Success)
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1951 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1952 /* Error */
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1953 return -1;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1954 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1955 else
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1956 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1957 return (result != 0);
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1958 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1959 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1960
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1961
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1962 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1963 * @brief Get the value of some metadata associated with a given DICOM instance.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1964 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1965 * This functions returns the value of some metadata that is associated with the DICOM instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1966 * Before calling this function, the existence of the metadata must have been checked with
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1967 * ::OrthancPluginHasInstanceMetadata().
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1968 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1969 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1970 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1971 * @param metadata The metadata of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1972 * @return The metadata value if success, NULL if error.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1973 * @ingroup Callbacks
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1974 **/
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1975 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceMetadata(
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1976 OrthancPluginContext* context,
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1977 OrthancPluginDicomInstance* instance,
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1978 const char* metadata)
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1979 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1980 const char* result;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1981
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1982 _OrthancPluginAccessDicomInstance params;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1983 memset(&params, 0, sizeof(params));
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1984 params.resultString = &result;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1985 params.instance = instance;
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1986 params.key = metadata;
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1987
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1988 if (context->InvokeService(context, _OrthancPluginService_GetInstanceMetadata, &params) != OrthancPluginErrorCode_Success)
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1989 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1990 /* Error */
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1991 return NULL;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1992 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1993 else
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1994 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1995 return result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1996 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1997 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1998
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1999
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2000
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2001 typedef struct
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2002 {
1295 50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2003 OrthancPluginStorageCreate create;
50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2004 OrthancPluginStorageRead read;
50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2005 OrthancPluginStorageRemove remove;
50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2006 OrthancPluginFree free;
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2007 } _OrthancPluginRegisterStorageArea;
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2008
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2009 /**
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2010 * @brief Register a custom storage area.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2011 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2012 * This function registers a custom storage area, to replace the
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2013 * built-in way Orthanc stores its files on the filesystem. This
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2014 * function must be called during the initialization of the plugin,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2015 * i.e. inside the OrthancPluginInitialize() public function.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2016 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2017 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
1141 2ff467bcfb98 doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1137 diff changeset	2018 * @param create The callback function to store a file on the custom storage area.
2ff467bcfb98 doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1137 diff changeset	2019 * @param read The callback function to read a file from the custom storage area.
2ff467bcfb98 doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1137 diff changeset	2020 * @param remove The callback function to remove a file from the custom storage area.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2021 * @ingroup Callbacks
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2022 **/
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2023 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterStorageArea(
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2024 OrthancPluginContext* context,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2025 OrthancPluginStorageCreate create,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2026 OrthancPluginStorageRead read,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2027 OrthancPluginStorageRemove remove)
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2028 {
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2029 _OrthancPluginRegisterStorageArea params;
1295 50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2030 params.create = create;
50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2031 params.read = read;
50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2032 params.remove = remove;
1136 208dc67b9bab sample custom storage plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1135 diff changeset	2033
208dc67b9bab sample custom storage plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1135 diff changeset	2034 #ifdef __cplusplus
1295 50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2035 params.free = ::free;
1136 208dc67b9bab sample custom storage plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1135 diff changeset	2036 #else
1295 50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2037 params.free = free;
1136 208dc67b9bab sample custom storage plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1135 diff changeset	2038 #endif
208dc67b9bab sample custom storage plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1135 diff changeset	2039
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2040 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, &params);
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2041 }
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2042
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2043
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2044
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2045 /**
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2046 * @brief Return the path to the Orthanc executable.
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2047 *
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2048 * This function returns the path to the Orthanc executable.
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2049 *
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2050 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2051 * @return NULL in the case of an error, or a newly allocated string
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2052 * containing the path. This string must be freed by
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2053 * OrthancPluginFreeString().
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2054 **/
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2055 ORTHANC_PLUGIN_INLINE char OrthancPluginGetOrthancPath(OrthancPluginContext context)
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2056 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2057 char* result;
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2058
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2059 _OrthancPluginRetrieveDynamicString params;
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2060 params.result = &result;
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2061 params.argument = NULL;
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2062
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2063 if (context->InvokeService(context, _OrthancPluginService_GetOrthancPath, &params) != OrthancPluginErrorCode_Success)
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2064 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2065 /* Error */
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2066 return NULL;
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2067 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2068 else
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2069 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2070 return result;
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2071 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2072 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2073
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2074
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2075 /**
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2076 * @brief Return the directory containing the Orthanc.
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2077 *
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2078 * This function returns the path to the directory containing the Orthanc executable.
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2079 *
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2080 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2081 * @return NULL in the case of an error, or a newly allocated string
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2082 * containing the path. This string must be freed by
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2083 * OrthancPluginFreeString().
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2084 **/
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2085 ORTHANC_PLUGIN_INLINE char OrthancPluginGetOrthancDirectory(OrthancPluginContext context)
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2086 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2087 char* result;
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2088
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2089 _OrthancPluginRetrieveDynamicString params;
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2090 params.result = &result;
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2091 params.argument = NULL;
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2092
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2093 if (context->InvokeService(context, _OrthancPluginService_GetOrthancDirectory, &params) != OrthancPluginErrorCode_Success)
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2094 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2095 /* Error */
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2096 return NULL;
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2097 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2098 else
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2099 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2100 return result;
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2101 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2102 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2103
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2104
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2105 /**
1423 7b7d597a190c The configuration can be splitted into several files stored inside the same folder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1407 diff changeset	2106 * @brief Return the path to the configuration file(s).
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2107 *
1423 7b7d597a190c The configuration can be splitted into several files stored inside the same folder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1407 diff changeset	2108 * This function returns the path to the configuration file(s) that
7b7d597a190c The configuration can be splitted into several files stored inside the same folder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1407 diff changeset	2109 * was specified when starting Orthanc. Since version 0.9.1, this
7b7d597a190c The configuration can be splitted into several files stored inside the same folder Sebastien Jodogne <s.jodogne@gmail.com> parents: 1407 diff changeset	2110 * path can refer to a folder that stores a set of configuration
1424 fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2111 * files. This function is deprecated in favor of
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2112 * OrthancPluginGetConfiguration().
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2113 *
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2114 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2115 * @return NULL in the case of an error, or a newly allocated string
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2116 * containing the path. This string must be freed by
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2117 * OrthancPluginFreeString().
1424 fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2118 * @see OrthancPluginGetConfiguration()
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2119 **/
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2120 ORTHANC_PLUGIN_INLINE char OrthancPluginGetConfigurationPath(OrthancPluginContext context)
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2121 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2122 char* result;
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2123
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2124 _OrthancPluginRetrieveDynamicString params;
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2125 params.result = &result;
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2126 params.argument = NULL;
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2127
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2128 if (context->InvokeService(context, _OrthancPluginService_GetConfigurationPath, &params) != OrthancPluginErrorCode_Success)
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2129 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2130 /* Error */
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2131 return NULL;
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2132 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2133 else
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2134 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2135 return result;
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2136 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2137 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2138
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2139
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2140
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2141 typedef struct
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2142 {
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2143 OrthancPluginOnChangeCallback callback;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2144 } _OrthancPluginOnChangeCallback;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2145
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2146 /**
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2147 * @brief Register a callback to monitor changes.
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2148 *
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2149 * This function registers a callback function that is called
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2150 * whenever a change happens to some DICOM resource.
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2151 *
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2152 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2153 * @param callback The callback function.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2154 * @ingroup Callbacks
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2155 **/
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2156 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterOnChangeCallback(
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2157 OrthancPluginContext* context,
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2158 OrthancPluginOnChangeCallback callback)
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2159 {
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2160 _OrthancPluginOnChangeCallback params;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2161 params.callback = callback;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2162
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2163 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, &params);
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2164 }
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2165
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2166
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2167
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2168 typedef struct
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2169 {
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2170 const char* plugin;
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2171 _OrthancPluginProperty property;
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2172 const char* value;
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2173 } _OrthancPluginSetPluginProperty;
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2174
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2175
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2176 /**
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2177 * @brief Set the URI where the plugin provides its Web interface.
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2178 *
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2179 * For plugins that come with a Web interface, this function
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2180 * declares the entry path where to find this interface. This
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2181 * information is notably used in the "Plugins" page of Orthanc
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2182 * Explorer.
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2183 *
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2184 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2185 * @param uri The root URI for this plugin.
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2186 **/
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2187 ORTHANC_PLUGIN_INLINE void OrthancPluginSetRootUri(
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2188 OrthancPluginContext* context,
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2189 const char* uri)
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2190 {
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2191 _OrthancPluginSetPluginProperty params;
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2192 params.plugin = OrthancPluginGetName();
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2193 params.property = _OrthancPluginProperty_RootUri;
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2194 params.value = uri;
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2195
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2196 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, &params);
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2197 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2198
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2199
1233 eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2200 /**
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2201 * @brief Set a description for this plugin.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2202 *
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2203 * Set a description for this plugin. It is displayed in the
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2204 * "Plugins" page of Orthanc Explorer.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2205 *
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2206 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2207 * @param description The description.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2208 **/
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2209 ORTHANC_PLUGIN_INLINE void OrthancPluginSetDescription(
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2210 OrthancPluginContext* context,
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2211 const char* description)
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2212 {
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2213 _OrthancPluginSetPluginProperty params;
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2214 params.plugin = OrthancPluginGetName();
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2215 params.property = _OrthancPluginProperty_Description;
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2216 params.value = description;
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2217
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2218 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, &params);
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2219 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2220
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2221
1233 eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2222 /**
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2223 * @brief Extend the JavaScript code of Orthanc Explorer.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2224 *
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2225 * Add JavaScript code to customize the default behavior of Orthanc
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2226 * Explorer. This can for instance be used to add new buttons.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2227 *
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2228 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2229 * @param javascript The custom JavaScript code.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2230 **/
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2231 ORTHANC_PLUGIN_INLINE void OrthancPluginExtendOrthancExplorer(
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2232 OrthancPluginContext* context,
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2233 const char* javascript)
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2234 {
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2235 _OrthancPluginSetPluginProperty params;
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2236 params.plugin = OrthancPluginGetName();
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2237 params.property = _OrthancPluginProperty_OrthancExplorer;
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2238 params.value = javascript;
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2239
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2240 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, &params);
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2241 }
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2242
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2243
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2244 typedef struct
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2245 {
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2246 char** result;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2247 int32_t property;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2248 const char* value;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2249 } _OrthancPluginGlobalProperty;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2250
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2251
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2252 /**
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2253 * @brief Get the value of a global property.
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2254 *
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2255 * Get the value of a global property that is stored in the Orthanc database. Global
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2256 * properties whose index is below 1024 are reserved by Orthanc.
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2257 *
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2258 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2259 * @param property The global property of interest.
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2260 * @param defaultValue The value to return, if the global property is unset.
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2261 * @return The value of the global property, or NULL in the case of an error. This
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2262 * string must be freed by OrthancPluginFreeString().
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2263 * @ingroup Orthanc
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2264 **/
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2265 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetGlobalProperty(
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2266 OrthancPluginContext* context,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2267 int32_t property,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2268 const char* defaultValue)
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2269 {
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2270 char* result;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2271
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2272 _OrthancPluginGlobalProperty params;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2273 params.result = &result;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2274 params.property = property;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2275 params.value = defaultValue;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2276
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2277 if (context->InvokeService(context, _OrthancPluginService_GetGlobalProperty, &params) != OrthancPluginErrorCode_Success)
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2278 {
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2279 /* Error */
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2280 return NULL;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2281 }
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2282 else
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2283 {
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2284 return result;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2285 }
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2286 }
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2287
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2288
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2289 /**
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2290 * @brief Set the value of a global property.
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2291 *
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2292 * Set the value of a global property into the Orthanc
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2293 * database. Setting a global property can be used by plugins to
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2294 * save their internal parameters. Plugins are only allowed to set
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2295 * properties whose index are above or equal to 1024 (properties
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2296 * below 1024 are read-only and reserved by Orthanc).
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2297 *
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2298 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2299 * @param property The global property of interest.
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2300 * @param value The value to be set in the global property.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2301 * @return 0 if success, or the error code if failure.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2302 * @ingroup Orthanc
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2303 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2304 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginSetGlobalProperty(
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2305 OrthancPluginContext* context,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2306 int32_t property,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2307 const char* value)
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2308 {
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2309 _OrthancPluginGlobalProperty params;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2310 params.result = NULL;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2311 params.property = property;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2312 params.value = value;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2313
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2314 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, &params);
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2315 }
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2316
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2317
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2318
1280 d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2319 typedef struct
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2320 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2321 int32_t *resultInt32;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2322 uint32_t *resultUint32;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2323 int64_t *resultInt64;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2324 uint64_t *resultUint64;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2325 } _OrthancPluginReturnSingleValue;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2326
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2327 /**
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2328 * @brief Get the number of command-line arguments.
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2329 *
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2330 * Retrieve the number of command-line arguments that were used to launch Orthanc.
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2331 *
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2332 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2333 * @return The number of arguments.
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2334 **/
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2335 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetCommandLineArgumentsCount(
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2336 OrthancPluginContext* context)
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2337 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2338 uint32_t count = 0;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2339
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2340 _OrthancPluginReturnSingleValue params;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2341 memset(&params, 0, sizeof(params));
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2342 params.resultUint32 = &count;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2343
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2344 if (context->InvokeService(context, _OrthancPluginService_GetCommandLineArgumentsCount, &params) != OrthancPluginErrorCode_Success)
1280 d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2345 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2346 /* Error */
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2347 return 0;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2348 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2349 else
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2350 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2351 return count;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2352 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2353 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2354
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2355
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2356
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2357 /**
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2358 * @brief Get the value of a command-line argument.
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2359 *
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2360 * Get the value of one of the command-line arguments that were used
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2361 * to launch Orthanc. The number of available arguments can be
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2362 * retrieved by OrthancPluginGetCommandLineArgumentsCount().
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2363 *
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2364 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2365 * @param argument The index of the argument.
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2366 * @return The value of the argument, or NULL in the case of an error. This
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2367 * string must be freed by OrthancPluginFreeString().
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2368 **/
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2369 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetCommandLineArgument(
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2370 OrthancPluginContext* context,
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2371 uint32_t argument)
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2372 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2373 char* result;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2374
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2375 _OrthancPluginGlobalProperty params;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2376 params.result = &result;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2377 params.property = (int32_t) argument;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2378 params.value = NULL;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2379
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2380 if (context->InvokeService(context, _OrthancPluginService_GetCommandLineArgument, &params) != OrthancPluginErrorCode_Success)
1280 d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2381 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2382 /* Error */
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2383 return NULL;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2384 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2385 else
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2386 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2387 return result;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2388 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2389 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2390
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2391
1407 d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2392 /**
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2393 * @brief Get the expected version of the database schema.
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2394 *
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2395 * Retrieve the expected version of the database schema.
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2396 *
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2397 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2398 * @return The version.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2399 * @ingroup Callbacks
1407 d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2400 **/
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2401 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetExpectedDatabaseVersion(
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2402 OrthancPluginContext* context)
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2403 {
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2404 uint32_t count = 0;
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2405
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2406 _OrthancPluginReturnSingleValue params;
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2407 memset(&params, 0, sizeof(params));
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2408 params.resultUint32 = &count;
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2409
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2410 if (context->InvokeService(context, _OrthancPluginService_GetExpectedDatabaseVersion, &params) != OrthancPluginErrorCode_Success)
1407 d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2411 {
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2412 /* Error */
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2413 return 0;
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2414 }
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2415 else
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2416 {
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2417 return count;
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2418 }
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2419 }
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2420
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2421
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2422
1424 fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2423 /**
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2424 * @brief Return the content of the configuration file(s).
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2425 *
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2426 * This function returns the content of the configuration that is
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2427 * used by Orthanc, formatted as a JSON string.
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2428 *
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2429 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2430 * @return NULL in the case of an error, or a newly allocated string
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2431 * containing the configuration. This string must be freed by
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2432 * OrthancPluginFreeString().
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2433 **/
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2434 ORTHANC_PLUGIN_INLINE char OrthancPluginGetConfiguration(OrthancPluginContext context)
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2435 {
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2436 char* result;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2437
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2438 _OrthancPluginRetrieveDynamicString params;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2439 params.result = &result;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2440 params.argument = NULL;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2441
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2442 if (context->InvokeService(context, _OrthancPluginService_GetConfiguration, &params) != OrthancPluginErrorCode_Success)
1424 fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2443 {
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2444 /* Error */
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2445 return NULL;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2446 }
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2447 else
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2448 {
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2449 return result;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2450 }
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2451 }
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2452
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2453
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2454
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2455 typedef struct
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2456 {
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2457 OrthancPluginRestOutput* output;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2458 const char* subType;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2459 const char* contentType;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2460 } _OrthancPluginStartMultipartAnswer;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2461
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2462 /**
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2463 * @brief Start an HTTP multipart answer.
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2464 *
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2465 * Initiates a HTTP multipart answer, as the result of a REST request.
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2466 *
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2467 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2468 * @param output The HTTP connection to the client application.
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2469 * @param subType The sub-type of the multipart answer ("mixed" or "related").
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2470 * @param contentType The MIME type of the items in the multipart answer.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2471 * @return 0 if success, or the error code if failure.
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2472 * @see OrthancPluginSendMultipartItem()
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2473 * @ingroup REST
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2474 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2475 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2476 OrthancPluginContext* context,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2477 OrthancPluginRestOutput* output,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2478 const char* subType,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2479 const char* contentType)
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2480 {
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2481 _OrthancPluginStartMultipartAnswer params;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2482 params.output = output;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2483 params.subType = subType;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2484 params.contentType = contentType;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2485 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, &params);
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2486 }
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2487
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2488
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2489 /**
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2490 * @brief Send an item as a part of some HTTP multipart answer.
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2491 *
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2492 * This function sends an item as a part of some HTTP multipart
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2493 * answer that was initiated by OrthancPluginStartMultipartAnswer().
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2494 *
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2495 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2496 * @param output The HTTP connection to the client application.
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2497 * @param answer Pointer to the memory buffer containing the item.
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2498 * @param answerSize Number of bytes of the item.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2499 * @return 0 if success, or the error code if failure (this notably happens
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2500 * if the connection is closed by the client).
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2501 * @ingroup REST
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2502 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2503 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginSendMultipartItem(
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2504 OrthancPluginContext* context,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2505 OrthancPluginRestOutput* output,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2506 const char* answer,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2507 uint32_t answerSize)
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2508 {
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2509 _OrthancPluginAnswerBuffer params;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2510 params.output = output;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2511 params.answer = answer;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2512 params.answerSize = answerSize;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2513 params.mimeType = NULL;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2514 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, &params);
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2515 }
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2516
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2517
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2518
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2519 typedef struct
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2520 {
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2521 OrthancPluginMemoryBuffer* target;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2522 const void* source;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2523 uint32_t size;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2524 OrthancPluginCompressionType compression;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2525 uint8_t uncompress;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2526 } _OrthancPluginBufferCompression;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2527
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2528
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2529 /**
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2530 * @brief Compress or decompress a buffer.
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2531 *
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2532 * This function compresses or decompresses a buffer, using the
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2533 * version of the zlib library that is used by the Orthanc core.
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2534 *
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2535 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2536 * @param target The target memory buffer.
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2537 * @param source The source buffer.
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2538 * @param size The size in bytes of the source buffer.
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2539 * @param compression The compression algorithm.
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2540 * @param uncompress If set to "0", the buffer must be compressed.
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2541 * If set to "1", the buffer must be uncompressed.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2542 * @return 0 if success, or the error code if failure.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2543 * @ingroup Compression
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2544 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2545 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginBufferCompression(
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2546 OrthancPluginContext* context,
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2547 OrthancPluginMemoryBuffer* target,
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2548 const void* source,
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2549 uint32_t size,
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2550 OrthancPluginCompressionType compression,
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2551 uint8_t uncompress)
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2552 {
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2553 _OrthancPluginBufferCompression params;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2554 params.target = target;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2555 params.source = source;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2556 params.size = size;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2557 params.compression = compression;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2558 params.uncompress = uncompress;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2559
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2560 return context->InvokeService(context, _OrthancPluginService_BufferCompression, &params);
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2561 }
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2562
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2563
1588 b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2564
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2565 typedef struct
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2566 {
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2567 OrthancPluginMemoryBuffer* target;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2568 const char* path;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2569 } _OrthancPluginReadFile;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2570
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2571 /**
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2572 * @brief Read a file.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2573 *
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2574 * Read the content of a file on the filesystem, and returns it into
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2575 * a newly allocated memory buffer.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2576 *
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2577 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2578 * @param target The target memory buffer.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2579 * @param path The path of the file to be read.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2580 * @return 0 if success, or the error code if failure.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2581 **/
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2582 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginReadFile(
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2583 OrthancPluginContext* context,
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2584 OrthancPluginMemoryBuffer* target,
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2585 const char* path)
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2586 {
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2587 _OrthancPluginReadFile params;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2588 params.target = target;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2589 params.path = path;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2590 return context->InvokeService(context, _OrthancPluginService_ReadFile, &params);
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2591 }
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2592
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2593
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2594
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2595 typedef struct
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2596 {
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2597 const char* path;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2598 const void* data;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2599 uint32_t size;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2600 } _OrthancPluginWriteFile;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2601
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2602 /**
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2603 * @brief Write a file.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2604 *
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2605 * Write the content of a memory buffer to the filesystem.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2606 *
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2607 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2608 * @param path The path of the file to be written.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2609 * @param data The content of the memory buffer.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2610 * @param size The size of the memory buffer.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2611 * @return 0 if success, or the error code if failure.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2612 **/
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2613 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginWriteFile(
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2614 OrthancPluginContext* context,
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2615 const char* path,
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2616 const void* data,
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2617 uint32_t size)
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2618 {
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2619 _OrthancPluginWriteFile params;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2620 params.path = path;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2621 params.data = data;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2622 params.size = size;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2623 return context->InvokeService(context, _OrthancPluginService_WriteFile, &params);
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2624 }
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2625
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2626
1593 235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2627
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2628 typedef struct
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2629 {
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2630 const char** target;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2631 OrthancPluginErrorCode error;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2632 } _OrthancPluginGetErrorDescription;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2633
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2634 /**
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2635 * @brief Get the description of a given error code.
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2636 *
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2637 * This function returns the description of a given error code.
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2638 *
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2639 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	2640 * @param error The error code of interest.
1593 235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2641 * @return The error description. This is a statically-allocated
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2642 * string, do not free it.
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2643 **/
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2644 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetErrorDescription(
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2645 OrthancPluginContext* context,
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2646 OrthancPluginErrorCode error)
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2647 {
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2648 const char* result = NULL;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2649
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2650 _OrthancPluginGetErrorDescription params;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2651 params.target = &result;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2652 params.error = error;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2653
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2654 if (context->InvokeService(context, _OrthancPluginService_GetErrorDescription, &params) != OrthancPluginErrorCode_Success \|\|
1593 235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2655 result == NULL)
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2656 {
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2657 return "Unknown error code";
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2658 }
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2659 else
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2660 {
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2661 return result;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2662 }
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2663 }
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2664
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2665
1594 2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2666
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2667 typedef struct
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2668 {
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2669 OrthancPluginRestOutput* output;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2670 uint16_t status;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2671 const char* body;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2672 uint32_t bodySize;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2673 } _OrthancPluginSendHttpStatus;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2674
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2675 /**
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2676 * @brief Send a HTTP status, with a custom body.
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2677 *
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2678 * This function answers to a HTTP request by sending a HTTP status
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2679 * code (such as "400 - Bad Request"), together with a body
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2680 * describing the error. The body will only be returned if the
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2681 * configuration option "HttpDescribeErrors" of Orthanc is set to "true".
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2682 *
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2683 * Note that:
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2684 * - Successful requests (status 200) must use ::OrthancPluginAnswerBuffer().
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2685 * - Redirections (status 301) must use ::OrthancPluginRedirect().
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2686 * - Unauthorized access (status 401) must use ::OrthancPluginSendUnauthorized().
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2687 * - Methods not allowed (status 405) must use ::OrthancPluginSendMethodNotAllowed().
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2688 *
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2689 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2690 * @param output The HTTP connection to the client application.
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2691 * @param status The HTTP status code to be sent.
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	2692 * @param body The body of the answer.
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	2693 * @param bodySize The size of the body.
1594 2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2694 * @see OrthancPluginSendHttpStatusCode()
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2695 * @ingroup REST
1594 2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2696 **/
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2697 ORTHANC_PLUGIN_INLINE void OrthancPluginSendHttpStatus(
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2698 OrthancPluginContext* context,
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2699 OrthancPluginRestOutput* output,
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2700 uint16_t status,
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2701 const char* body,
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2702 uint32_t bodySize)
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2703 {
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2704 _OrthancPluginSendHttpStatus params;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2705 params.output = output;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2706 params.status = status;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2707 params.body = body;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2708 params.bodySize = bodySize;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2709 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, &params);
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2710 }
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2711
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2712
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2713
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2714 typedef struct
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2715 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2716 const OrthancPluginImage* image;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2717 uint32_t* resultUint32;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2718 OrthancPluginPixelFormat* resultPixelFormat;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2719 const void** resultBuffer;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2720 } _OrthancPluginGetImageInfo;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2721
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2722
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2723 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2724 * @brief Return the pixel format of an image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2725 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2726 * This function returns the type of memory layout for the pixels of the given image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2727 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2728 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2729 * @param image The image of interest.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2730 * @return The pixel format.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2731 * @ingroup Compression
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2732 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2733 ORTHANC_PLUGIN_INLINE OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2734 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2735 const OrthancPluginImage* image)
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2736 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2737 OrthancPluginPixelFormat target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2738
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2739 _OrthancPluginGetImageInfo params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2740 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2741 params.image = image;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2742 params.resultPixelFormat = &target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2743
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2744 if (context->InvokeService(context, _OrthancPluginService_GetImagePixelFormat, &params) != OrthancPluginErrorCode_Success)
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2745 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2746 return OrthancPluginPixelFormat_Unknown;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2747 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2748 else
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2749 {
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2750 return (OrthancPluginPixelFormat) target;
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2751 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2752 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2753
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2754
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2755
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2756 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2757 * @brief Return the width of an image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2758 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2759 * This function returns the width of the given image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2760 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2761 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2762 * @param image The image of interest.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2763 * @return The width.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2764 * @ingroup Compression
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2765 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2766 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetImageWidth(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2767 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2768 const OrthancPluginImage* image)
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2769 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2770 uint32_t width;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2771
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2772 _OrthancPluginGetImageInfo params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2773 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2774 params.image = image;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2775 params.resultUint32 = &width;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2776
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2777 if (context->InvokeService(context, _OrthancPluginService_GetImageWidth, &params) != OrthancPluginErrorCode_Success)
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2778 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2779 return 0;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2780 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2781 else
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2782 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2783 return width;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2784 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2785 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2786
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2787
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2788
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2789 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2790 * @brief Return the height of an image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2791 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2792 * This function returns the height of the given image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2793 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2794 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2795 * @param image The image of interest.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2796 * @return The height.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2797 * @ingroup Compression
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2798 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2799 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetImageHeight(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2800 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2801 const OrthancPluginImage* image)
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2802 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2803 uint32_t height;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2804
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2805 _OrthancPluginGetImageInfo params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2806 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2807 params.image = image;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2808 params.resultUint32 = &height;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2809
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2810 if (context->InvokeService(context, _OrthancPluginService_GetImageHeight, &params) != OrthancPluginErrorCode_Success)
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2811 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2812 return 0;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2813 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2814 else
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2815 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2816 return height;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2817 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2818 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2819
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2820
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2821
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2822 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2823 * @brief Return the pitch of an image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2824 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2825 * This function returns the pitch of the given image. The pitch is
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2826 * defined as the number of bytes between 2 successive lines of the
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2827 * image in the memory buffer.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2828 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2829 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2830 * @param image The image of interest.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2831 * @return The pitch.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2832 * @ingroup Compression
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2833 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2834 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetImagePitch(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2835 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2836 const OrthancPluginImage* image)
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2837 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2838 uint32_t pitch;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2839
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2840 _OrthancPluginGetImageInfo params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2841 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2842 params.image = image;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2843 params.resultUint32 = &pitch;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2844
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2845 if (context->InvokeService(context, _OrthancPluginService_GetImagePitch, &params) != OrthancPluginErrorCode_Success)
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2846 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2847 return 0;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2848 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2849 else
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2850 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2851 return pitch;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2852 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2853 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2854
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2855
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2856
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2857 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2858 * @brief Return a pointer to the content of an image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2859 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2860 * This function returns a pointer to the memory buffer that
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2861 * contains the pixels of the image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2862 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2863 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2864 * @param image The image of interest.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2865 * @return The pointer.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2866 * @ingroup Compression
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2867 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2868 ORTHANC_PLUGIN_INLINE const void* OrthancPluginGetImageBuffer(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2869 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2870 const OrthancPluginImage* image)
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2871 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2872 const void* target = NULL;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2873
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2874 _OrthancPluginGetImageInfo params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2875 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2876 params.resultBuffer = &target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2877 params.image = image;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2878
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2879 if (context->InvokeService(context, _OrthancPluginService_GetImageBuffer, &params) != OrthancPluginErrorCode_Success)
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2880 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2881 return NULL;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2882 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2883 else
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2884 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2885 return target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2886 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2887 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2888
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2889
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2890 typedef struct
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2891 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2892 OrthancPluginImage** target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2893 const void* data;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2894 uint32_t size;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2895 OrthancPluginImageFormat format;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2896 } _OrthancPluginUncompressImage;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2897
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2898
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2899 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2900 * @brief Decode a compressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2901 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2902 * This function decodes a compressed image from a memory buffer.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2903 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2904 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2905 * @param data Pointer to a memory buffer containing the compressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2906 * @param size Size of the memory buffer containing the compressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2907 * @param format The file format of the compressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2908 * @return The uncompressed image. It must be freed with OrthancPluginFreeImage().
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2909 * @ingroup Compression
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2910 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2911 ORTHANC_PLUGIN_INLINE OrthancPluginImage *OrthancPluginUncompressImage(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2912 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2913 const void* data,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2914 uint32_t size,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2915 OrthancPluginImageFormat format)
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2916 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2917 OrthancPluginImage* target = NULL;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2918
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2919 _OrthancPluginUncompressImage params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2920 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2921 params.target = &target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2922 params.data = data;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2923 params.size = size;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2924 params.format = format;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2925
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2926 if (context->InvokeService(context, _OrthancPluginService_UncompressImage, &params) != OrthancPluginErrorCode_Success)
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2927 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2928 return NULL;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2929 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2930 else
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2931 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2932 return target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2933 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2934 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2935
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2936
1605 fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	2937
fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	2938
fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	2939 typedef struct
fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	2940 {
fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	2941 OrthancPluginImage* image;
fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	2942 } _OrthancPluginFreeImage;
fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	2943
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2944 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2945 * @brief Free an image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2946 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2947 * This function frees an image that was decoded with OrthancPluginUncompressImage().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2948 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2949 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2950 * @param image The image.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2951 * @ingroup Compression
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2952 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2953 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeImage(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2954 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2955 OrthancPluginImage* image)
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2956 {
1605 fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	2957 _OrthancPluginFreeImage params;
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2958 params.image = image;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2959
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2960 context->InvokeService(context, _OrthancPluginService_FreeImage, &params);
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2961 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2962
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2963
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2964
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2965
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2966 typedef struct
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2967 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2968 OrthancPluginMemoryBuffer* target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2969 OrthancPluginImageFormat imageFormat;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2970 OrthancPluginPixelFormat pixelFormat;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2971 uint32_t width;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2972 uint32_t height;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2973 uint32_t pitch;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2974 const void* buffer;
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2975 uint8_t quality;
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2976 } _OrthancPluginCompressImage;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2977
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2978
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2979 /**
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2980 * @brief Encode a PNG image.
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2981 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2982 * This function compresses the given memory buffer containing an
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2983 * image using the PNG specification, and stores the result of the
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2984 * compression into a newly allocated memory buffer.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2985 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2986 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2987 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2988 * @param format The memory layout of the uncompressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2989 * @param width The width of the image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2990 * @param height The height of the image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2991 * @param pitch The pitch of the image (i.e. the number of bytes
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2992 * between 2 successive lines of the image in the memory buffer).
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2993 * @param buffer The memory buffer containing the uncompressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2994 * @return 0 if success, or the error code if failure.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2995 * @see OrthancPluginCompressAndAnswerPngImage()
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2996 * @ingroup Compression
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2997 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2998 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCompressPngImage(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2999 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3000 OrthancPluginMemoryBuffer* target,
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3001 OrthancPluginPixelFormat format,
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3002 uint32_t width,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3003 uint32_t height,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3004 uint32_t pitch,
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	3005 const void* buffer)
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3006 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3007 _OrthancPluginCompressImage params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3008 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3009 params.target = target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3010 params.imageFormat = OrthancPluginImageFormat_Png;
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3011 params.pixelFormat = format;
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3012 params.width = width;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3013 params.height = height;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3014 params.pitch = pitch;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3015 params.buffer = buffer;
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	3016 params.quality = 0; // Unused for PNG
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3017
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3018 return context->InvokeService(context, _OrthancPluginService_CompressImage, &params);
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3019 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3020
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3021
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3022 /**
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	3023 * @brief Encode a JPEG image.
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3024 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3025 * This function compresses the given memory buffer containing an
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3026 * image using the JPEG specification, and stores the result of the
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3027 * compression into a newly allocated memory buffer.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3028 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3029 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3030 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3031 * @param format The memory layout of the uncompressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3032 * @param width The width of the image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3033 * @param height The height of the image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3034 * @param pitch The pitch of the image (i.e. the number of bytes
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3035 * between 2 successive lines of the image in the memory buffer).
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3036 * @param buffer The memory buffer containing the uncompressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3037 * @param quality The quality of the JPEG encoding, between 1 (worst
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3038 * quality, best compression) and 100 (best quality, worst
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3039 * compression).
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3040 * @return 0 if success, or the error code if failure.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	3041 * @ingroup Compression
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3042 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3043 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCompressJpegImage(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3044 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3045 OrthancPluginMemoryBuffer* target,
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3046 OrthancPluginPixelFormat format,
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3047 uint32_t width,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3048 uint32_t height,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3049 uint32_t pitch,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3050 const void* buffer,
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3051 uint8_t quality)
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3052 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3053 _OrthancPluginCompressImage params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3054 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3055 params.target = target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3056 params.imageFormat = OrthancPluginImageFormat_Jpeg;
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3057 params.pixelFormat = format;
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3058 params.width = width;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3059 params.height = height;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3060 params.pitch = pitch;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3061 params.buffer = buffer;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3062 params.quality = quality;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3063
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3064 return context->InvokeService(context, _OrthancPluginService_CompressImage, &params);
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3065 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3066
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3067
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3068
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3069 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3070 * @brief Answer to a REST request with a JPEG image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3071 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3072 * This function answers to a REST request with a JPEG image. The
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3073 * parameters of this function describe a memory buffer that
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3074 * contains an uncompressed image. The image will be automatically compressed
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3075 * as a JPEG image by the core system of Orthanc.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3076 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3077 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3078 * @param output The HTTP connection to the client application.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3079 * @param format The memory layout of the uncompressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3080 * @param width The width of the image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3081 * @param height The height of the image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3082 * @param pitch The pitch of the image (i.e. the number of bytes
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3083 * between 2 successive lines of the image in the memory buffer).
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3084 * @param buffer The memory buffer containing the uncompressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3085 * @param quality The quality of the JPEG encoding, between 1 (worst
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3086 * quality, best compression) and 100 (best quality, worst
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3087 * compression).
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	3088 * @ingroup REST
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3089 **/
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3090 ORTHANC_PLUGIN_INLINE void OrthancPluginCompressAndAnswerJpegImage(
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3091 OrthancPluginContext* context,
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3092 OrthancPluginRestOutput* output,
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3093 OrthancPluginPixelFormat format,
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3094 uint32_t width,
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3095 uint32_t height,
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3096 uint32_t pitch,
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3097 const void* buffer,
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3098 uint8_t quality)
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3099 {
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3100 _OrthancPluginCompressAndAnswerImage params;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3101 params.output = output;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3102 params.imageFormat = OrthancPluginImageFormat_Jpeg;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3103 params.pixelFormat = format;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3104 params.width = width;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3105 params.height = height;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3106 params.pitch = pitch;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3107 params.buffer = buffer;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3108 params.quality = quality;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3109 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, &params);
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3110 }
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3111
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3112
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3113
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3114
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3115 typedef struct
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3116 {
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3117 OrthancPluginMemoryBuffer* target;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3118 OrthancPluginHttpMethod method;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3119 const char* url;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3120 const char* username;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3121 const char* password;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3122 const char* body;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3123 uint32_t bodySize;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3124 } _OrthancPluginCallHttpClient;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3125
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3126
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3127 /**
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3128 * @brief Issue a HTTP GET call.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3129 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3130 * Make a HTTP GET call to the given URL. The result to the query is
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3131 * stored into a newly allocated memory buffer. Favor
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3132 * OrthancPluginRestApiGet() if calling the built-in REST API of the
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3133 * Orthanc instance that hosts this plugin.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3134 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3135 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3136 * @param target The target memory buffer.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3137 * @param url The URL of interest.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3138 * @param username The username (can be <tt>NULL</tt> if no password protection).
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3139 * @param password The password (can be <tt>NULL</tt> if no password protection).
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3140 * @return 0 if success, or the error code if failure.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3141 **/
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3142 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpGet(
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3143 OrthancPluginContext* context,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3144 OrthancPluginMemoryBuffer* target,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3145 const char* url,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3146 const char* username,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3147 const char* password)
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3148 {
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3149 _OrthancPluginCallHttpClient params;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3150 memset(&params, 0, sizeof(params));
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3151
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3152 params.target = target;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3153 params.method = OrthancPluginHttpMethod_Get;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3154 params.url = url;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3155 params.username = username;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3156 params.password = password;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3157
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3158 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, &params);
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3159 }
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3160
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3161
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3162 /**
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3163 * @brief Issue a HTTP POST call.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3164 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3165 * Make a HTTP POST call to the given URL. The result to the query
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3166 * is stored into a newly allocated memory buffer. Favor
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3167 * OrthancPluginRestApiPost() if calling the built-in REST API of
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3168 * the Orthanc instance that hosts this plugin.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3169 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3170 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3171 * @param target The target memory buffer.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3172 * @param url The URL of interest.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3173 * @param body The content of the body of the request.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3174 * @param bodySize The size of the body of the request.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3175 * @param username The username (can be <tt>NULL</tt> if no password protection).
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3176 * @param password The password (can be <tt>NULL</tt> if no password protection).
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3177 * @return 0 if success, or the error code if failure.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3178 **/
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3179 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpPost(
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3180 OrthancPluginContext* context,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3181 OrthancPluginMemoryBuffer* target,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3182 const char* url,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3183 const char* body,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3184 uint32_t bodySize,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3185 const char* username,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3186 const char* password)
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3187 {
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3188 _OrthancPluginCallHttpClient params;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3189 memset(&params, 0, sizeof(params));
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3190
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3191 params.target = target;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3192 params.method = OrthancPluginHttpMethod_Post;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3193 params.url = url;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3194 params.body = body;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3195 params.bodySize = bodySize;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3196 params.username = username;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3197 params.password = password;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3198
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3199 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, &params);
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3200 }
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3201
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3202
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3203 /**
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3204 * @brief Issue a HTTP PUT call.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3205 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3206 * Make a HTTP PUT call to the given URL. The result to the query is
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3207 * stored into a newly allocated memory buffer. Favor
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3208 * OrthancPluginRestApiPut() if calling the built-in REST API of the
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3209 * Orthanc instance that hosts this plugin.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3210 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3211 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3212 * @param target The target memory buffer.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3213 * @param url The URL of interest.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3214 * @param body The content of the body of the request.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3215 * @param bodySize The size of the body of the request.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3216 * @param username The username (can be <tt>NULL</tt> if no password protection).
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3217 * @param password The password (can be <tt>NULL</tt> if no password protection).
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3218 * @return 0 if success, or the error code if failure.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3219 **/
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3220 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpPut(
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3221 OrthancPluginContext* context,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3222 OrthancPluginMemoryBuffer* target,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3223 const char* url,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3224 const char* body,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3225 uint32_t bodySize,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3226 const char* username,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3227 const char* password)
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3228 {
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3229 _OrthancPluginCallHttpClient params;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3230 memset(&params, 0, sizeof(params));
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3231
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3232 params.target = target;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3233 params.method = OrthancPluginHttpMethod_Put;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3234 params.url = url;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3235 params.body = body;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3236 params.bodySize = bodySize;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3237 params.username = username;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3238 params.password = password;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3239
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3240 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, &params);
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3241 }
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3242
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3243
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3244 /**
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3245 * @brief Issue a HTTP DELETE call.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3246 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3247 * Make a HTTP DELETE call to the given URL. Favor
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3248 * OrthancPluginRestApiDelete() if calling the built-in REST API of
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3249 * the Orthanc instance that hosts this plugin.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3250 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3251 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3252 * @param url The URL of interest.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3253 * @param username The username (can be <tt>NULL</tt> if no password protection).
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3254 * @param password The password (can be <tt>NULL</tt> if no password protection).
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3255 * @return 0 if success, or the error code if failure.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3256 **/
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3257 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpDelete(
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3258 OrthancPluginContext* context,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3259 const char* url,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3260 const char* username,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3261 const char* password)
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3262 {
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3263 _OrthancPluginCallHttpClient params;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3264 memset(&params, 0, sizeof(params));
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3265
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3266 params.method = OrthancPluginHttpMethod_Delete;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3267 params.url = url;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3268 params.username = username;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3269 params.password = password;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3270
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3271 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, &params);
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3272 }
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3273
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3274
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3275
1608 adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3276 typedef struct
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3277 {
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3278 OrthancPluginImage** target;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3279 const OrthancPluginImage* source;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3280 OrthancPluginPixelFormat targetFormat;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3281 } _OrthancPluginConvertPixelFormat;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3282
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3283
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3284 /**
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3285 * @brief Change the pixel format of an image.
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3286 *
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3287 * This function creates a new image, changing the memory layout of the pixels.
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3288 *
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3289 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3290 * @param source The source image.
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3291 * @param targetFormat The target pixel format.
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3292 * @return The resulting image. It must be freed with OrthancPluginFreeImage().
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3293 * @ingroup Compression
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3294 **/
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3295 ORTHANC_PLUGIN_INLINE OrthancPluginImage *OrthancPluginConvertPixelFormat(
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3296 OrthancPluginContext* context,
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3297 const OrthancPluginImage* source,
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3298 OrthancPluginPixelFormat targetFormat)
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3299 {
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3300 OrthancPluginImage* target = NULL;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3301
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3302 _OrthancPluginConvertPixelFormat params;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3303 params.target = &target;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3304 params.source = source;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3305 params.targetFormat = targetFormat;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3306
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3307 if (context->InvokeService(context, _OrthancPluginService_ConvertPixelFormat, &params) != OrthancPluginErrorCode_Success)
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3308 {
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3309 return NULL;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3310 }
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3311 else
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3312 {
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3313 return target;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3314 }
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3315 }
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3316
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3317
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3318 #ifdef __cplusplus
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3319 }
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3320 #endif
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	3321
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	3322
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	3323 /** @} */
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	3324

Mercurial > hg > orthanc

annotate Plugins/Include/orthanc/OrthancCPlugin.h @ 1608:adc6a5704cdb