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

annotate Plugins/Include/orthanc/OrthancCPlugin.h @ 1781:5ad4e4d92ecb

AcceptMediaDispatcher bootstrap

author	Sebastien Jodogne <s.jodogne@gmail.com>
date	Tue, 17 Nov 2015 17:46:32 +0100
parents	94990da8710e
children	164d78911382

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().
1609 c74495267acf Implementation of the "GetAllPublicIdsWithLimit" extension Sebastien Jodogne <s.jodogne@gmail.com> parents: 1608 diff changeset	20 * - Possibly register a custom database back-end area using OrthancPluginRegisterDatabaseBackendV2().
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	21 * -# <tt>void OrthancPluginFinalize()</tt>:
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	22 * This function is invoked by Orthanc during its shutdown. The plugin
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	23 * must free all its memory.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	24 * -# <tt>const char* OrthancPluginGetName()</tt>:
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	25 * The plugin must return a short string to identify itself.
1041 2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	26 * -# <tt>const char* OrthancPluginGetVersion()</tt>:
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	27 * The plugin must return a string containing its version number.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	28 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	29 * The name and the version of a plugin is only used to prevent it
1602 292bce3f54ed JpegWriter Sebastien Jodogne <s.jodogne@gmail.com> parents: 1601 diff changeset	30 * from being loaded twice. Note that, in C++, it is mandatory to
292bce3f54ed JpegWriter Sebastien Jodogne <s.jodogne@gmail.com> parents: 1601 diff changeset	31 * declare these functions within an <tt>extern "C"</tt> section.
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	32 *
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	33 * To ensure multi-threading safety, the various REST callbacks are
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	34 * guaranteed to be executed in mutual exclusion since Orthanc
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	35 * 0.8.5. If this feature is undesired (notably when developing
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	36 * high-performance plugins handling simultaneous requests), use
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	37 * ::OrthancPluginRegisterRestCallbackNoLock().
906 cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	38 **/
cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	39
cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	40
cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	41
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	42 /**
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	43 * @defgroup Images Images and compression
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	44 * @brief Functions to deal with images and compressed buffers.
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	45 *
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	46 * @defgroup REST REST
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	47 * @brief Functions to answer REST requests in a callback.
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	48 *
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	49 * @defgroup Callbacks Callbacks
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	50 * @brief Functions to register and manage callbacks by the plugins.
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	51 *
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	52 * @defgroup Orthanc Orthanc
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	53 * @brief Functions to access the content of the Orthanc server.
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	54 **/
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	55
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	56
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	57
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	58 /**
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	59 * @defgroup Toolbox Toolbox
6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	60 * @brief Generic functions to help with the creation of plugins.
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	61 **/
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	62
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	63
906 cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	64
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	65 /**
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	66 * Orthanc - A Lightweight, RESTful DICOM Store
1288 6e7e5ed91c2d upgrade to year 2015 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1282 diff changeset	67 * Copyright (C) 2012-2015 Sebastien Jodogne, Medical Physics
6e7e5ed91c2d upgrade to year 2015 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1282 diff changeset	68 * Department, University Hospital of Liege, Belgium
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	69 *
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	70 * This program is free software: you can redistribute it and/or
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	71 * modify it under the terms of the GNU General Public License as
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	72 * published by the Free Software Foundation, either version 3 of the
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	73 * License, or (at your option) any later version.
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	74 *
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	75 * In addition, as a special exception, the copyright holders of this
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	76 * program give permission to link the code of its release with the
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	77 * OpenSSL project's "OpenSSL" library (or with modified versions of it
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	78 * that use the same license as the "OpenSSL" library), and distribute
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	79 * the linked executables. You must obey the GNU General Public License
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	80 * in all respects for all of the code used other than "OpenSSL". If you
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	81 * modify file(s) with this exception, you may extend this exception to
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	82 * your version of the file(s), but you are not obligated to do so. If
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	83 * you do not wish to do so, delete this exception statement from your
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	84 * version. If you delete this exception statement from all source files
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	85 * in the program, then also delete it here.
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	86 *
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	87 * This program is distributed in the hope that it will be useful, but
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	88 * WITHOUT ANY WARRANTY; without even the implied warranty of
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	89 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	90 * General Public License for more details.
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	91 *
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	92 * You should have received a copy of the GNU General Public License
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	93 * along with this program. If not, see <http://www.gnu.org/licenses/>.
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	94 **/
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	95
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	96
906 cbc0ea03dffe sample plugin configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 904 diff changeset	97
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	98 #pragma once
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	99
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	100
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	101 #include <stdio.h>
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	102 #include <string.h>
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	103
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	104 #ifdef WIN32
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	105 #define ORTHANC_PLUGINS_API __declspec(dllexport)
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	106 #else
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	107 #define ORTHANC_PLUGINS_API
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	108 #endif
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	109
1039 5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	110 #define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 0
1407 d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	111 #define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 9
1629 bad4772b605c OrthancPluginErrorCode in database plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1628 diff changeset	112 #define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 5
1039 5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	113
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	114
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	115
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	116 /********************************************************************
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	117 ** Check that function inlining is properly supported. The use of
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	118 ** inlining is required, to avoid the duplication of object code
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	119 ** between two compilation modules that would use the Orthanc Plugin
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	120 ** API.
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	121 ********************************************************************/
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	122
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	123 /* If the auto-detection of the "inline" keyword below does not work
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	124 automatically and that your compiler is known to properly support
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	125 inlining, uncomment the following #define and adapt the definition
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	126 of "static inline". */
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	127
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	128 /* #define ORTHANC_PLUGIN_INLINE static inline */
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	129
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	130 #ifndef ORTHANC_PLUGIN_INLINE
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	131 # if __STDC_VERSION__ >= 199901L
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	132 /* This is C99 or above: http://predef.sourceforge.net/prestd.html */
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	133 # define ORTHANC_PLUGIN_INLINE static inline
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	134 # elif defined(__cplusplus)
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	135 /* This is C++ */
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	136 # define ORTHANC_PLUGIN_INLINE static inline
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	137 # elif defined(__GNUC__)
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	138 /* This is GCC running in C89 mode */
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	139 # define ORTHANC_PLUGIN_INLINE static __inline
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	140 # elif defined(_MSC_VER)
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	141 /* This is Visual Studio running in C89 mode */
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	142 # define ORTHANC_PLUGIN_INLINE static __inline
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	143 # else
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	144 # error Your compiler is not known to support the "inline" keyword
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	145 # endif
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	146 #endif
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	147
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	148
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	149
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	150 /********************************************************************
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	151 ** Inclusion of standard libraries.
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	152 ********************************************************************/
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	153
1322 f497a72d9f71 fixes to the sample plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1313 diff changeset	154 /**
f497a72d9f71 fixes to the sample plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1313 diff changeset	155 * For Microsoft Visual Studio, a compatibility "stdint.h" can be
f497a72d9f71 fixes to the sample plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1313 diff changeset	156 * downloaded at the following URL:
f497a72d9f71 fixes to the sample plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1313 diff changeset	157 * https://orthanc.googlecode.com/hg/Resources/ThirdParty/VisualStudio/stdint.h
f497a72d9f71 fixes to the sample plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1313 diff changeset	158 **/
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	159 #include <stdint.h>
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	160
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	161 #include <stdlib.h>
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	162
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	163
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	164
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	165 /********************************************************************
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	166 ** Definition of the Orthanc Plugin API.
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	167 ********************************************************************/
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	168
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	169 /** @{ */
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	170
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	171 #ifdef __cplusplus
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	172 extern "C"
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	173 {
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	174 #endif
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	175
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	176 /**
1578 09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	177 * The various error codes that can be returned by the Orthanc core.
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	178 **/
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	179 typedef enum
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	180 {
1579 b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	181 OrthancPluginErrorCode_InternalError = -1 /!< Internal error /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	182 OrthancPluginErrorCode_Success = 0 /!< Success /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	183 OrthancPluginErrorCode_Plugin = 1 /!< Error encountered within the plugin engine /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	184 OrthancPluginErrorCode_NotImplemented = 2 /!< Not implemented yet /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	185 OrthancPluginErrorCode_ParameterOutOfRange = 3 /!< Parameter out of range /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	186 OrthancPluginErrorCode_NotEnoughMemory = 4 /!< Not enough memory /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	187 OrthancPluginErrorCode_BadParameterType = 5 /!< Bad type for a parameter /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	188 OrthancPluginErrorCode_BadSequenceOfCalls = 6 /!< Bad sequence of calls /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	189 OrthancPluginErrorCode_InexistentItem = 7 /!< Accessing an inexistent item /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	190 OrthancPluginErrorCode_BadRequest = 8 /!< Bad request /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	191 OrthancPluginErrorCode_NetworkProtocol = 9 /!< Error in the network protocol /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	192 OrthancPluginErrorCode_SystemCommand = 10 /!< Error while calling a system command /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	193 OrthancPluginErrorCode_Database = 11 /!< Error with the database engine /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	194 OrthancPluginErrorCode_UriSyntax = 12 /!< Badly formatted URI /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	195 OrthancPluginErrorCode_InexistentFile = 13 /!< Inexistent file /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	196 OrthancPluginErrorCode_CannotWriteFile = 14 /!< Cannot write to file /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	197 OrthancPluginErrorCode_BadFileFormat = 15 /!< Bad file format /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	198 OrthancPluginErrorCode_Timeout = 16 /!< Timeout /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	199 OrthancPluginErrorCode_UnknownResource = 17 /!< Unknown resource /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	200 OrthancPluginErrorCode_IncompatibleDatabaseVersion = 18 /!< Incompatible version of the database /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	201 OrthancPluginErrorCode_FullStorage = 19 /!< The file storage is full /,
1582 bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	202 OrthancPluginErrorCode_CorruptedFile = 20 /!< Corrupted file (e.g. inconsistent MD5 hash) /,
1579 b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	203 OrthancPluginErrorCode_InexistentTag = 21 /!< Inexistent tag /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	204 OrthancPluginErrorCode_ReadOnly = 22 /!< Cannot modify a read-only data structure /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	205 OrthancPluginErrorCode_IncompatibleImageFormat = 23 /!< Incompatible format of the images /,
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	206 OrthancPluginErrorCode_IncompatibleImageSize = 24 /!< Incompatible size of the images /,
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	207 OrthancPluginErrorCode_SharedLibrary = 25 /!< Error while using a shared library (plugin) /,
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	208 OrthancPluginErrorCode_UnknownPluginService = 26 /!< Plugin invoking an unknown service /,
1582 bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	209 OrthancPluginErrorCode_UnknownDicomTag = 27 /!< Unknown DICOM tag /,
1596 f2e3d030ea59 BadJson error code Sebastien Jodogne <s.jodogne@gmail.com> parents: 1595 diff changeset	210 OrthancPluginErrorCode_BadJson = 28 /!< Cannot parse a JSON document /,
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	211 OrthancPluginErrorCode_Unauthorized = 29 /!< Bad credentials were provided to an HTTP request /,
1610 2dff2bdffdb8 font support within Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1609 diff changeset	212 OrthancPluginErrorCode_BadFont = 30 /!< Badly formatted font file /,
1643 87c77b9b3679 provision for error codes in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1642 diff changeset	213 OrthancPluginErrorCode_DatabasePlugin = 31 /!< The plugin implementing a custom database back-end does not fulfill the proper interface /,
87c77b9b3679 provision for error codes in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1642 diff changeset	214 OrthancPluginErrorCode_StorageAreaPlugin = 32 /!< Error in the plugin implementing a custom storage area /,
1746 d143db00a794 SetOfResources Sebastien Jodogne <s.jodogne@gmail.com> parents: 1743 diff changeset	215 OrthancPluginErrorCode_EmptyRequest = 33 /!< The request is empty /,
1781 5ad4e4d92ecb AcceptMediaDispatcher bootstrap Sebastien Jodogne <s.jodogne@gmail.com> parents: 1780 diff changeset	216 OrthancPluginErrorCode_NotAcceptable = 34 /!< Cannot send a response which is acceptable according to the Accept HTTP header /,
1582 bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	217 OrthancPluginErrorCode_SQLiteNotOpened = 1000 /!< SQLite: The database is not opened /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	218 OrthancPluginErrorCode_SQLiteAlreadyOpened = 1001 /!< SQLite: Connection is already open /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	219 OrthancPluginErrorCode_SQLiteCannotOpen = 1002 /!< SQLite: Unable to open the database /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	220 OrthancPluginErrorCode_SQLiteStatementAlreadyUsed = 1003 /!< SQLite: This cached statement is already being referred to /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	221 OrthancPluginErrorCode_SQLiteExecute = 1004 /!< SQLite: Cannot execute a command /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	222 OrthancPluginErrorCode_SQLiteRollbackWithoutTransaction = 1005 /!< SQLite: Rolling back a nonexistent transaction (have you called Begin()?) /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	223 OrthancPluginErrorCode_SQLiteCommitWithoutTransaction = 1006 /!< SQLite: Committing a nonexistent transaction /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	224 OrthancPluginErrorCode_SQLiteRegisterFunction = 1007 /!< SQLite: Unable to register a function /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	225 OrthancPluginErrorCode_SQLiteFlush = 1008 /!< SQLite: Unable to flush the database /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	226 OrthancPluginErrorCode_SQLiteCannotRun = 1009 /!< SQLite: Cannot run a cached statement /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	227 OrthancPluginErrorCode_SQLiteCannotStep = 1010 /!< SQLite: Cannot step over a cached statement /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	228 OrthancPluginErrorCode_SQLiteBindOutOfRange = 1011 /!< SQLite: Bing a value while out of range (serious error) /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	229 OrthancPluginErrorCode_SQLitePrepareStatement = 1012 /!< SQLite: Cannot prepare a cached statement /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	230 OrthancPluginErrorCode_SQLiteTransactionAlreadyStarted = 1013 /!< SQLite: Beginning the same transaction twice /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	231 OrthancPluginErrorCode_SQLiteTransactionCommit = 1014 /!< SQLite: Failure when committing the transaction /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	232 OrthancPluginErrorCode_SQLiteTransactionBegin = 1015 /!< SQLite: Cannot start a transaction /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	233 OrthancPluginErrorCode_DirectoryOverFile = 2000 /!< The directory to be created is already occupied by a regular file /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	234 OrthancPluginErrorCode_FileStorageCannotWrite = 2001 /!< Unable to create a subdirectory or a file in the file storage /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	235 OrthancPluginErrorCode_DirectoryExpected = 2002 /!< The specified path does not point to a directory /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	236 OrthancPluginErrorCode_HttpPortInUse = 2003 /!< The TCP port of the HTTP server is already in use /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	237 OrthancPluginErrorCode_DicomPortInUse = 2004 /!< The TCP port of the DICOM server is already in use /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	238 OrthancPluginErrorCode_BadHttpStatusInRest = 2005 /!< This HTTP status is not allowed in a REST API /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	239 OrthancPluginErrorCode_RegularFileExpected = 2006 /!< The specified path does not point to a regular file /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	240 OrthancPluginErrorCode_PathToExecutable = 2007 /!< Unable to get the path to the executable /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	241 OrthancPluginErrorCode_MakeDirectory = 2008 /!< Cannot create a directory /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	242 OrthancPluginErrorCode_BadApplicationEntityTitle = 2009 /!< An application entity title (AET) cannot be empty or be longer than 16 characters /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	243 OrthancPluginErrorCode_NoCFindHandler = 2010 /!< No request handler factory for DICOM C-FIND SCP /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	244 OrthancPluginErrorCode_NoCMoveHandler = 2011 /!< No request handler factory for DICOM C-MOVE SCP /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	245 OrthancPluginErrorCode_NoCStoreHandler = 2012 /!< No request handler factory for DICOM C-STORE SCP /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	246 OrthancPluginErrorCode_NoApplicationEntityFilter = 2013 /!< No application entity filter /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	247 OrthancPluginErrorCode_NoSopClassOrInstance = 2014 /!< DicomUserConnection: Unable to find the SOP class and instance /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	248 OrthancPluginErrorCode_NoPresentationContext = 2015 /!< DicomUserConnection: No acceptable presentation context for modality /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	249 OrthancPluginErrorCode_DicomFindUnavailable = 2016 /!< DicomUserConnection: The C-FIND command is not supported by the remote SCP /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	250 OrthancPluginErrorCode_DicomMoveUnavailable = 2017 /!< DicomUserConnection: The C-MOVE command is not supported by the remote SCP /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	251 OrthancPluginErrorCode_CannotStoreInstance = 2018 /!< Cannot store an instance /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	252 OrthancPluginErrorCode_CreateDicomNotString = 2019 /!< Only string values are supported when creating DICOM instances /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	253 OrthancPluginErrorCode_CreateDicomOverrideTag = 2020 /!< Trying to override a value inherited from a parent module /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	254 OrthancPluginErrorCode_CreateDicomUseContent = 2021 /!< Use \"Content\" to inject an image into a new DICOM instance /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	255 OrthancPluginErrorCode_CreateDicomNoPayload = 2022 /!< No payload is present for one instance in the series /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	256 OrthancPluginErrorCode_CreateDicomUseDataUriScheme = 2023 /!< The payload of the DICOM instance must be specified according to Data URI scheme /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	257 OrthancPluginErrorCode_CreateDicomBadParent = 2024 /!< Trying to attach a new DICOM instance to an inexistent resource /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	258 OrthancPluginErrorCode_CreateDicomParentIsInstance = 2025 /!< Trying to attach a new DICOM instance to an instance (must be a series, study or patient) /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	259 OrthancPluginErrorCode_CreateDicomParentEncoding = 2026 /!< Unable to get the encoding of the parent resource /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	260 OrthancPluginErrorCode_UnknownModality = 2027 /!< Unknown modality /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	261 OrthancPluginErrorCode_BadJobOrdering = 2028 /!< Bad ordering of filters in a job /,
1583 9ea3d082b064 got rid of custom exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1582 diff changeset	262 OrthancPluginErrorCode_JsonToLuaTable = 2029 /!< Cannot convert the given JSON object to a Lua table /,
9ea3d082b064 got rid of custom exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1582 diff changeset	263 OrthancPluginErrorCode_CannotCreateLua = 2030 /!< Cannot create the Lua context /,
9ea3d082b064 got rid of custom exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1582 diff changeset	264 OrthancPluginErrorCode_CannotExecuteLua = 2031 /!< Cannot execute a Lua command /,
9ea3d082b064 got rid of custom exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1582 diff changeset	265 OrthancPluginErrorCode_LuaAlreadyExecuted = 2032 /!< Arguments cannot be pushed after the Lua function is executed /,
9ea3d082b064 got rid of custom exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1582 diff changeset	266 OrthancPluginErrorCode_LuaBadOutput = 2033 /!< The Lua function does not give the expected number of outputs /,
9ea3d082b064 got rid of custom exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1582 diff changeset	267 OrthancPluginErrorCode_NotLuaPredicate = 2034 /!< The Lua function is not a predicate (only true/false outputs allowed) /,
9ea3d082b064 got rid of custom exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1582 diff changeset	268 OrthancPluginErrorCode_LuaReturnsNoString = 2035 /!< The Lua function does not return a string /,
1630 ffd23c0104af "/system" URI gives information about the plugins used for storage area and DB back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1629 diff changeset	269 OrthancPluginErrorCode_StorageAreaAlreadyRegistered = 2036 /!< Another plugin has already registered a custom storage area /,
ffd23c0104af "/system" URI gives information about the plugins used for storage area and DB back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1629 diff changeset	270 OrthancPluginErrorCode_DatabaseBackendAlreadyRegistered = 2037 /!< Another plugin has already registered a custom database back-end /,
1643 87c77b9b3679 provision for error codes in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1642 diff changeset	271 OrthancPluginErrorCode_DatabaseNotInitialized = 2038 /!< Plugin trying to call the database during its initialization /,
1674 4fc502d469f4 fix build if SSL is disabled Sebastien Jodogne <s.jodogne@gmail.com> parents: 1673 diff changeset	272 OrthancPluginErrorCode_SslDisabled = 2039 /!< Orthanc has been built without SSL support /,
1703 b80e76dd1d56 ordered-slices continued Sebastien Jodogne <s.jodogne@gmail.com> parents: 1674 diff changeset	273 OrthancPluginErrorCode_CannotOrderSlices = 2040 /!< Unable to order the slices of the series /,
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	274
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	275 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
1578 09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	276 } OrthancPluginErrorCode;
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	277
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	278
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	279 /**
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	280 * 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	281 * plugins.
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	282 **/
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	283 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	284
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	285
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	286 /**
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	287 * The various HTTP methods for a REST call.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	288 **/
894 690aeb4cb899 REST callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 888 diff changeset	289 typedef enum
690aeb4cb899 REST callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 888 diff changeset	290 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	291 OrthancPluginHttpMethod_Get = 1, /!< GET request /
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	292 OrthancPluginHttpMethod_Post = 2, /!< POST request /
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	293 OrthancPluginHttpMethod_Put = 3, /!< PUT request /
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	294 OrthancPluginHttpMethod_Delete = 4, /!< DELETE request /
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	295
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	296 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
896 c4053ac5db04 better plugni api Sebastien Jodogne <s.jodogne@gmail.com> parents: 894 diff changeset	297 } OrthancPluginHttpMethod;
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	298
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	299
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	300 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	301 * @brief The parameters of a REST request.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	302 * @ingroup Callbacks
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	303 **/
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	304 typedef struct
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	305 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	306 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	307 * @brief The HTTP method.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	308 **/
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	309 OrthancPluginHttpMethod method;
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	310
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	311 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	312 * @brief The number of groups of the regular expression.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	313 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	314 uint32_t groupsCount;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	315
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	316 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	317 * @brief The matched values for the groups of the regular expression.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	318 **/
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	319 const char* const* groups;
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	320
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	321 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	322 * @brief For a GET request, the number of GET parameters.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	323 **/
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	324 uint32_t getCount;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	325
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	326 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	327 * @brief For a GET request, the keys of the GET parameters.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	328 **/
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	329 const char* const* getKeys;
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	330
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	331 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	332 * @brief For a GET request, the values of the GET parameters.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	333 **/
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	334 const char* const* getValues;
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	335
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	336 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	337 * @brief For a PUT or POST request, the content of the body.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	338 **/
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	339 const char* body;
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	340
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	341 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	342 * @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	343 **/
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	344 uint32_t bodySize;
1041 2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	345
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	346
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	347 /* --------------------------------------------------
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	348 New in version 0.8.1
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	349 -------------------------------------------------- */
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	350
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	351 /**
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	352 * @brief The number of HTTP headers.
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	353 **/
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	354 uint32_t headersCount;
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	355
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	356 /**
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	357 * @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	358 **/
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	359 const char* const* headersKeys;
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	360
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	361 /**
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	362 * @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	363 **/
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	364 const char* const* headersValues;
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	365
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	366 } OrthancPluginHttpRequest;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	367
1041 2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	368
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	369 typedef enum
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	370 {
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	371 /* Generic services */
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	372 _OrthancPluginService_LogInfo = 1,
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	373 _OrthancPluginService_LogWarning = 2,
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	374 _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	375 _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	376 _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	377 _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	378 _OrthancPluginService_SetPluginProperty = 7,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	379 _OrthancPluginService_GetGlobalProperty = 8,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	380 _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	381 _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	382 _OrthancPluginService_GetCommandLineArgument = 11,
1407 d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	383 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
1424 fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	384 _OrthancPluginService_GetConfiguration = 13,
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	385 _OrthancPluginService_BufferCompression = 14,
1588 b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	386 _OrthancPluginService_ReadFile = 15,
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	387 _OrthancPluginService_WriteFile = 16,
1593 235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	388 _OrthancPluginService_GetErrorDescription = 17,
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	389 _OrthancPluginService_CallHttpClient = 18,
1649 8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	390 _OrthancPluginService_RegisterErrorCode = 19,
1657 5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	391 _OrthancPluginService_RegisterDictionaryTag = 20,
1740 5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	392 _OrthancPluginService_DicomBufferToJson = 21,
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	393 _OrthancPluginService_DicomInstanceToJson = 22,
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	394
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	395 /* Registration of callbacks */
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	396 _OrthancPluginService_RegisterRestCallback = 1000,
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	397 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	398 _OrthancPluginService_RegisterStorageArea = 1002,
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	399 _OrthancPluginService_RegisterOnChangeCallback = 1003,
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	400 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	401
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	402 /* Sending answers to REST calls */
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	403 _OrthancPluginService_AnswerBuffer = 2000,
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	404 _OrthancPluginService_CompressAndAnswerPngImage = 2001, /* Unused as of Orthanc 0.9.4 */
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	405 _OrthancPluginService_Redirect = 2002,
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	406 _OrthancPluginService_SendHttpStatusCode = 2003,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	407 _OrthancPluginService_SendUnauthorized = 2004,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	408 _OrthancPluginService_SendMethodNotAllowed = 2005,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	409 _OrthancPluginService_SetCookie = 2006,
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	410 _OrthancPluginService_SetHttpHeader = 2007,
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	411 _OrthancPluginService_StartMultipartAnswer = 2008,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	412 _OrthancPluginService_SendMultipartItem = 2009,
1593 235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	413 _OrthancPluginService_SendHttpStatus = 2010,
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	414 _OrthancPluginService_CompressAndAnswerImage = 2011,
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	415
912 dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	416 /* Access to the Orthanc database and API */
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	417 _OrthancPluginService_GetDicomForInstance = 3000,
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	418 _OrthancPluginService_RestApiGet = 3001,
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	419 _OrthancPluginService_RestApiPost = 3002,
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	420 _OrthancPluginService_RestApiDelete = 3003,
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	421 _OrthancPluginService_RestApiPut = 3004,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	422 _OrthancPluginService_LookupPatient = 3005,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	423 _OrthancPluginService_LookupStudy = 3006,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	424 _OrthancPluginService_LookupSeries = 3007,
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	425 _OrthancPluginService_LookupInstance = 3008,
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	426 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	427 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	428 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	429 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	430 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
1669 a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	431 _OrthancPluginService_ReconstructMainDicomTags = 3014,
1780 94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	432 _OrthancPluginService_RestApiGet2 = 3015,
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	433
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	434 /* Access to DICOM instances */
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	435 _OrthancPluginService_GetInstanceRemoteAet = 4000,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	436 _OrthancPluginService_GetInstanceSize = 4001,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	437 _OrthancPluginService_GetInstanceData = 4002,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	438 _OrthancPluginService_GetInstanceJson = 4003,
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	439 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	440 _OrthancPluginService_HasInstanceMetadata = 4005,
1309 8f4487d8f79e new files for custom database back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 diff changeset	441 _OrthancPluginService_GetInstanceMetadata = 4006,
8f4487d8f79e new files for custom database back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 diff changeset	442
8f4487d8f79e new files for custom database back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 diff changeset	443 /* 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	444 _OrthancPluginService_RegisterDatabaseBackend = 5000,
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	445 _OrthancPluginService_DatabaseAnswer = 5001,
1609 c74495267acf Implementation of the "GetAllPublicIdsWithLimit" extension Sebastien Jodogne <s.jodogne@gmail.com> parents: 1608 diff changeset	446 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002,
1615 c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	447 _OrthancPluginService_StorageAreaCreate = 5003,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	448 _OrthancPluginService_StorageAreaRead = 5004,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	449 _OrthancPluginService_StorageAreaRemove = 5005,
1309 8f4487d8f79e new files for custom database back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 diff changeset	450
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	451 /* Primitives for handling images */
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	452 _OrthancPluginService_GetImagePixelFormat = 6000,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	453 _OrthancPluginService_GetImageWidth = 6001,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	454 _OrthancPluginService_GetImageHeight = 6002,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	455 _OrthancPluginService_GetImagePitch = 6003,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	456 _OrthancPluginService_GetImageBuffer = 6004,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	457 _OrthancPluginService_UncompressImage = 6005,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	458 _OrthancPluginService_FreeImage = 6006,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	459 _OrthancPluginService_CompressImage = 6007,
1608 adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	460 _OrthancPluginService_ConvertPixelFormat = 6008,
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	461 _OrthancPluginService_GetFontsCount = 6009,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	462 _OrthancPluginService_GetFontInfo = 6010,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	463 _OrthancPluginService_DrawText = 6011,
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	464
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	465 _OrthancPluginService_INTERNAL = 0x7fffffff
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	466 } _OrthancPluginService;
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	467
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	468
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	469 typedef enum
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	470 {
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	471 _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	472 _OrthancPluginProperty_RootUri = 2,
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	473 _OrthancPluginProperty_OrthancExplorer = 3,
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	474
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	475 _OrthancPluginProperty_INTERNAL = 0x7fffffff
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	476 } _OrthancPluginProperty;
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	477
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	478
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	479
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	480 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	481 * The memory layout of the pixels of an image.
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	482 * @ingroup Images
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	483 **/
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	484 typedef enum
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	485 {
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	486 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	487 * @brief Graylevel 8bpp image.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	488 *
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	489 * 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	490 * one byte.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	491 **/
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	492 OrthancPluginPixelFormat_Grayscale8 = 1,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	493
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	494 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	495 * @brief Graylevel, unsigned 16bpp image.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	496 *
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	497 * 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	498 * two bytes.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	499 **/
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	500 OrthancPluginPixelFormat_Grayscale16 = 2,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	501
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	502 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	503 * @brief Graylevel, signed 16bpp image.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	504 *
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	505 * 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	506 * bytes.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	507 **/
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	508 OrthancPluginPixelFormat_SignedGrayscale16 = 3,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	509
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	510 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	511 * @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	512 *
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	513 * 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	514 * 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	515 **/
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	516 OrthancPluginPixelFormat_RGB24 = 4,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	517
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	518 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	519 * @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	520 *
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	521 * 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	522 * 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	523 **/
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	524 OrthancPluginPixelFormat_RGBA32 = 5,
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	525
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	526 OrthancPluginPixelFormat_Unknown = 6, /!< Unknown pixel format /
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	527
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	528 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	529 } OrthancPluginPixelFormat;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	530
894 690aeb4cb899 REST callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 888 diff changeset	531
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	532
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	533 /**
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	534 * 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	535 **/
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	536 typedef enum
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	537 {
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	538 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	539 OrthancPluginContentType_Dicom = 1, /!< DICOM /
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	540 OrthancPluginContentType_DicomAsJson = 2, /!< JSON summary of a DICOM file /
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	541
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	542 _OrthancPluginContentType_INTERNAL = 0x7fffffff
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	543 } OrthancPluginContentType;
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
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	547 /**
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	548 * The supported types of DICOM resources.
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	549 **/
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	550 typedef enum
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	551 {
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	552 OrthancPluginResourceType_Patient = 0, /!< Patient /
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	553 OrthancPluginResourceType_Study = 1, /!< Study /
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	554 OrthancPluginResourceType_Series = 2, /!< Series /
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	555 OrthancPluginResourceType_Instance = 3, /!< Instance /
1741 06addfcd1d4c OrthancStarted and OrthancStopped events in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1740 diff changeset	556 OrthancPluginResourceType_None = 4, /!< Unavailable resource type /
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	557
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	558 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	559 } OrthancPluginResourceType;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	560
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	561
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	562
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	563 /**
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	564 * The supported types of changes that can happen to DICOM resources.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	565 * @ingroup Callbacks
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	566 **/
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	567 typedef enum
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	568 {
1198 1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	569 OrthancPluginChangeType_CompletedSeries = 0, /!< Series is now complete /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	570 OrthancPluginChangeType_Deleted = 1, /!< Deleted resource /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	571 OrthancPluginChangeType_NewChildInstance = 2, /!< A new instance was added to this resource /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	572 OrthancPluginChangeType_NewInstance = 3, /!< New instance received /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	573 OrthancPluginChangeType_NewPatient = 4, /!< New patient created /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	574 OrthancPluginChangeType_NewSeries = 5, /!< New series created /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	575 OrthancPluginChangeType_NewStudy = 6, /!< New study created /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	576 OrthancPluginChangeType_StablePatient = 7, /!< Timeout: No new instance in this patient /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	577 OrthancPluginChangeType_StableSeries = 8, /!< Timeout: No new instance in this series /
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	578 OrthancPluginChangeType_StableStudy = 9, /!< Timeout: No new instance in this study /
1741 06addfcd1d4c OrthancStarted and OrthancStopped events in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1740 diff changeset	579 OrthancPluginChangeType_OrthancStarted = 10, /!< Orthanc has started /
06addfcd1d4c OrthancStarted and OrthancStopped events in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1740 diff changeset	580 OrthancPluginChangeType_OrthancStopped = 11, /!< Orthanc is stopping /
1773 613df4362575 New UpdatedAttachment and UpdatedMetadata events in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1765 diff changeset	581 OrthancPluginChangeType_UpdatedAttachment = 12, /!< Some user-defined attachment has changed for this resource /
613df4362575 New UpdatedAttachment and UpdatedMetadata events in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1765 diff changeset	582 OrthancPluginChangeType_UpdatedMetadata = 13, /!< Some user-defined metadata has changed for this resource /
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	583
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	584 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	585 } OrthancPluginChangeType;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	586
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	587
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	588 /**
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	589 * The compression algorithms that are supported by the Orthanc core.
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	590 * @ingroup Images
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	591 **/
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	592 typedef enum
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	593 {
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	594 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	595 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	596 OrthancPluginCompressionType_Gzip = 2, /!< Standard gzip compression /
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	597 OrthancPluginCompressionType_GzipWithSize = 3, /!< gzip, prefixed with uncompressed size (uint64_t) /
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	598
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	599 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	600 } OrthancPluginCompressionType;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	601
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	602
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	603 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	604 * The image formats that are supported by the Orthanc core.
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	605 * @ingroup Images
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	606 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	607 typedef enum
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	608 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	609 OrthancPluginImageFormat_Png = 0, /!< Image compressed using PNG /
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	610 OrthancPluginImageFormat_Jpeg = 1, /!< Image compressed using JPEG /
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	611
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	612 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	613 } OrthancPluginImageFormat;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	614
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	615
1657 5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	616 /**
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	617 * The value representations present in the DICOM standard (version 2013).
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	618 * @ingroup Toolbox
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	619 **/
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	620 typedef enum
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	621 {
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	622 OrthancPluginValueRepresentation_AE = 1, /!< Application Entity /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	623 OrthancPluginValueRepresentation_AS = 2, /!< Age String /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	624 OrthancPluginValueRepresentation_AT = 3, /!< Attribute Tag /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	625 OrthancPluginValueRepresentation_CS = 4, /!< Code String /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	626 OrthancPluginValueRepresentation_DA = 5, /!< Date /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	627 OrthancPluginValueRepresentation_DS = 6, /!< Decimal String /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	628 OrthancPluginValueRepresentation_DT = 7, /!< Date Time /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	629 OrthancPluginValueRepresentation_FD = 8, /!< Floating Point Double /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	630 OrthancPluginValueRepresentation_FL = 9, /!< Floating Point Single /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	631 OrthancPluginValueRepresentation_IS = 10, /!< Integer String /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	632 OrthancPluginValueRepresentation_LO = 11, /!< Long String /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	633 OrthancPluginValueRepresentation_LT = 12, /!< Long Text /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	634 OrthancPluginValueRepresentation_OB = 13, /!< Other Byte String /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	635 OrthancPluginValueRepresentation_OF = 14, /!< Other Float String /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	636 OrthancPluginValueRepresentation_OW = 15, /!< Other Word String /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	637 OrthancPluginValueRepresentation_PN = 16, /!< Person Name /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	638 OrthancPluginValueRepresentation_SH = 17, /!< Short String /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	639 OrthancPluginValueRepresentation_SL = 18, /!< Signed Long /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	640 OrthancPluginValueRepresentation_SQ = 19, /!< Sequence of Items /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	641 OrthancPluginValueRepresentation_SS = 20, /!< Signed Short /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	642 OrthancPluginValueRepresentation_ST = 21, /!< Short Text /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	643 OrthancPluginValueRepresentation_TM = 22, /!< Time /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	644 OrthancPluginValueRepresentation_UI = 23, /!< Unique Identifier (UID) /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	645 OrthancPluginValueRepresentation_UL = 24, /!< Unsigned Long /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	646 OrthancPluginValueRepresentation_UN = 25, /!< Unknown /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	647 OrthancPluginValueRepresentation_US = 26, /!< Unsigned Short /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	648 OrthancPluginValueRepresentation_UT = 27, /!< Unlimited Text /
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	649
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	650 _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	651 } OrthancPluginValueRepresentation;
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	652
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	653
1743 8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	654 /**
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	655 * The possible output formats for a DICOM-to-JSON conversion.
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	656 * @ingroup Toolbox
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	657 **/
1740 5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	658 typedef enum
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	659 {
1743 8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	660 OrthancPluginDicomToJsonFormat_Full = 1, /!< Full output, with most details /
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	661 OrthancPluginDicomToJsonFormat_Short = 2, /!< Tags output as hexadecimal numbers /
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	662 OrthancPluginDicomToJsonFormat_Simple = 3, /!< Human-readable JSON /
1740 5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	663
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	664 _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	665 } OrthancPluginDicomToJsonFormat;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	666
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	667
1743 8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	668 /**
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	669 * Flags to customize a DICOM-to-JSON conversion. By default, binary
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	670 * tags are formatted using Data URI scheme.
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	671 * @ingroup Toolbox
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	672 **/
1740 5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	673 typedef enum
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	674 {
1743 8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	675 OrthancPluginDicomToJsonFlags_IncludeBinary = (1 << 0), /!< Include the binary tags /
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	676 OrthancPluginDicomToJsonFlags_IncludePrivateTags = (1 << 1), /!< Include the private tags /
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	677 OrthancPluginDicomToJsonFlags_IncludeUnknownTags = (1 << 2), /!< Include the tags unknown by the dictionary /
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	678 OrthancPluginDicomToJsonFlags_IncludePixelData = (1 << 3), /!< Include the pixel data /
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	679 OrthancPluginDicomToJsonFlags_ConvertBinaryToAscii = (1 << 4), /!< Output binary tags as-is, dropping non-ASCII /
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	680 OrthancPluginDicomToJsonFlags_ConvertBinaryToNull = (1 << 5), /!< Signal binary tags as null values /
1740 5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	681
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	682 _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	683 } OrthancPluginDicomToJsonFlags;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	684
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	685
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	686 /**
1760 51db4a25a741 LookupIdentifier is plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1746 diff changeset	687 * The constraints on the DICOM identifiers that must be supported
51db4a25a741 LookupIdentifier is plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1746 diff changeset	688 * by the database plugins.
51db4a25a741 LookupIdentifier is plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1746 diff changeset	689 **/
51db4a25a741 LookupIdentifier is plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1746 diff changeset	690 typedef enum
51db4a25a741 LookupIdentifier is plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1746 diff changeset	691 {
51db4a25a741 LookupIdentifier is plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1746 diff changeset	692 OrthancPluginIdentifierConstraint_Equal, /!< Equal /
51db4a25a741 LookupIdentifier is plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1746 diff changeset	693 OrthancPluginIdentifierConstraint_SmallerOrEqual, /!< Less or equal /
51db4a25a741 LookupIdentifier is plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1746 diff changeset	694 OrthancPluginIdentifierConstraint_GreaterOrEqual, /!< More or equal /
51db4a25a741 LookupIdentifier is plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1746 diff changeset	695 OrthancPluginIdentifierConstraint_Wildcard, /!< Case-sensitive wildcard matching (with and ?) */
51db4a25a741 LookupIdentifier is plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1746 diff changeset	696
51db4a25a741 LookupIdentifier is plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1746 diff changeset	697 _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff
51db4a25a741 LookupIdentifier is plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1746 diff changeset	698 } OrthancPluginIdentifierConstraint;
51db4a25a741 LookupIdentifier is plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1746 diff changeset	699
51db4a25a741 LookupIdentifier is plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1746 diff changeset	700
51db4a25a741 LookupIdentifier is plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1746 diff changeset	701
51db4a25a741 LookupIdentifier is plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1746 diff changeset	702 /**
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	703 * @brief A memory buffer allocated by the core system of Orthanc.
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 * A memory buffer allocated by the core system of Orthanc. When the
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	706 * 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	707 * call to ::OrthancPluginFreeMemoryBuffer().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	708 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	709 typedef struct
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	710 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	711 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	712 * @brief The content of the buffer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	713 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	714 void* data;
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	715
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	716 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	717 * @brief The number of bytes in the buffer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	718 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	719 uint32_t size;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	720 } OrthancPluginMemoryBuffer;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	721
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	722
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	723
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	724
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	725 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	726 * @brief Opaque structure that represents the HTTP connection to the client application.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	727 * @ingroup Callback
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	728 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	729 typedef struct _OrthancPluginRestOutput_t OrthancPluginRestOutput;
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	730
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	731
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	732
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	733 /**
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	734 * @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	735 **/
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	736 typedef struct _OrthancPluginDicomInstance_t OrthancPluginDicomInstance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	737
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	738
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	739
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	740 /**
1615 c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	741 * @brief Opaque structure that represents an image that is uncompressed in memory.
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	742 * @ingroup Images
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	743 **/
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	744 typedef struct _OrthancPluginImage_t OrthancPluginImage;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	745
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	746
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	747
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	748 /**
1615 c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	749 * @brief Opaque structure that represents the storage area that is actually used by Orthanc.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	750 * @ingroup Images
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	751 **/
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	752 typedef struct _OrthancPluginStorageArea_t OrthancPluginStorageArea;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	753
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	754
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	755
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	756 /**
908 e078ea944089 refactoring HttpOutput Sebastien Jodogne <s.jodogne@gmail.com> parents: 907 diff changeset	757 * @brief Signature of a callback function that answers to a REST request.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	758 * @ingroup Callbacks
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	759 **/
1628 77c4cc4def0f OrthancPluginErrorCode in REST callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1627 diff changeset	760 typedef OrthancPluginErrorCode (*OrthancPluginRestCallback) (
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	761 OrthancPluginRestOutput* output,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	762 const char* url,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	763 const OrthancPluginHttpRequest* request);
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	764
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	765
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	766
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	767 /**
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	768 * @brief Signature of a callback function that is triggered when Orthanc receives a DICOM instance.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	769 * @ingroup Callbacks
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	770 **/
1627 da7854deb662 Plugin callbacks must now return explicit "OrthancPluginErrorCode" instead of integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1615 diff changeset	771 typedef OrthancPluginErrorCode (*OrthancPluginOnStoredInstanceCallback) (
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	772 OrthancPluginDicomInstance* instance,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	773 const char* instanceId);
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	774
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
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	777 /**
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	778 * @brief Signature of a callback function that is triggered when a change happens to some DICOM resource.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	779 * @ingroup Callbacks
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	780 **/
1627 da7854deb662 Plugin callbacks must now return explicit "OrthancPluginErrorCode" instead of integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1615 diff changeset	781 typedef OrthancPluginErrorCode (*OrthancPluginOnChangeCallback) (
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	782 OrthancPluginChangeType changeType,
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	783 OrthancPluginResourceType resourceType,
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	784 const char* resourceId);
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	785
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	786
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	787
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	788 /**
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	789 * @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	790 **/
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	791 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	792
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	793
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	794
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	795 /**
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	796 * @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	797 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	798 * 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	799 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	800 * @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	801 * @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	802 * @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	803 * @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	804 * @return 0 if success, other value if error.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	805 * @ingroup Callbacks
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	806 **/
1627 da7854deb662 Plugin callbacks must now return explicit "OrthancPluginErrorCode" instead of integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1615 diff changeset	807 typedef OrthancPluginErrorCode (*OrthancPluginStorageCreate) (
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	808 const char* uuid,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	809 const void* content,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	810 int64_t size,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	811 OrthancPluginContentType type);
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	812
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	813
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	814
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	815 /**
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	816 * @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	817 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	818 * 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	819 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	820 * @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	821 * @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	822 * @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	823 * @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	824 * @return 0 if success, other value if error.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	825 * @ingroup Callbacks
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	826 **/
1627 da7854deb662 Plugin callbacks must now return explicit "OrthancPluginErrorCode" instead of integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1615 diff changeset	827 typedef OrthancPluginErrorCode (*OrthancPluginStorageRead) (
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	828 void** content,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	829 int64_t* size,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	830 const char* uuid,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	831 OrthancPluginContentType type);
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	832
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	833
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	834
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	835 /**
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	836 * @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	837 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	838 * 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	839 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	840 * @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	841 * @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	842 * @return 0 if success, other value if error.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	843 * @ingroup Callbacks
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	844 **/
1627 da7854deb662 Plugin callbacks must now return explicit "OrthancPluginErrorCode" instead of integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1615 diff changeset	845 typedef OrthancPluginErrorCode (*OrthancPluginStorageRemove) (
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	846 const char* uuid,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	847 OrthancPluginContentType type);
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	848
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	849
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	850
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	851 /**
1297 501432928727 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1295 diff changeset	852 * @brief Data structure that contains information about the Orthanc core.
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	853 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	854 typedef struct _OrthancPluginContext_t
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	855 {
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	856 void* pluginsManager;
357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	857 const char* orthancVersion;
357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	858 OrthancPluginFree Free;
357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	859 OrthancPluginErrorCode (InvokeService) (struct _OrthancPluginContext_t context,
357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	860 _OrthancPluginService service,
357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	861 const void* params);
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	862 } OrthancPluginContext;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	863
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	864
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	865
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	866 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	867 * @brief Free a string.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	868 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	869 * Free a string that was allocated by the core system of Orthanc.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	870 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	871 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	872 * @param str The string to be freed.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	873 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	874 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeString(
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	875 OrthancPluginContext* context,
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	876 char* str)
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	877 {
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	878 if (str != NULL)
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	879 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	880 context->Free(str);
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	881 }
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	882 }
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	883
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	884
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	885 /**
1041 2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	886 * @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	887 *
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	888 * 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	889 * 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	890 * this function should always be checked in the
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	891 * OrthancPluginInitialize() entry point of the plugin.
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	892 *
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	893 * @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	894 * @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	895 * result is 0, the initialization of the plugin should fail.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	896 * @ingroup Callbacks
1039 5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	897 **/
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	898 ORTHANC_PLUGIN_INLINE int OrthancPluginCheckVersion(
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	899 OrthancPluginContext* context)
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	900 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	901 int major, minor, revision;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	902
1579 b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	903 if (sizeof(int32_t) != sizeof(OrthancPluginErrorCode) \|\|
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	904 sizeof(int32_t) != sizeof(OrthancPluginHttpMethod) \|\|
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	905 sizeof(int32_t) != sizeof(_OrthancPluginService) \|\|
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	906 sizeof(int32_t) != sizeof(_OrthancPluginProperty) \|\|
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	907 sizeof(int32_t) != sizeof(OrthancPluginPixelFormat) \|\|
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	908 sizeof(int32_t) != sizeof(OrthancPluginContentType) \|\|
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	909 sizeof(int32_t) != sizeof(OrthancPluginResourceType) \|\|
b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	910 sizeof(int32_t) != sizeof(OrthancPluginChangeType) \|\|
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	911 sizeof(int32_t) != sizeof(OrthancPluginCompressionType) \|\|
1657 5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	912 sizeof(int32_t) != sizeof(OrthancPluginImageFormat) \|\|
1740 5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	913 sizeof(int32_t) != sizeof(OrthancPluginValueRepresentation) \|\|
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	914 sizeof(int32_t) != sizeof(OrthancPluginDicomToJsonFormat) \|\|
1760 51db4a25a741 LookupIdentifier is plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1746 diff changeset	915 sizeof(int32_t) != sizeof(OrthancPluginDicomToJsonFlags) \|\|
51db4a25a741 LookupIdentifier is plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1746 diff changeset	916 sizeof(int32_t) != sizeof(OrthancPluginIdentifierConstraint))
1578 09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	917 {
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	918 /* Mismatch in the size of the enumerations */
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	919 return 0;
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	920 }
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	921
1039 5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	922 /* Assume compatibility with the mainline */
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	923 if (!strcmp(context->orthancVersion, "mainline"))
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	924 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	925 return 1;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	926 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	927
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	928 /* Parse the version of the Orthanc core */
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	929 if (
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	930 #ifdef _MSC_VER
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	931 sscanf_s
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	932 #else
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	933 sscanf
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	934 #endif
1303 bba8a47922d1 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1297 diff changeset	935 (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	936 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	937 return 0;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	938 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	939
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	940 /* Check the major number of the version */
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	941
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	942 if (major > ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	943 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	944 return 1;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	945 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	946
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	947 if (major < ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	948 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	949 return 0;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	950 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	951
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	952 /* Check the minor number of the version */
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	953
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	954 if (minor > ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	955 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	956 return 1;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	957 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	958
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	959 if (minor < ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	960 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	961 return 0;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	962 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	963
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	964 /* Check the revision number of the version */
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	965
1040 d06186cdc502 check plugin version in samples Sebastien Jodogne <s.jodogne@gmail.com> parents: 1039 diff changeset	966 if (revision >= ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER)
1039 5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	967 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	968 return 1;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	969 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	970 else
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	971 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	972 return 0;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	973 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	974 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	975
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	976
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	977 /**
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	978 * @brief Free a memory buffer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	979 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	980 * 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	981 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	982 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	983 * @param buffer The memory buffer to release.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	984 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	985 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeMemoryBuffer(
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	986 OrthancPluginContext* context,
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	987 OrthancPluginMemoryBuffer* buffer)
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	988 {
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	989 context->Free(buffer->data);
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	990 }
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	991
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	992
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	993 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	994 * @brief Log an error.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	995 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	996 * Log an error message using the Orthanc logging system.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	997 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	998 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	999 * @param message The message to be logged.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1000 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1001 ORTHANC_PLUGIN_INLINE void OrthancPluginLogError(
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1002 OrthancPluginContext* context,
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1003 const char* message)
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	1004 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1005 context->InvokeService(context, _OrthancPluginService_LogError, message);
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	1006 }
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	1007
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	1008
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1009 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1010 * @brief Log a warning.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1011 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1012 * Log a warning message using the Orthanc logging system.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1013 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1014 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1015 * @param message The message to be logged.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1016 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1017 ORTHANC_PLUGIN_INLINE void OrthancPluginLogWarning(
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1018 OrthancPluginContext* context,
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1019 const char* message)
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	1020 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1021 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	1022 }
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	1023
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	1024
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1025 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1026 * @brief Log an information.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1027 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1028 * Log an information message using the Orthanc logging system.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1029 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1030 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1031 * @param message The message to be logged.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1032 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1033 ORTHANC_PLUGIN_INLINE void OrthancPluginLogInfo(
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1034 OrthancPluginContext* context,
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1035 const char* message)
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	1036 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1037 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	1038 }
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	1039
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	1040
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1041
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1042 typedef struct
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1043 {
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1044 const char* pathRegularExpression;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1045 OrthancPluginRestCallback callback;
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1046 } _OrthancPluginRestCallback;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1047
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1048 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1049 * @brief Register a REST callback.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1050 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1051 * This function registers a REST callback against a regular
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1052 * expression for a URI. This function must be called during the
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1053 * initialization of the plugin, i.e. inside the
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1054 * OrthancPluginInitialize() public function.
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1055 *
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1056 * Each REST callback is guaranteed to run in mutual exclusion.
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1057 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1058 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1059 * @param pathRegularExpression Regular expression for the URI. May contain groups.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1060 * @param callback The callback function to handle the REST call.
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1061 * @see OrthancPluginRegisterRestCallbackNoLock()
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1062 * @ingroup Callbacks
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1063 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1064 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterRestCallback(
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1065 OrthancPluginContext* context,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1066 const char* pathRegularExpression,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1067 OrthancPluginRestCallback callback)
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1068 {
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1069 _OrthancPluginRestCallback params;
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1070 params.pathRegularExpression = pathRegularExpression;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1071 params.callback = callback;
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1072 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, &params);
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1073 }
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1074
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1075
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1076
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1077 /**
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1078 * @brief Register a REST callback, without locking.
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1079 *
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1080 * This function registers a REST callback against a regular
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1081 * expression for a URI. This function must be called during the
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1082 * initialization of the plugin, i.e. inside the
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1083 * OrthancPluginInitialize() public function.
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1084 *
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1085 * Contrarily to OrthancPluginRegisterRestCallback(), the callback
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1086 * will NOT be invoked in mutual exclusion. This can be useful for
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1087 * high-performance plugins that must handle concurrent requests
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1088 * (Orthanc uses a pool of threads, one thread being assigned to
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1089 * each incoming HTTP request). Of course, it is up to the plugin to
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1090 * implement the required locking mechanisms.
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1091 *
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1092 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1093 * @param pathRegularExpression Regular expression for the URI. May contain groups.
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1094 * @param callback The callback function to handle the REST call.
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1095 * @see OrthancPluginRegisterRestCallback()
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1096 * @ingroup Callbacks
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1097 **/
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1098 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterRestCallbackNoLock(
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1099 OrthancPluginContext* context,
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1100 const char* pathRegularExpression,
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1101 OrthancPluginRestCallback callback)
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1102 {
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1103 _OrthancPluginRestCallback params;
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1104 params.pathRegularExpression = pathRegularExpression;
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1105 params.callback = callback;
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1106 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, &params);
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1107 }
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1108
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1109
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1110
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1111 typedef struct
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1112 {
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1113 OrthancPluginOnStoredInstanceCallback callback;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1114 } _OrthancPluginOnStoredInstanceCallback;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1115
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1116 /**
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1117 * @brief Register a callback for received instances.
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1118 *
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1119 * This function registers a callback function that is called
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1120 * 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	1121 *
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1122 * @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	1123 * @param callback The callback function.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1124 * @ingroup Callbacks
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1125 **/
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1126 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterOnStoredInstanceCallback(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1127 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1128 OrthancPluginOnStoredInstanceCallback callback)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1129 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1130 _OrthancPluginOnStoredInstanceCallback params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1131 params.callback = callback;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1132
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1133 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, &params);
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1134 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1135
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1136
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1137
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1138 typedef struct
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1139 {
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1140 OrthancPluginRestOutput* output;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1141 const char* answer;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1142 uint32_t answerSize;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1143 const char* mimeType;
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1144 } _OrthancPluginAnswerBuffer;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1145
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1146 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1147 * @brief Answer to a REST request.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1148 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1149 * 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	1150 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1151 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1152 * @param output The HTTP connection to the client application.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1153 * @param answer Pointer to the memory buffer containing the answer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1154 * @param answerSize Number of bytes of the answer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1155 * @param mimeType The MIME type of the answer.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1156 * @ingroup REST
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1157 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1158 ORTHANC_PLUGIN_INLINE void OrthancPluginAnswerBuffer(
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1159 OrthancPluginContext* context,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1160 OrthancPluginRestOutput* output,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1161 const char* answer,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1162 uint32_t answerSize,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1163 const char* mimeType)
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1164 {
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1165 _OrthancPluginAnswerBuffer params;
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1166 params.output = output;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1167 params.answer = answer;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1168 params.answerSize = answerSize;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1169 params.mimeType = mimeType;
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1170 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, &params);
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1171 }
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1172
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1173
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1174 typedef struct
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1175 {
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1176 OrthancPluginRestOutput* output;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1177 OrthancPluginPixelFormat format;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1178 uint32_t width;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1179 uint32_t height;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1180 uint32_t pitch;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1181 const void* buffer;
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1182 } _OrthancPluginCompressAndAnswerPngImage;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1183
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1184 typedef struct
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1185 {
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1186 OrthancPluginRestOutput* output;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1187 OrthancPluginImageFormat imageFormat;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1188 OrthancPluginPixelFormat pixelFormat;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1189 uint32_t width;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1190 uint32_t height;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1191 uint32_t pitch;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1192 const void* buffer;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1193 uint8_t quality;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1194 } _OrthancPluginCompressAndAnswerImage;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1195
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1196
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1197 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1198 * @brief Answer to a REST request with a PNG image.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1199 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1200 * This function answers to a REST request with a PNG image. The
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1201 * parameters of this function describe a memory buffer that
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1202 * contains an uncompressed image. The image will be automatically compressed
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1203 * as a PNG image by the core system of Orthanc.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1204 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1205 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1206 * @param output The HTTP connection to the client application.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1207 * @param format The memory layout of the uncompressed image.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1208 * @param width The width of the image.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1209 * @param height The height of the image.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1210 * @param pitch The pitch of the image (i.e. the number of bytes
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1211 * between 2 successive lines of the image in the memory buffer).
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1212 * @param buffer The memory buffer containing the uncompressed image.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1213 * @ingroup REST
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1214 **/
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1215 ORTHANC_PLUGIN_INLINE void OrthancPluginCompressAndAnswerPngImage(
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1216 OrthancPluginContext* context,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1217 OrthancPluginRestOutput* output,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1218 OrthancPluginPixelFormat format,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1219 uint32_t width,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1220 uint32_t height,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1221 uint32_t pitch,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1222 const void* buffer)
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1223 {
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1224 _OrthancPluginCompressAndAnswerImage params;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1225 params.output = output;
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1226 params.imageFormat = OrthancPluginImageFormat_Png;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1227 params.pixelFormat = format;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1228 params.width = width;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1229 params.height = height;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1230 params.pitch = pitch;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1231 params.buffer = buffer;
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1232 params.quality = 0; /* No quality for PNG */
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1233 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, &params);
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1234 }
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1235
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1236
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1237
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1238 typedef struct
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1239 {
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1240 OrthancPluginMemoryBuffer* target;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1241 const char* instanceId;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1242 } _OrthancPluginGetDicomForInstance;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1243
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1244 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1245 * @brief Retrieve a DICOM instance using its Orthanc identifier.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1246 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1247 * Retrieve a DICOM instance using its Orthanc identifier. The DICOM
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1248 * file is stored into a newly allocated memory buffer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1249 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1250 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1251 * @param target The target memory buffer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1252 * @param instanceId The Orthanc identifier of the DICOM instance of interest.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1253 * @return 0 if success, or the error code if failure.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1254 * @ingroup Orthanc
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1255 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1256 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginGetDicomForInstance(
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1257 OrthancPluginContext* context,
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1258 OrthancPluginMemoryBuffer* target,
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1259 const char* instanceId)
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1260 {
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1261 _OrthancPluginGetDicomForInstance params;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1262 params.target = target;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1263 params.instanceId = instanceId;
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1264 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, &params);
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1265 }
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1266
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	1267
912 dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1268
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1269 typedef struct
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1270 {
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1271 OrthancPluginMemoryBuffer* target;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1272 const char* uri;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1273 } _OrthancPluginRestApiGet;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1274
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1275 /**
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1276 * @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	1277 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1278 * 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	1279 * 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	1280 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1281 * @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	1282 * @param target The target memory buffer.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1283 * @param uri The URI in the built-in Orthanc API.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1284 * @return 0 if success, or the error code if failure.
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	1285 * @see OrthancPluginRestApiGetAfterPlugins
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1286 * @ingroup Orthanc
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1287 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1288 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiGet(
912 dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1289 OrthancPluginContext* context,
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1290 OrthancPluginMemoryBuffer* target,
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1291 const char* uri)
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1292 {
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1293 _OrthancPluginRestApiGet params;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1294 params.target = target;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1295 params.uri = uri;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1296 return context->InvokeService(context, _OrthancPluginService_RestApiGet, &params);
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1297 }
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1298
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1299
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1300
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1301 /**
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1302 * @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	1303 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1304 * 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	1305 * 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	1306 * 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	1307 * 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	1308 * 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	1309 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1310 * @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	1311 * @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	1312 * @param uri The URI in the built-in Orthanc API.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1313 * @return 0 if success, or the error code if failure.
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	1314 * @see OrthancPluginRestApiGet
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1315 * @ingroup Orthanc
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1316 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1317 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiGetAfterPlugins(
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1318 OrthancPluginContext* context,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1319 OrthancPluginMemoryBuffer* target,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1320 const char* uri)
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1321 {
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1322 _OrthancPluginRestApiGet params;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1323 params.target = target;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1324 params.uri = uri;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1325 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	1326 }
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1327
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1328
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1329
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1330 typedef struct
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1331 {
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1332 OrthancPluginMemoryBuffer* target;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1333 const char* uri;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1334 const char* body;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1335 uint32_t bodySize;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1336 } _OrthancPluginRestApiPostPut;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1337
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1338 /**
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1339 * @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	1340 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1341 * 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	1342 * 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	1343 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1344 * @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	1345 * @param target The target memory buffer.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1346 * @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	1347 * @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	1348 * @param bodySize The size of the body.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1349 * @return 0 if success, or the error code if failure.
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	1350 * @see OrthancPluginRestApiPostAfterPlugins
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1351 * @ingroup Orthanc
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1352 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1353 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPost(
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1354 OrthancPluginContext* context,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1355 OrthancPluginMemoryBuffer* target,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1356 const char* uri,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1357 const char* body,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1358 uint32_t bodySize)
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1359 {
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1360 _OrthancPluginRestApiPostPut params;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1361 params.target = target;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1362 params.uri = uri;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1363 params.body = body;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1364 params.bodySize = bodySize;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1365 return context->InvokeService(context, _OrthancPluginService_RestApiPost, &params);
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1366 }
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1367
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1368
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1369 /**
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1370 * @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	1371 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1372 * 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	1373 * 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	1374 * 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	1375 * 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	1376 * 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	1377 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1378 * @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	1379 * @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	1380 * @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	1381 * @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	1382 * @param bodySize The size of the body.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1383 * @return 0 if success, or the error code if failure.
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	1384 * @see OrthancPluginRestApiPost
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1385 * @ingroup Orthanc
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1386 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1387 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPostAfterPlugins(
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1388 OrthancPluginContext* context,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1389 OrthancPluginMemoryBuffer* target,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1390 const char* uri,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1391 const char* body,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1392 uint32_t bodySize)
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1393 {
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1394 _OrthancPluginRestApiPostPut params;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1395 params.target = target;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1396 params.uri = uri;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1397 params.body = body;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1398 params.bodySize = bodySize;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1399 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	1400 }
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1401
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1402
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1403
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1404 /**
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1405 * @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	1406 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1407 * 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	1408 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1409 * @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	1410 * @param uri The URI to delete in the built-in Orthanc API.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1411 * @return 0 if success, or the error code if failure.
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	1412 * @see OrthancPluginRestApiDeleteAfterPlugins
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1413 * @ingroup Orthanc
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1414 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1415 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiDelete(
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1416 OrthancPluginContext* context,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1417 const char* uri)
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1418 {
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1419 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1420 }
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1421
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1422
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1423 /**
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1424 * @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	1425 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1426 * 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	1427 * 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	1428 * 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	1429 * 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	1430 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1431 * @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	1432 * @param uri The URI to delete in the built-in Orthanc API.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1433 * @return 0 if success, or the error code if failure.
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	1434 * @see OrthancPluginRestApiDelete
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1435 * @ingroup Orthanc
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1436 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1437 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1438 OrthancPluginContext* context,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1439 const char* uri)
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1440 {
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1441 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	1442 }
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1443
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1444
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1445
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1446 /**
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1447 * @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	1448 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1449 * 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	1450 * 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	1451 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1452 * @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	1453 * @param target The target memory buffer.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1454 * @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	1455 * @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	1456 * @param bodySize The size of the body.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1457 * @return 0 if success, or the error code if failure.
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	1458 * @see OrthancPluginRestApiPutAfterPlugins
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1459 * @ingroup Orthanc
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1460 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1461 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPut(
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1462 OrthancPluginContext* context,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1463 OrthancPluginMemoryBuffer* target,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1464 const char* uri,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1465 const char* body,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1466 uint32_t bodySize)
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1467 {
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1468 _OrthancPluginRestApiPostPut params;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1469 params.target = target;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1470 params.uri = uri;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1471 params.body = body;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1472 params.bodySize = bodySize;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1473 return context->InvokeService(context, _OrthancPluginService_RestApiPut, &params);
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1474 }
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1475
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1476
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1477
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1478 /**
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1479 * @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	1480 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1481 * 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	1482 * 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	1483 * 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	1484 * 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	1485 * 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	1486 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1487 * @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	1488 * @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	1489 * @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	1490 * @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	1491 * @param bodySize The size of the body.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1492 * @return 0 if success, or the error code if failure.
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	1493 * @see OrthancPluginRestApiPut
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1494 * @ingroup Orthanc
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1495 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1496 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPutAfterPlugins(
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1497 OrthancPluginContext* context,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1498 OrthancPluginMemoryBuffer* target,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1499 const char* uri,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1500 const char* body,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1501 uint32_t bodySize)
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1502 {
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1503 _OrthancPluginRestApiPostPut params;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1504 params.target = target;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1505 params.uri = uri;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1506 params.body = body;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1507 params.bodySize = bodySize;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1508 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	1509 }
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1510
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1511
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1512
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1513 typedef struct
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1514 {
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1515 OrthancPluginRestOutput* output;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1516 const char* argument;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1517 } _OrthancPluginOutputPlusArgument;
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1518
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1519 /**
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1520 * @brief Redirect a REST request.
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1521 *
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1522 * 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	1523 * to another URI using HTTP status 301.
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1524 *
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1525 * @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	1526 * @param output The HTTP connection to the client application.
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1527 * @param redirection Where to redirect.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1528 * @ingroup REST
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1529 **/
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1530 ORTHANC_PLUGIN_INLINE void OrthancPluginRedirect(
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1531 OrthancPluginContext* context,
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1532 OrthancPluginRestOutput* output,
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1533 const char* redirection)
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1534 {
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1535 _OrthancPluginOutputPlusArgument params;
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1536 params.output = output;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1537 params.argument = redirection;
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1538 context->InvokeService(context, _OrthancPluginService_Redirect, &params);
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1539 }
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1540
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1541
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1542
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1543 typedef struct
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1544 {
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1545 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	1546 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	1547 } _OrthancPluginRetrieveDynamicString;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1548
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1549 /**
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1550 * @brief Look for a patient.
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1551 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1552 * 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	1553 * 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	1554 * over all the stored patients).
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1555 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1556 * @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	1557 * @param patientID The Patient ID of interest.
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1558 * @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	1559 * Orthanc ID of the patient. This string must be freed by OrthancPluginFreeString().
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1560 * @ingroup Orthanc
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1561 **/
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1562 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupPatient(
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1563 OrthancPluginContext* context,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1564 const char* patientID)
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1565 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1566 char* result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1567
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1568 _OrthancPluginRetrieveDynamicString params;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1569 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	1570 params.argument = patientID;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1571
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1572 if (context->InvokeService(context, _OrthancPluginService_LookupPatient, &params) != OrthancPluginErrorCode_Success)
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1573 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1574 /* Error */
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1575 return NULL;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1576 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1577 else
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1578 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1579 return result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1580 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1581 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1582
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1583
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1584 /**
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1585 * @brief Look for a study.
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1586 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1587 * 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	1588 * 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	1589 * over all the stored studies).
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1590 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1591 * @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	1592 * @param studyUID The Study Instance UID of interest.
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1593 * @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	1594 * Orthanc ID of the study. This string must be freed by OrthancPluginFreeString().
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1595 * @ingroup Orthanc
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1596 **/
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1597 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupStudy(
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1598 OrthancPluginContext* context,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1599 const char* studyUID)
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1600 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1601 char* result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1602
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1603 _OrthancPluginRetrieveDynamicString params;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1604 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	1605 params.argument = studyUID;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1606
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1607 if (context->InvokeService(context, _OrthancPluginService_LookupStudy, &params) != OrthancPluginErrorCode_Success)
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1608 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1609 /* Error */
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1610 return NULL;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1611 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1612 else
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1613 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1614 return result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1615 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1616 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1617
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1618
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1619 /**
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1620 * @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	1621 *
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1622 * 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	1623 * 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	1624 * over all the stored studies).
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1625 *
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1626 * @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	1627 * @param accessionNumber The Accession Number of interest.
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1628 * @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	1629 * Orthanc ID of the study. This string must be freed by OrthancPluginFreeString().
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1630 * @ingroup Orthanc
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1631 **/
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1632 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupStudyWithAccessionNumber(
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1633 OrthancPluginContext* context,
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1634 const char* accessionNumber)
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1635 {
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1636 char* result;
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1637
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1638 _OrthancPluginRetrieveDynamicString params;
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1639 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	1640 params.argument = accessionNumber;
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1641
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1642 if (context->InvokeService(context, _OrthancPluginService_LookupStudyWithAccessionNumber, &params) != OrthancPluginErrorCode_Success)
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1643 {
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1644 /* Error */
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1645 return NULL;
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1646 }
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1647 else
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1648 {
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1649 return result;
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1650 }
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1651 }
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1652
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1653
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1654 /**
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1655 * @brief Look for a series.
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1656 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1657 * 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	1658 * 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	1659 * over all the stored series).
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1660 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1661 * @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	1662 * @param seriesUID The Series Instance UID of interest.
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1663 * @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	1664 * Orthanc ID of the series. This string must be freed by OrthancPluginFreeString().
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1665 * @ingroup Orthanc
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1666 **/
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1667 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupSeries(
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1668 OrthancPluginContext* context,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1669 const char* seriesUID)
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1670 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1671 char* result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1672
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1673 _OrthancPluginRetrieveDynamicString params;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1674 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	1675 params.argument = seriesUID;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1676
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1677 if (context->InvokeService(context, _OrthancPluginService_LookupSeries, &params) != OrthancPluginErrorCode_Success)
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1678 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1679 /* Error */
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1680 return NULL;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1681 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1682 else
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1683 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1684 return result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1685 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1686 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1687
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1688
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1689 /**
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1690 * @brief Look for an instance.
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1691 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1692 * 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	1693 * 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	1694 * over all the stored instances).
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1695 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1696 * @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	1697 * @param sopInstanceUID The SOP Instance UID of interest.
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1698 * @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	1699 * Orthanc ID of the instance. This string must be freed by OrthancPluginFreeString().
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1700 * @ingroup Orthanc
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1701 **/
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1702 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupInstance(
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1703 OrthancPluginContext* context,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1704 const char* sopInstanceUID)
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1705 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1706 char* result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1707
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1708 _OrthancPluginRetrieveDynamicString params;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1709 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	1710 params.argument = sopInstanceUID;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1711
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1712 if (context->InvokeService(context, _OrthancPluginService_LookupInstance, &params) != OrthancPluginErrorCode_Success)
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1713 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1714 /* Error */
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1715 return NULL;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1716 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1717 else
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1718 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1719 return result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1720 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1721 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1722
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1723
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1724
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1725 typedef struct
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1726 {
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1727 OrthancPluginRestOutput* output;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1728 uint16_t status;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1729 } _OrthancPluginSendHttpStatusCode;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1730
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1731 /**
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1732 * @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	1733 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1734 * 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	1735 * 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	1736 * - 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	1737 * - 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	1738 * - 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	1739 * - 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	1740 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1741 * @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	1742 * @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	1743 * @param status The HTTP status code to be sent.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1744 * @ingroup REST
1594 2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	1745 * @see OrthancPluginSendHttpStatus()
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1746 **/
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1747 ORTHANC_PLUGIN_INLINE void OrthancPluginSendHttpStatusCode(
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1748 OrthancPluginContext* context,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1749 OrthancPluginRestOutput* output,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1750 uint16_t status)
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1751 {
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1752 _OrthancPluginSendHttpStatusCode params;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1753 params.output = output;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1754 params.status = status;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1755 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	1756 }
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1757
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1758
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1759 /**
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1760 * @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	1761 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1762 * 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	1763 * not authorized.
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1764 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1765 * @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	1766 * @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	1767 * @param realm The realm for the authorization process.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1768 * @ingroup REST
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1769 **/
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1770 ORTHANC_PLUGIN_INLINE void OrthancPluginSendUnauthorized(
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1771 OrthancPluginContext* context,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1772 OrthancPluginRestOutput* output,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1773 const char* realm)
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1774 {
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1775 _OrthancPluginOutputPlusArgument params;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1776 params.output = output;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1777 params.argument = realm;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1778 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	1779 }
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1780
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1781
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1782 /**
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1783 * @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	1784 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1785 * 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	1786 * 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	1787 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1788 * @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	1789 * @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	1790 * @param allowedMethods The allowed methods for this URI (e.g. "GET,POST" after a PUT or a POST request).
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1791 * @ingroup REST
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1792 **/
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1793 ORTHANC_PLUGIN_INLINE void OrthancPluginSendMethodNotAllowed(
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1794 OrthancPluginContext* context,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1795 OrthancPluginRestOutput* output,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1796 const char* allowedMethods)
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1797 {
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1798 _OrthancPluginOutputPlusArgument params;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1799 params.output = output;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1800 params.argument = allowedMethods;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1801 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	1802 }
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1803
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1804
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1805 typedef struct
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1806 {
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1807 OrthancPluginRestOutput* output;
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1808 const char* key;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1809 const char* value;
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1810 } _OrthancPluginSetHttpHeader;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1811
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1812 /**
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1813 * @brief Set a cookie.
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1814 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1815 * 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	1816 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1817 * @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	1818 * @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	1819 * @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	1820 * @param value The value of the cookie.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1821 * @ingroup REST
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1822 **/
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1823 ORTHANC_PLUGIN_INLINE void OrthancPluginSetCookie(
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1824 OrthancPluginContext* context,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1825 OrthancPluginRestOutput* output,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1826 const char* cookie,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1827 const char* value)
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1828 {
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1829 _OrthancPluginSetHttpHeader params;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1830 params.output = output;
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1831 params.key = cookie;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1832 params.value = value;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1833 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	1834 }
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1835
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1836
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1837 /**
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1838 * @brief Set some HTTP header.
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1839 *
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1840 * This function sets a HTTP header in the HTTP answer.
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1841 *
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1842 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1843 * @param output The HTTP connection to the client application.
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1844 * @param key The HTTP header to be set.
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1845 * @param value The value of the HTTP header.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1846 * @ingroup REST
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1847 **/
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1848 ORTHANC_PLUGIN_INLINE void OrthancPluginSetHttpHeader(
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1849 OrthancPluginContext* context,
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1850 OrthancPluginRestOutput* output,
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1851 const char* key,
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1852 const char* value)
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1853 {
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1854 _OrthancPluginSetHttpHeader params;
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1855 params.output = output;
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1856 params.key = key;
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1857 params.value = value;
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1858 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, &params);
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1859 }
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1860
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1861
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1862 typedef struct
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1863 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1864 char** resultStringToFree;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1865 const char** resultString;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1866 int64_t* resultInt64;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1867 const char* key;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1868 OrthancPluginDicomInstance* instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1869 } _OrthancPluginAccessDicomInstance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1870
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1871
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1872 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1873 * @brief Get the AET of a DICOM instance.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1874 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1875 * 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	1876 * DICOM modality from which a DICOM instance originates.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1877 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1878 * @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	1879 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1880 * @return The AET if success, NULL if error.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1881 * @ingroup Callbacks
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1882 **/
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1883 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceRemoteAet(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1884 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1885 OrthancPluginDicomInstance* instance)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1886 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1887 const char* result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1888
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1889 _OrthancPluginAccessDicomInstance params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1890 memset(&params, 0, sizeof(params));
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1891 params.resultString = &result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1892 params.instance = instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1893
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1894 if (context->InvokeService(context, _OrthancPluginService_GetInstanceRemoteAet, &params) != OrthancPluginErrorCode_Success)
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1895 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1896 /* Error */
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1897 return NULL;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1898 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1899 else
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1900 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1901 return result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1902 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1903 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1904
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1905
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1906 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1907 * @brief Get the size of a DICOM file.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1908 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1909 * 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	1910 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1911 * @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	1912 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1913 * @return The size of the file, -1 in case of error.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1914 * @ingroup Callbacks
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1915 **/
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1916 ORTHANC_PLUGIN_INLINE int64_t OrthancPluginGetInstanceSize(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1917 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1918 OrthancPluginDicomInstance* instance)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1919 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1920 int64_t size;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1921
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1922 _OrthancPluginAccessDicomInstance params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1923 memset(&params, 0, sizeof(params));
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1924 params.resultInt64 = &size;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1925 params.instance = instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1926
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1927 if (context->InvokeService(context, _OrthancPluginService_GetInstanceSize, &params) != OrthancPluginErrorCode_Success)
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1928 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1929 /* Error */
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1930 return -1;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1931 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1932 else
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1933 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1934 return size;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1935 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1936 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1937
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1938
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1939 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1940 * @brief Get the data of a DICOM file.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1941 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1942 * 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	1943 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1944 * @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	1945 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1946 * @return The pointer to the DICOM data, NULL in case of error.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1947 * @ingroup Callbacks
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1948 **/
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1949 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceData(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1950 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1951 OrthancPluginDicomInstance* instance)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1952 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1953 const char* result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1954
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1955 _OrthancPluginAccessDicomInstance params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1956 memset(&params, 0, sizeof(params));
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1957 params.resultString = &result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1958 params.instance = instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1959
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1960 if (context->InvokeService(context, _OrthancPluginService_GetInstanceData, &params) != OrthancPluginErrorCode_Success)
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1961 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1962 /* Error */
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1963 return NULL;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1964 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1965 else
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1966 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1967 return result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1968 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1969 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1970
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1971
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1972 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1973 * @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	1974 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1975 * 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	1976 * 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	1977 * of the given DICOM instance.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1978 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1979 * @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	1980 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1981 * @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	1982 * This string must be freed by OrthancPluginFreeString().
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1983 * @ingroup Callbacks
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1984 **/
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1985 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceJson(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1986 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1987 OrthancPluginDicomInstance* instance)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1988 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1989 char* result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1990
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1991 _OrthancPluginAccessDicomInstance params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1992 memset(&params, 0, sizeof(params));
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1993 params.resultStringToFree = &result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1994 params.instance = instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1995
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1996 if (context->InvokeService(context, _OrthancPluginService_GetInstanceJson, &params) != OrthancPluginErrorCode_Success)
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1997 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1998 /* Error */
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1999 return NULL;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2000 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2001 else
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2002 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2003 return result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2004 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2005 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2006
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2007
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2008 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2009 * @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	2010 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2011 * 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	2012 * 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	2013 * of the given DICOM instance. In contrast with
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2014 * ::OrthancPluginGetInstanceJson(), the returned JSON file is in
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2015 * its simplified version.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2016 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2017 * @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	2018 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2019 * @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	2020 * This string must be freed by OrthancPluginFreeString().
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2021 * @ingroup Callbacks
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2022 **/
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2023 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceSimplifiedJson(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2024 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2025 OrthancPluginDicomInstance* instance)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2026 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2027 char* result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2028
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2029 _OrthancPluginAccessDicomInstance params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2030 memset(&params, 0, sizeof(params));
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2031 params.resultStringToFree = &result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2032 params.instance = instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2033
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2034 if (context->InvokeService(context, _OrthancPluginService_GetInstanceSimplifiedJson, &params) != OrthancPluginErrorCode_Success)
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2035 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2036 /* Error */
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2037 return NULL;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2038 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2039 else
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2040 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2041 return result;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2042 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2043 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2044
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2045
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2046 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2047 * @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	2048 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2049 * 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	2050 * 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	2051 * callbacks registered by
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2052 * ::OrthancPluginRegisterOnStoredInstanceCallback(), the only
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2053 * possibly available metadata are "ReceptionDate", "RemoteAET" and
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2054 * "IndexInSeries".
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2055 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2056 * @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	2057 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2058 * @param metadata The metadata of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2059 * @return 1 if the metadata is present, 0 if it is absent, -1 in case of error.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2060 * @ingroup Callbacks
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2061 **/
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2062 ORTHANC_PLUGIN_INLINE int OrthancPluginHasInstanceMetadata(
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2063 OrthancPluginContext* context,
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2064 OrthancPluginDicomInstance* instance,
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2065 const char* metadata)
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2066 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2067 int64_t result;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2068
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2069 _OrthancPluginAccessDicomInstance params;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2070 memset(&params, 0, sizeof(params));
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2071 params.resultInt64 = &result;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2072 params.instance = instance;
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2073 params.key = metadata;
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2074
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2075 if (context->InvokeService(context, _OrthancPluginService_HasInstanceMetadata, &params) != OrthancPluginErrorCode_Success)
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2076 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2077 /* Error */
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2078 return -1;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2079 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2080 else
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2081 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2082 return (result != 0);
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2083 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2084 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2085
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2086
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2087 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2088 * @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	2089 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2090 * 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	2091 * 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	2092 * ::OrthancPluginHasInstanceMetadata().
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2093 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2094 * @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	2095 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2096 * @param metadata The metadata of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2097 * @return The metadata value if success, NULL if error.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2098 * @ingroup Callbacks
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2099 **/
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2100 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceMetadata(
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2101 OrthancPluginContext* context,
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2102 OrthancPluginDicomInstance* instance,
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2103 const char* metadata)
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2104 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2105 const char* result;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2106
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2107 _OrthancPluginAccessDicomInstance params;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2108 memset(&params, 0, sizeof(params));
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2109 params.resultString = &result;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2110 params.instance = instance;
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2111 params.key = metadata;
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2112
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2113 if (context->InvokeService(context, _OrthancPluginService_GetInstanceMetadata, &params) != OrthancPluginErrorCode_Success)
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2114 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2115 /* Error */
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2116 return NULL;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2117 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2118 else
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2119 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2120 return result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2121 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2122 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2123
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2124
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2125
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2126 typedef struct
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2127 {
1295 50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2128 OrthancPluginStorageCreate create;
50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2129 OrthancPluginStorageRead read;
50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2130 OrthancPluginStorageRemove remove;
50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2131 OrthancPluginFree free;
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2132 } _OrthancPluginRegisterStorageArea;
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2133
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2134 /**
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2135 * @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	2136 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2137 * 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	2138 * 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	2139 * 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	2140 * 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	2141 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2142 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
1141 2ff467bcfb98 doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1137 diff changeset	2143 * @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	2144 * @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	2145 * @param remove The callback function to remove a file from the custom storage area.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2146 * @ingroup Callbacks
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2147 **/
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2148 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	2149 OrthancPluginContext* context,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2150 OrthancPluginStorageCreate create,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2151 OrthancPluginStorageRead read,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2152 OrthancPluginStorageRemove remove)
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2153 {
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2154 _OrthancPluginRegisterStorageArea params;
1295 50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2155 params.create = create;
50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2156 params.read = read;
50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2157 params.remove = remove;
1136 208dc67b9bab sample custom storage plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1135 diff changeset	2158
208dc67b9bab sample custom storage plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1135 diff changeset	2159 #ifdef __cplusplus
1295 50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2160 params.free = ::free;
1136 208dc67b9bab sample custom storage plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1135 diff changeset	2161 #else
1295 50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2162 params.free = free;
1136 208dc67b9bab sample custom storage plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1135 diff changeset	2163 #endif
208dc67b9bab sample custom storage plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1135 diff changeset	2164
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2165 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	2166 }
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2167
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2168
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2169
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2170 /**
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2171 * @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	2172 *
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2173 * 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	2174 *
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2175 * @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	2176 * @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	2177 * 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	2178 * OrthancPluginFreeString().
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2179 **/
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2180 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	2181 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2182 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	2183
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2184 _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	2185 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	2186 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	2187
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2188 if (context->InvokeService(context, _OrthancPluginService_GetOrthancPath, &params) != OrthancPluginErrorCode_Success)
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2189 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2190 /* Error */
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2191 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	2192 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2193 else
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2194 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2195 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	2196 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2197 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2198
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2199
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2200 /**
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2201 * @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	2202 *
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2203 * 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	2204 *
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2205 * @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	2206 * @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	2207 * 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	2208 * OrthancPluginFreeString().
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2209 **/
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2210 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	2211 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2212 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	2213
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2214 _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	2215 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	2216 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	2217
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2218 if (context->InvokeService(context, _OrthancPluginService_GetOrthancDirectory, &params) != OrthancPluginErrorCode_Success)
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2219 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2220 /* Error */
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2221 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	2222 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2223 else
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2224 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2225 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	2226 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2227 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2228
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2229
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2230 /**
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	2231 * @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	2232 *
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	2233 * 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	2234 * 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	2235 * 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	2236 * files. This function is deprecated in favor of
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2237 * 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	2238 *
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2239 * @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	2240 * @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	2241 * 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	2242 * OrthancPluginFreeString().
1424 fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2243 * @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	2244 **/
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2245 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	2246 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2247 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	2248
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2249 _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	2250 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	2251 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	2252
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2253 if (context->InvokeService(context, _OrthancPluginService_GetConfigurationPath, &params) != OrthancPluginErrorCode_Success)
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2254 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2255 /* Error */
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2256 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	2257 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2258 else
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2259 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2260 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	2261 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2262 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2263
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2264
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2265
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2266 typedef struct
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2267 {
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2268 OrthancPluginOnChangeCallback callback;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2269 } _OrthancPluginOnChangeCallback;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2270
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2271 /**
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2272 * @brief Register a callback to monitor changes.
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2273 *
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2274 * 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	2275 * whenever a change happens to some DICOM resource.
1642 0669d05b6de1 warning about OrthancPluginRegisterOnChangeCallback Sebastien Jodogne <s.jodogne@gmail.com> parents: 1630 diff changeset	2276 *
0669d05b6de1 warning about OrthancPluginRegisterOnChangeCallback Sebastien Jodogne <s.jodogne@gmail.com> parents: 1630 diff changeset	2277 * @warning If your change callback has to call the REST API of
0669d05b6de1 warning about OrthancPluginRegisterOnChangeCallback Sebastien Jodogne <s.jodogne@gmail.com> parents: 1630 diff changeset	2278 * Orthanc, you should make these calls in a separate thread (with
0669d05b6de1 warning about OrthancPluginRegisterOnChangeCallback Sebastien Jodogne <s.jodogne@gmail.com> parents: 1630 diff changeset	2279 * the events passing through a message queue). Otherwise, this
0669d05b6de1 warning about OrthancPluginRegisterOnChangeCallback Sebastien Jodogne <s.jodogne@gmail.com> parents: 1630 diff changeset	2280 * could result in deadlocks in the presence of other plugins or Lua
0669d05b6de1 warning about OrthancPluginRegisterOnChangeCallback Sebastien Jodogne <s.jodogne@gmail.com> parents: 1630 diff changeset	2281 * script.
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2282 *
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2283 * @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	2284 * @param callback The callback function.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2285 * @ingroup Callbacks
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2286 **/
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2287 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterOnChangeCallback(
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2288 OrthancPluginContext* context,
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2289 OrthancPluginOnChangeCallback callback)
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2290 {
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2291 _OrthancPluginOnChangeCallback params;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2292 params.callback = callback;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2293
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2294 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, &params);
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2295 }
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2296
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2297
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2298
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2299 typedef struct
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2300 {
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2301 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	2302 _OrthancPluginProperty property;
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2303 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	2304 } _OrthancPluginSetPluginProperty;
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2305
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2306
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2307 /**
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2308 * @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	2309 *
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2310 * 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	2311 * 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	2312 * 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	2313 * Explorer.
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2314 *
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2315 * @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	2316 * @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	2317 **/
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2318 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	2319 OrthancPluginContext* context,
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2320 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	2321 {
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2322 _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	2323 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	2324 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	2325 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	2326
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2327 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	2328 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2329
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2330
1233 eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2331 /**
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2332 * @brief Set a description for this plugin.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2333 *
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2334 * Set a description for this plugin. It is displayed in the
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2335 * "Plugins" page of Orthanc Explorer.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2336 *
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2337 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2338 * @param description The description.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2339 **/
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2340 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	2341 OrthancPluginContext* context,
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2342 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	2343 {
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2344 _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	2345 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	2346 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	2347 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	2348
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2349 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	2350 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2351
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2352
1233 eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2353 /**
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2354 * @brief Extend the JavaScript code of Orthanc Explorer.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2355 *
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2356 * Add JavaScript code to customize the default behavior of Orthanc
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2357 * Explorer. This can for instance be used to add new buttons.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2358 *
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2359 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2360 * @param javascript The custom JavaScript code.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2361 **/
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2362 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	2363 OrthancPluginContext* context,
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2364 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	2365 {
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2366 _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	2367 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	2368 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	2369 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	2370
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2371 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	2372 }
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2373
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2374
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2375 typedef struct
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2376 {
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2377 char** result;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2378 int32_t property;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2379 const char* value;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2380 } _OrthancPluginGlobalProperty;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2381
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2382
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2383 /**
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2384 * @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	2385 *
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2386 * 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	2387 * 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	2388 *
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2389 * @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	2390 * @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	2391 * @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	2392 * @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	2393 * string must be freed by OrthancPluginFreeString().
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2394 * @ingroup Orthanc
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2395 **/
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2396 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	2397 OrthancPluginContext* context,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2398 int32_t property,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2399 const char* defaultValue)
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2400 {
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2401 char* result;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2402
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2403 _OrthancPluginGlobalProperty params;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2404 params.result = &result;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2405 params.property = property;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2406 params.value = defaultValue;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2407
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2408 if (context->InvokeService(context, _OrthancPluginService_GetGlobalProperty, &params) != OrthancPluginErrorCode_Success)
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2409 {
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2410 /* Error */
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2411 return NULL;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2412 }
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2413 else
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2414 {
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2415 return result;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2416 }
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2417 }
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2418
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2419
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2420 /**
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2421 * @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	2422 *
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2423 * 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	2424 * 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	2425 * 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	2426 * 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	2427 * 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	2428 *
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2429 * @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	2430 * @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	2431 * @param value The value to be set in the global property.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2432 * @return 0 if success, or the error code if failure.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2433 * @ingroup Orthanc
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2434 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2435 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginSetGlobalProperty(
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2436 OrthancPluginContext* context,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2437 int32_t property,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2438 const char* value)
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2439 {
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2440 _OrthancPluginGlobalProperty params;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2441 params.result = NULL;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2442 params.property = property;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2443 params.value = value;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2444
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2445 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, &params);
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2446 }
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2447
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2448
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2449
1280 d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2450 typedef struct
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2451 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2452 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	2453 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	2454 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	2455 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	2456 } _OrthancPluginReturnSingleValue;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2457
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2458 /**
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2459 * @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	2460 *
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2461 * 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	2462 *
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2463 * @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	2464 * @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	2465 **/
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2466 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	2467 OrthancPluginContext* context)
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2468 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2469 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	2470
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2471 _OrthancPluginReturnSingleValue params;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2472 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	2473 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	2474
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2475 if (context->InvokeService(context, _OrthancPluginService_GetCommandLineArgumentsCount, &params) != OrthancPluginErrorCode_Success)
1280 d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2476 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2477 /* Error */
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2478 return 0;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2479 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2480 else
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2481 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2482 return count;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2483 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2484 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2485
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2486
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2487
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2488 /**
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2489 * @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	2490 *
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2491 * 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	2492 * 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	2493 * 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	2494 *
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2495 * @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	2496 * @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	2497 * @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	2498 * 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	2499 **/
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2500 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	2501 OrthancPluginContext* context,
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2502 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	2503 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2504 char* result;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2505
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2506 _OrthancPluginGlobalProperty params;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2507 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	2508 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	2509 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	2510
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2511 if (context->InvokeService(context, _OrthancPluginService_GetCommandLineArgument, &params) != OrthancPluginErrorCode_Success)
1280 d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2512 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2513 /* Error */
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2514 return NULL;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2515 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2516 else
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2517 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2518 return result;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2519 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2520 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2521
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2522
1407 d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2523 /**
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2524 * @brief Get the expected version of the database schema.
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2525 *
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2526 * Retrieve the expected version of the database schema.
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2527 *
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2528 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2529 * @return The version.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2530 * @ingroup Callbacks
1615 c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	2531 * @deprecated Please instead use IDatabaseBackend::UpgradeDatabase()
1407 d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2532 **/
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2533 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetExpectedDatabaseVersion(
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2534 OrthancPluginContext* context)
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2535 {
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2536 uint32_t count = 0;
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2537
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2538 _OrthancPluginReturnSingleValue params;
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2539 memset(&params, 0, sizeof(params));
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2540 params.resultUint32 = &count;
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2541
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2542 if (context->InvokeService(context, _OrthancPluginService_GetExpectedDatabaseVersion, &params) != OrthancPluginErrorCode_Success)
1407 d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2543 {
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2544 /* Error */
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2545 return 0;
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2546 }
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2547 else
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2548 {
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2549 return count;
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2550 }
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2551 }
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2552
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2553
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2554
1424 fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2555 /**
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2556 * @brief Return the content of the configuration file(s).
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2557 *
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2558 * This function returns the content of the configuration that is
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2559 * used by Orthanc, formatted as a JSON string.
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2560 *
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2561 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2562 * @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	2563 * containing the configuration. This string must be freed by
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2564 * OrthancPluginFreeString().
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2565 **/
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2566 ORTHANC_PLUGIN_INLINE char OrthancPluginGetConfiguration(OrthancPluginContext context)
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2567 {
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2568 char* result;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2569
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2570 _OrthancPluginRetrieveDynamicString params;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2571 params.result = &result;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2572 params.argument = NULL;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2573
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2574 if (context->InvokeService(context, _OrthancPluginService_GetConfiguration, &params) != OrthancPluginErrorCode_Success)
1424 fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2575 {
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2576 /* Error */
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2577 return NULL;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2578 }
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2579 else
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2580 {
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2581 return result;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2582 }
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2583 }
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2584
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2585
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2586
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2587 typedef struct
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2588 {
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2589 OrthancPluginRestOutput* output;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2590 const char* subType;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2591 const char* contentType;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2592 } _OrthancPluginStartMultipartAnswer;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2593
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2594 /**
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2595 * @brief Start an HTTP multipart answer.
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2596 *
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2597 * 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	2598 *
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2599 * @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	2600 * @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	2601 * @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	2602 * @param contentType The MIME type of the items in the multipart answer.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2603 * @return 0 if success, or the error code if failure.
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2604 * @see OrthancPluginSendMultipartItem()
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2605 * @ingroup REST
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2606 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2607 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2608 OrthancPluginContext* context,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2609 OrthancPluginRestOutput* output,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2610 const char* subType,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2611 const char* contentType)
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2612 {
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2613 _OrthancPluginStartMultipartAnswer params;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2614 params.output = output;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2615 params.subType = subType;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2616 params.contentType = contentType;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2617 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	2618 }
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2619
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2620
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2621 /**
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2622 * @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	2623 *
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2624 * 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	2625 * answer that was initiated by OrthancPluginStartMultipartAnswer().
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2626 *
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2627 * @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	2628 * @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	2629 * @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	2630 * @param answerSize Number of bytes of the item.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2631 * @return 0 if success, or the error code if failure (this notably happens
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2632 * if the connection is closed by the client).
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2633 * @ingroup REST
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2634 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2635 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginSendMultipartItem(
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2636 OrthancPluginContext* context,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2637 OrthancPluginRestOutput* output,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2638 const char* answer,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2639 uint32_t answerSize)
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2640 {
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2641 _OrthancPluginAnswerBuffer params;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2642 params.output = output;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2643 params.answer = answer;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2644 params.answerSize = answerSize;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2645 params.mimeType = NULL;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2646 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	2647 }
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2648
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2649
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2650
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2651 typedef struct
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2652 {
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2653 OrthancPluginMemoryBuffer* target;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2654 const void* source;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2655 uint32_t size;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2656 OrthancPluginCompressionType compression;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2657 uint8_t uncompress;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2658 } _OrthancPluginBufferCompression;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2659
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2660
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2661 /**
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2662 * @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	2663 *
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2664 * 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	2665 * 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	2666 *
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2667 * @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	2668 * @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	2669 * @param source The source buffer.
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2670 * @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	2671 * @param compression The compression algorithm.
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2672 * @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	2673 * If set to "1", the buffer must be uncompressed.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2674 * @return 0 if success, or the error code if failure.
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	2675 * @ingroup Images
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2676 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2677 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginBufferCompression(
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2678 OrthancPluginContext* context,
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2679 OrthancPluginMemoryBuffer* target,
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2680 const void* source,
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2681 uint32_t size,
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2682 OrthancPluginCompressionType compression,
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2683 uint8_t uncompress)
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2684 {
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2685 _OrthancPluginBufferCompression params;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2686 params.target = target;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2687 params.source = source;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2688 params.size = size;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2689 params.compression = compression;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2690 params.uncompress = uncompress;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2691
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2692 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	2693 }
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2694
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2695
1588 b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2696
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2697 typedef struct
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2698 {
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2699 OrthancPluginMemoryBuffer* target;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2700 const char* path;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2701 } _OrthancPluginReadFile;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2702
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2703 /**
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2704 * @brief Read a file.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2705 *
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2706 * Read the content of a file on the filesystem, and returns it into
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2707 * a newly allocated memory buffer.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2708 *
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2709 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2710 * @param target The target memory buffer.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2711 * @param path The path of the file to be read.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2712 * @return 0 if success, or the error code if failure.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2713 **/
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2714 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginReadFile(
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2715 OrthancPluginContext* context,
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2716 OrthancPluginMemoryBuffer* target,
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2717 const char* path)
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2718 {
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2719 _OrthancPluginReadFile params;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2720 params.target = target;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2721 params.path = path;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2722 return context->InvokeService(context, _OrthancPluginService_ReadFile, &params);
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2723 }
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2724
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2725
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2726
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2727 typedef struct
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2728 {
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2729 const char* path;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2730 const void* data;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2731 uint32_t size;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2732 } _OrthancPluginWriteFile;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2733
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2734 /**
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2735 * @brief Write a file.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2736 *
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2737 * Write the content of a memory buffer to the filesystem.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2738 *
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2739 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2740 * @param path The path of the file to be written.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2741 * @param data The content of the memory buffer.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2742 * @param size The size of the memory buffer.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2743 * @return 0 if success, or the error code if failure.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2744 **/
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2745 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginWriteFile(
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2746 OrthancPluginContext* context,
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2747 const char* path,
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2748 const void* data,
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2749 uint32_t size)
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2750 {
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2751 _OrthancPluginWriteFile params;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2752 params.path = path;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2753 params.data = data;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2754 params.size = size;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2755 return context->InvokeService(context, _OrthancPluginService_WriteFile, &params);
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2756 }
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2757
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2758
1593 235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2759
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2760 typedef struct
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2761 {
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2762 const char** target;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2763 OrthancPluginErrorCode error;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2764 } _OrthancPluginGetErrorDescription;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2765
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2766 /**
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2767 * @brief Get the description of a given error code.
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2768 *
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2769 * This function returns the description of a given error code.
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2770 *
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2771 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	2772 * @param error The error code of interest.
1593 235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2773 * @return The error description. This is a statically-allocated
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2774 * string, do not free it.
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2775 **/
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2776 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetErrorDescription(
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2777 OrthancPluginContext* context,
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2778 OrthancPluginErrorCode error)
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2779 {
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2780 const char* result = NULL;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2781
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2782 _OrthancPluginGetErrorDescription params;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2783 params.target = &result;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2784 params.error = error;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2785
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2786 if (context->InvokeService(context, _OrthancPluginService_GetErrorDescription, &params) != OrthancPluginErrorCode_Success \|\|
1593 235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2787 result == NULL)
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2788 {
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2789 return "Unknown error code";
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2790 }
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2791 else
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2792 {
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2793 return result;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2794 }
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2795 }
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2796
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2797
1594 2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2798
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2799 typedef struct
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2800 {
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2801 OrthancPluginRestOutput* output;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2802 uint16_t status;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2803 const char* body;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2804 uint32_t bodySize;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2805 } _OrthancPluginSendHttpStatus;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2806
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2807 /**
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2808 * @brief Send a HTTP status, with a custom body.
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2809 *
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2810 * This function answers to a HTTP request by sending a HTTP status
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2811 * code (such as "400 - Bad Request"), together with a body
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2812 * describing the error. The body will only be returned if the
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2813 * configuration option "HttpDescribeErrors" of Orthanc is set to "true".
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2814 *
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2815 * Note that:
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2816 * - Successful requests (status 200) must use ::OrthancPluginAnswerBuffer().
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2817 * - Redirections (status 301) must use ::OrthancPluginRedirect().
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2818 * - Unauthorized access (status 401) must use ::OrthancPluginSendUnauthorized().
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2819 * - Methods not allowed (status 405) must use ::OrthancPluginSendMethodNotAllowed().
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2820 *
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2821 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2822 * @param output The HTTP connection to the client application.
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2823 * @param status The HTTP status code to be sent.
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	2824 * @param body The body of the answer.
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	2825 * @param bodySize The size of the body.
1594 2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2826 * @see OrthancPluginSendHttpStatusCode()
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2827 * @ingroup REST
1594 2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2828 **/
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2829 ORTHANC_PLUGIN_INLINE void OrthancPluginSendHttpStatus(
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2830 OrthancPluginContext* context,
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2831 OrthancPluginRestOutput* output,
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2832 uint16_t status,
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2833 const char* body,
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2834 uint32_t bodySize)
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2835 {
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2836 _OrthancPluginSendHttpStatus params;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2837 params.output = output;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2838 params.status = status;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2839 params.body = body;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2840 params.bodySize = bodySize;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2841 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, &params);
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2842 }
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2843
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2844
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2845
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2846 typedef struct
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2847 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2848 const OrthancPluginImage* image;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2849 uint32_t* resultUint32;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2850 OrthancPluginPixelFormat* resultPixelFormat;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2851 const void** resultBuffer;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2852 } _OrthancPluginGetImageInfo;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2853
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2854
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2855 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2856 * @brief Return the pixel format of an image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2857 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2858 * This function returns the type of memory layout for the pixels of the given image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2859 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2860 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2861 * @param image The image of interest.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2862 * @return The pixel format.
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	2863 * @ingroup Images
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2864 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2865 ORTHANC_PLUGIN_INLINE OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2866 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2867 const OrthancPluginImage* image)
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2868 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2869 OrthancPluginPixelFormat target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2870
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2871 _OrthancPluginGetImageInfo params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2872 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2873 params.image = image;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2874 params.resultPixelFormat = &target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2875
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2876 if (context->InvokeService(context, _OrthancPluginService_GetImagePixelFormat, &params) != OrthancPluginErrorCode_Success)
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2877 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2878 return OrthancPluginPixelFormat_Unknown;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2879 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2880 else
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2881 {
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2882 return (OrthancPluginPixelFormat) target;
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2883 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2884 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2885
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2886
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2887
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2888 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2889 * @brief Return the width of an image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2890 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2891 * This function returns the width of the given image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2892 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2893 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2894 * @param image The image of interest.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2895 * @return The width.
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	2896 * @ingroup Images
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2897 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2898 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetImageWidth(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2899 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2900 const OrthancPluginImage* image)
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2901 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2902 uint32_t width;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2903
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2904 _OrthancPluginGetImageInfo params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2905 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2906 params.image = image;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2907 params.resultUint32 = &width;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2908
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2909 if (context->InvokeService(context, _OrthancPluginService_GetImageWidth, &params) != OrthancPluginErrorCode_Success)
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2910 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2911 return 0;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2912 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2913 else
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2914 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2915 return width;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2916 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2917 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2918
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2919
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2920
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2921 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2922 * @brief Return the height of an image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2923 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2924 * This function returns the height of the given image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2925 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2926 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2927 * @param image The image of interest.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2928 * @return The height.
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	2929 * @ingroup Images
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2930 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2931 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetImageHeight(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2932 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2933 const OrthancPluginImage* image)
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2934 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2935 uint32_t height;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2936
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2937 _OrthancPluginGetImageInfo params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2938 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2939 params.image = image;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2940 params.resultUint32 = &height;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2941
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2942 if (context->InvokeService(context, _OrthancPluginService_GetImageHeight, &params) != OrthancPluginErrorCode_Success)
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2943 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2944 return 0;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2945 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2946 else
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2947 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2948 return height;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2949 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2950 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2951
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2952
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2953
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2954 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2955 * @brief Return the pitch of an image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2956 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2957 * This function returns the pitch of the given image. The pitch is
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2958 * defined as the number of bytes between 2 successive lines of the
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2959 * image in the memory buffer.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2960 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2961 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2962 * @param image The image of interest.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2963 * @return The pitch.
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	2964 * @ingroup Images
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2965 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2966 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetImagePitch(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2967 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2968 const OrthancPluginImage* image)
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2969 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2970 uint32_t pitch;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2971
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2972 _OrthancPluginGetImageInfo params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2973 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2974 params.image = image;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2975 params.resultUint32 = &pitch;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2976
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2977 if (context->InvokeService(context, _OrthancPluginService_GetImagePitch, &params) != OrthancPluginErrorCode_Success)
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2978 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2979 return 0;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2980 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2981 else
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2982 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2983 return pitch;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2984 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2985 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2986
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2987
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2988
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2989 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2990 * @brief Return a pointer to the content of an image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2991 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2992 * This function returns a pointer to the memory buffer that
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2993 * contains the pixels of the image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2994 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2995 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2996 * @param image The image of interest.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2997 * @return The pointer.
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	2998 * @ingroup Images
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2999 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3000 ORTHANC_PLUGIN_INLINE const void* OrthancPluginGetImageBuffer(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3001 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3002 const OrthancPluginImage* image)
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3003 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3004 const void* target = NULL;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3005
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3006 _OrthancPluginGetImageInfo params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3007 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3008 params.resultBuffer = &target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3009 params.image = image;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3010
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	3011 if (context->InvokeService(context, _OrthancPluginService_GetImageBuffer, &params) != OrthancPluginErrorCode_Success)
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3012 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3013 return NULL;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3014 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3015 else
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3016 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3017 return target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3018 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3019 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3020
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3021
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3022 typedef struct
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3023 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3024 OrthancPluginImage** target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3025 const void* data;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3026 uint32_t size;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3027 OrthancPluginImageFormat format;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3028 } _OrthancPluginUncompressImage;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3029
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3030
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3031 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3032 * @brief Decode a compressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3033 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3034 * This function decodes a compressed image from a memory buffer.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3035 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3036 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3037 * @param data Pointer to a memory buffer containing the compressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3038 * @param size Size of the memory buffer containing the compressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3039 * @param format The file format of the compressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3040 * @return The uncompressed image. It must be freed with OrthancPluginFreeImage().
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3041 * @ingroup Images
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3042 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3043 ORTHANC_PLUGIN_INLINE OrthancPluginImage *OrthancPluginUncompressImage(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3044 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3045 const void* data,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3046 uint32_t size,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3047 OrthancPluginImageFormat format)
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3048 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3049 OrthancPluginImage* target = NULL;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3050
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3051 _OrthancPluginUncompressImage params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3052 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3053 params.target = &target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3054 params.data = data;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3055 params.size = size;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3056 params.format = format;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3057
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	3058 if (context->InvokeService(context, _OrthancPluginService_UncompressImage, &params) != OrthancPluginErrorCode_Success)
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3059 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3060 return NULL;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3061 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3062 else
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3063 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3064 return target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3065 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3066 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3067
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3068
1605 fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	3069
fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	3070
fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	3071 typedef struct
fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	3072 {
fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	3073 OrthancPluginImage* image;
fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	3074 } _OrthancPluginFreeImage;
fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	3075
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3076 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3077 * @brief Free an image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3078 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3079 * This function frees an image that was decoded with OrthancPluginUncompressImage().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3080 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3081 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3082 * @param image The image.
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3083 * @ingroup Images
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3084 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3085 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeImage(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3086 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3087 OrthancPluginImage* image)
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3088 {
1605 fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	3089 _OrthancPluginFreeImage params;
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3090 params.image = image;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3091
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3092 context->InvokeService(context, _OrthancPluginService_FreeImage, &params);
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3093 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3094
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3095
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3096
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3097
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3098 typedef struct
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3099 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3100 OrthancPluginMemoryBuffer* target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3101 OrthancPluginImageFormat imageFormat;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3102 OrthancPluginPixelFormat pixelFormat;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3103 uint32_t width;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3104 uint32_t height;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3105 uint32_t pitch;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3106 const void* buffer;
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	3107 uint8_t quality;
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3108 } _OrthancPluginCompressImage;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3109
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3110
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3111 /**
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	3112 * @brief Encode a PNG image.
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3113 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3114 * This function compresses the given memory buffer containing an
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3115 * image using the PNG specification, and stores the result of the
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3116 * compression into a newly allocated memory buffer.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3117 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3118 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3119 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3120 * @param format The memory layout of the uncompressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3121 * @param width The width of the image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3122 * @param height The height of the image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3123 * @param pitch The pitch of the image (i.e. the number of bytes
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3124 * between 2 successive lines of the image in the memory buffer).
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3125 * @param buffer The memory buffer containing the uncompressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3126 * @return 0 if success, or the error code if failure.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3127 * @see OrthancPluginCompressAndAnswerPngImage()
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3128 * @ingroup Images
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3129 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3130 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCompressPngImage(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3131 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3132 OrthancPluginMemoryBuffer* target,
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3133 OrthancPluginPixelFormat format,
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3134 uint32_t width,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3135 uint32_t height,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3136 uint32_t pitch,
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	3137 const void* buffer)
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3138 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3139 _OrthancPluginCompressImage params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3140 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3141 params.target = target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3142 params.imageFormat = OrthancPluginImageFormat_Png;
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3143 params.pixelFormat = format;
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3144 params.width = width;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3145 params.height = height;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3146 params.pitch = pitch;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3147 params.buffer = buffer;
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3148 params.quality = 0; /* Unused for PNG */
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3149
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3150 return context->InvokeService(context, _OrthancPluginService_CompressImage, &params);
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3151 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3152
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3153
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3154 /**
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	3155 * @brief Encode a JPEG image.
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3156 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3157 * This function compresses the given memory buffer containing an
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3158 * image using the JPEG specification, and stores the result of the
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3159 * compression into a newly allocated memory buffer.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3160 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3161 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3162 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3163 * @param format The memory layout of the uncompressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3164 * @param width The width of the image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3165 * @param height The height of the image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3166 * @param pitch The pitch of the image (i.e. the number of bytes
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3167 * between 2 successive lines of the image in the memory buffer).
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3168 * @param buffer The memory buffer containing the uncompressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3169 * @param quality The quality of the JPEG encoding, between 1 (worst
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3170 * quality, best compression) and 100 (best quality, worst
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3171 * compression).
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3172 * @return 0 if success, or the error code if failure.
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3173 * @ingroup Images
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3174 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3175 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCompressJpegImage(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3176 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3177 OrthancPluginMemoryBuffer* target,
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3178 OrthancPluginPixelFormat format,
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3179 uint32_t width,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3180 uint32_t height,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3181 uint32_t pitch,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3182 const void* buffer,
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3183 uint8_t quality)
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3184 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3185 _OrthancPluginCompressImage params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3186 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3187 params.target = target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3188 params.imageFormat = OrthancPluginImageFormat_Jpeg;
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3189 params.pixelFormat = format;
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3190 params.width = width;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3191 params.height = height;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3192 params.pitch = pitch;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3193 params.buffer = buffer;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3194 params.quality = quality;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3195
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3196 return context->InvokeService(context, _OrthancPluginService_CompressImage, &params);
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3197 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3198
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3199
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3200
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3201 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3202 * @brief Answer to a REST request with a JPEG image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3203 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3204 * This function answers to a REST request with a JPEG image. The
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3205 * parameters of this function describe a memory buffer that
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3206 * contains an uncompressed image. The image will be automatically compressed
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3207 * as a JPEG image by the core system of Orthanc.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3208 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3209 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3210 * @param output The HTTP connection to the client application.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3211 * @param format The memory layout of the uncompressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3212 * @param width The width of the image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3213 * @param height The height of the image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3214 * @param pitch The pitch of the image (i.e. the number of bytes
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3215 * between 2 successive lines of the image in the memory buffer).
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3216 * @param buffer The memory buffer containing the uncompressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3217 * @param quality The quality of the JPEG encoding, between 1 (worst
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3218 * quality, best compression) and 100 (best quality, worst
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3219 * compression).
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	3220 * @ingroup REST
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3221 **/
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3222 ORTHANC_PLUGIN_INLINE void OrthancPluginCompressAndAnswerJpegImage(
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3223 OrthancPluginContext* context,
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3224 OrthancPluginRestOutput* output,
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3225 OrthancPluginPixelFormat format,
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3226 uint32_t width,
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3227 uint32_t height,
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3228 uint32_t pitch,
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3229 const void* buffer,
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3230 uint8_t quality)
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3231 {
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3232 _OrthancPluginCompressAndAnswerImage params;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3233 params.output = output;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3234 params.imageFormat = OrthancPluginImageFormat_Jpeg;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3235 params.pixelFormat = format;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3236 params.width = width;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3237 params.height = height;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3238 params.pitch = pitch;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3239 params.buffer = buffer;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3240 params.quality = quality;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3241 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, &params);
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3242 }
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3243
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3244
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3245
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3246
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3247 typedef struct
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3248 {
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3249 OrthancPluginMemoryBuffer* target;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3250 OrthancPluginHttpMethod method;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3251 const char* url;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3252 const char* username;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3253 const char* password;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3254 const char* body;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3255 uint32_t bodySize;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3256 } _OrthancPluginCallHttpClient;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3257
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3258
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3259 /**
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3260 * @brief Issue a HTTP GET call.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3261 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3262 * Make a HTTP GET call to the given URL. The result to the query is
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3263 * stored into a newly allocated memory buffer. Favor
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3264 * OrthancPluginRestApiGet() if calling the built-in REST API of the
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3265 * Orthanc instance that hosts this plugin.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3266 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3267 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3268 * @param target The target memory buffer.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3269 * @param url The URL of interest.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3270 * @param username The username (can be <tt>NULL</tt> if no password protection).
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3271 * @param password The password (can be <tt>NULL</tt> if no password protection).
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3272 * @return 0 if success, or the error code if failure.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3273 **/
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3274 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpGet(
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3275 OrthancPluginContext* context,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3276 OrthancPluginMemoryBuffer* target,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3277 const char* url,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3278 const char* username,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3279 const char* password)
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3280 {
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3281 _OrthancPluginCallHttpClient params;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3282 memset(&params, 0, sizeof(params));
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3283
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3284 params.target = target;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3285 params.method = OrthancPluginHttpMethod_Get;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3286 params.url = url;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3287 params.username = username;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3288 params.password = password;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3289
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3290 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, &params);
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3291 }
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3292
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3293
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3294 /**
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3295 * @brief Issue a HTTP POST call.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3296 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3297 * Make a HTTP POST call to the given URL. The result to the query
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3298 * is stored into a newly allocated memory buffer. Favor
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3299 * OrthancPluginRestApiPost() if calling the built-in REST API of
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3300 * the Orthanc instance that hosts this plugin.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3301 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3302 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3303 * @param target The target memory buffer.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3304 * @param url The URL of interest.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3305 * @param body The content of the body of the request.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3306 * @param bodySize The size of the body of the request.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3307 * @param username The username (can be <tt>NULL</tt> if no password protection).
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3308 * @param password The password (can be <tt>NULL</tt> if no password protection).
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3309 * @return 0 if success, or the error code if failure.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3310 **/
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3311 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpPost(
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3312 OrthancPluginContext* context,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3313 OrthancPluginMemoryBuffer* target,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3314 const char* url,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3315 const char* body,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3316 uint32_t bodySize,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3317 const char* username,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3318 const char* password)
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3319 {
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3320 _OrthancPluginCallHttpClient params;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3321 memset(&params, 0, sizeof(params));
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3322
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3323 params.target = target;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3324 params.method = OrthancPluginHttpMethod_Post;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3325 params.url = url;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3326 params.body = body;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3327 params.bodySize = bodySize;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3328 params.username = username;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3329 params.password = password;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3330
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3331 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, &params);
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3332 }
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3333
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3334
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3335 /**
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3336 * @brief Issue a HTTP PUT call.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3337 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3338 * Make a HTTP PUT call to the given URL. The result to the query is
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3339 * stored into a newly allocated memory buffer. Favor
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3340 * OrthancPluginRestApiPut() if calling the built-in REST API of the
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3341 * Orthanc instance that hosts this plugin.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3342 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3343 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3344 * @param target The target memory buffer.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3345 * @param url The URL of interest.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3346 * @param body The content of the body of the request.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3347 * @param bodySize The size of the body of the request.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3348 * @param username The username (can be <tt>NULL</tt> if no password protection).
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3349 * @param password The password (can be <tt>NULL</tt> if no password protection).
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3350 * @return 0 if success, or the error code if failure.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3351 **/
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3352 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpPut(
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3353 OrthancPluginContext* context,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3354 OrthancPluginMemoryBuffer* target,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3355 const char* url,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3356 const char* body,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3357 uint32_t bodySize,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3358 const char* username,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3359 const char* password)
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3360 {
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3361 _OrthancPluginCallHttpClient params;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3362 memset(&params, 0, sizeof(params));
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3363
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3364 params.target = target;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3365 params.method = OrthancPluginHttpMethod_Put;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3366 params.url = url;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3367 params.body = body;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3368 params.bodySize = bodySize;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3369 params.username = username;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3370 params.password = password;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3371
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3372 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, &params);
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3373 }
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3374
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3375
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3376 /**
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3377 * @brief Issue a HTTP DELETE call.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3378 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3379 * Make a HTTP DELETE call to the given URL. Favor
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3380 * OrthancPluginRestApiDelete() if calling the built-in REST API of
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3381 * the Orthanc instance that hosts this plugin.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3382 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3383 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3384 * @param url The URL of interest.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3385 * @param username The username (can be <tt>NULL</tt> if no password protection).
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3386 * @param password The password (can be <tt>NULL</tt> if no password protection).
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3387 * @return 0 if success, or the error code if failure.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3388 **/
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3389 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpDelete(
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3390 OrthancPluginContext* context,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3391 const char* url,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3392 const char* username,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3393 const char* password)
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3394 {
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3395 _OrthancPluginCallHttpClient params;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3396 memset(&params, 0, sizeof(params));
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3397
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3398 params.method = OrthancPluginHttpMethod_Delete;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3399 params.url = url;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3400 params.username = username;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3401 params.password = password;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3402
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3403 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, &params);
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3404 }
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3405
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3406
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3407
1608 adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3408 typedef struct
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3409 {
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3410 OrthancPluginImage** target;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3411 const OrthancPluginImage* source;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3412 OrthancPluginPixelFormat targetFormat;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3413 } _OrthancPluginConvertPixelFormat;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3414
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3415
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3416 /**
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3417 * @brief Change the pixel format of an image.
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3418 *
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3419 * This function creates a new image, changing the memory layout of the pixels.
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3420 *
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3421 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3422 * @param source The source image.
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3423 * @param targetFormat The target pixel format.
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3424 * @return The resulting image. It must be freed with OrthancPluginFreeImage().
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3425 * @ingroup Images
1608 adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3426 **/
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3427 ORTHANC_PLUGIN_INLINE OrthancPluginImage *OrthancPluginConvertPixelFormat(
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3428 OrthancPluginContext* context,
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3429 const OrthancPluginImage* source,
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3430 OrthancPluginPixelFormat targetFormat)
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3431 {
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3432 OrthancPluginImage* target = NULL;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3433
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3434 _OrthancPluginConvertPixelFormat params;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3435 params.target = &target;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3436 params.source = source;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3437 params.targetFormat = targetFormat;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3438
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3439 if (context->InvokeService(context, _OrthancPluginService_ConvertPixelFormat, &params) != OrthancPluginErrorCode_Success)
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3440 {
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3441 return NULL;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3442 }
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3443 else
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3444 {
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3445 return target;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3446 }
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3447 }
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3448
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3449
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3450
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3451 /**
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3452 * @brief Return the number of available fonts.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3453 *
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3454 * This function returns the number of fonts that are built in the
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3455 * Orthanc core. These fonts can be used to draw texts on images
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3456 * through OrthancPluginDrawText().
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3457 *
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3458 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3459 * @return The number of fonts.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3460 * @ingroup Images
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3461 **/
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3462 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetFontsCount(
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3463 OrthancPluginContext* context)
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3464 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3465 uint32_t count = 0;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3466
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3467 _OrthancPluginReturnSingleValue params;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3468 memset(&params, 0, sizeof(params));
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3469 params.resultUint32 = &count;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3470
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3471 if (context->InvokeService(context, _OrthancPluginService_GetFontsCount, &params) != OrthancPluginErrorCode_Success)
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3472 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3473 /* Error */
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3474 return 0;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3475 }
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3476 else
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3477 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3478 return count;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3479 }
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3480 }
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3481
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3482
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3483
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3484
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3485 typedef struct
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3486 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3487 uint32_t fontIndex; /* in */
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3488 const char** name; /* out */
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3489 uint32_t* size; /* out */
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3490 } _OrthancPluginGetFontInfo;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3491
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3492 /**
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3493 * @brief Return the name of a font.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3494 *
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3495 * This function returns the name of a font that is built in the Orthanc core.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3496 *
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3497 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3498 * @param fontIndex The index of the font. This value must be less than OrthancPluginGetFontsCount().
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3499 * @return The font name. This is a statically-allocated string, do not free it.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3500 * @ingroup Images
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3501 **/
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3502 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetFontName(
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3503 OrthancPluginContext* context,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3504 uint32_t fontIndex)
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3505 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3506 const char* result = NULL;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3507
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3508 _OrthancPluginGetFontInfo params;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3509 memset(&params, 0, sizeof(params));
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3510 params.name = &result;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3511 params.fontIndex = fontIndex;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3512
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3513 if (context->InvokeService(context, _OrthancPluginService_GetFontInfo, &params) != OrthancPluginErrorCode_Success)
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3514 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3515 return NULL;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3516 }
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3517 else
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3518 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3519 return result;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3520 }
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3521 }
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3522
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3523
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3524 /**
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3525 * @brief Return the size of a font.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3526 *
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3527 * This function returns the size of a font that is built in the Orthanc core.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3528 *
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3529 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3530 * @param fontIndex The index of the font. This value must be less than OrthancPluginGetFontsCount().
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3531 * @return The font size.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3532 * @ingroup Images
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3533 **/
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3534 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetFontSize(
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3535 OrthancPluginContext* context,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3536 uint32_t fontIndex)
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3537 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3538 uint32_t result;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3539
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3540 _OrthancPluginGetFontInfo params;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3541 memset(&params, 0, sizeof(params));
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3542 params.size = &result;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3543 params.fontIndex = fontIndex;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3544
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3545 if (context->InvokeService(context, _OrthancPluginService_GetFontInfo, &params) != OrthancPluginErrorCode_Success)
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3546 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3547 return 0;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3548 }
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3549 else
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3550 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3551 return result;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3552 }
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3553 }
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3554
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3555
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3556
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3557 typedef struct
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3558 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3559 OrthancPluginImage* image;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3560 uint32_t fontIndex;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3561 const char* utf8Text;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3562 int32_t x;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3563 int32_t y;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3564 uint8_t r;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3565 uint8_t g;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3566 uint8_t b;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3567 } _OrthancPluginDrawText;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3568
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3569
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3570 /**
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3571 * @brief Draw text on an image.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3572 *
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3573 * This function draws some text on some image.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3574 *
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3575 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3576 * @param image The image upon which to draw the text.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3577 * @param fontIndex The index of the font. This value must be less than OrthancPluginGetFontsCount().
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3578 * @param utf8Text The text to be drawn, encoded as an UTF-8 zero-terminated string.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3579 * @param x The X position of the text over the image.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3580 * @param y The Y position of the text over the image.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3581 * @param r The value of the red color channel of the text.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3582 * @param g The value of the green color channel of the text.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3583 * @param b The value of the blue color channel of the text.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3584 * @return 0 if success, other value if error.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3585 * @ingroup Images
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3586 **/
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3587 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginDrawText(
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3588 OrthancPluginContext* context,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3589 OrthancPluginImage* image,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3590 uint32_t fontIndex,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3591 const char* utf8Text,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3592 int32_t x,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3593 int32_t y,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3594 uint8_t r,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3595 uint8_t g,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3596 uint8_t b)
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3597 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3598 _OrthancPluginDrawText params;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3599 memset(&params, 0, sizeof(params));
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3600 params.image = image;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3601 params.fontIndex = fontIndex;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3602 params.utf8Text = utf8Text;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3603 params.x = x;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3604 params.y = y;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3605 params.r = r;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3606 params.g = g;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3607 params.b = b;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3608
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3609 return context->InvokeService(context, _OrthancPluginService_DrawText, &params);
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3610 }
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3611
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3612
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3613
1615 c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3614 typedef struct
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3615 {
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3616 OrthancPluginStorageArea* storageArea;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3617 const char* uuid;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3618 const void* content;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3619 uint64_t size;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3620 OrthancPluginContentType type;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3621 } _OrthancPluginStorageAreaCreate;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3622
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3623
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3624 /**
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3625 * @brief Create a file inside the storage area.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3626 *
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3627 * This function creates a new file inside the storage area that is
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3628 * currently used by Orthanc.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3629 *
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3630 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3631 * @param storageArea The storage area.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3632 * @param uuid The identifier of the file to be created.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3633 * @param content The content to store in the newly created file.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3634 * @param size The size of the content.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3635 * @param type The type of the file content.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3636 * @return 0 if success, other value if error.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3637 * @ingroup Callbacks
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3638 **/
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3639 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStorageAreaCreate(
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3640 OrthancPluginContext* context,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3641 OrthancPluginStorageArea* storageArea,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3642 const char* uuid,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3643 const void* content,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3644 uint64_t size,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3645 OrthancPluginContentType type)
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3646 {
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3647 _OrthancPluginStorageAreaCreate params;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3648 params.storageArea = storageArea;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3649 params.uuid = uuid;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3650 params.content = content;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3651 params.size = size;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3652 params.type = type;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3653
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3654 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, &params);
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3655 }
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3656
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3657
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3658 typedef struct
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3659 {
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3660 OrthancPluginMemoryBuffer* target;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3661 OrthancPluginStorageArea* storageArea;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3662 const char* uuid;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3663 OrthancPluginContentType type;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3664 } _OrthancPluginStorageAreaRead;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3665
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3666
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3667 /**
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3668 * @brief Read a file from the storage area.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3669 *
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3670 * This function reads the content of a given file from the storage
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3671 * area that is currently used by Orthanc.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3672 *
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3673 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3674 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer().
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3675 * @param storageArea The storage area.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3676 * @param uuid The identifier of the file to be read.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3677 * @param type The type of the file content.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3678 * @return 0 if success, other value if error.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3679 * @ingroup Callbacks
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3680 **/
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3681 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStorageAreaRead(
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3682 OrthancPluginContext* context,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3683 OrthancPluginMemoryBuffer* target,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3684 OrthancPluginStorageArea* storageArea,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3685 const char* uuid,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3686 OrthancPluginContentType type)
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3687 {
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3688 _OrthancPluginStorageAreaRead params;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3689 params.target = target;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3690 params.storageArea = storageArea;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3691 params.uuid = uuid;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3692 params.type = type;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3693
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3694 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, &params);
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3695 }
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3696
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3697
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3698 typedef struct
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3699 {
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3700 OrthancPluginStorageArea* storageArea;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3701 const char* uuid;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3702 OrthancPluginContentType type;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3703 } _OrthancPluginStorageAreaRemove;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3704
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3705 /**
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3706 * @brief Remove a file from the storage area.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3707 *
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3708 * This function removes a given file from the storage area that is
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3709 * currently used by Orthanc.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3710 *
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3711 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3712 * @param storageArea The storage area.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3713 * @param uuid The identifier of the file to be removed.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3714 * @param type The type of the file content.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3715 * @return 0 if success, other value if error.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3716 * @ingroup Callbacks
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3717 **/
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3718 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStorageAreaRemove(
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3719 OrthancPluginContext* context,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3720 OrthancPluginStorageArea* storageArea,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3721 const char* uuid,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3722 OrthancPluginContentType type)
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3723 {
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3724 _OrthancPluginStorageAreaRemove params;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3725 params.storageArea = storageArea;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3726 params.uuid = uuid;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3727 params.type = type;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3728
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3729 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, &params);
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3730 }
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3731
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3732
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3733
1649 8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3734 typedef struct
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3735 {
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3736 OrthancPluginErrorCode* target;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3737 int32_t code;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3738 uint16_t httpStatus;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3739 const char* message;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3740 } _OrthancPluginRegisterErrorCode;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3741
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3742 /**
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3743 * @brief Declare a custom error code for this plugin.
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3744 *
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3745 * This function declares a custom error code that can be generated
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3746 * by this plugin. This declaration is used to enrich the body of
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3747 * the HTTP answer in the case of an error, and to set the proper
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3748 * HTTP status code.
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3749 *
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3750 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3751 * @param code The error code that is internal to this plugin.
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3752 * @param httpStatus The HTTP status corresponding to this error.
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3753 * @param message The description of the error.
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3754 * @return The error code that has been assigned inside the Orthanc core.
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3755 * @ingroup Toolbox
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3756 **/
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3757 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterErrorCode(
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3758 OrthancPluginContext* context,
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3759 int32_t code,
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3760 uint16_t httpStatus,
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3761 const char* message)
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3762 {
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3763 OrthancPluginErrorCode target;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3764
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3765 _OrthancPluginRegisterErrorCode params;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3766 params.target = &target;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3767 params.code = code;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3768 params.httpStatus = httpStatus;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3769 params.message = message;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3770
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3771 if (context->InvokeService(context, _OrthancPluginService_RegisterErrorCode, &params) == OrthancPluginErrorCode_Success)
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3772 {
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3773 return target;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3774 }
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3775 else
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3776 {
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3777 /* There was an error while assigned the error. Use a generic code. */
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3778 return OrthancPluginErrorCode_Plugin;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3779 }
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3780 }
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3781
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3782
1657 5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3783
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3784 typedef struct
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3785 {
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3786 uint16_t group;
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3787 uint16_t element;
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3788 OrthancPluginValueRepresentation vr;
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3789 const char* name;
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3790 uint32_t minMultiplicity;
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3791 uint32_t maxMultiplicity;
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3792 } _OrthancPluginRegisterDictionaryTag;
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3793
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3794 /**
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3795 * @brief Register a new tag into the DICOM dictionary.
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3796 *
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3797 * This function declares a new tag in the dictionary of DICOM tags
1765 57b9e6890482 New configuration option: "Dictionary" to declare custom DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1760 diff changeset	3798 * that are known to Orthanc. This function should be used in the
1657 5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3799 * OrthancPluginInitialize() callback.
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3800 *
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3801 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3802 * @param group The group of the tag.
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3803 * @param element The element of the tag.
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3804 * @param vr The value representation of the tag.
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3805 * @param name The nickname of the tag.
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3806 * @param minMultiplicity The minimum multiplicity of the tag (must be above 0).
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3807 * @param maxMultiplicity The maximum multiplicity of the tag. A value of 0 means
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3808 * an arbitrary multiplicity ("<tt>n</tt>").
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3809 * @return 0 if success, other value if error.
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3810 * @ingroup Toolbox
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3811 **/
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3812 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterDictionaryTag(
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3813 OrthancPluginContext* context,
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3814 uint16_t group,
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3815 uint16_t element,
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3816 OrthancPluginValueRepresentation vr,
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3817 const char* name,
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3818 uint32_t minMultiplicity,
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3819 uint32_t maxMultiplicity)
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3820 {
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3821 _OrthancPluginRegisterDictionaryTag params;
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3822 params.group = group;
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3823 params.element = element;
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3824 params.vr = vr;
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3825 params.name = name;
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3826 params.minMultiplicity = minMultiplicity;
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3827 params.maxMultiplicity = maxMultiplicity;
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3828
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3829 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, &params);
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3830 }
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3831
5360cdba70d8 New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1649 diff changeset	3832
1669 a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	3833
a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	3834
a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	3835 typedef struct
a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	3836 {
a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	3837 OrthancPluginStorageArea* storageArea;
a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	3838 OrthancPluginResourceType level;
a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	3839 } _OrthancPluginReconstructMainDicomTags;
a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	3840
1673 0bbcfd9695e5 UpgradeDatabase in the sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1669 diff changeset	3841 /**
0bbcfd9695e5 UpgradeDatabase in the sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1669 diff changeset	3842 * @brief Reconstruct the main DICOM tags.
0bbcfd9695e5 UpgradeDatabase in the sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1669 diff changeset	3843 *
0bbcfd9695e5 UpgradeDatabase in the sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1669 diff changeset	3844 * This function requests the Orthanc core to reconstruct the main
0bbcfd9695e5 UpgradeDatabase in the sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1669 diff changeset	3845 * DICOM tags of all the resources of the given type. This function
0bbcfd9695e5 UpgradeDatabase in the sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1669 diff changeset	3846 * can only be used as a part of the upgrade of a custom database
0bbcfd9695e5 UpgradeDatabase in the sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1669 diff changeset	3847 * back-end
0bbcfd9695e5 UpgradeDatabase in the sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1669 diff changeset	3848 * (cf. OrthancPlugins::IDatabaseBackend::UpgradeDatabase). A
0bbcfd9695e5 UpgradeDatabase in the sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1669 diff changeset	3849 * database transaction will be automatically setup.
0bbcfd9695e5 UpgradeDatabase in the sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1669 diff changeset	3850 *
0bbcfd9695e5 UpgradeDatabase in the sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1669 diff changeset	3851 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
0bbcfd9695e5 UpgradeDatabase in the sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1669 diff changeset	3852 * @param storageArea The storage area.
0bbcfd9695e5 UpgradeDatabase in the sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1669 diff changeset	3853 * @param level The type of the resources of interest.
0bbcfd9695e5 UpgradeDatabase in the sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1669 diff changeset	3854 * @return 0 if success, other value if error.
0bbcfd9695e5 UpgradeDatabase in the sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1669 diff changeset	3855 * @ingroup Callbacks
0bbcfd9695e5 UpgradeDatabase in the sample plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1669 diff changeset	3856 **/
1669 a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	3857 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags(
a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	3858 OrthancPluginContext* context,
a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	3859 OrthancPluginStorageArea* storageArea,
a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	3860 OrthancPluginResourceType level)
a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	3861 {
a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	3862 _OrthancPluginReconstructMainDicomTags params;
a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	3863 params.level = level;
a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	3864 params.storageArea = storageArea;
a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	3865
a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	3866 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, &params);
a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	3867 }
a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	3868
a412ad57f0f9 refactoring of sample plugins, OrthancPluginReconstructMainDicomTags Sebastien Jodogne <s.jodogne@gmail.com> parents: 1657 diff changeset	3869
1740 5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3870 typedef struct
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3871 {
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3872 char** result;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3873 const char* instanceId;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3874 const char* buffer;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3875 uint32_t size;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3876 OrthancPluginDicomToJsonFormat format;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3877 OrthancPluginDicomToJsonFlags flags;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3878 uint32_t maxStringLength;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3879 } _OrthancPluginDicomToJson;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3880
1743 8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3881
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3882 /**
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3883 * @brief Format a DICOM memory buffer as a JSON string.
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3884 *
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3885 * This function takes as input a memory buffer containing a DICOM
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3886 * file, and outputs a JSON string representing the tags of this
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3887 * DICOM file.
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3888 *
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3889 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3890 * @param buffer The memory buffer containing the DICOM file.
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3891 * @param size The size of the memory buffer.
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3892 * @param format The output format.
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3893 * @param flags The output flags.
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3894 * @param maxStringLength The maximum length of a field. Too long fields will
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3895 * be output as "null". The 0 value means no maximum length.
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3896 * @return The NULL value if the case of an error, or the JSON
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3897 * string. This string must be freed by OrthancPluginFreeString().
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3898 * @ingroup Toolbox
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3899 * @see OrthancPluginDicomInstanceToJson
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3900 **/
1740 5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3901 ORTHANC_PLUGIN_INLINE char* OrthancPluginDicomBufferToJson(
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3902 OrthancPluginContext* context,
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3903 const char* buffer,
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3904 uint32_t size,
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3905 OrthancPluginDicomToJsonFormat format,
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3906 OrthancPluginDicomToJsonFlags flags,
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3907 uint32_t maxStringLength)
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3908 {
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3909 char* result;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3910
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3911 _OrthancPluginDicomToJson params;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3912 memset(&params, 0, sizeof(params));
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3913 params.result = &result;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3914 params.buffer = buffer;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3915 params.size = size;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3916 params.format = format;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3917 params.flags = flags;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3918 params.maxStringLength = maxStringLength;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3919
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3920 if (context->InvokeService(context, _OrthancPluginService_DicomBufferToJson, &params) != OrthancPluginErrorCode_Success)
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3921 {
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3922 /* Error */
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3923 return NULL;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3924 }
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3925 else
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3926 {
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3927 return result;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3928 }
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3929 }
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3930
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3931
1743 8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3932 /**
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3933 * @brief Format a DICOM instance as a JSON string.
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3934 *
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3935 * This function formats a DICOM instance that is stored in Orthanc,
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3936 * and outputs a JSON string representing the tags of this DICOM
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3937 * instance.
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3938 *
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3939 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3940 * @param instanceId The Orthanc identifier of the instance.
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3941 * @param format The output format.
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3942 * @param flags The output flags.
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3943 * @param maxStringLength The maximum length of a field. Too long fields will
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3944 * be output as "null". The 0 value means no maximum length.
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3945 * @return The NULL value if the case of an error, or the JSON
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3946 * string. This string must be freed by OrthancPluginFreeString().
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3947 * @ingroup Toolbox
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3948 * @see OrthancPluginDicomInstanceToJson
8fc1d096aa38 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1741 diff changeset	3949 **/
1740 5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3950 ORTHANC_PLUGIN_INLINE char* OrthancPluginDicomInstanceToJson(
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3951 OrthancPluginContext* context,
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3952 const char* instanceId,
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3953 OrthancPluginDicomToJsonFormat format,
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3954 OrthancPluginDicomToJsonFlags flags,
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3955 uint32_t maxStringLength)
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3956 {
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3957 char* result;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3958
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3959 _OrthancPluginDicomToJson params;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3960 memset(&params, 0, sizeof(params));
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3961 params.result = &result;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3962 params.instanceId = instanceId;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3963 params.format = format;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3964 params.flags = flags;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3965 params.maxStringLength = maxStringLength;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3966
1741 06addfcd1d4c OrthancStarted and OrthancStopped events in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1740 diff changeset	3967 if (context->InvokeService(context, _OrthancPluginService_DicomInstanceToJson, &params) != OrthancPluginErrorCode_Success)
1740 5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3968 {
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3969 /* Error */
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3970 return NULL;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3971 }
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3972 else
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3973 {
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3974 return result;
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3975 }
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3976 }
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3977
5e99a70b0635 DicomToJson callable from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1703 diff changeset	3978
1780 94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	3979 typedef struct
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	3980 {
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	3981 OrthancPluginMemoryBuffer* target;
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	3982 const char* uri;
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	3983 uint32_t headersCount;
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	3984 const char* const* headersKeys;
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	3985 const char* const* headersValues;
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	3986 int32_t afterPlugins;
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	3987 } _OrthancPluginRestApiGet2;
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	3988
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	3989 /**
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	3990 * @brief Make a GET call to the Orthanc REST API, with custom HTTP headers.
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	3991 *
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	3992 * Make a GET call to the Orthanc REST API with extended
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	3993 * parameters. The result to the query is stored into a newly
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	3994 * allocated memory buffer.
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	3995 *
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	3996 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	3997 * @param target The target memory buffer.
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	3998 * @param uri The URI in the built-in Orthanc API.
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	3999 * @param headersCount The number of HTTP headers.
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4000 * @param headersKeys Array containing the keys of the HTTP headers.
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4001 * @param headersValues Array containing the values of the HTTP headers.
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4002 * @param afterPlugins If 0, the built-in API of Orthanc is used.
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4003 * If 1, the API is tainted by the plugins.
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4004 * @return 0 if success, or the error code if failure.
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4005 * @see OrthancPluginRestApiGet, OrthancPluginRestApiGetAfterPlugins
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4006 * @ingroup Orthanc
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4007 **/
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4008 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiGet2(
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4009 OrthancPluginContext* context,
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4010 OrthancPluginMemoryBuffer* target,
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4011 const char* uri,
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4012 uint32_t headersCount,
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4013 const char* const* headersKeys,
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4014 const char* const* headersValues,
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4015 int32_t afterPlugins)
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4016 {
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4017 _OrthancPluginRestApiGet2 params;
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4018 params.target = target;
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4019 params.uri = uri;
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4020 params.headersCount = headersCount;
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4021 params.headersKeys = headersKeys;
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4022 params.headersValues = headersValues;
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4023 params.afterPlugins = afterPlugins;
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4024
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4025 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, &params);
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4026 }
94990da8710e OrthancPluginRestApiGet2 Sebastien Jodogne <s.jodogne@gmail.com> parents: 1773 diff changeset	4027
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4028 #ifdef __cplusplus
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4029 }
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	4030 #endif
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	4031
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	4032
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	4033 /** @} */
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	4034

Mercurial > hg > orthanc

annotate Plugins/Include/orthanc/OrthancCPlugin.h @ 1781:5ad4e4d92ecb