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

annotate Plugins/Include/orthanc/OrthancCPlugin.h @ 1578:09715095fc53

cont

author	Sebastien Jodogne <s.jodogne@gmail.com>
date	Tue, 25 Aug 2015 15:33:36 +0200
parents	89ab71a68fcf
children	b93c398f934d

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

Mercurial > hg > orthanc

annotate Plugins/Include/orthanc/OrthancCPlugin.h @ 1578:09715095fc53