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

annotate Plugins/Include/orthanc/OrthancCPlugin.h @ 1649:8040d56cb0b3

New function "OrthancPluginRegisterErrorCode()" to declare custom error codes

author	Sebastien Jodogne <s.jodogne@gmail.com>
date	Fri, 25 Sep 2015 16:24:13 +0200
parents	87c77b9b3679
children	5360cdba70d8

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 /,
1582 bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	215 OrthancPluginErrorCode_SQLiteNotOpened = 1000 /!< SQLite: The database is not opened /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	216 OrthancPluginErrorCode_SQLiteAlreadyOpened = 1001 /!< SQLite: Connection is already open /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	217 OrthancPluginErrorCode_SQLiteCannotOpen = 1002 /!< SQLite: Unable to open the database /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	218 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	219 OrthancPluginErrorCode_SQLiteExecute = 1004 /!< SQLite: Cannot execute a command /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	220 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	221 OrthancPluginErrorCode_SQLiteCommitWithoutTransaction = 1006 /!< SQLite: Committing a nonexistent transaction /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	222 OrthancPluginErrorCode_SQLiteRegisterFunction = 1007 /!< SQLite: Unable to register a function /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	223 OrthancPluginErrorCode_SQLiteFlush = 1008 /!< SQLite: Unable to flush the database /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	224 OrthancPluginErrorCode_SQLiteCannotRun = 1009 /!< SQLite: Cannot run a cached statement /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	225 OrthancPluginErrorCode_SQLiteCannotStep = 1010 /!< SQLite: Cannot step over a cached statement /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	226 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	227 OrthancPluginErrorCode_SQLitePrepareStatement = 1012 /!< SQLite: Cannot prepare a cached statement /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	228 OrthancPluginErrorCode_SQLiteTransactionAlreadyStarted = 1013 /!< SQLite: Beginning the same transaction twice /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	229 OrthancPluginErrorCode_SQLiteTransactionCommit = 1014 /!< SQLite: Failure when committing the transaction /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	230 OrthancPluginErrorCode_SQLiteTransactionBegin = 1015 /!< SQLite: Cannot start a transaction /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	231 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	232 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	233 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	234 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	235 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	236 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	237 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	238 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	239 OrthancPluginErrorCode_MakeDirectory = 2008 /!< Cannot create a directory /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	240 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	241 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	242 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	243 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	244 OrthancPluginErrorCode_NoApplicationEntityFilter = 2013 /!< No application entity filter /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	245 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	246 OrthancPluginErrorCode_NoPresentationContext = 2015 /!< DicomUserConnection: No acceptable presentation context for modality /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	247 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	248 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	249 OrthancPluginErrorCode_CannotStoreInstance = 2018 /!< Cannot store an instance /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	250 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	251 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	252 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	253 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	254 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	255 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	256 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	257 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	258 OrthancPluginErrorCode_UnknownModality = 2027 /!< Unknown modality /,
bd1889029cbb encoding of exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1581 diff changeset	259 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	260 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	261 OrthancPluginErrorCode_CannotCreateLua = 2030 /!< Cannot create the Lua context /,
9ea3d082b064 got rid of custom exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1582 diff changeset	262 OrthancPluginErrorCode_CannotExecuteLua = 2031 /!< Cannot execute a Lua command /,
9ea3d082b064 got rid of custom exceptions Sebastien Jodogne <s.jodogne@gmail.com> parents: 1582 diff changeset	263 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	264 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	265 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	266 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	267 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	268 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	269 OrthancPluginErrorCode_DatabaseNotInitialized = 2038 /!< Plugin trying to call the database during its initialization /,
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	270
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	271 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
1578 09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	272 } OrthancPluginErrorCode;
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	273
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	274
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	275 /**
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	276 * 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	277 * plugins.
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	278 **/
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	279 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	280
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	281
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	282 /**
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	283 * The various HTTP methods for a REST call.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	284 **/
894 690aeb4cb899 REST callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 888 diff changeset	285 typedef enum
690aeb4cb899 REST callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 888 diff changeset	286 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	287 OrthancPluginHttpMethod_Get = 1, /!< GET request /
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	288 OrthancPluginHttpMethod_Post = 2, /!< POST request /
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	289 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	290 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	291
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	292 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
896 c4053ac5db04 better plugni api Sebastien Jodogne <s.jodogne@gmail.com> parents: 894 diff changeset	293 } OrthancPluginHttpMethod;
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	294
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	295
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	296 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	297 * @brief The parameters of a REST request.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	298 * @ingroup Callbacks
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	299 **/
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	300 typedef struct
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	301 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	302 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	303 * @brief The HTTP method.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	304 **/
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	305 OrthancPluginHttpMethod method;
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	306
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	307 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	308 * @brief The number of groups of the regular expression.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	309 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	310 uint32_t groupsCount;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	311
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	312 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	313 * @brief The matched values for the groups of the regular expression.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	314 **/
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	315 const char* const* groups;
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 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	318 * @brief For a GET request, the number of GET parameters.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	319 **/
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	320 uint32_t getCount;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	321
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	322 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	323 * @brief For a GET request, the keys of the GET parameters.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	324 **/
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	325 const char* const* getKeys;
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 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	328 * @brief For a GET request, the values of the GET parameters.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	329 **/
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	330 const char* const* getValues;
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 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	333 * @brief For a PUT or POST request, the content of the body.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	334 **/
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	335 const char* body;
907 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 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	338 * @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	339 **/
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	340 uint32_t bodySize;
1041 2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	341
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	342
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	343 /* --------------------------------------------------
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	344 New in version 0.8.1
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 * @brief The number of HTTP headers.
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 uint32_t headersCount;
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 /**
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	353 * @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	354 **/
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	355 const char* const* headersKeys;
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 /**
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	358 * @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	359 **/
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	360 const char* const* headersValues;
2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	361
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	362 } OrthancPluginHttpRequest;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	363
1041 2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	364
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	365 typedef enum
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	366 {
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	367 /* Generic services */
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	368 _OrthancPluginService_LogInfo = 1,
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	369 _OrthancPluginService_LogWarning = 2,
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	370 _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	371 _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	372 _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	373 _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	374 _OrthancPluginService_SetPluginProperty = 7,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	375 _OrthancPluginService_GetGlobalProperty = 8,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	376 _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	377 _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	378 _OrthancPluginService_GetCommandLineArgument = 11,
1407 d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	379 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
1424 fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	380 _OrthancPluginService_GetConfiguration = 13,
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	381 _OrthancPluginService_BufferCompression = 14,
1588 b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	382 _OrthancPluginService_ReadFile = 15,
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	383 _OrthancPluginService_WriteFile = 16,
1593 235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	384 _OrthancPluginService_GetErrorDescription = 17,
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	385 _OrthancPluginService_CallHttpClient = 18,
1649 8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	386 _OrthancPluginService_RegisterErrorCode = 19,
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	387
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	388 /* Registration of callbacks */
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	389 _OrthancPluginService_RegisterRestCallback = 1000,
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	390 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	391 _OrthancPluginService_RegisterStorageArea = 1002,
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	392 _OrthancPluginService_RegisterOnChangeCallback = 1003,
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	393 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
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 /* Sending answers to REST calls */
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	396 _OrthancPluginService_AnswerBuffer = 2000,
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	397 _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	398 _OrthancPluginService_Redirect = 2002,
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	399 _OrthancPluginService_SendHttpStatusCode = 2003,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	400 _OrthancPluginService_SendUnauthorized = 2004,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	401 _OrthancPluginService_SendMethodNotAllowed = 2005,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	402 _OrthancPluginService_SetCookie = 2006,
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	403 _OrthancPluginService_SetHttpHeader = 2007,
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	404 _OrthancPluginService_StartMultipartAnswer = 2008,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	405 _OrthancPluginService_SendMultipartItem = 2009,
1593 235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	406 _OrthancPluginService_SendHttpStatus = 2010,
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	407 _OrthancPluginService_CompressAndAnswerImage = 2011,
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	408
912 dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	409 /* Access to the Orthanc database and API */
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	410 _OrthancPluginService_GetDicomForInstance = 3000,
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	411 _OrthancPluginService_RestApiGet = 3001,
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	412 _OrthancPluginService_RestApiPost = 3002,
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	413 _OrthancPluginService_RestApiDelete = 3003,
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	414 _OrthancPluginService_RestApiPut = 3004,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	415 _OrthancPluginService_LookupPatient = 3005,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	416 _OrthancPluginService_LookupStudy = 3006,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	417 _OrthancPluginService_LookupSeries = 3007,
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	418 _OrthancPluginService_LookupInstance = 3008,
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	419 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	420 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	421 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	422 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	423 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	424
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	425 /* Access to DICOM instances */
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	426 _OrthancPluginService_GetInstanceRemoteAet = 4000,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	427 _OrthancPluginService_GetInstanceSize = 4001,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	428 _OrthancPluginService_GetInstanceData = 4002,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	429 _OrthancPluginService_GetInstanceJson = 4003,
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	430 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	431 _OrthancPluginService_HasInstanceMetadata = 4005,
1309 8f4487d8f79e new files for custom database back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 diff changeset	432 _OrthancPluginService_GetInstanceMetadata = 4006,
8f4487d8f79e new files for custom database back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 diff changeset	433
8f4487d8f79e new files for custom database back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 diff changeset	434 /* 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	435 _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	436 _OrthancPluginService_DatabaseAnswer = 5001,
1609 c74495267acf Implementation of the "GetAllPublicIdsWithLimit" extension Sebastien Jodogne <s.jodogne@gmail.com> parents: 1608 diff changeset	437 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002,
1615 c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	438 _OrthancPluginService_StorageAreaCreate = 5003,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	439 _OrthancPluginService_StorageAreaRead = 5004,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	440 _OrthancPluginService_StorageAreaRemove = 5005,
1309 8f4487d8f79e new files for custom database back-end Sebastien Jodogne <s.jodogne@gmail.com> parents: 1303 diff changeset	441
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	442 /* Primitives for handling images */
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	443 _OrthancPluginService_GetImagePixelFormat = 6000,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	444 _OrthancPluginService_GetImageWidth = 6001,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	445 _OrthancPluginService_GetImageHeight = 6002,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	446 _OrthancPluginService_GetImagePitch = 6003,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	447 _OrthancPluginService_GetImageBuffer = 6004,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	448 _OrthancPluginService_UncompressImage = 6005,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	449 _OrthancPluginService_FreeImage = 6006,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	450 _OrthancPluginService_CompressImage = 6007,
1608 adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	451 _OrthancPluginService_ConvertPixelFormat = 6008,
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	452 _OrthancPluginService_GetFontsCount = 6009,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	453 _OrthancPluginService_GetFontInfo = 6010,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	454 _OrthancPluginService_DrawText = 6011,
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	455
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	456 _OrthancPluginService_INTERNAL = 0x7fffffff
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	457 } _OrthancPluginService;
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	458
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	459
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	460 typedef enum
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	461 {
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	462 _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	463 _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	464 _OrthancPluginProperty_OrthancExplorer = 3,
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	465
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	466 _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	467 } _OrthancPluginProperty;
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	468
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	469
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	470
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	471 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	472 * 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	473 * @ingroup Images
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	474 **/
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	475 typedef enum
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	476 {
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	477 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	478 * @brief Graylevel 8bpp image.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	479 *
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	480 * 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	481 * one byte.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	482 **/
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	483 OrthancPluginPixelFormat_Grayscale8 = 1,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	484
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	485 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	486 * @brief Graylevel, unsigned 16bpp image.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	487 *
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	488 * 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	489 * two bytes.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	490 **/
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	491 OrthancPluginPixelFormat_Grayscale16 = 2,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	492
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	493 /**
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	494 * @brief Graylevel, signed 16bpp image.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	495 *
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	496 * 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	497 * bytes.
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	498 **/
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	499 OrthancPluginPixelFormat_SignedGrayscale16 = 3,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	500
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 * @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	503 *
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	504 * 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	505 * 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	506 **/
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	507 OrthancPluginPixelFormat_RGB24 = 4,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	508
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 * @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	511 *
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	512 * 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	513 * 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	514 **/
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	515 OrthancPluginPixelFormat_RGBA32 = 5,
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	516
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	517 OrthancPluginPixelFormat_Unknown = 6, /!< Unknown pixel format /
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	518
1580 bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	519 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	520 } OrthancPluginPixelFormat;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	521
894 690aeb4cb899 REST callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 888 diff changeset	522
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	523
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	524 /**
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	525 * 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	526 **/
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	527 typedef enum
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	528 {
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	529 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	530 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	531 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	532
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	533 _OrthancPluginContentType_INTERNAL = 0x7fffffff
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	534 } OrthancPluginContentType;
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
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	537
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	538 /**
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	539 * The supported types of DICOM resources.
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	540 **/
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	541 typedef enum
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	542 {
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	543 OrthancPluginResourceType_Patient = 0, /!< Patient /
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	544 OrthancPluginResourceType_Study = 1, /!< Study /
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	545 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	546 OrthancPluginResourceType_Instance = 3, /!< Instance /
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	547
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	548 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	549 } OrthancPluginResourceType;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	550
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
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	553 /**
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	554 * 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	555 * @ingroup Callbacks
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	556 **/
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	557 typedef enum
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	558 {
1198 1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	559 OrthancPluginChangeType_CompletedSeries = 0, /!< Series is now complete /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	560 OrthancPluginChangeType_Deleted = 1, /!< Deleted resource /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	561 OrthancPluginChangeType_NewChildInstance = 2, /!< A new instance was added to this resource /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	562 OrthancPluginChangeType_NewInstance = 3, /!< New instance received /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	563 OrthancPluginChangeType_NewPatient = 4, /!< New patient created /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	564 OrthancPluginChangeType_NewSeries = 5, /!< New series created /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	565 OrthancPluginChangeType_NewStudy = 6, /!< New study created /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	566 OrthancPluginChangeType_StablePatient = 7, /!< Timeout: No new instance in this patient /
1169528a9a5f refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1189 diff changeset	567 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	568 OrthancPluginChangeType_StableStudy = 9, /!< Timeout: No new instance in this study /
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	569
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	570 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	571 } OrthancPluginChangeType;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	572
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	573
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	574 /**
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	575 * 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	576 * @ingroup Images
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	577 **/
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	578 typedef enum
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	579 {
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	580 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	581 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	582 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	583 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	584
bf502300c52e force the size of the enumerations in the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1579 diff changeset	585 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	586 } OrthancPluginCompressionType;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	587
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 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	590 * 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	591 * @ingroup Images
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	592 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	593 typedef enum
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	594 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	595 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	596 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	597
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	598 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	599 } OrthancPluginImageFormat;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	600
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	601
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	602
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	603 /**
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	604 * @brief A memory buffer allocated by the core system of Orthanc.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	605 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	606 * A memory buffer allocated by the core system of Orthanc. When the
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	607 * 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	608 * call to ::OrthancPluginFreeMemoryBuffer().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	609 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	610 typedef struct
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	611 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	612 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	613 * @brief The content of the buffer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	614 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	615 void* data;
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	616
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	617 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	618 * @brief The number of bytes in the buffer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	619 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	620 uint32_t size;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	621 } OrthancPluginMemoryBuffer;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	622
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	623
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	624
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	625
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	626 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	627 * @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	628 * @ingroup Callback
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	629 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	630 typedef struct _OrthancPluginRestOutput_t OrthancPluginRestOutput;
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	631
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	632
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	633
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	634 /**
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	635 * @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	636 **/
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	637 typedef struct _OrthancPluginDicomInstance_t OrthancPluginDicomInstance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	638
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	639
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	640
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	641 /**
1615 c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	642 * @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	643 * @ingroup Images
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	644 **/
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	645 typedef struct _OrthancPluginImage_t OrthancPluginImage;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	646
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	647
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	648
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	649 /**
1615 c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	650 * @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	651 * @ingroup Images
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	652 **/
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	653 typedef struct _OrthancPluginStorageArea_t OrthancPluginStorageArea;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	654
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	655
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	656
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	657 /**
908 e078ea944089 refactoring HttpOutput Sebastien Jodogne <s.jodogne@gmail.com> parents: 907 diff changeset	658 * @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	659 * @ingroup Callbacks
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	660 **/
1628 77c4cc4def0f OrthancPluginErrorCode in REST callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1627 diff changeset	661 typedef OrthancPluginErrorCode (*OrthancPluginRestCallback) (
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	662 OrthancPluginRestOutput* output,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	663 const char* url,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	664 const OrthancPluginHttpRequest* request);
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	665
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	666
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	667
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	668 /**
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	669 * @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	670 * @ingroup Callbacks
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	671 **/
1627 da7854deb662 Plugin callbacks must now return explicit "OrthancPluginErrorCode" instead of integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1615 diff changeset	672 typedef OrthancPluginErrorCode (*OrthancPluginOnStoredInstanceCallback) (
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	673 OrthancPluginDicomInstance* instance,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	674 const char* instanceId);
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	675
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	676
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	677
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	678 /**
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	679 * @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	680 * @ingroup Callbacks
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	681 **/
1627 da7854deb662 Plugin callbacks must now return explicit "OrthancPluginErrorCode" instead of integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1615 diff changeset	682 typedef OrthancPluginErrorCode (*OrthancPluginOnChangeCallback) (
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	683 OrthancPluginChangeType changeType,
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	684 OrthancPluginResourceType resourceType,
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	685 const char* resourceId);
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	686
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	687
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	688
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	689 /**
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	690 * @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	691 **/
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	692 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	693
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	694
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	695
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	696 /**
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	697 * @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	698 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	699 * 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	700 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	701 * @param uuid The UUID of the file.
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	702 * @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	703 * @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	704 * @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	705 * @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	706 * @ingroup Callbacks
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	707 **/
1627 da7854deb662 Plugin callbacks must now return explicit "OrthancPluginErrorCode" instead of integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1615 diff changeset	708 typedef OrthancPluginErrorCode (*OrthancPluginStorageCreate) (
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	709 const char* uuid,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	710 const void* content,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	711 int64_t size,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	712 OrthancPluginContentType type);
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	713
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	714
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	715
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	716 /**
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	717 * @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	718 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	719 * 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	720 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	721 * @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	722 * @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	723 * @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	724 * @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	725 * @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	726 * @ingroup Callbacks
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	727 **/
1627 da7854deb662 Plugin callbacks must now return explicit "OrthancPluginErrorCode" instead of integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1615 diff changeset	728 typedef OrthancPluginErrorCode (*OrthancPluginStorageRead) (
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	729 void** content,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	730 int64_t* size,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	731 const char* uuid,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	732 OrthancPluginContentType type);
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	733
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	734
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	735
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	736 /**
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	737 * @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	738 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	739 * 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	740 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	741 * @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	742 * @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	743 * @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	744 * @ingroup Callbacks
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	745 **/
1627 da7854deb662 Plugin callbacks must now return explicit "OrthancPluginErrorCode" instead of integers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1615 diff changeset	746 typedef OrthancPluginErrorCode (*OrthancPluginStorageRemove) (
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	747 const char* uuid,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	748 OrthancPluginContentType type);
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	749
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	750
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	751
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	752 /**
1297 501432928727 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 1295 diff changeset	753 * @brief Data structure that contains information about the Orthanc core.
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	754 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	755 typedef struct _OrthancPluginContext_t
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	756 {
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	757 void* pluginsManager;
357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	758 const char* orthancVersion;
357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	759 OrthancPluginFree Free;
357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	760 OrthancPluginErrorCode (InvokeService) (struct _OrthancPluginContext_t context,
357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	761 _OrthancPluginService service,
357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	762 const void* params);
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	763 } OrthancPluginContext;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	764
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	765
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	766
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	767 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	768 * @brief Free a string.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	769 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	770 * Free a string that was allocated by the core system of Orthanc.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	771 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	772 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	773 * @param str The string to be freed.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	774 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	775 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeString(
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	776 OrthancPluginContext* context,
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	777 char* str)
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	778 {
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	779 if (str != NULL)
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	780 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	781 context->Free(str);
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	782 }
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	783 }
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	784
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	785
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	786 /**
1041 2c49b7dffcec plugins have access to the HTTP headers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1040 diff changeset	787 * @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	788 *
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	789 * 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	790 * 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	791 * this function should always be checked in the
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	792 * OrthancPluginInitialize() entry point of the plugin.
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	793 *
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	794 * @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	795 * @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	796 * 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	797 * @ingroup Callbacks
1039 5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	798 **/
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	799 ORTHANC_PLUGIN_INLINE int OrthancPluginCheckVersion(
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	800 OrthancPluginContext* context)
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	801 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	802 int major, minor, revision;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	803
1579 b93c398f934d check the size of the enumerations in the plugin engine Sebastien Jodogne <s.jodogne@gmail.com> parents: 1578 diff changeset	804 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	805 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	806 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	807 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	808 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	809 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	810 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	811 sizeof(int32_t) != sizeof(OrthancPluginChangeType) \|\|
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	812 sizeof(int32_t) != sizeof(OrthancPluginCompressionType) \|\|
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	813 sizeof(int32_t) != sizeof(OrthancPluginImageFormat))
1578 09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	814 {
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	815 /* Mismatch in the size of the enumerations */
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	816 return 0;
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	817 }
09715095fc53 cont Sebastien Jodogne <s.jodogne@gmail.com> parents: 1554 diff changeset	818
1039 5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	819 /* Assume compatibility with the mainline */
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	820 if (!strcmp(context->orthancVersion, "mainline"))
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	821 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	822 return 1;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	823 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	824
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	825 /* Parse the version of the Orthanc core */
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	826 if (
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	827 #ifdef _MSC_VER
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	828 sscanf_s
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	829 #else
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	830 sscanf
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	831 #endif
1303 bba8a47922d1 cppcheck Sebastien Jodogne <s.jodogne@gmail.com> parents: 1297 diff changeset	832 (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	833 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	834 return 0;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	835 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	836
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	837 /* Check the major number of the version */
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	838
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	839 if (major > ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	840 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	841 return 1;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	842 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	843
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	844 if (major < ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	845 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	846 return 0;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	847 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	848
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	849 /* Check the minor number of the version */
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	850
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	851 if (minor > ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	852 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	853 return 1;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	854 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	855
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	856 if (minor < ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	857 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	858 return 0;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	859 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	860
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	861 /* Check the revision number of the version */
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	862
1040 d06186cdc502 check plugin version in samples Sebastien Jodogne <s.jodogne@gmail.com> parents: 1039 diff changeset	863 if (revision >= ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER)
1039 5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	864 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	865 return 1;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	866 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	867 else
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	868 {
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	869 return 0;
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	870 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	871 }
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	872
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	873
5a5a4890ffca check version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1037 diff changeset	874 /**
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	875 * @brief Free a memory buffer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	876 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	877 * 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	878 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	879 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	880 * @param buffer The memory buffer to release.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	881 **/
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	882 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeMemoryBuffer(
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	883 OrthancPluginContext* context,
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	884 OrthancPluginMemoryBuffer* buffer)
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	885 {
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	886 context->Free(buffer->data);
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	887 }
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	888
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	889
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	890 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	891 * @brief Log an error.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	892 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	893 * Log an error message using the Orthanc logging system.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	894 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	895 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	896 * @param message The message to be logged.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	897 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	898 ORTHANC_PLUGIN_INLINE void OrthancPluginLogError(
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	899 OrthancPluginContext* context,
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	900 const char* message)
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	901 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	902 context->InvokeService(context, _OrthancPluginService_LogError, message);
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	903 }
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	904
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	905
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	906 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	907 * @brief Log a warning.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	908 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	909 * Log a warning message using the Orthanc logging system.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	910 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	911 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	912 * @param message The message to be logged.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	913 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	914 ORTHANC_PLUGIN_INLINE void OrthancPluginLogWarning(
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	915 OrthancPluginContext* context,
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	916 const char* message)
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	917 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	918 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	919 }
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	920
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	921
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	922 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	923 * @brief Log an information.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	924 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	925 * Log an information message using the Orthanc logging system.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	926 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	927 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	928 * @param message The message to be logged.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	929 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	930 ORTHANC_PLUGIN_INLINE void OrthancPluginLogInfo(
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	931 OrthancPluginContext* context,
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	932 const char* message)
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	933 {
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	934 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	935 }
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	936
7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	937
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	938
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	939 typedef struct
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	940 {
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	941 const char* pathRegularExpression;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	942 OrthancPluginRestCallback callback;
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	943 } _OrthancPluginRestCallback;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	944
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	945 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	946 * @brief Register a REST callback.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	947 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	948 * This function registers a REST callback against a regular
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	949 * expression for a URI. This function must be called during the
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	950 * initialization of the plugin, i.e. inside the
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	951 * OrthancPluginInitialize() public function.
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	952 *
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	953 * Each REST callback is guaranteed to run in mutual exclusion.
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	954 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	955 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	956 * @param pathRegularExpression Regular expression for the URI. May contain groups.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	957 * @param callback The callback function to handle the REST call.
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	958 * @see OrthancPluginRegisterRestCallbackNoLock()
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	959 * @ingroup Callbacks
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	960 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	961 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterRestCallback(
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	962 OrthancPluginContext* context,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	963 const char* pathRegularExpression,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	964 OrthancPluginRestCallback callback)
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	965 {
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	966 _OrthancPluginRestCallback params;
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	967 params.pathRegularExpression = pathRegularExpression;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	968 params.callback = callback;
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	969 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, &params);
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	970 }
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	971
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	972
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	973
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	974 /**
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	975 * @brief Register a REST callback, without locking.
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	976 *
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	977 * This function registers a REST callback against a regular
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	978 * expression for a URI. This function must be called during the
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	979 * initialization of the plugin, i.e. inside the
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	980 * OrthancPluginInitialize() public function.
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	981 *
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	982 * Contrarily to OrthancPluginRegisterRestCallback(), the callback
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	983 * 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	984 * high-performance plugins that must handle concurrent requests
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	985 * (Orthanc uses a pool of threads, one thread being assigned to
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	986 * 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	987 * implement the required locking mechanisms.
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	988 *
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	989 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	990 * @param pathRegularExpression Regular expression for the URI. May contain groups.
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	991 * @param callback The callback function to handle the REST call.
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	992 * @see OrthancPluginRegisterRestCallback()
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	993 * @ingroup Callbacks
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	994 **/
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	995 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterRestCallbackNoLock(
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	996 OrthancPluginContext* context,
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	997 const char* pathRegularExpression,
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	998 OrthancPluginRestCallback callback)
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	999 {
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1000 _OrthancPluginRestCallback params;
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1001 params.pathRegularExpression = pathRegularExpression;
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1002 params.callback = callback;
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1003 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, &params);
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1004 }
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1005
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1006
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	1007
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1008 typedef struct
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1009 {
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1010 OrthancPluginOnStoredInstanceCallback callback;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1011 } _OrthancPluginOnStoredInstanceCallback;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1012
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1013 /**
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1014 * @brief Register a callback for received instances.
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1015 *
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1016 * This function registers a callback function that is called
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1017 * 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	1018 *
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1019 * @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	1020 * @param callback The callback function.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1021 * @ingroup Callbacks
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1022 **/
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1023 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterOnStoredInstanceCallback(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1024 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1025 OrthancPluginOnStoredInstanceCallback callback)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1026 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1027 _OrthancPluginOnStoredInstanceCallback params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1028 params.callback = callback;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1029
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1030 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, &params);
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1031 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1032
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1033
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1034
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1035 typedef struct
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1036 {
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1037 OrthancPluginRestOutput* output;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1038 const char* answer;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1039 uint32_t answerSize;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1040 const char* mimeType;
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1041 } _OrthancPluginAnswerBuffer;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1042
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1043 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1044 * @brief Answer to a REST request.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1045 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1046 * 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	1047 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1048 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1049 * @param output The HTTP connection to the client application.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1050 * @param answer Pointer to the memory buffer containing the answer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1051 * @param answerSize Number of bytes of the answer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1052 * @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	1053 * @ingroup REST
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1054 **/
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1055 ORTHANC_PLUGIN_INLINE void OrthancPluginAnswerBuffer(
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1056 OrthancPluginContext* context,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1057 OrthancPluginRestOutput* output,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1058 const char* answer,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1059 uint32_t answerSize,
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	1060 const char* mimeType)
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1061 {
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1062 _OrthancPluginAnswerBuffer params;
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1063 params.output = output;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1064 params.answer = answer;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1065 params.answerSize = answerSize;
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1066 params.mimeType = mimeType;
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1067 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, &params);
899 bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1068 }
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1069
bb0a51561016 refactoring Sebastien Jodogne <s.jodogne@gmail.com> parents: 898 diff changeset	1070
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1071 typedef struct
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1072 {
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1073 OrthancPluginRestOutput* output;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1074 OrthancPluginPixelFormat format;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1075 uint32_t width;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1076 uint32_t height;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1077 uint32_t pitch;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1078 const void* buffer;
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1079 } _OrthancPluginCompressAndAnswerPngImage;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1080
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1081 typedef struct
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1082 {
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1083 OrthancPluginRestOutput* output;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1084 OrthancPluginImageFormat imageFormat;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1085 OrthancPluginPixelFormat pixelFormat;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1086 uint32_t width;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1087 uint32_t height;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1088 uint32_t pitch;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1089 const void* buffer;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1090 uint8_t quality;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1091 } _OrthancPluginCompressAndAnswerImage;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1092
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1093
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1094 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1095 * @brief Answer to a REST request with a PNG image.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1096 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1097 * This function answers to a REST request with a PNG image. The
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1098 * parameters of this function describe a memory buffer that
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1099 * contains an uncompressed image. The image will be automatically compressed
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1100 * as a PNG image by the core system of Orthanc.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1101 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1102 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1103 * @param output The HTTP connection to the client application.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1104 * @param format The memory layout of the uncompressed image.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1105 * @param width The width of the image.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1106 * @param height The height of the image.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1107 * @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	1108 * between 2 successive lines of the image in the memory buffer).
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1109 * @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	1110 * @ingroup REST
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1111 **/
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1112 ORTHANC_PLUGIN_INLINE void OrthancPluginCompressAndAnswerPngImage(
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1113 OrthancPluginContext* context,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1114 OrthancPluginRestOutput* output,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1115 OrthancPluginPixelFormat format,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1116 uint32_t width,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1117 uint32_t height,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1118 uint32_t pitch,
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1119 const void* buffer)
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1120 {
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1121 _OrthancPluginCompressAndAnswerImage params;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1122 params.output = output;
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1123 params.imageFormat = OrthancPluginImageFormat_Png;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1124 params.pixelFormat = format;
901 7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1125 params.width = width;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1126 params.height = height;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1127 params.pitch = pitch;
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1128 params.buffer = buffer;
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1129 params.quality = 0; /* No quality for PNG */
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	1130 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	1131 }
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1132
7d88f3f4a3b3 refactoring IsServedUri, answer PNG images, regular expression groups Sebastien Jodogne <s.jodogne@gmail.com> parents: 900 diff changeset	1133
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1134
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1135 typedef struct
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1136 {
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1137 OrthancPluginMemoryBuffer* target;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1138 const char* instanceId;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1139 } _OrthancPluginGetDicomForInstance;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1140
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1141 /**
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1142 * @brief Retrieve a DICOM instance using its Orthanc identifier.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1143 *
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1144 * Retrieve a DICOM instance using its Orthanc identifier. The DICOM
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1145 * file is stored into a newly allocated memory buffer.
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 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1148 * @param target The target memory buffer.
9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1149 * @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	1150 * @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	1151 * @ingroup Orthanc
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1152 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1153 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginGetDicomForInstance(
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1154 OrthancPluginContext* context,
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1155 OrthancPluginMemoryBuffer* target,
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1156 const char* instanceId)
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1157 {
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1158 _OrthancPluginGetDicomForInstance params;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1159 params.target = target;
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1160 params.instanceId = instanceId;
907 9b8298234254 documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 906 diff changeset	1161 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, &params);
904 2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1162 }
2732b5f57d9c sample to forward dicom data Sebastien Jodogne <s.jodogne@gmail.com> parents: 901 diff changeset	1163
898 7000fc86fe62 improved plugin api Sebastien Jodogne <s.jodogne@gmail.com> parents: 897 diff changeset	1164
912 dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1165
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1166 typedef struct
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1167 {
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1168 OrthancPluginMemoryBuffer* target;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1169 const char* uri;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1170 } _OrthancPluginRestApiGet;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1171
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1172 /**
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1173 * @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	1174 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1175 * 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	1176 * 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	1177 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1178 * @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	1179 * @param target The target memory buffer.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1180 * @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	1181 * @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	1182 * @see OrthancPluginRestApiGetAfterPlugins
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1183 * @ingroup Orthanc
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1184 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1185 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiGet(
912 dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1186 OrthancPluginContext* context,
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1187 OrthancPluginMemoryBuffer* target,
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1188 const char* uri)
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1189 {
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1190 _OrthancPluginRestApiGet params;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1191 params.target = target;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1192 params.uri = uri;
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1193 return context->InvokeService(context, _OrthancPluginService_RestApiGet, &params);
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1194 }
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1195
dcb2469f00f4 PluginsHttpHandler::RestApiGet Sebastien Jodogne <s.jodogne@gmail.com> parents: 908 diff changeset	1196
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1197
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1198 /**
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1199 * @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	1200 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1201 * 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	1202 * 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	1203 * 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	1204 * 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	1205 * 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	1206 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1207 * @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	1208 * @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	1209 * @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	1210 * @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	1211 * @see OrthancPluginRestApiGet
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1212 * @ingroup Orthanc
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1213 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1214 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	1215 OrthancPluginContext* context,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1216 OrthancPluginMemoryBuffer* target,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1217 const char* uri)
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1218 {
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1219 _OrthancPluginRestApiGet params;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1220 params.target = target;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1221 params.uri = uri;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1222 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	1223 }
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1224
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1225
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1226
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1227 typedef struct
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1228 {
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1229 OrthancPluginMemoryBuffer* target;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1230 const char* uri;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1231 const char* body;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1232 uint32_t bodySize;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1233 } _OrthancPluginRestApiPostPut;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1234
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1235 /**
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1236 * @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	1237 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1238 * 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	1239 * 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	1240 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1241 * @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	1242 * @param target The target memory buffer.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1243 * @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	1244 * @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	1245 * @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	1246 * @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	1247 * @see OrthancPluginRestApiPostAfterPlugins
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1248 * @ingroup Orthanc
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1249 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1250 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPost(
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1251 OrthancPluginContext* context,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1252 OrthancPluginMemoryBuffer* target,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1253 const char* uri,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1254 const char* body,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1255 uint32_t bodySize)
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1256 {
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1257 _OrthancPluginRestApiPostPut params;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1258 params.target = target;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1259 params.uri = uri;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1260 params.body = body;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1261 params.bodySize = bodySize;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1262 return context->InvokeService(context, _OrthancPluginService_RestApiPost, &params);
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1263 }
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1264
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1265
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1266 /**
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1267 * @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	1268 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1269 * 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	1270 * 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	1271 * 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	1272 * 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	1273 * 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	1274 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1275 * @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	1276 * @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	1277 * @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	1278 * @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	1279 * @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	1280 * @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	1281 * @see OrthancPluginRestApiPost
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1282 * @ingroup Orthanc
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1283 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1284 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	1285 OrthancPluginContext* context,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1286 OrthancPluginMemoryBuffer* target,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1287 const char* uri,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1288 const char* body,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1289 uint32_t bodySize)
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1290 {
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1291 _OrthancPluginRestApiPostPut params;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1292 params.target = target;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1293 params.uri = uri;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1294 params.body = body;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1295 params.bodySize = bodySize;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1296 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	1297 }
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1298
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1299
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1300
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1301 /**
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1302 * @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	1303 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1304 * 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	1305 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1306 * @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	1307 * @param uri The URI to delete in the built-in Orthanc API.
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1308 * @return 0 if success, or the error code if failure.
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	1309 * @see OrthancPluginRestApiDeleteAfterPlugins
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1310 * @ingroup Orthanc
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1311 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1312 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiDelete(
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1313 OrthancPluginContext* context,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1314 const char* uri)
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1315 {
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1316 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1317 }
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1318
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1319
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1320 /**
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1321 * @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	1322 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1323 * 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	1324 * 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	1325 * 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	1326 * 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	1327 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1328 * @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	1329 * @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	1330 * @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	1331 * @see OrthancPluginRestApiDelete
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1332 * @ingroup Orthanc
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1333 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1334 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	1335 OrthancPluginContext* context,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1336 const char* uri)
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1337 {
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1338 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	1339 }
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1340
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1341
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1342
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1343 /**
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1344 * @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	1345 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1346 * 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	1347 * 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	1348 *
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1349 * @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	1350 * @param target The target memory buffer.
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1351 * @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	1352 * @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	1353 * @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	1354 * @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	1355 * @see OrthancPluginRestApiPutAfterPlugins
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1356 * @ingroup Orthanc
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1357 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1358 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPut(
913 3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1359 OrthancPluginContext* context,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1360 OrthancPluginMemoryBuffer* target,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1361 const char* uri,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1362 const char* body,
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1363 uint32_t bodySize)
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1364 {
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1365 _OrthancPluginRestApiPostPut params;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1366 params.target = target;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1367 params.uri = uri;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1368 params.body = body;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1369 params.bodySize = bodySize;
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1370 return context->InvokeService(context, _OrthancPluginService_RestApiPut, &params);
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1371 }
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1372
3e43de893d88 POST, DELETE, PUT from Orthanc plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 912 diff changeset	1373
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1374
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1375 /**
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1376 * @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	1377 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1378 * 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	1379 * 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	1380 * 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	1381 * 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	1382 * 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	1383 *
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1384 * @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	1385 * @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	1386 * @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	1387 * @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	1388 * @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	1389 * @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	1390 * @see OrthancPluginRestApiPut
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1391 * @ingroup Orthanc
1282 7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1392 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	1393 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	1394 OrthancPluginContext* context,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1395 OrthancPluginMemoryBuffer* target,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1396 const char* uri,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1397 const char* body,
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1398 uint32_t bodySize)
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1399 {
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1400 _OrthancPluginRestApiPostPut params;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1401 params.target = target;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1402 params.uri = uri;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1403 params.body = body;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1404 params.bodySize = bodySize;
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1405 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	1406 }
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1407
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1408
7bccdd221e2b Plugins can do REST calls to other plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1280 diff changeset	1409
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1410 typedef struct
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1411 {
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1412 OrthancPluginRestOutput* output;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1413 const char* argument;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1414 } _OrthancPluginOutputPlusArgument;
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1415
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1416 /**
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1417 * @brief Redirect a REST request.
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1418 *
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1419 * 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	1420 * to another URI using HTTP status 301.
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1421 *
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1422 * @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	1423 * @param output The HTTP connection to the client application.
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1424 * @param redirection Where to redirect.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1425 * @ingroup REST
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1426 **/
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1427 ORTHANC_PLUGIN_INLINE void OrthancPluginRedirect(
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1428 OrthancPluginContext* context,
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1429 OrthancPluginRestOutput* output,
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1430 const char* redirection)
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1431 {
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1432 _OrthancPluginOutputPlusArgument params;
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1433 params.output = output;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1434 params.argument = redirection;
993 501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1435 context->InvokeService(context, _OrthancPluginService_Redirect, &params);
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1436 }
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1437
501880d76474 improvements to GDCM plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 913 diff changeset	1438
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1439
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1440 typedef struct
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1441 {
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1442 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	1443 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	1444 } _OrthancPluginRetrieveDynamicString;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1445
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1446 /**
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1447 * @brief Look for a patient.
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1448 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1449 * 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	1450 * 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	1451 * over all the stored patients).
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1452 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1453 * @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	1454 * @param patientID The Patient ID of interest.
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1455 * @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	1456 * 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	1457 * @ingroup Orthanc
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1458 **/
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1459 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupPatient(
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1460 OrthancPluginContext* context,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1461 const char* patientID)
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1462 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1463 char* result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1464
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1465 _OrthancPluginRetrieveDynamicString params;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1466 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	1467 params.argument = patientID;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1468
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1469 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	1470 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1471 /* Error */
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1472 return NULL;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1473 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1474 else
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1475 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1476 return result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1477 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1478 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1479
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1480
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1481 /**
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1482 * @brief Look for a study.
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1483 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1484 * 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	1485 * 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	1486 * over all the stored studies).
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1487 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1488 * @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	1489 * @param studyUID The Study Instance UID of interest.
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1490 * @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	1491 * 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	1492 * @ingroup Orthanc
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1493 **/
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1494 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupStudy(
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1495 OrthancPluginContext* context,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1496 const char* studyUID)
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1497 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1498 char* result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1499
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1500 _OrthancPluginRetrieveDynamicString params;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1501 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	1502 params.argument = studyUID;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1503
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1504 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	1505 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1506 /* Error */
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1507 return NULL;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1508 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1509 else
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1510 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1511 return result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1512 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1513 }
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1514
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1515
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1516 /**
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1517 * @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	1518 *
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1519 * 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	1520 * 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	1521 * over all the stored studies).
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1522 *
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1523 * @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	1524 * @param accessionNumber The Accession Number of interest.
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1525 * @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	1526 * 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	1527 * @ingroup Orthanc
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1528 **/
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1529 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupStudyWithAccessionNumber(
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1530 OrthancPluginContext* context,
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1531 const char* accessionNumber)
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1532 {
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1533 char* result;
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1534
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	1535 _OrthancPluginRetrieveDynamicString params;
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1536 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	1537 params.argument = accessionNumber;
1069 a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1538
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1539 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	1540 {
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1541 /* Error */
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1542 return NULL;
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1543 }
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1544 else
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1545 {
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1546 return result;
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1547 }
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1548 }
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1549
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1550
a91b4900f06a plugin lookup using accession number Sebastien Jodogne <s.jodogne@gmail.com> parents: 1068 diff changeset	1551 /**
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1552 * @brief Look for a series.
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1553 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1554 * 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	1555 * 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	1556 * over all the stored series).
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1557 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1558 * @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	1559 * @param seriesUID The Series Instance UID of interest.
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1560 * @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	1561 * 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	1562 * @ingroup Orthanc
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1563 **/
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1564 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupSeries(
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1565 OrthancPluginContext* context,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1566 const char* seriesUID)
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1567 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1568 char* result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1569
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 _OrthancPluginRetrieveDynamicString params;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1571 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	1572 params.argument = seriesUID;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1573
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1574 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	1575 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1576 /* Error */
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1577 return NULL;
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 else
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 return result;
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
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 * @brief Look for an instance.
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1588 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1589 * 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	1590 * 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	1591 * over all the stored instances).
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1592 *
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1593 * @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	1594 * @param sopInstanceUID The SOP Instance UID of interest.
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1595 * @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	1596 * 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	1597 * @ingroup Orthanc
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1598 **/
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1599 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupInstance(
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1600 OrthancPluginContext* context,
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1601 const char* sopInstanceUID)
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1602 {
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1603 char* result;
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1604
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 _OrthancPluginRetrieveDynamicString params;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1606 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	1607 params.argument = sopInstanceUID;
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1608
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1609 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	1610 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1611 /* Error */
1037 6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1612 return NULL;
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 else
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 return result;
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
6208ab500ffd LookupResource service in plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1027 diff changeset	1620
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1621
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1622 typedef struct
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1623 {
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1624 OrthancPluginRestOutput* output;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1625 uint16_t status;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1626 } _OrthancPluginSendHttpStatusCode;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1627
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1628 /**
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1629 * @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	1630 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1631 * 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	1632 * 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	1633 * - 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	1634 * - 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	1635 * - 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	1636 * - 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	1637 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1638 * @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	1639 * @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	1640 * @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	1641 * @ingroup REST
1594 2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	1642 * @see OrthancPluginSendHttpStatus()
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1643 **/
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1644 ORTHANC_PLUGIN_INLINE void OrthancPluginSendHttpStatusCode(
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1645 OrthancPluginContext* context,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1646 OrthancPluginRestOutput* output,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1647 uint16_t status)
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1648 {
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1649 _OrthancPluginSendHttpStatusCode params;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1650 params.output = output;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1651 params.status = status;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1652 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	1653 }
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1654
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1655
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1656 /**
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1657 * @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	1658 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1659 * 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	1660 * not authorized.
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1661 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1662 * @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	1663 * @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	1664 * @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	1665 * @ingroup REST
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1666 **/
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1667 ORTHANC_PLUGIN_INLINE void OrthancPluginSendUnauthorized(
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1668 OrthancPluginContext* context,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1669 OrthancPluginRestOutput* output,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1670 const char* realm)
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1671 {
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1672 _OrthancPluginOutputPlusArgument params;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1673 params.output = output;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1674 params.argument = realm;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1675 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	1676 }
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1677
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1678
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1679 /**
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1680 * @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	1681 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1682 * 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	1683 * 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	1684 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1685 * @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	1686 * @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	1687 * @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	1688 * @ingroup REST
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1689 **/
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1690 ORTHANC_PLUGIN_INLINE void OrthancPluginSendMethodNotAllowed(
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1691 OrthancPluginContext* context,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1692 OrthancPluginRestOutput* output,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1693 const char* allowedMethods)
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1694 {
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1695 _OrthancPluginOutputPlusArgument params;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1696 params.output = output;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1697 params.argument = allowedMethods;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1698 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	1699 }
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1700
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1701
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1702 typedef struct
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1703 {
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1704 OrthancPluginRestOutput* output;
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1705 const char* key;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1706 const char* value;
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1707 } _OrthancPluginSetHttpHeader;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1708
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1709 /**
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1710 * @brief Set a cookie.
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1711 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1712 * 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	1713 *
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1714 * @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	1715 * @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	1716 * @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	1717 * @param value The value of the cookie.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1718 * @ingroup REST
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1719 **/
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1720 ORTHANC_PLUGIN_INLINE void OrthancPluginSetCookie(
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1721 OrthancPluginContext* context,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1722 OrthancPluginRestOutput* output,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1723 const char* cookie,
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1724 const char* value)
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1725 {
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1726 _OrthancPluginSetHttpHeader params;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1727 params.output = output;
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1728 params.key = cookie;
1042 8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1729 params.value = value;
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1730 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	1731 }
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1732
8d1845feb277 set cookies, not allowed methods, unauthorized in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1041 diff changeset	1733
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1734 /**
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1735 * @brief Set some HTTP header.
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1736 *
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1737 * This function sets a HTTP header in the HTTP answer.
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1738 *
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1739 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1740 * @param output The HTTP connection to the client application.
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1741 * @param key The HTTP header to be set.
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1742 * @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	1743 * @ingroup REST
1137 d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1744 **/
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1745 ORTHANC_PLUGIN_INLINE void OrthancPluginSetHttpHeader(
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1746 OrthancPluginContext* context,
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1747 OrthancPluginRestOutput* output,
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1748 const char* key,
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1749 const char* value)
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1750 {
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1751 _OrthancPluginSetHttpHeader params;
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1752 params.output = output;
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1753 params.key = key;
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1754 params.value = value;
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1755 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, &params);
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1756 }
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1757
d9c27f9f1a51 OrthancPluginSetHttpHeader Sebastien Jodogne <s.jodogne@gmail.com> parents: 1136 diff changeset	1758
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1759 typedef struct
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1760 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1761 char** resultStringToFree;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1762 const char** resultString;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1763 int64_t* resultInt64;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1764 const char* key;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1765 OrthancPluginDicomInstance* instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1766 } _OrthancPluginAccessDicomInstance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1767
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1768
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1769 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1770 * @brief Get the AET of a DICOM instance.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1771 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1772 * 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	1773 * DICOM modality from which a DICOM instance originates.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1774 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1775 * @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	1776 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1777 * @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	1778 * @ingroup Callbacks
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1779 **/
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1780 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceRemoteAet(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1781 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1782 OrthancPluginDicomInstance* instance)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1783 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1784 const char* result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1785
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1786 _OrthancPluginAccessDicomInstance params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1787 memset(&params, 0, sizeof(params));
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1788 params.resultString = &result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1789 params.instance = instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1790
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1791 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	1792 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1793 /* Error */
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1794 return NULL;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1795 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1796 else
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1797 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1798 return result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1799 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1800 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1801
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1802
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1803 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1804 * @brief Get the size of a DICOM file.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1805 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1806 * 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	1807 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1808 * @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	1809 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1810 * @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	1811 * @ingroup Callbacks
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1812 **/
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1813 ORTHANC_PLUGIN_INLINE int64_t OrthancPluginGetInstanceSize(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1814 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1815 OrthancPluginDicomInstance* instance)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1816 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1817 int64_t size;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1818
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1819 _OrthancPluginAccessDicomInstance params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1820 memset(&params, 0, sizeof(params));
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1821 params.resultInt64 = &size;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1822 params.instance = instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1823
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1824 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	1825 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1826 /* Error */
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1827 return -1;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1828 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1829 else
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1830 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1831 return size;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1832 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1833 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1834
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1835
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1836 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1837 * @brief Get the data of a DICOM file.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1838 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1839 * 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	1840 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1841 * @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	1842 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1843 * @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	1844 * @ingroup Callbacks
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1845 **/
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1846 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceData(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1847 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1848 OrthancPluginDicomInstance* instance)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1849 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1850 const char* result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1851
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1852 _OrthancPluginAccessDicomInstance params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1853 memset(&params, 0, sizeof(params));
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1854 params.resultString = &result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1855 params.instance = instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1856
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1857 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	1858 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1859 /* Error */
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1860 return NULL;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1861 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1862 else
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 return result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1865 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1866 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1867
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1868
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1869 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1870 * @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	1871 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1872 * 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	1873 * 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	1874 * of the given DICOM instance.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1875 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1876 * @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	1877 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1878 * @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	1879 * This string must be freed by OrthancPluginFreeString().
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1880 * @ingroup Callbacks
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1881 **/
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1882 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceJson(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1883 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1884 OrthancPluginDicomInstance* instance)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1885 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1886 char* result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1887
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1888 _OrthancPluginAccessDicomInstance params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1889 memset(&params, 0, sizeof(params));
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1890 params.resultStringToFree = &result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1891 params.instance = instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1892
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1893 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	1894 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1895 /* Error */
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1896 return NULL;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1897 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1898 else
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1899 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1900 return result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1901 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1902 }
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
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1905 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1906 * @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	1907 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1908 * 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	1909 * 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	1910 * of the given DICOM instance. In contrast with
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1911 * ::OrthancPluginGetInstanceJson(), the returned JSON file is in
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1912 * its simplified version.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1913 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1914 * @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	1915 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1916 * @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	1917 * This string must be freed by OrthancPluginFreeString().
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	1918 * @ingroup Callbacks
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1919 **/
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1920 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceSimplifiedJson(
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1921 OrthancPluginContext* context,
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1922 OrthancPluginDicomInstance* instance)
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1923 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1924 char* result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1925
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1926 _OrthancPluginAccessDicomInstance params;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1927 memset(&params, 0, sizeof(params));
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1928 params.resultStringToFree = &result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1929 params.instance = instance;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	1930
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1931 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	1932 {
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1933 /* Error */
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1934 return NULL;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1935 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1936 else
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1937 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1938 return result;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1939 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1940 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1941
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1942
1068 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 * @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	1945 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1946 * 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	1947 * 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	1948 * callbacks registered by
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1949 * ::OrthancPluginRegisterOnStoredInstanceCallback(), the only
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1950 * possibly available metadata are "ReceptionDate", "RemoteAET" and
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1951 * "IndexInSeries".
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1952 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1953 * @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	1954 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1955 * @param metadata The metadata of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1956 * @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	1957 * @ingroup Callbacks
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1958 **/
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1959 ORTHANC_PLUGIN_INLINE int OrthancPluginHasInstanceMetadata(
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1960 OrthancPluginContext* context,
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1961 OrthancPluginDicomInstance* instance,
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1962 const char* metadata)
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1963 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1964 int64_t result;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1965
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1966 _OrthancPluginAccessDicomInstance params;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1967 memset(&params, 0, sizeof(params));
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1968 params.resultInt64 = &result;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1969 params.instance = instance;
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1970 params.key = metadata;
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1971
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	1972 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	1973 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1974 /* Error */
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1975 return -1;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1976 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1977 else
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1978 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1979 return (result != 0);
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1980 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1981 }
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1982
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1983
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1984 /**
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1985 * @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	1986 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1987 * 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	1988 * 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	1989 * ::OrthancPluginHasInstanceMetadata().
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1990 *
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1991 * @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	1992 * @param instance The instance of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1993 * @param metadata The metadata of interest.
f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1994 * @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	1995 * @ingroup Callbacks
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	1996 **/
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1997 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceMetadata(
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1998 OrthancPluginContext* context,
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	1999 OrthancPluginDicomInstance* instance,
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2000 const char* metadata)
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2001 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2002 const char* result;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2003
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2004 _OrthancPluginAccessDicomInstance params;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2005 memset(&params, 0, sizeof(params));
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2006 params.resultString = &result;
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2007 params.instance = instance;
1068 f54a9c6fea5d documentation of plugin sdk Sebastien Jodogne <s.jodogne@gmail.com> parents: 1067 diff changeset	2008 params.key = metadata;
1067 ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2009
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2010 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	2011 {
ace99e272203 access metadata in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1066 diff changeset	2012 /* Error */
1066 bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2013 return NULL;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2014 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2015 else
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2016 {
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2017 return result;
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2018 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2019 }
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2020
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2021
bb82e5e818e9 OnStoredInstance callback in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1042 diff changeset	2022
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2023 typedef struct
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2024 {
1295 50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2025 OrthancPluginStorageCreate create;
50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2026 OrthancPluginStorageRead read;
50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2027 OrthancPluginStorageRemove remove;
50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2028 OrthancPluginFree free;
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2029 } _OrthancPluginRegisterStorageArea;
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2030
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2031 /**
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2032 * @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	2033 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2034 * 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	2035 * 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	2036 * 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	2037 * 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	2038 *
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2039 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
1141 2ff467bcfb98 doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1137 diff changeset	2040 * @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	2041 * @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	2042 * @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	2043 * @ingroup Callbacks
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2044 **/
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2045 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	2046 OrthancPluginContext* context,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2047 OrthancPluginStorageCreate create,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2048 OrthancPluginStorageRead read,
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2049 OrthancPluginStorageRemove remove)
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2050 {
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2051 _OrthancPluginRegisterStorageArea params;
1295 50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2052 params.create = create;
50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2053 params.read = read;
50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2054 params.remove = remove;
1136 208dc67b9bab sample custom storage plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1135 diff changeset	2055
208dc67b9bab sample custom storage plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1135 diff changeset	2056 #ifdef __cplusplus
1295 50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2057 params.free = ::free;
1136 208dc67b9bab sample custom storage plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1135 diff changeset	2058 #else
1295 50632b89e294 reorganization Sebastien Jodogne <s.jodogne@gmail.com> parents: 1288 diff changeset	2059 params.free = free;
1136 208dc67b9bab sample custom storage plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1135 diff changeset	2060 #endif
208dc67b9bab sample custom storage plugin Sebastien Jodogne <s.jodogne@gmail.com> parents: 1135 diff changeset	2061
1135 67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2062 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	2063 }
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2064
67c3c1e4a6e0 index-only mode, and custom storage area with plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1069 diff changeset	2065
1145 0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2066
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2067 /**
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2068 * @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	2069 *
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2070 * 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	2071 *
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2072 * @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	2073 * @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	2074 * 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	2075 * OrthancPluginFreeString().
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2076 **/
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2077 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	2078 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2079 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	2080
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2081 _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	2082 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	2083 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	2084
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2085 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	2086 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2087 /* Error */
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2088 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	2089 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2090 else
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2091 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2092 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	2093 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2094 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2095
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2096
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2097 /**
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2098 * @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	2099 *
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2100 * 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	2101 *
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2102 * @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	2103 * @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	2104 * 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	2105 * OrthancPluginFreeString().
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2106 **/
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2107 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	2108 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2109 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	2110
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2111 _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	2112 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	2113 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	2114
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2115 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	2116 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2117 /* Error */
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2118 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	2119 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2120 else
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2121 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2122 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	2123 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2124 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2125
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2126
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2127 /**
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	2128 * @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	2129 *
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	2130 * 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	2131 * 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	2132 * 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	2133 * files. This function is deprecated in favor of
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2134 * 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	2135 *
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2136 * @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	2137 * @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	2138 * 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	2139 * OrthancPluginFreeString().
1424 fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2140 * @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	2141 **/
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2142 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	2143 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2144 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	2145
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2146 _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	2147 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	2148 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	2149
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2150 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	2151 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2152 /* Error */
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2153 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	2154 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2155 else
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2156 {
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2157 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	2158 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2159 }
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2160
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2161
0479d02c6778 Plugins can retrieve the path to Orthanc and to its configuration file Sebastien Jodogne <s.jodogne@gmail.com> parents: 1141 diff changeset	2162
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2163 typedef struct
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2164 {
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2165 OrthancPluginOnChangeCallback callback;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2166 } _OrthancPluginOnChangeCallback;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2167
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2168 /**
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2169 * @brief Register a callback to monitor changes.
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2170 *
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2171 * 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	2172 * whenever a change happens to some DICOM resource.
1642 0669d05b6de1 warning about OrthancPluginRegisterOnChangeCallback Sebastien Jodogne <s.jodogne@gmail.com> parents: 1630 diff changeset	2173 *
0669d05b6de1 warning about OrthancPluginRegisterOnChangeCallback Sebastien Jodogne <s.jodogne@gmail.com> parents: 1630 diff changeset	2174 * @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	2175 * 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	2176 * the events passing through a message queue). Otherwise, this
0669d05b6de1 warning about OrthancPluginRegisterOnChangeCallback Sebastien Jodogne <s.jodogne@gmail.com> parents: 1630 diff changeset	2177 * 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	2178 * script.
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2179 *
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2180 * @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	2181 * @param callback The callback function.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2182 * @ingroup Callbacks
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2183 **/
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2184 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterOnChangeCallback(
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2185 OrthancPluginContext* context,
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2186 OrthancPluginOnChangeCallback callback)
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2187 {
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2188 _OrthancPluginOnChangeCallback params;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2189 params.callback = callback;
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2190
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2191 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, &params);
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2192 }
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2193
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2194
5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2195
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2196 typedef struct
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2197 {
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2198 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	2199 _OrthancPluginProperty property;
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2200 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	2201 } _OrthancPluginSetPluginProperty;
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2202
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2203
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2204 /**
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2205 * @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	2206 *
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2207 * 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	2208 * 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	2209 * 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	2210 * Explorer.
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2211 *
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2212 * @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	2213 * @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	2214 **/
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2215 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	2216 OrthancPluginContext* context,
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2217 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	2218 {
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2219 _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	2220 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	2221 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	2222 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	2223
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2224 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	2225 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2226
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2227
1233 eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2228 /**
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2229 * @brief Set a description for this plugin.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2230 *
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2231 * Set a description for this plugin. It is displayed in the
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2232 * "Plugins" page of Orthanc Explorer.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2233 *
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2234 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2235 * @param description The description.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2236 **/
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2237 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	2238 OrthancPluginContext* context,
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2239 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	2240 {
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2241 _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	2242 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	2243 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	2244 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	2245
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2246 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	2247 }
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2248
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2249
1233 eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2250 /**
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2251 * @brief Extend the JavaScript code of Orthanc Explorer.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2252 *
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2253 * Add JavaScript code to customize the default behavior of Orthanc
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2254 * Explorer. This can for instance be used to add new buttons.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2255 *
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2256 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2257 * @param javascript The custom JavaScript code.
eac00401cb96 fixes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1232 diff changeset	2258 **/
1232 f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2259 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	2260 OrthancPluginContext* context,
f1c01451a8ee Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript Sebastien Jodogne <s.jodogne@gmail.com> parents: 1198 diff changeset	2261 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	2262 {
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2263 _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	2264 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	2265 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	2266 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	2267
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2268 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	2269 }
1177 5b2d8c280ac2 Plugins can monitor changes through callbacks Sebastien Jodogne <s.jodogne@gmail.com> parents: 1145 diff changeset	2270
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2271
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2272 typedef struct
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2273 {
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2274 char** result;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2275 int32_t property;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2276 const char* value;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2277 } _OrthancPluginGlobalProperty;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2278
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2279
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2280 /**
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2281 * @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	2282 *
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2283 * 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	2284 * 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	2285 *
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2286 * @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	2287 * @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	2288 * @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	2289 * @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	2290 * string must be freed by OrthancPluginFreeString().
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2291 * @ingroup Orthanc
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2292 **/
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2293 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	2294 OrthancPluginContext* context,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2295 int32_t property,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2296 const char* defaultValue)
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2297 {
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2298 char* result;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2299
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2300 _OrthancPluginGlobalProperty params;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2301 params.result = &result;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2302 params.property = property;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2303 params.value = defaultValue;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2304
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2305 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	2306 {
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2307 /* Error */
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2308 return NULL;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2309 }
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2310 else
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2311 {
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2312 return result;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2313 }
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2314 }
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2315
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2316
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2317 /**
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2318 * @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	2319 *
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2320 * 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	2321 * 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	2322 * 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	2323 * 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	2324 * 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	2325 *
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2326 * @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	2327 * @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	2328 * @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	2329 * @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	2330 * @ingroup Orthanc
1249 40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2331 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2332 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	2333 OrthancPluginContext* context,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2334 int32_t property,
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2335 const char* value)
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2336 {
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2337 _OrthancPluginGlobalProperty params;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2338 params.result = NULL;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2339 params.property = property;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2340 params.value = value;
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2341
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2342 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	2343 }
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2344
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2345
40725595aaf0 Plugins can get/set global properties to save their configuration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1233 diff changeset	2346
1280 d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2347 typedef struct
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2348 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2349 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	2350 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	2351 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	2352 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	2353 } _OrthancPluginReturnSingleValue;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2354
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2355 /**
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2356 * @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	2357 *
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2358 * 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	2359 *
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2360 * @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	2361 * @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	2362 **/
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2363 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	2364 OrthancPluginContext* context)
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2365 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2366 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	2367
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2368 _OrthancPluginReturnSingleValue params;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2369 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	2370 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	2371
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2372 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	2373 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2374 /* Error */
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2375 return 0;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2376 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2377 else
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2378 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2379 return count;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2380 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2381 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2382
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2383
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2384
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2385 /**
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2386 * @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	2387 *
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2388 * 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	2389 * 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	2390 * 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	2391 *
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2392 * @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	2393 * @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	2394 * @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	2395 * 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	2396 **/
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2397 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	2398 OrthancPluginContext* context,
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2399 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	2400 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2401 char* result;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2402
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2403 _OrthancPluginGlobalProperty params;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2404 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	2405 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	2406 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	2407
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2408 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	2409 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2410 /* Error */
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2411 return NULL;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2412 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2413 else
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2414 {
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2415 return result;
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2416 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2417 }
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2418
d6a65dc6d0ac Plugins can access the command-line arguments used to launch Orthanc Sebastien Jodogne <s.jodogne@gmail.com> parents: 1249 diff changeset	2419
1407 d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2420 /**
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2421 * @brief Get the expected version of the database schema.
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2422 *
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2423 * Retrieve the expected version of the database schema.
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2424 *
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2425 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2426 * @return The version.
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2427 * @ingroup Callbacks
1615 c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	2428 * @deprecated Please instead use IDatabaseBackend::UpgradeDatabase()
1407 d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2429 **/
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2430 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetExpectedDatabaseVersion(
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2431 OrthancPluginContext* context)
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2432 {
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2433 uint32_t count = 0;
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2434
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2435 _OrthancPluginReturnSingleValue params;
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2436 memset(&params, 0, sizeof(params));
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2437 params.resultUint32 = &count;
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2438
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2439 if (context->InvokeService(context, _OrthancPluginService_GetExpectedDatabaseVersion, &params) != OrthancPluginErrorCode_Success)
1407 d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2440 {
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2441 /* Error */
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2442 return 0;
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2443 }
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2444 else
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2445 {
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2446 return count;
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2447 }
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2448 }
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2449
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2450
d371a66972a4 OrthancPluginGetExpectedDatabaseVersion Sebastien Jodogne <s.jodogne@gmail.com> parents: 1322 diff changeset	2451
1424 fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2452 /**
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2453 * @brief Return the content of the configuration file(s).
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2454 *
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2455 * This function returns the content of the configuration that is
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2456 * used by Orthanc, formatted as a JSON string.
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2457 *
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2458 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2459 * @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	2460 * containing the configuration. This string must be freed by
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2461 * OrthancPluginFreeString().
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2462 **/
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2463 ORTHANC_PLUGIN_INLINE char OrthancPluginGetConfiguration(OrthancPluginContext context)
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2464 {
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2465 char* result;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2466
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2467 _OrthancPluginRetrieveDynamicString params;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2468 params.result = &result;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2469 params.argument = NULL;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2470
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2471 if (context->InvokeService(context, _OrthancPluginService_GetConfiguration, &params) != OrthancPluginErrorCode_Success)
1424 fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2472 {
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2473 /* Error */
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2474 return NULL;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2475 }
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2476 else
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2477 {
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2478 return result;
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2479 }
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2480 }
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2481
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2482
fe384a9d3b51 OrthancPluginGetConfiguration Sebastien Jodogne <s.jodogne@gmail.com> parents: 1423 diff changeset	2483
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2484 typedef struct
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2485 {
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2486 OrthancPluginRestOutput* output;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2487 const char* subType;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2488 const char* contentType;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2489 } _OrthancPluginStartMultipartAnswer;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2490
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2491 /**
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2492 * @brief Start an HTTP multipart answer.
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2493 *
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2494 * 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	2495 *
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2496 * @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	2497 * @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	2498 * @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	2499 * @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	2500 * @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	2501 * @see OrthancPluginSendMultipartItem()
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2502 * @ingroup REST
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2503 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2504 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2505 OrthancPluginContext* context,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2506 OrthancPluginRestOutput* output,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2507 const char* subType,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2508 const char* contentType)
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2509 {
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2510 _OrthancPluginStartMultipartAnswer params;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2511 params.output = output;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2512 params.subType = subType;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2513 params.contentType = contentType;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2514 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	2515 }
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2516
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2517
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2518 /**
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2519 * @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	2520 *
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2521 * 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	2522 * answer that was initiated by OrthancPluginStartMultipartAnswer().
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2523 *
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2524 * @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	2525 * @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	2526 * @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	2527 * @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	2528 * @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	2529 * 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	2530 * @ingroup REST
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2531 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2532 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginSendMultipartItem(
1430 ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2533 OrthancPluginContext* context,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2534 OrthancPluginRestOutput* output,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2535 const char* answer,
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2536 uint32_t answerSize)
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2537 {
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2538 _OrthancPluginAnswerBuffer params;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2539 params.output = output;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2540 params.answer = answer;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2541 params.answerSize = answerSize;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2542 params.mimeType = NULL;
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2543 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	2544 }
ad94a3583b07 Plugins can send answers as multipart messages Sebastien Jodogne <s.jodogne@gmail.com> parents: 1426 diff changeset	2545
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2546
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2547
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2548 typedef struct
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2549 {
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2550 OrthancPluginMemoryBuffer* target;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2551 const void* source;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2552 uint32_t size;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2553 OrthancPluginCompressionType compression;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2554 uint8_t uncompress;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2555 } _OrthancPluginBufferCompression;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2556
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2557
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2558 /**
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2559 * @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	2560 *
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2561 * 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	2562 * 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	2563 *
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2564 * @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	2565 * @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	2566 * @param source The source buffer.
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2567 * @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	2568 * @param compression The compression algorithm.
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2569 * @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	2570 * 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	2571 * @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	2572 * @ingroup Images
1554 89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2573 **/
1581 357c4bb15701 Plugins have access to explicit error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1580 diff changeset	2574 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	2575 OrthancPluginContext* context,
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2576 OrthancPluginMemoryBuffer* target,
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2577 const void* source,
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2578 uint32_t size,
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2579 OrthancPluginCompressionType compression,
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2580 uint8_t uncompress)
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2581 {
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2582 _OrthancPluginBufferCompression params;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2583 params.target = target;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2584 params.source = source;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2585 params.size = size;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2586 params.compression = compression;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2587 params.uncompress = uncompress;
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2588
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2589 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	2590 }
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2591
89ab71a68fcf New function OrthancPluginBufferCompression() to (un)compress memory buffers Sebastien Jodogne <s.jodogne@gmail.com> parents: 1466 diff changeset	2592
1588 b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2593
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2594 typedef struct
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2595 {
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2596 OrthancPluginMemoryBuffer* target;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2597 const char* path;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2598 } _OrthancPluginReadFile;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2599
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2600 /**
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2601 * @brief Read a file.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2602 *
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2603 * 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	2604 * a newly allocated memory buffer.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2605 *
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2606 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2607 * @param target The target memory buffer.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2608 * @param path The path of the file to be read.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2609 * @return 0 if success, or the error code if failure.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2610 **/
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2611 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginReadFile(
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2612 OrthancPluginContext* context,
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2613 OrthancPluginMemoryBuffer* target,
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2614 const char* path)
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2615 {
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2616 _OrthancPluginReadFile params;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2617 params.target = target;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2618 params.path = path;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2619 return context->InvokeService(context, _OrthancPluginService_ReadFile, &params);
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2620 }
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2621
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2622
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2623
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2624 typedef struct
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2625 {
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2626 const char* path;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2627 const void* data;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2628 uint32_t size;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2629 } _OrthancPluginWriteFile;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2630
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2631 /**
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2632 * @brief Write a file.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2633 *
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2634 * Write the content of a memory buffer to the filesystem.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2635 *
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2636 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2637 * @param path The path of the file to be written.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2638 * @param data The content of the memory buffer.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2639 * @param size The size of the memory buffer.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2640 * @return 0 if success, or the error code if failure.
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2641 **/
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2642 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginWriteFile(
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2643 OrthancPluginContext* context,
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2644 const char* path,
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2645 const void* data,
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2646 uint32_t size)
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2647 {
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2648 _OrthancPluginWriteFile params;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2649 params.path = path;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2650 params.data = data;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2651 params.size = size;
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2652 return context->InvokeService(context, _OrthancPluginService_WriteFile, &params);
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2653 }
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2654
b5bc87a7212d OrthancPluginReadFile, OrthancPluginWriteFile Sebastien Jodogne <s.jodogne@gmail.com> parents: 1583 diff changeset	2655
1593 235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2656
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2657 typedef struct
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2658 {
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2659 const char** target;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2660 OrthancPluginErrorCode error;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2661 } _OrthancPluginGetErrorDescription;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2662
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2663 /**
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2664 * @brief Get the description of a given error code.
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2665 *
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2666 * This function returns the description of a given error code.
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2667 *
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2668 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	2669 * @param error The error code of interest.
1593 235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2670 * @return The error description. This is a statically-allocated
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2671 * string, do not free it.
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2672 **/
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2673 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetErrorDescription(
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2674 OrthancPluginContext* context,
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2675 OrthancPluginErrorCode error)
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2676 {
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2677 const char* result = NULL;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2678
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2679 _OrthancPluginGetErrorDescription params;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2680 params.target = &result;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2681 params.error = error;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2682
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2683 if (context->InvokeService(context, _OrthancPluginService_GetErrorDescription, &params) != OrthancPluginErrorCode_Success \|\|
1593 235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2684 result == NULL)
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2685 {
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2686 return "Unknown error code";
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2687 }
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2688 else
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2689 {
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2690 return result;
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2691 }
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2692 }
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2693
235d89817b89 OrthancPluginGetErrorDescription Sebastien Jodogne <s.jodogne@gmail.com> parents: 1588 diff changeset	2694
1594 2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2695
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2696 typedef struct
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2697 {
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2698 OrthancPluginRestOutput* output;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2699 uint16_t status;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2700 const char* body;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2701 uint32_t bodySize;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2702 } _OrthancPluginSendHttpStatus;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2703
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2704 /**
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2705 * @brief Send a HTTP status, with a custom body.
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2706 *
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2707 * This function answers to a HTTP request by sending a HTTP status
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2708 * code (such as "400 - Bad Request"), together with a body
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2709 * describing the error. The body will only be returned if the
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2710 * configuration option "HttpDescribeErrors" of Orthanc is set to "true".
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2711 *
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2712 * Note that:
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2713 * - Successful requests (status 200) must use ::OrthancPluginAnswerBuffer().
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2714 * - Redirections (status 301) must use ::OrthancPluginRedirect().
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2715 * - Unauthorized access (status 401) must use ::OrthancPluginSendUnauthorized().
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2716 * - Methods not allowed (status 405) must use ::OrthancPluginSendMethodNotAllowed().
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2717 *
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2718 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2719 * @param output The HTTP connection to the client application.
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2720 * @param status The HTTP status code to be sent.
1595 e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	2721 * @param body The body of the answer.
e1e54a73ba8b OrthancPluginRegisterRestCallbackNoLock, documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1594 diff changeset	2722 * @param bodySize The size of the body.
1594 2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2723 * @see OrthancPluginSendHttpStatusCode()
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	2724 * @ingroup REST
1594 2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2725 **/
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2726 ORTHANC_PLUGIN_INLINE void OrthancPluginSendHttpStatus(
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2727 OrthancPluginContext* context,
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2728 OrthancPluginRestOutput* output,
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2729 uint16_t status,
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2730 const char* body,
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2731 uint32_t bodySize)
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2732 {
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2733 _OrthancPluginSendHttpStatus params;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2734 params.output = output;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2735 params.status = status;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2736 params.body = body;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2737 params.bodySize = bodySize;
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2738 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, &params);
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2739 }
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2740
2bac60a4f584 OrthancPluginSendHttpStatus Sebastien Jodogne <s.jodogne@gmail.com> parents: 1593 diff changeset	2741
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2742
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2743 typedef struct
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2744 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2745 const OrthancPluginImage* image;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2746 uint32_t* resultUint32;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2747 OrthancPluginPixelFormat* resultPixelFormat;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2748 const void** resultBuffer;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2749 } _OrthancPluginGetImageInfo;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2750
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2751
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2752 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2753 * @brief Return the pixel format of an image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2754 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2755 * 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	2756 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2757 * @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	2758 * @param image The image of interest.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2759 * @return The pixel format.
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	2760 * @ingroup Images
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2761 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2762 ORTHANC_PLUGIN_INLINE OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2763 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2764 const OrthancPluginImage* image)
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2765 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2766 OrthancPluginPixelFormat target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2767
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2768 _OrthancPluginGetImageInfo params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2769 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2770 params.image = image;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2771 params.resultPixelFormat = &target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2772
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2773 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	2774 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2775 return OrthancPluginPixelFormat_Unknown;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2776 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2777 else
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2778 {
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2779 return (OrthancPluginPixelFormat) target;
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2780 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2781 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2782
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2783
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2784
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2785 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2786 * @brief Return the width of an image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2787 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2788 * This function returns the width of the given image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2789 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2790 * @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	2791 * @param image The image of interest.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2792 * @return The width.
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	2793 * @ingroup Images
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2794 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2795 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetImageWidth(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2796 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2797 const OrthancPluginImage* image)
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2798 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2799 uint32_t width;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2800
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2801 _OrthancPluginGetImageInfo params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2802 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2803 params.image = image;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2804 params.resultUint32 = &width;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2805
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2806 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	2807 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2808 return 0;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2809 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2810 else
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2811 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2812 return width;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2813 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2814 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2815
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2816
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2817
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2818 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2819 * @brief Return the height of an image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2820 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2821 * This function returns the height of the given image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2822 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2823 * @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	2824 * @param image The image of interest.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2825 * @return The height.
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	2826 * @ingroup Images
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2827 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2828 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetImageHeight(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2829 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2830 const OrthancPluginImage* image)
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2831 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2832 uint32_t height;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2833
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2834 _OrthancPluginGetImageInfo params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2835 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2836 params.image = image;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2837 params.resultUint32 = &height;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2838
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2839 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	2840 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2841 return 0;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2842 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2843 else
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2844 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2845 return height;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2846 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2847 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2848
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2849
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2850
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2851 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2852 * @brief Return the pitch of an image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2853 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2854 * 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	2855 * 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	2856 * image in the memory buffer.
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 * @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	2859 * @param image The image of interest.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2860 * @return The pitch.
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	2861 * @ingroup Images
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2862 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2863 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetImagePitch(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2864 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2865 const OrthancPluginImage* image)
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2866 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2867 uint32_t pitch;
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 _OrthancPluginGetImageInfo params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2870 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2871 params.image = image;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2872 params.resultUint32 = &pitch;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2873
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2874 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	2875 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2876 return 0;
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 else
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 return pitch;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2881 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2882 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2883
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
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2886 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2887 * @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	2888 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2889 * 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	2890 * contains the pixels of the image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2891 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2892 * @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	2893 * @param image The image of interest.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2894 * @return The pointer.
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	2895 * @ingroup Images
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2896 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2897 ORTHANC_PLUGIN_INLINE const void* OrthancPluginGetImageBuffer(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2898 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2899 const OrthancPluginImage* image)
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2900 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2901 const void* target = NULL;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2902
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2903 _OrthancPluginGetImageInfo params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2904 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2905 params.resultBuffer = &target;
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
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2908 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	2909 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2910 return NULL;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2911 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2912 else
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2913 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2914 return target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2915 }
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 typedef struct
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2920 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2921 OrthancPluginImage** target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2922 const void* data;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2923 uint32_t size;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2924 OrthancPluginImageFormat format;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2925 } _OrthancPluginUncompressImage;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2926
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2927
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2928 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2929 * @brief Decode a compressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2930 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2931 * 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	2932 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2933 * @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	2934 * @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	2935 * @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	2936 * @param format The file format of the compressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2937 * @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	2938 * @ingroup Images
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2939 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2940 ORTHANC_PLUGIN_INLINE OrthancPluginImage *OrthancPluginUncompressImage(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2941 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2942 const void* data,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2943 uint32_t size,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2944 OrthancPluginImageFormat format)
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 OrthancPluginImage* target = NULL;
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 _OrthancPluginUncompressImage params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2949 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2950 params.target = &target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2951 params.data = data;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2952 params.size = size;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2953 params.format = format;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2954
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	2955 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	2956 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2957 return NULL;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2958 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2959 else
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2960 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2961 return target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2962 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2963 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2964
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2965
1605 fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	2966
fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	2967
fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	2968 typedef struct
fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	2969 {
fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	2970 OrthancPluginImage* image;
fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	2971 } _OrthancPluginFreeImage;
fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	2972
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2973 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2974 * @brief Free an image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2975 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2976 * 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	2977 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2978 * @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	2979 * @param image The image.
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	2980 * @ingroup Images
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	2981 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2982 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeImage(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2983 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2984 OrthancPluginImage* image)
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2985 {
1605 fd0464ce1962 fix Sebastien Jodogne <s.jodogne@gmail.com> parents: 1602 diff changeset	2986 _OrthancPluginFreeImage params;
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2987 params.image = image;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2988
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2989 context->InvokeService(context, _OrthancPluginService_FreeImage, &params);
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2990 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2991
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2992
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2993
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2994
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2995 typedef struct
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2996 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2997 OrthancPluginMemoryBuffer* target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2998 OrthancPluginImageFormat imageFormat;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	2999 OrthancPluginPixelFormat pixelFormat;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3000 uint32_t width;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3001 uint32_t height;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3002 uint32_t pitch;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3003 const void* buffer;
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	3004 uint8_t quality;
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3005 } _OrthancPluginCompressImage;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3006
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3007
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3008 /**
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	3009 * @brief Encode a PNG image.
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3010 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3011 * This function compresses the given memory buffer containing an
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3012 * 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	3013 * compression into a newly allocated memory buffer.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3014 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3015 * @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	3016 * @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	3017 * @param format The memory layout of the uncompressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3018 * @param width The width of the image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3019 * @param height The height of the image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3020 * @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	3021 * 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	3022 * @param buffer The memory buffer containing the uncompressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3023 * @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	3024 * @see OrthancPluginCompressAndAnswerPngImage()
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3025 * @ingroup Images
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3026 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3027 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCompressPngImage(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3028 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3029 OrthancPluginMemoryBuffer* target,
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3030 OrthancPluginPixelFormat format,
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3031 uint32_t width,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3032 uint32_t height,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3033 uint32_t pitch,
1599 dd1f9e81f891 fixes to image primitives Sebastien Jodogne <s.jodogne@gmail.com> parents: 1598 diff changeset	3034 const void* buffer)
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3035 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3036 _OrthancPluginCompressImage params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3037 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3038 params.target = target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3039 params.imageFormat = OrthancPluginImageFormat_Png;
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3040 params.pixelFormat = format;
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3041 params.width = width;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3042 params.height = height;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3043 params.pitch = pitch;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3044 params.buffer = buffer;
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3045 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	3046
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3047 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	3048 }
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3049
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3050
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3051 /**
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	3052 * @brief Encode a JPEG image.
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3053 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3054 * This function compresses the given memory buffer containing an
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3055 * 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	3056 * compression into a newly allocated memory buffer.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3057 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3058 * @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	3059 * @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	3060 * @param format The memory layout of the uncompressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3061 * @param width The width of the image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3062 * @param height The height of the image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3063 * @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	3064 * 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	3065 * @param buffer The memory buffer containing the uncompressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3066 * @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	3067 * quality, best compression) and 100 (best quality, worst
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3068 * compression).
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3069 * @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	3070 * @ingroup Images
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3071 **/
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3072 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCompressJpegImage(
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3073 OrthancPluginContext* context,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3074 OrthancPluginMemoryBuffer* target,
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3075 OrthancPluginPixelFormat format,
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3076 uint32_t width,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3077 uint32_t height,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3078 uint32_t pitch,
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3079 const void* buffer,
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3080 uint8_t quality)
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3081 {
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3082 _OrthancPluginCompressImage params;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3083 memset(&params, 0, sizeof(params));
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3084 params.target = target;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3085 params.imageFormat = OrthancPluginImageFormat_Jpeg;
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3086 params.pixelFormat = format;
1598 c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3087 params.width = width;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3088 params.height = height;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3089 params.pitch = pitch;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3090 params.buffer = buffer;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3091 params.quality = quality;
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3092
c6b50b803387 primitives for image encoding/decoding in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1596 diff changeset	3093 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	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
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3098 /**
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3099 * @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	3100 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3101 * 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	3102 * parameters of this function describe a memory buffer that
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3103 * 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	3104 * 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	3105 *
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3106 * @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	3107 * @param output The HTTP connection to the client application.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3108 * @param format The memory layout of the uncompressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3109 * @param width The width of the image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3110 * @param height The height of the image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3111 * @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	3112 * 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	3113 * @param buffer The memory buffer containing the uncompressed image.
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3114 * @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	3115 * quality, best compression) and 100 (best quality, worst
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3116 * compression).
1601 6cccf1da35c6 groups in the plugin documentation Sebastien Jodogne <s.jodogne@gmail.com> parents: 1600 diff changeset	3117 * @ingroup REST
1600 7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3118 **/
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3119 ORTHANC_PLUGIN_INLINE void OrthancPluginCompressAndAnswerJpegImage(
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3120 OrthancPluginContext* context,
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3121 OrthancPluginRestOutput* output,
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3122 OrthancPluginPixelFormat format,
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3123 uint32_t width,
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3124 uint32_t height,
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3125 uint32_t pitch,
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3126 const void* buffer,
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3127 uint8_t quality)
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3128 {
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3129 _OrthancPluginCompressAndAnswerImage params;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3130 params.output = output;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3131 params.imageFormat = OrthancPluginImageFormat_Jpeg;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3132 params.pixelFormat = format;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3133 params.width = width;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3134 params.height = height;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3135 params.pitch = pitch;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3136 params.buffer = buffer;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3137 params.quality = quality;
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3138 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, &params);
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3139 }
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3140
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3141
7151d63e6d81 documentation, primitives for jpeg Sebastien Jodogne <s.jodogne@gmail.com> parents: 1599 diff changeset	3142
1606 31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3143
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3144 typedef struct
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3145 {
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3146 OrthancPluginMemoryBuffer* target;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3147 OrthancPluginHttpMethod method;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3148 const char* url;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3149 const char* username;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3150 const char* password;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3151 const char* body;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3152 uint32_t bodySize;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3153 } _OrthancPluginCallHttpClient;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3154
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3155
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3156 /**
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3157 * @brief Issue a HTTP GET call.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3158 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3159 * 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	3160 * 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	3161 * 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	3162 * Orthanc instance that hosts this plugin.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3163 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3164 * @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	3165 * @param target The target memory buffer.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3166 * @param url The URL of interest.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3167 * @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	3168 * @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	3169 * @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	3170 **/
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3171 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpGet(
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3172 OrthancPluginContext* context,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3173 OrthancPluginMemoryBuffer* target,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3174 const char* url,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3175 const char* username,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3176 const char* password)
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3177 {
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3178 _OrthancPluginCallHttpClient params;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3179 memset(&params, 0, sizeof(params));
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3180
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3181 params.target = target;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3182 params.method = OrthancPluginHttpMethod_Get;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3183 params.url = url;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3184 params.username = username;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3185 params.password = password;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3186
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3187 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	3188 }
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3189
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3190
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3191 /**
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3192 * @brief Issue a HTTP POST call.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3193 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3194 * 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	3195 * 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	3196 * 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	3197 * 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	3198 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3199 * @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	3200 * @param target The target memory buffer.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3201 * @param url The URL of interest.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3202 * @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	3203 * @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	3204 * @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	3205 * @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	3206 * @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	3207 **/
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3208 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpPost(
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3209 OrthancPluginContext* context,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3210 OrthancPluginMemoryBuffer* target,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3211 const char* url,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3212 const char* body,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3213 uint32_t bodySize,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3214 const char* username,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3215 const char* password)
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3216 {
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3217 _OrthancPluginCallHttpClient params;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3218 memset(&params, 0, sizeof(params));
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3219
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3220 params.target = target;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3221 params.method = OrthancPluginHttpMethod_Post;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3222 params.url = url;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3223 params.body = body;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3224 params.bodySize = bodySize;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3225 params.username = username;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3226 params.password = password;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3227
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3228 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	3229 }
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3230
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3231
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3232 /**
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3233 * @brief Issue a HTTP PUT call.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3234 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3235 * 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	3236 * 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	3237 * 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	3238 * Orthanc instance that hosts this plugin.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3239 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3240 * @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	3241 * @param target The target memory buffer.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3242 * @param url The URL of interest.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3243 * @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	3244 * @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	3245 * @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	3246 * @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	3247 * @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	3248 **/
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3249 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpPut(
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3250 OrthancPluginContext* context,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3251 OrthancPluginMemoryBuffer* target,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3252 const char* url,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3253 const char* body,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3254 uint32_t bodySize,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3255 const char* username,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3256 const char* password)
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 _OrthancPluginCallHttpClient params;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3259 memset(&params, 0, sizeof(params));
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3260
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3261 params.target = target;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3262 params.method = OrthancPluginHttpMethod_Put;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3263 params.url = url;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3264 params.body = body;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3265 params.bodySize = bodySize;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3266 params.username = username;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3267 params.password = password;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3268
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3269 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	3270 }
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3271
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3272
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3273 /**
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3274 * @brief Issue a HTTP DELETE call.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3275 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3276 * 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	3277 * 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	3278 * 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	3279 *
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3280 * @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	3281 * @param url The URL of interest.
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3282 * @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	3283 * @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	3284 * @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	3285 **/
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3286 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpDelete(
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3287 OrthancPluginContext* context,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3288 const char* url,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3289 const char* username,
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3290 const char* password)
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 _OrthancPluginCallHttpClient params;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3293 memset(&params, 0, sizeof(params));
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 params.method = OrthancPluginHttpMethod_Delete;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3296 params.url = url;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3297 params.username = username;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3298 params.password = password;
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3299
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3300 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	3301 }
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3302
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3303
31f4adefb88f issuing HTTP requests from the plugin SDK Sebastien Jodogne <s.jodogne@gmail.com> parents: 1605 diff changeset	3304
1608 adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3305 typedef struct
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3306 {
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3307 OrthancPluginImage** target;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3308 const OrthancPluginImage* source;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3309 OrthancPluginPixelFormat targetFormat;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3310 } _OrthancPluginConvertPixelFormat;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3311
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3312
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3313 /**
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3314 * @brief Change the pixel format of an image.
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3315 *
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3316 * 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	3317 *
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3318 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3319 * @param source The source image.
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3320 * @param targetFormat The target pixel format.
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3321 * @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	3322 * @ingroup Images
1608 adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3323 **/
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3324 ORTHANC_PLUGIN_INLINE OrthancPluginImage *OrthancPluginConvertPixelFormat(
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3325 OrthancPluginContext* context,
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3326 const OrthancPluginImage* source,
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3327 OrthancPluginPixelFormat targetFormat)
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3328 {
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3329 OrthancPluginImage* target = NULL;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3330
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3331 _OrthancPluginConvertPixelFormat params;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3332 params.target = &target;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3333 params.source = source;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3334 params.targetFormat = targetFormat;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3335
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3336 if (context->InvokeService(context, _OrthancPluginService_ConvertPixelFormat, &params) != OrthancPluginErrorCode_Success)
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3337 {
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3338 return NULL;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3339 }
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3340 else
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3341 {
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3342 return target;
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3343 }
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3344 }
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3345
adc6a5704cdb OrthancPluginConvertPixelFormat Sebastien Jodogne <s.jodogne@gmail.com> parents: 1606 diff changeset	3346
1613 1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3347
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3348 /**
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3349 * @brief Return the number of available fonts.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3350 *
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3351 * 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	3352 * 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	3353 * through OrthancPluginDrawText().
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3354 *
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3355 * @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	3356 * @return The number of fonts.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3357 * @ingroup Images
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3358 **/
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3359 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetFontsCount(
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3360 OrthancPluginContext* context)
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3361 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3362 uint32_t count = 0;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3363
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3364 _OrthancPluginReturnSingleValue params;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3365 memset(&params, 0, sizeof(params));
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3366 params.resultUint32 = &count;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3367
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3368 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	3369 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3370 /* Error */
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3371 return 0;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3372 }
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3373 else
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3374 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3375 return count;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3376 }
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3377 }
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3378
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3379
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3380
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3381
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3382 typedef struct
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3383 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3384 uint32_t fontIndex; /* in */
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3385 const char** name; /* out */
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3386 uint32_t* size; /* out */
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3387 } _OrthancPluginGetFontInfo;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3388
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3389 /**
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3390 * @brief Return the name of a font.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3391 *
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3392 * 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	3393 *
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3394 * @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	3395 * @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	3396 * @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	3397 * @ingroup Images
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3398 **/
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3399 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetFontName(
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3400 OrthancPluginContext* context,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3401 uint32_t fontIndex)
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3402 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3403 const char* result = NULL;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3404
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3405 _OrthancPluginGetFontInfo params;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3406 memset(&params, 0, sizeof(params));
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3407 params.name = &result;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3408 params.fontIndex = fontIndex;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3409
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3410 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	3411 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3412 return NULL;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3413 }
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3414 else
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3415 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3416 return result;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3417 }
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3418 }
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3419
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3420
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3421 /**
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3422 * @brief Return the size of a font.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3423 *
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3424 * 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	3425 *
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3426 * @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	3427 * @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	3428 * @return The font size.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3429 * @ingroup Images
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3430 **/
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3431 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetFontSize(
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3432 OrthancPluginContext* context,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3433 uint32_t fontIndex)
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3434 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3435 uint32_t result;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3436
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3437 _OrthancPluginGetFontInfo params;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3438 memset(&params, 0, sizeof(params));
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3439 params.size = &result;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3440 params.fontIndex = fontIndex;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3441
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3442 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	3443 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3444 return 0;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3445 }
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3446 else
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3447 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3448 return result;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3449 }
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
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 typedef struct
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3455 {
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3456 OrthancPluginImage* image;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3457 uint32_t fontIndex;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3458 const char* utf8Text;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3459 int32_t x;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3460 int32_t y;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3461 uint8_t r;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3462 uint8_t g;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3463 uint8_t b;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3464 } _OrthancPluginDrawText;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3465
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 /**
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3468 * @brief Draw text on an image.
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3469 *
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3470 * 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	3471 *
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3472 * @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	3473 * @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	3474 * @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	3475 * @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	3476 * @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	3477 * @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	3478 * @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	3479 * @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	3480 * @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	3481 * @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	3482 * @ingroup Images
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 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginDrawText(
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3485 OrthancPluginContext* context,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3486 OrthancPluginImage* image,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3487 uint32_t fontIndex,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3488 const char* utf8Text,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3489 int32_t x,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3490 int32_t y,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3491 uint8_t r,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3492 uint8_t g,
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3493 uint8_t b)
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 _OrthancPluginDrawText params;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3496 memset(&params, 0, sizeof(params));
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3497 params.image = image;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3498 params.fontIndex = fontIndex;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3499 params.utf8Text = utf8Text;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3500 params.x = x;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3501 params.y = y;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3502 params.r = r;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3503 params.g = g;
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3504 params.b = b;
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 return context->InvokeService(context, _OrthancPluginService_DrawText, &params);
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
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3509
1ec254a7c645 drawing texts on image from plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1610 diff changeset	3510
1615 c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3511 typedef struct
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3512 {
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3513 OrthancPluginStorageArea* storageArea;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3514 const char* uuid;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3515 const void* content;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3516 uint64_t size;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3517 OrthancPluginContentType type;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3518 } _OrthancPluginStorageAreaCreate;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3519
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3520
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3521 /**
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3522 * @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	3523 *
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3524 * 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	3525 * currently used by Orthanc.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3526 *
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3527 * @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	3528 * @param storageArea The storage area.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3529 * @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	3530 * @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	3531 * @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	3532 * @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	3533 * @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	3534 * @ingroup Callbacks
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3535 **/
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3536 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStorageAreaCreate(
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3537 OrthancPluginContext* context,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3538 OrthancPluginStorageArea* storageArea,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3539 const char* uuid,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3540 const void* content,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3541 uint64_t size,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3542 OrthancPluginContentType type)
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3543 {
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3544 _OrthancPluginStorageAreaCreate params;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3545 params.storageArea = storageArea;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3546 params.uuid = uuid;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3547 params.content = content;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3548 params.size = size;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3549 params.type = type;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3550
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3551 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	3552 }
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3553
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3554
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3555 typedef struct
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3556 {
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3557 OrthancPluginMemoryBuffer* target;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3558 OrthancPluginStorageArea* storageArea;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3559 const char* uuid;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3560 OrthancPluginContentType type;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3561 } _OrthancPluginStorageAreaRead;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3562
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3563
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3564 /**
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3565 * @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	3566 *
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3567 * 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	3568 * 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	3569 *
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3570 * @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	3571 * @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	3572 * @param storageArea The storage area.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3573 * @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	3574 * @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	3575 * @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	3576 * @ingroup Callbacks
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3577 **/
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3578 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStorageAreaRead(
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3579 OrthancPluginContext* context,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3580 OrthancPluginMemoryBuffer* target,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3581 OrthancPluginStorageArea* storageArea,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3582 const char* uuid,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3583 OrthancPluginContentType type)
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3584 {
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3585 _OrthancPluginStorageAreaRead params;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3586 params.target = target;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3587 params.storageArea = storageArea;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3588 params.uuid = uuid;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3589 params.type = type;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3590
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3591 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	3592 }
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3593
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3594
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3595 typedef struct
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3596 {
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3597 OrthancPluginStorageArea* storageArea;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3598 const char* uuid;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3599 OrthancPluginContentType type;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3600 } _OrthancPluginStorageAreaRemove;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3601
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3602 /**
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3603 * @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	3604 *
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3605 * 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	3606 * currently used by Orthanc.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3607 *
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3608 * @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	3609 * @param storageArea The storage area.
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3610 * @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	3611 * @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	3612 * @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	3613 * @ingroup Callbacks
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3614 **/
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3615 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStorageAreaRemove(
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3616 OrthancPluginContext* context,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3617 OrthancPluginStorageArea* storageArea,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3618 const char* uuid,
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3619 OrthancPluginContentType type)
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3620 {
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3621 _OrthancPluginStorageAreaRemove params;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3622 params.storageArea = storageArea;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3623 params.uuid = uuid;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3624 params.type = type;
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3625
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3626 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	3627 }
c40fe92a68e7 Primitives to upgrade the database version in plugins Sebastien Jodogne <s.jodogne@gmail.com> parents: 1613 diff changeset	3628
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
1649 8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3631 typedef struct
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3632 {
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3633 OrthancPluginErrorCode* target;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3634 int32_t code;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3635 uint16_t httpStatus;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3636 const char* message;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3637 } _OrthancPluginRegisterErrorCode;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3638
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3639 /**
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3640 * @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	3641 *
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3642 * 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	3643 * 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	3644 * 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	3645 * HTTP status code.
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3646 *
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3647 * @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	3648 * @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	3649 * @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	3650 * @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	3651 * @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	3652 * @ingroup Toolbox
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3653 **/
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3654 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterErrorCode(
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3655 OrthancPluginContext* context,
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3656 int32_t code,
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3657 uint16_t httpStatus,
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3658 const char* message)
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3659 {
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3660 OrthancPluginErrorCode target;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3661
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3662 _OrthancPluginRegisterErrorCode params;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3663 params.target = &target;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3664 params.code = code;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3665 params.httpStatus = httpStatus;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3666 params.message = message;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3667
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3668 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	3669 {
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3670 return target;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3671 }
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3672 else
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3673 {
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3674 /* 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	3675 return OrthancPluginErrorCode_Plugin;
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3676 }
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3677 }
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3678
8040d56cb0b3 New function "OrthancPluginRegisterErrorCode()" to declare custom error codes Sebastien Jodogne <s.jodogne@gmail.com> parents: 1643 diff changeset	3679
886 29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3680 #ifdef __cplusplus
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3681 }
29087d728e0a plugin sample Sebastien Jodogne <s.jodogne@gmail.com> parents: diff changeset	3682 #endif
900 1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	3683
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	3684
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	3685 /** @} */
1b92ce45cc8d plugin doc Sebastien Jodogne <s.jodogne@gmail.com> parents: 899 diff changeset	3686

Mercurial > hg > orthanc

annotate Plugins/Include/orthanc/OrthancCPlugin.h @ 1649:8040d56cb0b3