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

annotate Plugins/Include/orthanc/OrthancCPlugin.h @ 1581:357c4bb15701

Plugins have access to explicit error codes

author	Sebastien Jodogne <s.jodogne@gmail.com>
date	Tue, 25 Aug 2015 16:18:37 +0200
parents	bf502300c52e
children	bd1889029cbb

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().
1309 8f4487d8f79e new files for custom database back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 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
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	30 * from being loaded twice.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	31 *
1466 0cd0f2ad3599 Fix potential deadlock in the callbacks of plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1430 diff changeset	32 * The various REST callbacks are guaranteed to be executed in mutual
1187 49edef619f1f note Sebastien Jodogne <s.jodogne@gmail.com> parents: 1177 diff changeset	33 * exclusion since Orthanc 0.8.5.
906 cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	34 **/
cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	35
cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	36
cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	37
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	38 /**
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	39 * @defgroup CInterface C Interface
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	40 * @brief The C interface to create Orthanc plugins.
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	41 *
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	42 * These functions must be used to create C plugins for Orthanc.
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	43 **/
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	44
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	45
906 cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	46
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	47 /**
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	48 * Orthanc - A Lightweight, RESTful DICOM Store
1288 6e7e5ed91c2d upgrade to year 2015 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1282 diff changeset	49 * Copyright (C) 2012-2015 Sebastien Jodogne, Medical Physics
6e7e5ed91c2d upgrade to year 2015 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1282 diff changeset	50 * Department, University Hospital of Liege, Belgium
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	51 *
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	52 * This program is free software: you can redistribute it and/or
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	53 * modify it under the terms of the GNU General Public License as
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	54 * published by the Free Software Foundation, either version 3 of the
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	55 * License, or (at your option) any later version.
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	56 *
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	57 * In addition, as a special exception, the copyright holders of this
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	58 * program give permission to link the code of its release with the
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	59 * OpenSSL project's "OpenSSL" library (or with modified versions of it
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	60 * that use the same license as the "OpenSSL" library), and distribute
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	61 * the linked executables. You must obey the GNU General Public License
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	62 * 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	63 * modify file(s) with this exception, you may extend this exception to
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	64 * 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	65 * 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	66 * version. If you delete this exception statement from all source files
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	67 * in the program, then also delete it here.
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	68 *
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	69 * 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	70 * WITHOUT ANY WARRANTY; without even the implied warranty of
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	71 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	72 * General Public License for more details.
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	73 *
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	74 * You should have received a copy of the GNU General Public License
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	75 * along with this program. If not, see <http://www.gnu.org/licenses/>.
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	76 **/
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	77
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	78
906 cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	79
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	80 #pragma once
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	81
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	82
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	83 #include <stdio.h>
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	84 #include <string.h>
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	85
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	86 #ifdef WIN32
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	87 #define ORTHANC_PLUGINS_API __declspec(dllexport)
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	88 #else
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	89 #define ORTHANC_PLUGINS_API
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	90 #endif
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	91
1039 5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	92 #define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 0
1407 d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	93 #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	94 #define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 4
1039 5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	95
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	96
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	97
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	98 /********************************************************************
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	99 ** Check that function inlining is properly supported. The use of
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	100 ** inlining is required, to avoid the duplication of object code
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	101 ** between two compilation modules that would use the Orthanc Plugin
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	102 ** API.
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	103 ********************************************************************/
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	104
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	105 /* 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	106 automatically and that your compiler is known to properly support
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	107 inlining, uncomment the following #define and adapt the definition
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	108 of "static inline". */
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	109
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	110 /* #define ORTHANC_PLUGIN_INLINE static inline */
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	111
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	112 #ifndef ORTHANC_PLUGIN_INLINE
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	113 # if __STDC_VERSION__ >= 199901L
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	114 /* 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	115 # define ORTHANC_PLUGIN_INLINE static inline
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	116 # elif defined(__cplusplus)
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	117 /* This is C++ */
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	118 # define ORTHANC_PLUGIN_INLINE static inline
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	119 # elif defined(__GNUC__)
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	120 /* This is GCC running in C89 mode */
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	121 # define ORTHANC_PLUGIN_INLINE static __inline
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	122 # elif defined(_MSC_VER)
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	123 /* This is Visual Studio running in C89 mode */
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	124 # define ORTHANC_PLUGIN_INLINE static __inline
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	125 # else
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	126 # 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	127 # endif
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	128 #endif
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
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	131
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	132 /********************************************************************
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	133 ** Inclusion of standard libraries.
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	134 ********************************************************************/
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	135
1322 f497a72d9f71 fixes to the sample plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1313 diff changeset	136 /**
f497a72d9f71 fixes to the sample plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1313 diff changeset	137 * 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	138 * downloaded at the following URL:
f497a72d9f71 fixes to the sample plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1313 diff changeset	139 * 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	140 **/
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	141 #include <stdint.h>
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	142
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	143 #include <stdlib.h>
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	144
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	145
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	146
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 ** Definition of the Orthanc Plugin API.
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
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	151 /** @{ */
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	152
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	153 #ifdef __cplusplus
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	154 extern "C"
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	155 {
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	156 #endif
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	157
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	158 /**
1578 09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	159 * The various error codes that can be returned by the Orthanc core.
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	160 **/
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	161 typedef enum
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	162 {
1579 b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	163 OrthancPluginErrorCode_Custom = -2 /!< Custom error, see the attached error message /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	164 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	165 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	166 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	167 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	168 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	169 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	170 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	171 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	172 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	173 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	174 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	175 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	176 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	177 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	178 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	179 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	180 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	181 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	182 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	183 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	184 OrthancPluginErrorCode_FullStorage = 19 /!< The file storage is full /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	185 OrthancPluginErrorCode_CorruptedFile = 20 /!< Corrupted file (inconsistent MD5 hash) /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	186 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	187 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	188 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	189 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	190 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	191 OrthancPluginErrorCode_UnknownPluginService = 26 /!< Plugin invoking an unknown service /,
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	192
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	193 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
1578 09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	194 } OrthancPluginErrorCode;
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	195
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	196
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	197 /**
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	198 * 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	199 * plugins.
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	200 **/
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	201 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	202
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	203
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	204 /**
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	205 * The various HTTP methods for a REST call.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	206 **/
894 690aeb4cb899 REST callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 888 diff changeset	207 typedef enum
690aeb4cb899 REST callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 888 diff changeset	208 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	209 OrthancPluginHttpMethod_Get = 1, /!< GET request /
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	210 OrthancPluginHttpMethod_Post = 2, /!< POST request /
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	211 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	212 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	213
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	214 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
896 c4053ac5db04 better plugni api Sebastien Jodogne <s.jodogne@gmail.com> parents: 894 diff changeset	215 } OrthancPluginHttpMethod;
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	216
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	217
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	218 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	219 * @brief The parameters of a REST request.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	220 **/
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	221 typedef struct
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	222 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	223 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	224 * @brief The HTTP method.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	225 **/
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	226 OrthancPluginHttpMethod method;
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	227
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	228 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	229 * @brief The number of groups of the regular expression.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	230 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	231 uint32_t groupsCount;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	232
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	233 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	234 * @brief The matched values for the groups of the regular expression.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	235 **/
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	236 const char* const* groups;
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	237
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	238 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	239 * @brief For a GET request, the number of GET parameters.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	240 **/
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	241 uint32_t getCount;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	242
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	243 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	244 * @brief For a GET request, the keys of the GET parameters.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	245 **/
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	246 const char* const* getKeys;
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	247
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	248 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	249 * @brief For a GET request, the values of the GET parameters.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	250 **/
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	251 const char* const* getValues;
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	252
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	253 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	254 * @brief For a PUT or POST request, the content of the body.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	255 **/
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	256 const char* body;
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	257
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	258 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	259 * @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	260 **/
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	261 uint32_t bodySize;
1041 2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	262
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	263
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	264 /* --------------------------------------------------
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	265 New in version 0.8.1
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	266 -------------------------------------------------- */
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	267
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	268 /**
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	269 * @brief The number of HTTP headers.
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	270 **/
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	271 uint32_t headersCount;
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	272
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	273 /**
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	274 * @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	275 **/
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	276 const char* const* headersKeys;
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	277
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	278 /**
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	279 * @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	280 **/
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	281 const char* const* headersValues;
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	282
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	283 } OrthancPluginHttpRequest;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	284
1041 2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	285
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	286 typedef enum
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	287 {
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	288 /* Generic services */
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	289 _OrthancPluginService_LogInfo = 1,
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	290 _OrthancPluginService_LogWarning = 2,
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	291 _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	292 _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	293 _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	294 _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	295 _OrthancPluginService_SetPluginProperty = 7,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	296 _OrthancPluginService_GetGlobalProperty = 8,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	297 _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	298 _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	299 _OrthancPluginService_GetCommandLineArgument = 11,
1407 d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	300 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
1424 fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	301 _OrthancPluginService_GetConfiguration = 13,
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	302 _OrthancPluginService_BufferCompression = 14,
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	303
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	304 /* Registration of callbacks */
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	305 _OrthancPluginService_RegisterRestCallback = 1000,
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	306 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	307 _OrthancPluginService_RegisterStorageArea = 1002,
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	308 _OrthancPluginService_RegisterOnChangeCallback = 1003,
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	309
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	310 /* Sending answers to REST calls */
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	311 _OrthancPluginService_AnswerBuffer = 2000,
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	312 _OrthancPluginService_CompressAndAnswerPngImage = 2001,
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	313 _OrthancPluginService_Redirect = 2002,
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	314 _OrthancPluginService_SendHttpStatusCode = 2003,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	315 _OrthancPluginService_SendUnauthorized = 2004,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	316 _OrthancPluginService_SendMethodNotAllowed = 2005,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	317 _OrthancPluginService_SetCookie = 2006,
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	318 _OrthancPluginService_SetHttpHeader = 2007,
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	319 _OrthancPluginService_StartMultipartAnswer = 2008,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	320 _OrthancPluginService_SendMultipartItem = 2009,
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	321
912 dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	322 /* Access to the Orthanc database and API */
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	323 _OrthancPluginService_GetDicomForInstance = 3000,
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	324 _OrthancPluginService_RestApiGet = 3001,
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	325 _OrthancPluginService_RestApiPost = 3002,
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	326 _OrthancPluginService_RestApiDelete = 3003,
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	327 _OrthancPluginService_RestApiPut = 3004,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	328 _OrthancPluginService_LookupPatient = 3005,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	329 _OrthancPluginService_LookupStudy = 3006,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	330 _OrthancPluginService_LookupSeries = 3007,
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	331 _OrthancPluginService_LookupInstance = 3008,
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	332 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	333 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	334 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	335 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	336 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	337
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	338 /* Access to DICOM instances */
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	339 _OrthancPluginService_GetInstanceRemoteAet = 4000,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	340 _OrthancPluginService_GetInstanceSize = 4001,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	341 _OrthancPluginService_GetInstanceData = 4002,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	342 _OrthancPluginService_GetInstanceJson = 4003,
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	343 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	344 _OrthancPluginService_HasInstanceMetadata = 4005,
1309 8f4487d8f79e new files for custom database back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 diff changeset	345 _OrthancPluginService_GetInstanceMetadata = 4006,
8f4487d8f79e new files for custom database back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 diff changeset	346
8f4487d8f79e new files for custom database back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 diff changeset	347 /* 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	348 _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	349 _OrthancPluginService_DatabaseAnswer = 5001,
1309 8f4487d8f79e new files for custom database back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 diff changeset	350
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	351 _OrthancPluginService_INTERNAL = 0x7fffffff
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	352 } _OrthancPluginService;
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	353
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	354
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	355 typedef enum
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	356 {
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	357 _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	358 _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	359 _OrthancPluginProperty_OrthancExplorer = 3,
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	360
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	361 _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	362 } _OrthancPluginProperty;
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	363
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	364
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	365
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	366 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	367 * The memory layout of the pixels of an image.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	368 **/
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	369 typedef enum
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	370 {
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	371 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	372 * @brief Graylevel 8bpp image.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	373 *
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	374 * 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	375 * one byte.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	376 **/
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	377 OrthancPluginPixelFormat_Grayscale8 = 1,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	378
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	379 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	380 * @brief Graylevel, unsigned 16bpp image.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	381 *
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	382 * 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	383 * two bytes.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	384 **/
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	385 OrthancPluginPixelFormat_Grayscale16 = 2,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	386
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	387 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	388 * @brief Graylevel, signed 16bpp image.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	389 *
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	390 * 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	391 * bytes.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	392 **/
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	393 OrthancPluginPixelFormat_SignedGrayscale16 = 3,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	394
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	395 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	396 * @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	397 *
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	398 * 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	399 * 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	400 **/
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	401 OrthancPluginPixelFormat_RGB24 = 4,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	402
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	403 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	404 * @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	405 *
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	406 * 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	407 * 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	408 **/
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	409 OrthancPluginPixelFormat_RGBA32 = 5,
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	410
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	411 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	412 } OrthancPluginPixelFormat;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	413
894 690aeb4cb899 REST callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 888 diff changeset	414
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	415
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	416 /**
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	417 * 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	418 **/
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	419 typedef enum
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	420 {
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	421 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	422 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	423 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	424
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	425 _OrthancPluginContentType_INTERNAL = 0x7fffffff
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	426 } OrthancPluginContentType;
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	427
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	428
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	429
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	430 /**
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	431 * The supported types of DICOM resources.
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	432 **/
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	433 typedef enum
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	434 {
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	435 OrthancPluginResourceType_Patient = 0, /!< Patient /
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	436 OrthancPluginResourceType_Study = 1, /!< Study /
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	437 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	438 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	439
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	440 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	441 } OrthancPluginResourceType;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	442
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	443
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	444
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	445 /**
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	446 * The supported types of changes that can happen to DICOM resources.
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	447 **/
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	448 typedef enum
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	449 {
1198 1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	450 OrthancPluginChangeType_CompletedSeries = 0, /!< Series is now complete /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	451 OrthancPluginChangeType_Deleted = 1, /!< Deleted resource /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	452 OrthancPluginChangeType_NewChildInstance = 2, /!< A new instance was added to this resource /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	453 OrthancPluginChangeType_NewInstance = 3, /!< New instance received /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	454 OrthancPluginChangeType_NewPatient = 4, /!< New patient created /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	455 OrthancPluginChangeType_NewSeries = 5, /!< New series created /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	456 OrthancPluginChangeType_NewStudy = 6, /!< New study created /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	457 OrthancPluginChangeType_StablePatient = 7, /!< Timeout: No new instance in this patient /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	458 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	459 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	460
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	461 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	462 } OrthancPluginChangeType;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	463
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	464
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	465 /**
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	466 * The compression algorithms that are known by the Orthanc core.
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	467 **/
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	468 typedef enum
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	469 {
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	470 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	471 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	472 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	473 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	474
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	475 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	476 } OrthancPluginCompressionType;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	477
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	478
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	479
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	480 /**
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	481 * @brief A memory buffer allocated by the core system of Orthanc.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	482 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	483 * A memory buffer allocated by the core system of Orthanc. When the
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	484 * 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	485 * call to ::OrthancPluginFreeMemoryBuffer().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	486 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	487 typedef struct
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	488 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	489 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	490 * @brief The content of the buffer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	491 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	492 void* data;
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	493
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	494 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	495 * @brief The number of bytes in the buffer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	496 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	497 uint32_t size;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	498 } OrthancPluginMemoryBuffer;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	499
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	500
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	501
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	502
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	503 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	504 * @brief Opaque structure that represents the HTTP connection to the client application.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	505 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	506 typedef struct _OrthancPluginRestOutput_t OrthancPluginRestOutput;
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	507
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	508
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	509
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	510 /**
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	511 * @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	512 **/
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	513 typedef struct _OrthancPluginDicomInstance_t OrthancPluginDicomInstance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	514
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	515
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	516
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	517 /**
908 e078ea944089 refactoring HttpOutput Sebastien Jodogne <s.jodogne@gmail.com> parents: 907 diff changeset	518 * @brief Signature of a callback function that answers to a REST request.
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	519 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	520 typedef int32_t (*OrthancPluginRestCallback) (
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	521 OrthancPluginRestOutput* output,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	522 const char* url,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	523 const OrthancPluginHttpRequest* request);
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	524
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	525
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	526
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	527 /**
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	528 * @brief Signature of a callback function that is triggered when Orthanc receives a DICOM instance.
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	529 **/
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	530 typedef int32_t (*OrthancPluginOnStoredInstanceCallback) (
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	531 OrthancPluginDicomInstance* instance,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	532 const char* instanceId);
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	533
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	534
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	535
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	536 /**
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	537 * @brief Signature of a callback function that is triggered when a change happens to some DICOM resource.
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 typedef int32_t (*OrthancPluginOnChangeCallback) (
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	540 OrthancPluginChangeType changeType,
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	541 OrthancPluginResourceType resourceType,
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	542 const char* resourceId);
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	543
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	544
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	545
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	546 /**
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	547 * @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	548 **/
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	549 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	550
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	551
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	552
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	553 /**
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	554 * @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	555 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	556 * 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	557 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	558 * @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	559 * @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	560 * @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	561 * @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	562 * @return 0 if success, other value if error.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	563 **/
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	564 typedef int32_t (*OrthancPluginStorageCreate) (
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	565 const char* uuid,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	566 const void* content,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	567 int64_t size,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	568 OrthancPluginContentType type);
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	569
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	570
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	571
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	572 /**
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	573 * @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	574 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	575 * 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	576 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	577 * @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	578 * @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	579 * @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	580 * @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	581 * @return 0 if success, other value if error.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	582 **/
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	583 typedef int32_t (*OrthancPluginStorageRead) (
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	584 void** content,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	585 int64_t* size,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	586 const char* uuid,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	587 OrthancPluginContentType type);
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	588
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	589
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	590
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	591 /**
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	592 * @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	593 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	594 * 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	595 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	596 * @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	597 * @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	598 * @return 0 if success, other value if error.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	599 **/
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	600 typedef int32_t (*OrthancPluginStorageRemove) (
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	601 const char* uuid,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	602 OrthancPluginContentType type);
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	603
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	604
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	605
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	606 /**
1297 501432928727 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1295 diff changeset	607 * @brief Data structure that contains information about the Orthanc core.
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	608 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	609 typedef struct _OrthancPluginContext_t
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	610 {
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	611 void* pluginsManager;
357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	612 const char* orthancVersion;
357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	613 OrthancPluginFree Free;
357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	614 OrthancPluginErrorCode (InvokeService) (struct _OrthancPluginContext_t context,
357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	615 _OrthancPluginService service,
357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	616 const void* params);
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	617 } OrthancPluginContext;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	618
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	619
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	620
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	621 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	622 * @brief Free a string.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	623 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	624 * Free a string that was allocated by the core system of Orthanc.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	625 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	626 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	627 * @param str The string to be freed.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	628 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	629 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeString(
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	630 OrthancPluginContext* context,
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	631 char* str)
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	632 {
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	633 if (str != NULL)
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	634 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	635 context->Free(str);
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	636 }
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	637 }
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	638
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	639
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	640 /**
1041 2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	641 * @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	642 *
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	643 * 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	644 * 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	645 * this function should always be checked in the
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	646 * OrthancPluginInitialize() entry point of the plugin.
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	647 *
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	648 * @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	649 * @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	650 * result is 0, the initialization of the plugin should fail.
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	651 **/
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	652 ORTHANC_PLUGIN_INLINE int OrthancPluginCheckVersion(
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	653 OrthancPluginContext* context)
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	654 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	655 int major, minor, revision;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	656
1579 b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	657 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	658 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	659 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	660 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	661 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	662 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	663 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	664 sizeof(int32_t) != sizeof(OrthancPluginChangeType) \|\|
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	665 sizeof(int32_t) != sizeof(OrthancPluginCompressionType))
1578 09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	666 {
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	667 /* Mismatch in the size of the enumerations */
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	668 return 0;
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	669 }
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	670
1039 5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	671 /* Assume compatibility with the mainline */
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	672 if (!strcmp(context->orthancVersion, "mainline"))
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	673 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	674 return 1;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	675 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	676
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	677 /* Parse the version of the Orthanc core */
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	678 if (
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	679 #ifdef _MSC_VER
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	680 sscanf_s
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	681 #else
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	682 sscanf
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	683 #endif
1303 bba8a47922d1 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1297 diff changeset	684 (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	685 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	686 return 0;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	687 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	688
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	689 /* Check the major number of the version */
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	690
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	691 if (major > ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	692 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	693 return 1;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	694 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	695
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	696 if (major < ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	697 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	698 return 0;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	699 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	700
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	701 /* Check the minor number of the version */
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	702
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	703 if (minor > ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	704 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	705 return 1;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	706 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	707
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	708 if (minor < ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	709 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	710 return 0;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	711 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	712
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	713 /* Check the revision number of the version */
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	714
1040 d06186cdc502 check plugin version in samples Sebastien Jodogne <s.jodogne@gmail.com> parents: 1039 diff changeset	715 if (revision >= ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER)
1039 5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	716 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	717 return 1;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	718 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	719 else
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	720 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	721 return 0;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	722 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	723 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	724
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	725
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	726 /**
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	727 * @brief Free a memory buffer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	728 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	729 * 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	730 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	731 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	732 * @param buffer The memory buffer to release.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	733 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	734 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeMemoryBuffer(
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	735 OrthancPluginContext* context,
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	736 OrthancPluginMemoryBuffer* buffer)
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	737 {
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	738 context->Free(buffer->data);
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	739 }
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	740
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	741
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	742 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	743 * @brief Log an error.
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 * Log an error message using the Orthanc logging system.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	746 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	747 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	748 * @param message The message to be logged.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	749 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	750 ORTHANC_PLUGIN_INLINE void OrthancPluginLogError(
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	751 OrthancPluginContext* context,
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	752 const char* message)
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	753 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	754 context->InvokeService(context, _OrthancPluginService_LogError, message);
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	755 }
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	756
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	757
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	758 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	759 * @brief Log a warning.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	760 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	761 * Log a warning message using the Orthanc logging system.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	762 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	763 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	764 * @param message The message to be logged.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	765 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	766 ORTHANC_PLUGIN_INLINE void OrthancPluginLogWarning(
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	767 OrthancPluginContext* context,
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	768 const char* message)
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	769 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	770 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	771 }
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	772
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	773
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	774 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	775 * @brief Log an information.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	776 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	777 * Log an information message using the Orthanc logging system.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	778 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	779 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	780 * @param message The message to be logged.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	781 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	782 ORTHANC_PLUGIN_INLINE void OrthancPluginLogInfo(
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	783 OrthancPluginContext* context,
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	784 const char* message)
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	785 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	786 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	787 }
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	788
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	789
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	790
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	791 typedef struct
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	792 {
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	793 const char* pathRegularExpression;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	794 OrthancPluginRestCallback callback;
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	795 } _OrthancPluginRestCallback;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	796
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	797 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	798 * @brief Register a REST callback.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	799 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	800 * This function registers a REST callback against a regular
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	801 * expression for a URI. This function must be called during the
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	802 * initialization of the plugin, i.e. inside the
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	803 * OrthancPluginInitialize() public function.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	804 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	805 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	806 * @param pathRegularExpression Regular expression for the URI. May contain groups.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	807 * @param callback The callback function to handle the REST call.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	808 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	809 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterRestCallback(
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	810 OrthancPluginContext* context,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	811 const char* pathRegularExpression,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	812 OrthancPluginRestCallback callback)
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	813 {
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	814 _OrthancPluginRestCallback params;
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	815 params.pathRegularExpression = pathRegularExpression;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	816 params.callback = callback;
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	817 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, &params);
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	818 }
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	819
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	820
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	821
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	822 typedef struct
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	823 {
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	824 OrthancPluginOnStoredInstanceCallback callback;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	825 } _OrthancPluginOnStoredInstanceCallback;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	826
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	827 /**
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	828 * @brief Register a callback for received instances.
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	829 *
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	830 * This function registers a callback function that is called
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	831 * 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	832 *
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	833 * @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	834 * @param callback The callback function.
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	835 **/
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	836 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterOnStoredInstanceCallback(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	837 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	838 OrthancPluginOnStoredInstanceCallback callback)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	839 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	840 _OrthancPluginOnStoredInstanceCallback params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	841 params.callback = callback;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	842
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	843 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, &params);
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	844 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	845
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	846
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	847
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	848 typedef struct
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	849 {
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	850 OrthancPluginRestOutput* output;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	851 const char* answer;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	852 uint32_t answerSize;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	853 const char* mimeType;
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	854 } _OrthancPluginAnswerBuffer;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	855
907 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 * @brief Answer to a REST request.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	858 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	859 * 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	860 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	861 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	862 * @param output The HTTP connection to the client application.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	863 * @param answer Pointer to the memory buffer containing the answer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	864 * @param answerSize Number of bytes of the answer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	865 * @param mimeType The MIME type of the answer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	866 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	867 ORTHANC_PLUGIN_INLINE void OrthancPluginAnswerBuffer(
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	868 OrthancPluginContext* context,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	869 OrthancPluginRestOutput* output,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	870 const char* answer,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	871 uint32_t answerSize,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	872 const char* mimeType)
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	873 {
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	874 _OrthancPluginAnswerBuffer params;
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	875 params.output = output;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	876 params.answer = answer;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	877 params.answerSize = answerSize;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	878 params.mimeType = mimeType;
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	879 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, &params);
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	880 }
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	881
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	882
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	883 typedef struct
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	884 {
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	885 OrthancPluginRestOutput* output;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	886 OrthancPluginPixelFormat format;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	887 uint32_t width;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	888 uint32_t height;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	889 uint32_t pitch;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	890 const void* buffer;
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	891 } _OrthancPluginCompressAndAnswerPngImage;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	892
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	893 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	894 * @brief Answer to a REST request with a PNG image.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	895 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	896 * This function answers to a REST request with a PNG image. The
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	897 * parameters of this function describe a memory buffer that
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	898 * contains an uncompressed image. The image will be automatically compressed
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	899 * as a PNG image by the core system of Orthanc.
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 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	902 * @param output The HTTP connection to the client application.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	903 * @param format The memory layout of the uncompressed image.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	904 * @param width The width of the image.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	905 * @param height The height of the image.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	906 * @param pitch The pitch of the image (i.e. the number of bytes
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	907 * between 2 successive lines of the image in the memory buffer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	908 * @param buffer The memory buffer containing the uncompressed image.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	909 **/
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	910 ORTHANC_PLUGIN_INLINE void OrthancPluginCompressAndAnswerPngImage(
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	911 OrthancPluginContext* context,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	912 OrthancPluginRestOutput* output,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	913 OrthancPluginPixelFormat format,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	914 uint32_t width,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	915 uint32_t height,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	916 uint32_t pitch,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	917 const void* buffer)
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	918 {
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	919 _OrthancPluginCompressAndAnswerPngImage params;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	920 params.output = output;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	921 params.format = format;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	922 params.width = width;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	923 params.height = height;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	924 params.pitch = pitch;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	925 params.buffer = buffer;
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	926 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerPngImage, &params);
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	927 }
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	928
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	929
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	930
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	931 typedef struct
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	932 {
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	933 OrthancPluginMemoryBuffer* target;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	934 const char* instanceId;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	935 } _OrthancPluginGetDicomForInstance;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	936
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	937 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	938 * @brief Retrieve a DICOM instance using its Orthanc identifier.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	939 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	940 * Retrieve a DICOM instance using its Orthanc identifier. The DICOM
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	941 * file is stored into a newly allocated memory buffer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	942 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	943 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	944 * @param target The target memory buffer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	945 * @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	946 * @return 0 if success, or the error code if failure.
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	947 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	948 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginGetDicomForInstance(
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	949 OrthancPluginContext* context,
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	950 OrthancPluginMemoryBuffer* target,
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	951 const char* instanceId)
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	952 {
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	953 _OrthancPluginGetDicomForInstance params;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	954 params.target = target;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	955 params.instanceId = instanceId;
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	956 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, &params);
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	957 }
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	958
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	959
912 dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	960
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	961 typedef struct
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	962 {
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	963 OrthancPluginMemoryBuffer* target;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	964 const char* uri;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	965 } _OrthancPluginRestApiGet;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	966
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	967 /**
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	968 * @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	969 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	970 * 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	971 * 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	972 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	973 * @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	974 * @param target The target memory buffer.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	975 * @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	976 * @return 0 if success, or the error code if failure.
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	977 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	978 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiGet(
912 dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	979 OrthancPluginContext* context,
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	980 OrthancPluginMemoryBuffer* target,
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	981 const char* uri)
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	982 {
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	983 _OrthancPluginRestApiGet params;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	984 params.target = target;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	985 params.uri = uri;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	986 return context->InvokeService(context, _OrthancPluginService_RestApiGet, &params);
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	987 }
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	988
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	989
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	990
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	991 /**
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	992 * @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	993 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	994 * 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	995 * 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	996 * 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	997 * 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	998 * 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	999 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1000 * @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	1001 * @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	1002 * @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	1003 * @return 0 if success, or the error code if failure.
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1004 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1005 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	1006 OrthancPluginContext* context,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1007 OrthancPluginMemoryBuffer* target,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1008 const char* uri)
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1009 {
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1010 _OrthancPluginRestApiGet params;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1011 params.target = target;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1012 params.uri = uri;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1013 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	1014 }
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1015
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1016
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1017
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1018 typedef struct
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1019 {
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1020 OrthancPluginMemoryBuffer* target;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1021 const char* uri;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1022 const char* body;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1023 uint32_t bodySize;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1024 } _OrthancPluginRestApiPostPut;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1025
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1026 /**
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1027 * @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	1028 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1029 * 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	1030 * 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	1031 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1032 * @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	1033 * @param target The target memory buffer.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1034 * @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	1035 * @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	1036 * @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	1037 * @return 0 if success, or the error code if failure.
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1038 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1039 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPost(
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1040 OrthancPluginContext* context,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1041 OrthancPluginMemoryBuffer* target,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1042 const char* uri,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1043 const char* body,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1044 uint32_t bodySize)
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1045 {
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1046 _OrthancPluginRestApiPostPut params;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1047 params.target = target;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1048 params.uri = uri;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1049 params.body = body;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1050 params.bodySize = bodySize;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1051 return context->InvokeService(context, _OrthancPluginService_RestApiPost, &params);
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1052 }
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1053
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1054
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1055 /**
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1056 * @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	1057 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1058 * 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	1059 * 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	1060 * 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	1061 * 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	1062 * 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	1063 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1064 * @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	1065 * @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	1066 * @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	1067 * @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	1068 * @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	1069 * @return 0 if success, or the error code if failure.
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1070 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1071 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	1072 OrthancPluginContext* context,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1073 OrthancPluginMemoryBuffer* target,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1074 const char* uri,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1075 const char* body,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1076 uint32_t bodySize)
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1077 {
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1078 _OrthancPluginRestApiPostPut params;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1079 params.target = target;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1080 params.uri = uri;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1081 params.body = body;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1082 params.bodySize = bodySize;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1083 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	1084 }
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1085
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1086
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1087
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1088 /**
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1089 * @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	1090 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1091 * 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	1092 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1093 * @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	1094 * @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	1095 * @return 0 if success, or the error code if failure.
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1096 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1097 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiDelete(
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1098 OrthancPluginContext* context,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1099 const char* uri)
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1100 {
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1101 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1102 }
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1103
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1104
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1105 /**
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1106 * @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	1107 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1108 * 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	1109 * 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	1110 * 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	1111 * 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	1112 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1113 * @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	1114 * @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	1115 * @return 0 if success, or the error code if failure.
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1116 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1117 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	1118 OrthancPluginContext* context,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1119 const char* uri)
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1120 {
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1121 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	1122 }
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1123
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1124
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1125
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1126 /**
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1127 * @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	1128 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1129 * 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	1130 * 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	1131 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1132 * @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	1133 * @param target The target memory buffer.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1134 * @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	1135 * @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	1136 * @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	1137 * @return 0 if success, or the error code if failure.
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1138 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1139 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPut(
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1140 OrthancPluginContext* context,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1141 OrthancPluginMemoryBuffer* target,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1142 const char* uri,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1143 const char* body,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1144 uint32_t bodySize)
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1145 {
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1146 _OrthancPluginRestApiPostPut params;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1147 params.target = target;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1148 params.uri = uri;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1149 params.body = body;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1150 params.bodySize = bodySize;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1151 return context->InvokeService(context, _OrthancPluginService_RestApiPut, &params);
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
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1154
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1155
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1156 /**
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1157 * @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	1158 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1159 * 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	1160 * 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	1161 * 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	1162 * 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	1163 * 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	1164 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1165 * @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	1166 * @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	1167 * @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	1168 * @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	1169 * @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	1170 * @return 0 if success, or the error code if failure.
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1171 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1172 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	1173 OrthancPluginContext* context,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1174 OrthancPluginMemoryBuffer* target,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1175 const char* uri,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1176 const char* body,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1177 uint32_t bodySize)
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 _OrthancPluginRestApiPostPut params;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1180 params.target = target;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1181 params.uri = uri;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1182 params.body = body;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1183 params.bodySize = bodySize;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1184 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	1185 }
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1186
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1187
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1188
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1189 typedef struct
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1190 {
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1191 OrthancPluginRestOutput* output;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1192 const char* argument;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1193 } _OrthancPluginOutputPlusArgument;
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1194
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1195 /**
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1196 * @brief Redirect a REST request.
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1197 *
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1198 * 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	1199 * to another URI using HTTP status 301.
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1200 *
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1201 * @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	1202 * @param output The HTTP connection to the client application.
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1203 * @param redirection Where to redirect.
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1204 **/
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1205 ORTHANC_PLUGIN_INLINE void OrthancPluginRedirect(
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1206 OrthancPluginContext* context,
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1207 OrthancPluginRestOutput* output,
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1208 const char* redirection)
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1209 {
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1210 _OrthancPluginOutputPlusArgument params;
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1211 params.output = output;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1212 params.argument = redirection;
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1213 context->InvokeService(context, _OrthancPluginService_Redirect, &params);
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1214 }
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1215
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1216
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1217
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1218 typedef struct
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1219 {
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1220 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	1221 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	1222 } _OrthancPluginRetrieveDynamicString;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1223
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1224 /**
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1225 * @brief Look for a patient.
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1226 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1227 * 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	1228 * 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	1229 * over all the stored patients).
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1230 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1231 * @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	1232 * @param patientID The Patient ID of interest.
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1233 * @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	1234 * Orthanc ID of the patient. This string must be freed by OrthancPluginFreeString().
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1235 **/
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1236 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupPatient(
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1237 OrthancPluginContext* context,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1238 const char* patientID)
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1239 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1240 char* result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1241
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1242 _OrthancPluginRetrieveDynamicString params;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1243 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	1244 params.argument = patientID;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1245
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1246 if (context->InvokeService(context, _OrthancPluginService_LookupPatient, &params))
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1247 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1248 /* Error */
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1249 return NULL;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1250 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1251 else
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1252 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1253 return result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1254 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1255 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1256
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1257
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1258 /**
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1259 * @brief Look for a study.
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1260 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1261 * 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	1262 * 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	1263 * over all the stored studies).
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1264 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1265 * @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	1266 * @param studyUID The Study Instance UID of interest.
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1267 * @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	1268 * Orthanc ID of the study. This string must be freed by OrthancPluginFreeString().
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1269 **/
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1270 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupStudy(
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1271 OrthancPluginContext* context,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1272 const char* studyUID)
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1273 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1274 char* result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1275
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1276 _OrthancPluginRetrieveDynamicString params;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1277 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	1278 params.argument = studyUID;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1279
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1280 if (context->InvokeService(context, _OrthancPluginService_LookupStudy, &params))
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1281 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1282 /* Error */
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1283 return NULL;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1284 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1285 else
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1286 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1287 return result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1288 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1289 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1290
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1291
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1292 /**
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1293 * @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	1294 *
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1295 * 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	1296 * 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	1297 * over all the stored studies).
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1298 *
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1299 * @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	1300 * @param accessionNumber The Accession Number of interest.
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1301 * @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	1302 * Orthanc ID of the study. This string must be freed by OrthancPluginFreeString().
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1303 **/
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1304 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupStudyWithAccessionNumber(
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1305 OrthancPluginContext* context,
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1306 const char* accessionNumber)
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1307 {
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1308 char* result;
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1309
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1310 _OrthancPluginRetrieveDynamicString params;
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1311 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	1312 params.argument = accessionNumber;
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1313
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1314 if (context->InvokeService(context, _OrthancPluginService_LookupStudyWithAccessionNumber, &params))
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1315 {
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1316 /* Error */
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1317 return NULL;
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1318 }
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1319 else
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1320 {
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1321 return result;
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1322 }
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1323 }
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1324
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1325
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1326 /**
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1327 * @brief Look for a series.
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1328 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1329 * 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	1330 * 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	1331 * over all the stored series).
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1332 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1333 * @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	1334 * @param seriesUID The Series Instance UID of interest.
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1335 * @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	1336 * Orthanc ID of the series. This string must be freed by OrthancPluginFreeString().
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1337 **/
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1338 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupSeries(
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1339 OrthancPluginContext* context,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1340 const char* seriesUID)
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1341 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1342 char* result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1343
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1344 _OrthancPluginRetrieveDynamicString params;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1345 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	1346 params.argument = seriesUID;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1347
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1348 if (context->InvokeService(context, _OrthancPluginService_LookupSeries, &params))
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1349 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1350 /* Error */
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1351 return NULL;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1352 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1353 else
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1354 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1355 return result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1356 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1357 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1358
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1359
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1360 /**
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1361 * @brief Look for an instance.
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1362 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1363 * 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	1364 * 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	1365 * over all the stored instances).
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1366 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1367 * @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	1368 * @param sopInstanceUID The SOP Instance UID of interest.
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1369 * @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	1370 * Orthanc ID of the instance. This string must be freed by OrthancPluginFreeString().
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1371 **/
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1372 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupInstance(
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1373 OrthancPluginContext* context,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1374 const char* sopInstanceUID)
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1375 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1376 char* result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1377
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1378 _OrthancPluginRetrieveDynamicString params;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1379 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	1380 params.argument = sopInstanceUID;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1381
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1382 if (context->InvokeService(context, _OrthancPluginService_LookupInstance, &params))
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1383 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1384 /* Error */
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1385 return NULL;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1386 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1387 else
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1388 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1389 return result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1390 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1391 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1392
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1393
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1394
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1395 typedef struct
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1396 {
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1397 OrthancPluginRestOutput* output;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1398 uint16_t status;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1399 } _OrthancPluginSendHttpStatusCode;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1400
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1401 /**
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1402 * @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	1403 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1404 * 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	1405 * 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	1406 * - 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	1407 * - 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	1408 * - 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	1409 * - 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	1410 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1411 * @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	1412 * @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	1413 * @param status The HTTP status code to be sent.
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1414 **/
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1415 ORTHANC_PLUGIN_INLINE void OrthancPluginSendHttpStatusCode(
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1416 OrthancPluginContext* context,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1417 OrthancPluginRestOutput* output,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1418 uint16_t status)
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1419 {
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1420 _OrthancPluginSendHttpStatusCode params;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1421 params.output = output;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1422 params.status = status;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1423 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	1424 }
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1425
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1426
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1427 /**
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1428 * @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	1429 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1430 * 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	1431 * not authorized.
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1432 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1433 * @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	1434 * @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	1435 * @param realm The realm for the authorization process.
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1436 **/
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1437 ORTHANC_PLUGIN_INLINE void OrthancPluginSendUnauthorized(
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1438 OrthancPluginContext* context,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1439 OrthancPluginRestOutput* output,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1440 const char* realm)
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1441 {
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1442 _OrthancPluginOutputPlusArgument params;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1443 params.output = output;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1444 params.argument = realm;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1445 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	1446 }
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1447
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1448
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1449 /**
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1450 * @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	1451 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1452 * 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	1453 * 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	1454 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1455 * @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	1456 * @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	1457 * @param allowedMethods The allowed methods for this URI (e.g. "GET,POST" after a PUT or a POST request).
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1458 **/
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1459 ORTHANC_PLUGIN_INLINE void OrthancPluginSendMethodNotAllowed(
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1460 OrthancPluginContext* context,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1461 OrthancPluginRestOutput* output,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1462 const char* allowedMethods)
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1463 {
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1464 _OrthancPluginOutputPlusArgument params;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1465 params.output = output;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1466 params.argument = allowedMethods;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1467 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	1468 }
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1469
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1470
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1471 typedef struct
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1472 {
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1473 OrthancPluginRestOutput* output;
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1474 const char* key;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1475 const char* value;
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1476 } _OrthancPluginSetHttpHeader;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1477
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1478 /**
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1479 * @brief Set a cookie.
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1480 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1481 * 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	1482 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1483 * @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	1484 * @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	1485 * @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	1486 * @param value The value of the cookie.
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1487 **/
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1488 ORTHANC_PLUGIN_INLINE void OrthancPluginSetCookie(
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1489 OrthancPluginContext* context,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1490 OrthancPluginRestOutput* output,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1491 const char* cookie,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1492 const char* value)
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1493 {
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1494 _OrthancPluginSetHttpHeader params;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1495 params.output = output;
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1496 params.key = cookie;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1497 params.value = value;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1498 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	1499 }
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1500
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1501
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1502 /**
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1503 * @brief Set some HTTP header.
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1504 *
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1505 * This function sets a HTTP header in the HTTP answer.
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1506 *
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1507 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1508 * @param output The HTTP connection to the client application.
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1509 * @param key The HTTP header to be set.
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1510 * @param value The value of the HTTP header.
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1511 **/
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1512 ORTHANC_PLUGIN_INLINE void OrthancPluginSetHttpHeader(
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1513 OrthancPluginContext* context,
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1514 OrthancPluginRestOutput* output,
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1515 const char* key,
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1516 const char* value)
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1517 {
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1518 _OrthancPluginSetHttpHeader params;
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1519 params.output = output;
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1520 params.key = key;
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1521 params.value = value;
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1522 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, &params);
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1523 }
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1524
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1525
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1526 typedef struct
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1527 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1528 char** resultStringToFree;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1529 const char** resultString;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1530 int64_t* resultInt64;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1531 const char* key;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1532 OrthancPluginDicomInstance* instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1533 } _OrthancPluginAccessDicomInstance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1534
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1535
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1536 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1537 * @brief Get the AET of a DICOM instance.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1538 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1539 * 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	1540 * DICOM modality from which a DICOM instance originates.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1541 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1542 * @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	1543 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1544 * @return The AET if success, NULL if error.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1545 **/
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1546 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceRemoteAet(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1547 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1548 OrthancPluginDicomInstance* instance)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1549 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1550 const char* result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1551
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1552 _OrthancPluginAccessDicomInstance params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1553 memset(&params, 0, sizeof(params));
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1554 params.resultString = &result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1555 params.instance = instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1556
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1557 if (context->InvokeService(context, _OrthancPluginService_GetInstanceRemoteAet, &params))
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1558 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1559 /* Error */
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1560 return NULL;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1561 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1562 else
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1563 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1564 return result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1565 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1566 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1567
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1568
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1569 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1570 * @brief Get the size of a DICOM file.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1571 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1572 * 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	1573 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1574 * @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	1575 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1576 * @return The size of the file, -1 in case of error.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1577 **/
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1578 ORTHANC_PLUGIN_INLINE int64_t OrthancPluginGetInstanceSize(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1579 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1580 OrthancPluginDicomInstance* instance)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1581 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1582 int64_t size;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1583
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1584 _OrthancPluginAccessDicomInstance params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1585 memset(&params, 0, sizeof(params));
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1586 params.resultInt64 = &size;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1587 params.instance = instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1588
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1589 if (context->InvokeService(context, _OrthancPluginService_GetInstanceSize, &params))
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1590 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1591 /* Error */
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1592 return -1;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1593 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1594 else
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1595 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1596 return size;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1597 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1598 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1599
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1600
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1601 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1602 * @brief Get the data of a DICOM file.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1603 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1604 * 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	1605 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1606 * @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	1607 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1608 * @return The pointer to the DICOM data, NULL in case of error.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1609 **/
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1610 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceData(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1611 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1612 OrthancPluginDicomInstance* instance)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1613 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1614 const char* result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1615
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1616 _OrthancPluginAccessDicomInstance params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1617 memset(&params, 0, sizeof(params));
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1618 params.resultString = &result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1619 params.instance = instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1620
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1621 if (context->InvokeService(context, _OrthancPluginService_GetInstanceData, &params))
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1622 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1623 /* Error */
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1624 return NULL;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1625 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1626 else
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1627 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1628 return result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1629 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1630 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1631
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1632
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1633 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1634 * @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	1635 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1636 * 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	1637 * 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	1638 * of the given DICOM instance.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1639 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1640 * @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	1641 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1642 * @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	1643 * This string must be freed by OrthancPluginFreeString().
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1644 **/
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1645 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceJson(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1646 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1647 OrthancPluginDicomInstance* instance)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1648 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1649 char* result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1650
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1651 _OrthancPluginAccessDicomInstance params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1652 memset(&params, 0, sizeof(params));
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1653 params.resultStringToFree = &result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1654 params.instance = instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1655
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1656 if (context->InvokeService(context, _OrthancPluginService_GetInstanceJson, &params))
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1657 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1658 /* Error */
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1659 return NULL;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1660 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1661 else
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1662 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1663 return result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1664 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1665 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1666
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1667
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1668 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1669 * @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	1670 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1671 * 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	1672 * 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	1673 * of the given DICOM instance. In contrast with
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1674 * ::OrthancPluginGetInstanceJson(), the returned JSON file is in
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1675 * its simplified version.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1676 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1677 * @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	1678 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1679 * @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	1680 * This string must be freed by OrthancPluginFreeString().
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1681 **/
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1682 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceSimplifiedJson(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1683 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1684 OrthancPluginDicomInstance* instance)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1685 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1686 char* result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1687
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1688 _OrthancPluginAccessDicomInstance params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1689 memset(&params, 0, sizeof(params));
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1690 params.resultStringToFree = &result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1691 params.instance = instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1692
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1693 if (context->InvokeService(context, _OrthancPluginService_GetInstanceSimplifiedJson, &params))
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1694 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1695 /* Error */
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1696 return NULL;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1697 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1698 else
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1699 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1700 return result;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1701 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1702 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1703
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1704
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1705 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1706 * @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	1707 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1708 * 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	1709 * 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	1710 * callbacks registered by
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1711 * ::OrthancPluginRegisterOnStoredInstanceCallback(), the only
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1712 * possibly available metadata are "ReceptionDate", "RemoteAET" and
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1713 * "IndexInSeries".
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1714 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1715 * @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	1716 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1717 * @param metadata The metadata of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1718 * @return 1 if the metadata is present, 0 if it is absent, -1 in case of error.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1719 **/
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1720 ORTHANC_PLUGIN_INLINE int OrthancPluginHasInstanceMetadata(
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1721 OrthancPluginContext* context,
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1722 OrthancPluginDicomInstance* instance,
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1723 const char* metadata)
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1724 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1725 int64_t result;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1726
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1727 _OrthancPluginAccessDicomInstance params;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1728 memset(&params, 0, sizeof(params));
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1729 params.resultInt64 = &result;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1730 params.instance = instance;
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1731 params.key = metadata;
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1732
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1733 if (context->InvokeService(context, _OrthancPluginService_HasInstanceMetadata, &params))
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1734 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1735 /* Error */
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1736 return -1;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1737 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1738 else
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1739 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1740 return (result != 0);
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1741 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1742 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1743
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1744
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1745 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1746 * @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	1747 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1748 * 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	1749 * 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	1750 * ::OrthancPluginHasInstanceMetadata().
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1751 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1752 * @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	1753 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1754 * @param metadata The metadata of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1755 * @return The metadata value if success, NULL if error.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1756 **/
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1757 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceMetadata(
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1758 OrthancPluginContext* context,
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1759 OrthancPluginDicomInstance* instance,
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1760 const char* metadata)
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1761 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1762 const char* result;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1763
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1764 _OrthancPluginAccessDicomInstance params;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1765 memset(&params, 0, sizeof(params));
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1766 params.resultString = &result;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1767 params.instance = instance;
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1768 params.key = metadata;
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1769
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1770 if (context->InvokeService(context, _OrthancPluginService_GetInstanceMetadata, &params))
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1771 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1772 /* Error */
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1773 return NULL;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1774 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1775 else
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1776 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1777 return result;
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
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1781
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1782
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	1783 typedef struct
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	1784 {
1295 50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	1785 OrthancPluginStorageCreate create;
50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	1786 OrthancPluginStorageRead read;
50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	1787 OrthancPluginStorageRemove remove;
50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	1788 OrthancPluginFree free;
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	1789 } _OrthancPluginRegisterStorageArea;
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	1790
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	1791 /**
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	1792 * @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	1793 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	1794 * 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	1795 * 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	1796 * 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	1797 * 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	1798 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	1799 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
1141 2ff467bcfb98 doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1137 diff changeset	1800 * @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	1801 * @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	1802 * @param remove The callback function to remove a file from the custom storage area.
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	1803 **/
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	1804 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	1805 OrthancPluginContext* context,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	1806 OrthancPluginStorageCreate create,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	1807 OrthancPluginStorageRead read,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	1808 OrthancPluginStorageRemove remove)
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	1809 {
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	1810 _OrthancPluginRegisterStorageArea params;
1295 50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	1811 params.create = create;
50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	1812 params.read = read;
50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	1813 params.remove = remove;
1136 208dc67b9bab sample custom storage plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1135 diff changeset	1814
208dc67b9bab sample custom storage plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1135 diff changeset	1815 #ifdef __cplusplus
1295 50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	1816 params.free = ::free;
1136 208dc67b9bab sample custom storage plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1135 diff changeset	1817 #else
1295 50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	1818 params.free = free;
1136 208dc67b9bab sample custom storage plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1135 diff changeset	1819 #endif
208dc67b9bab sample custom storage plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1135 diff changeset	1820
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	1821 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	1822 }
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	1823
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	1824
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1825
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1826 /**
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1827 * @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	1828 *
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1829 * 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	1830 *
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1831 * @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	1832 * @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	1833 * 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	1834 * OrthancPluginFreeString().
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1835 **/
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1836 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	1837 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1838 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	1839
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1840 _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	1841 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	1842 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	1843
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1844 if (context->InvokeService(context, _OrthancPluginService_GetOrthancPath, &params))
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1845 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1846 /* Error */
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1847 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	1848 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1849 else
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1850 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1851 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	1852 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1853 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1854
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1855
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1856 /**
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1857 * @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	1858 *
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1859 * 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	1860 *
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1861 * @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	1862 * @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	1863 * 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	1864 * OrthancPluginFreeString().
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1865 **/
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1866 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	1867 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1868 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	1869
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1870 _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	1871 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	1872 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	1873
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1874 if (context->InvokeService(context, _OrthancPluginService_GetOrthancDirectory, &params))
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1875 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1876 /* Error */
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1877 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	1878 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1879 else
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1880 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1881 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	1882 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1883 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1884
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1885
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1886 /**
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	1887 * @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	1888 *
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	1889 * 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	1890 * 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	1891 * 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	1892 * files. This function is deprecated in favor of
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	1893 * 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	1894 *
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1895 * @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	1896 * @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	1897 * 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	1898 * OrthancPluginFreeString().
1424 fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	1899 * @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	1900 **/
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1901 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	1902 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1903 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	1904
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1905 _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	1906 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	1907 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	1908
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1909 if (context->InvokeService(context, _OrthancPluginService_GetConfigurationPath, &params))
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1910 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1911 /* Error */
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1912 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	1913 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1914 else
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1915 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1916 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	1917 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1918 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1919
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1920
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1921
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1922 typedef struct
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1923 {
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1924 OrthancPluginOnChangeCallback callback;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1925 } _OrthancPluginOnChangeCallback;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1926
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1927 /**
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1928 * @brief Register a callback to monitor changes.
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1929 *
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1930 * 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	1931 * 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	1932 *
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1933 * @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	1934 * @param callback The callback function.
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1935 **/
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1936 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterOnChangeCallback(
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1937 OrthancPluginContext* context,
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1938 OrthancPluginOnChangeCallback callback)
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1939 {
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1940 _OrthancPluginOnChangeCallback params;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1941 params.callback = callback;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1942
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1943 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, &params);
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1944 }
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1945
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1946
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	1947
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	1948 typedef struct
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	1949 {
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	1950 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	1951 _OrthancPluginProperty property;
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	1952 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	1953 } _OrthancPluginSetPluginProperty;
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	1954
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	1955
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	1956 /**
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	1957 * @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	1958 *
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	1959 * 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	1960 * 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	1961 * 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	1962 * Explorer.
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	1963 *
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	1964 * @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	1965 * @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	1966 **/
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	1967 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	1968 OrthancPluginContext* context,
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	1969 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	1970 {
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	1971 _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	1972 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	1973 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	1974 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	1975
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	1976 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	1977 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	1978
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	1979
1233 eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	1980 /**
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	1981 * @brief Set a description for this plugin.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	1982 *
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	1983 * Set a description for this plugin. It is displayed in the
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	1984 * "Plugins" page of Orthanc Explorer.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	1985 *
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	1986 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	1987 * @param description The description.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	1988 **/
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	1989 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	1990 OrthancPluginContext* context,
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	1991 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	1992 {
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	1993 _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	1994 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	1995 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	1996 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	1997
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	1998 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	1999 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2000
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2001
1233 eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2002 /**
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2003 * @brief Extend the JavaScript code of Orthanc Explorer.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2004 *
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2005 * Add JavaScript code to customize the default behavior of Orthanc
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2006 * Explorer. This can for instance be used to add new buttons.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2007 *
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2008 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2009 * @param javascript The custom JavaScript code.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2010 **/
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2011 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	2012 OrthancPluginContext* context,
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2013 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	2014 {
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2015 _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	2016 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	2017 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	2018 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	2019
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2020 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	2021 }
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2022
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2023
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2024 typedef struct
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2025 {
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2026 char** result;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2027 int32_t property;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2028 const char* value;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2029 } _OrthancPluginGlobalProperty;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2030
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2031
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2032 /**
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2033 * @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	2034 *
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2035 * 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	2036 * 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	2037 *
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2038 * @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	2039 * @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	2040 * @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	2041 * @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	2042 * string must be freed by OrthancPluginFreeString().
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2043 **/
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2044 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	2045 OrthancPluginContext* context,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2046 int32_t property,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2047 const char* defaultValue)
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2048 {
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2049 char* result;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2050
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2051 _OrthancPluginGlobalProperty params;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2052 params.result = &result;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2053 params.property = property;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2054 params.value = defaultValue;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2055
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2056 if (context->InvokeService(context, _OrthancPluginService_GetGlobalProperty, &params))
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2057 {
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2058 /* Error */
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2059 return NULL;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2060 }
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2061 else
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2062 {
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2063 return result;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2064 }
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2065 }
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2066
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2067
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2068 /**
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2069 * @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	2070 *
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2071 * 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	2072 * 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	2073 * 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	2074 * 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	2075 * 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	2076 *
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2077 * @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	2078 * @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	2079 * @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	2080 * @return 0 if success, or the error code if failure.
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2081 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2082 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	2083 OrthancPluginContext* context,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2084 int32_t property,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2085 const char* value)
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2086 {
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2087 _OrthancPluginGlobalProperty params;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2088 params.result = NULL;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2089 params.property = property;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2090 params.value = value;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2091
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2092 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	2093 }
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2094
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2095
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2096
1280 d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2097 typedef struct
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2098 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2099 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	2100 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	2101 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	2102 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	2103 } _OrthancPluginReturnSingleValue;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2104
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2105 /**
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2106 * @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	2107 *
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2108 * 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	2109 *
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2110 * @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	2111 * @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	2112 **/
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2113 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	2114 OrthancPluginContext* context)
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2115 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2116 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	2117
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2118 _OrthancPluginReturnSingleValue params;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2119 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	2120 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	2121
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2122 if (context->InvokeService(context, _OrthancPluginService_GetCommandLineArgumentsCount, &params))
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2123 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2124 /* Error */
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2125 return 0;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2126 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2127 else
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2128 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2129 return count;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2130 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2131 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2132
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2133
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2134
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2135 /**
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2136 * @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	2137 *
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2138 * 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	2139 * 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	2140 * 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	2141 *
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2142 * @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	2143 * @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	2144 * @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	2145 * 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	2146 **/
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2147 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	2148 OrthancPluginContext* context,
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2149 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	2150 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2151 char* result;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2152
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2153 _OrthancPluginGlobalProperty params;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2154 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	2155 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	2156 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	2157
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2158 if (context->InvokeService(context, _OrthancPluginService_GetCommandLineArgument, &params))
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2159 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2160 /* Error */
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2161 return NULL;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2162 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2163 else
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2164 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2165 return result;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2166 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2167 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2168
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2169
1407 d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2170 /**
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2171 * @brief Get the expected version of the database schema.
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2172 *
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2173 * Retrieve the expected version of the database schema.
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2174 *
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2175 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2176 * @return The version.
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2177 **/
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2178 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetExpectedDatabaseVersion(
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2179 OrthancPluginContext* context)
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2180 {
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2181 uint32_t count = 0;
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2182
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2183 _OrthancPluginReturnSingleValue params;
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2184 memset(&params, 0, sizeof(params));
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2185 params.resultUint32 = &count;
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2186
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2187 if (context->InvokeService(context, _OrthancPluginService_GetExpectedDatabaseVersion, &params))
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2188 {
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2189 /* Error */
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2190 return 0;
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2191 }
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2192 else
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2193 {
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2194 return count;
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2195 }
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2196 }
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2197
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2198
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2199
1424 fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2200 /**
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2201 * @brief Return the content of the configuration file(s).
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2202 *
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2203 * This function returns the content of the configuration that is
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2204 * used by Orthanc, formatted as a JSON string.
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2205 *
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2206 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2207 * @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	2208 * containing the configuration. This string must be freed by
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2209 * OrthancPluginFreeString().
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2210 **/
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2211 ORTHANC_PLUGIN_INLINE char OrthancPluginGetConfiguration(OrthancPluginContext context)
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2212 {
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2213 char* result;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2214
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2215 _OrthancPluginRetrieveDynamicString params;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2216 params.result = &result;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2217 params.argument = NULL;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2218
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2219 if (context->InvokeService(context, _OrthancPluginService_GetConfiguration, &params))
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2220 {
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2221 /* Error */
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2222 return NULL;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2223 }
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2224 else
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2225 {
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2226 return result;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2227 }
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2228 }
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2229
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2230
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2231
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2232 typedef struct
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2233 {
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2234 OrthancPluginRestOutput* output;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2235 const char* subType;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2236 const char* contentType;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2237 } _OrthancPluginStartMultipartAnswer;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2238
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2239 /**
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2240 * @brief Start an HTTP multipart answer.
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2241 *
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2242 * 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	2243 *
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2244 * @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	2245 * @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	2246 * @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	2247 * @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	2248 * @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	2249 * @see OrthancPluginSendMultipartItem()
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2250 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2251 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2252 OrthancPluginContext* context,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2253 OrthancPluginRestOutput* output,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2254 const char* subType,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2255 const char* contentType)
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2256 {
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2257 _OrthancPluginStartMultipartAnswer params;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2258 params.output = output;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2259 params.subType = subType;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2260 params.contentType = contentType;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2261 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	2262 }
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2263
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2264
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2265 /**
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2266 * @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	2267 *
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2268 * 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	2269 * answer that was initiated by OrthancPluginStartMultipartAnswer().
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2270 *
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2271 * @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	2272 * @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	2273 * @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	2274 * @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	2275 * @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	2276 * if the connection is closed by the client).
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2277 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2278 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginSendMultipartItem(
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2279 OrthancPluginContext* context,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2280 OrthancPluginRestOutput* output,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2281 const char* answer,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2282 uint32_t answerSize)
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2283 {
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2284 _OrthancPluginAnswerBuffer params;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2285 params.output = output;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2286 params.answer = answer;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2287 params.answerSize = answerSize;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2288 params.mimeType = NULL;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2289 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	2290 }
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2291
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2292
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2293
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2294 typedef struct
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2295 {
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2296 OrthancPluginMemoryBuffer* target;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2297 const void* source;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2298 uint32_t size;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2299 OrthancPluginCompressionType compression;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2300 uint8_t uncompress;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2301 } _OrthancPluginBufferCompression;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2302
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2303
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2304 /**
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2305 * @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	2306 *
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2307 * 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	2308 * 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	2309 *
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2310 * @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	2311 * @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	2312 * @param source The source buffer.
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2313 * @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	2314 * @param compression The compression algorithm.
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2315 * @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	2316 * 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	2317 * @return 0 if success, or the error code if failure.
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2318 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2319 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	2320 OrthancPluginContext* context,
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2321 OrthancPluginMemoryBuffer* target,
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2322 const void* source,
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2323 uint32_t size,
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2324 OrthancPluginCompressionType compression,
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2325 uint8_t uncompress)
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2326 {
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2327 _OrthancPluginBufferCompression params;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2328 params.target = target;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2329 params.source = source;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2330 params.size = size;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2331 params.compression = compression;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2332 params.uncompress = uncompress;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2333
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2334 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	2335 }
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2336
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2337
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2338 #ifdef __cplusplus
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2339 }
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	2340 #endif
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	2341
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	2342
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	2343 /** @} */
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	2344

Mercurial > hg > orthanc

annotate Plugins/Include/orthanc/OrthancCPlugin.h @ 1581:357c4bb15701