Mercurial > hg > orthanc
annotate OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h @ 5604:c2a2fb8e868d default
reformatting NEWS
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Wed, 08 May 2024 10:30:34 +0200 |
| parents | d7eaa568da15 |
| children | 9e74e761b108 |
| 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 | 4 * This C/C++ SDK allows external developers to create plugins that |
| 5 * can be loaded into Orthanc to extend its functionality. Each | |
| 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 | 9 * -# <tt>int32_t OrthancPluginInitialize(const OrthancPluginContext* context)</tt>: |
| 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(). |
|
4440
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
19 * - Possibly register a custom storage area using ::OrthancPluginRegisterStorageArea2(). |
|
5194
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
20 * - Possibly register a custom database back-end area using OrthancPluginRegisterDatabaseBackendV4(). |
|
1995
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
21 * - Possibly register a handler for C-Find SCP using OrthancPluginRegisterFindCallback(). |
| 1803 | 22 * - Possibly register a handler for C-Find SCP against DICOM worklists using OrthancPluginRegisterWorklistCallback(). |
|
1999
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
23 * - Possibly register a handler for C-Move SCP using OrthancPluginRegisterMoveCallback(). |
|
1826
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
24 * - Possibly register a custom decoder for DICOM images using OrthancPluginRegisterDecodeImageCallback(). |
|
2268
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
25 * - Possibly register a callback to filter incoming HTTP requests using OrthancPluginRegisterIncomingHttpRequestFilter2(). |
|
2808
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
26 * - Possibly register a callback to unserialize jobs using OrthancPluginRegisterJobsUnserializer(). |
|
3179
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
27 * - Possibly register a callback to refresh its metrics using OrthancPluginRegisterRefreshMetricsCallback(). |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
28 * - Possibly register a callback to answer chunked HTTP transfers using ::OrthancPluginRegisterChunkedRestCallback(). |
|
3662
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
29 * - Possibly register a callback for Storage Commitment SCP using ::OrthancPluginRegisterStorageCommitmentScpCallback(). |
|
4919
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
30 * - Possibly register a callback to keep/discard/modify incoming DICOM instances using OrthancPluginRegisterReceivedInstanceCallback(). |
|
3930
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
31 * - Possibly register a custom transcoder for DICOM images using OrthancPluginRegisterTranscoderCallback(). |
|
4921
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
32 * - Possibly register a callback to discard instances received through DICOM C-STORE using OrthancPluginRegisterIncomingCStoreInstanceFilter(). |
|
4943
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
33 * - Possibly register a callback to branch a WebDAV virtual filesystem using OrthancPluginRegisterWebDavCollection(). |
| 907 | 34 * -# <tt>void OrthancPluginFinalize()</tt>: |
| 35 * This function is invoked by Orthanc during its shutdown. The plugin | |
| 36 * must free all its memory. | |
| 37 * -# <tt>const char* OrthancPluginGetName()</tt>: | |
| 38 * 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
|
39 * -# <tt>const char* OrthancPluginGetVersion()</tt>: |
| 907 | 40 * The plugin must return a string containing its version number. |
| 41 * | |
| 42 * The name and the version of a plugin is only used to prevent it | |
| 1602 | 43 * from being loaded twice. Note that, in C++, it is mandatory to |
| 44 * declare these functions within an <tt>extern "C"</tt> section. | |
| 907 | 45 * |
|
1595
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
46 * To ensure multi-threading safety, the various REST callbacks are |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
47 * guaranteed to be executed in mutual exclusion since Orthanc |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
48 * 0.8.5. If this feature is undesired (notably when developing |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
49 * high-performance plugins handling simultaneous requests), use |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
50 * ::OrthancPluginRegisterRestCallbackNoLock(). |
|
906
cbc0ea03dffe
sample plugin configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
904
diff
changeset
|
51 **/ |
|
cbc0ea03dffe
sample plugin configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
904
diff
changeset
|
52 |
|
cbc0ea03dffe
sample plugin configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
904
diff
changeset
|
53 |
|
cbc0ea03dffe
sample plugin configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
904
diff
changeset
|
54 |
| 900 | 55 /** |
|
1613
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
56 * @defgroup Images Images and compression |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
57 * @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
|
58 * |
|
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
59 * @defgroup REST REST |
|
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
60 * @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
|
61 * |
|
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
62 * @defgroup Callbacks Callbacks |
|
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
63 * @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
|
64 * |
| 2615 | 65 * @defgroup DicomCallbacks DicomCallbacks |
|
3707
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
66 * @brief Functions to register and manage DICOM callbacks (worklists, C-FIND, C-MOVE, storage commitment). |
|
1799
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
67 * |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
68 * @defgroup Orthanc Orthanc |
|
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
69 * @brief Functions to access the content of the Orthanc server. |
| 3936 | 70 * |
| 71 * @defgroup DicomInstance DicomInstance | |
| 72 * @brief Functions to access DICOM images that are managed by the Orthanc core. | |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
73 **/ |
|
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
74 |
|
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
75 |
|
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
76 |
|
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
77 /** |
|
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
78 * @defgroup Toolbox Toolbox |
|
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
79 * @brief Generic functions to help with the creation of plugins. |
| 900 | 80 **/ |
| 81 | |
| 82 | |
|
906
cbc0ea03dffe
sample plugin configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
904
diff
changeset
|
83 |
| 886 | 84 /** |
| 85 * Orthanc - A Lightweight, RESTful DICOM Store | |
| 1900 | 86 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics |
|
1288
6e7e5ed91c2d
upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1282
diff
changeset
|
87 * Department, University Hospital of Liege, Belgium |
|
5485
48b8dae6dc77
upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5474
diff
changeset
|
88 * Copyright (C) 2017-2024 Osimis S.A., Belgium |
|
48b8dae6dc77
upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5474
diff
changeset
|
89 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium |
| 886 | 90 * |
| 91 * This program is free software: you can redistribute it and/or | |
| 92 * modify it under the terms of the GNU General Public License as | |
| 93 * published by the Free Software Foundation, either version 3 of the | |
| 94 * License, or (at your option) any later version. | |
| 95 * | |
| 96 * This program is distributed in the hope that it will be useful, but | |
| 97 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 98 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 99 * General Public License for more details. | |
| 100 * | |
| 101 * You should have received a copy of the GNU General Public License | |
| 102 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 103 **/ | |
| 104 | |
| 105 | |
|
906
cbc0ea03dffe
sample plugin configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
904
diff
changeset
|
106 |
| 886 | 107 #pragma once |
| 108 | |
| 109 | |
| 900 | 110 #include <stdio.h> |
| 111 #include <string.h> | |
| 112 | |
| 886 | 113 #ifdef WIN32 |
|
3422
8b4169a88039
ORTHANC_PLUGINS_API using visibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3416
diff
changeset
|
114 # define ORTHANC_PLUGINS_API __declspec(dllexport) |
|
8b4169a88039
ORTHANC_PLUGINS_API using visibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3416
diff
changeset
|
115 #elif __GNUC__ >= 4 |
|
8b4169a88039
ORTHANC_PLUGINS_API using visibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3416
diff
changeset
|
116 # define ORTHANC_PLUGINS_API __attribute__ ((visibility ("default"))) |
| 886 | 117 #else |
|
3422
8b4169a88039
ORTHANC_PLUGINS_API using visibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3416
diff
changeset
|
118 # define ORTHANC_PLUGINS_API |
| 886 | 119 #endif |
| 120 | |
| 1893 | 121 #define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 1 |
| 5196 | 122 #define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 12 |
|
5539
2b3eeacf636c
added SetRootUri(), SetDescription() and ExtendOrthancExplorer() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5538
diff
changeset
|
123 #define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 4 |
|
2424
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
124 |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
125 |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
126 #if !defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE) |
|
3665
4c1d2ff7ddd0
handling of errors in storage commitment plugin factory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3664
diff
changeset
|
127 #define ORTHANC_PLUGINS_VERSION_IS_ABOVE(major, minor, revision) \ |
|
4c1d2ff7ddd0
handling of errors in storage commitment plugin factory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3664
diff
changeset
|
128 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER > major || \ |
|
4c1d2ff7ddd0
handling of errors in storage commitment plugin factory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3664
diff
changeset
|
129 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER == major && \ |
|
4c1d2ff7ddd0
handling of errors in storage commitment plugin factory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3664
diff
changeset
|
130 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER > minor || \ |
|
4c1d2ff7ddd0
handling of errors in storage commitment plugin factory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3664
diff
changeset
|
131 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER == minor && \ |
|
2424
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
132 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER >= revision)))) |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
133 #endif |
|
1039
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
134 |
| 886 | 135 |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
136 |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
137 /******************************************************************** |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
138 ** Check that function inlining is properly supported. The use of |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
139 ** inlining is required, to avoid the duplication of object code |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
140 ** between two compilation modules that would use the Orthanc Plugin |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
141 ** API. |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
142 ********************************************************************/ |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
143 |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
144 /* 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
|
145 automatically and that your compiler is known to properly support |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
146 inlining, uncomment the following #define and adapt the definition |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
147 of "static inline". */ |
|
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 /* #define ORTHANC_PLUGIN_INLINE static inline */ |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
150 |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
151 #ifndef ORTHANC_PLUGIN_INLINE |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
152 # if __STDC_VERSION__ >= 199901L |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
153 /* 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
|
154 # define ORTHANC_PLUGIN_INLINE static inline |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
155 # elif defined(__cplusplus) |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
156 /* This is C++ */ |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
157 # define ORTHANC_PLUGIN_INLINE static inline |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
158 # elif defined(__GNUC__) |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
159 /* This is GCC running in C89 mode */ |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
160 # define ORTHANC_PLUGIN_INLINE static __inline |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
161 # elif defined(_MSC_VER) |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
162 /* This is Visual Studio running in C89 mode */ |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
163 # define ORTHANC_PLUGIN_INLINE static __inline |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
164 # else |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
165 # 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
|
166 # endif |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
167 #endif |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
168 |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
169 |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
170 #ifndef ORTHANC_PLUGIN_DEPRECATED |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
171 # if defined(_MSC_VER) |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
172 # define ORTHANC_PLUGIN_DEPRECATED __declspec(deprecated) |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
173 # elif __GNUC__ >= 4 |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
174 # define ORTHANC_PLUGIN_DEPRECATED __attribute__ ((deprecated)) |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
175 # elif defined(__clang__) |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
176 # define ORTHANC_PLUGIN_DEPRECATED __attribute__ ((deprecated)) |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
177 # else |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
178 # pragma message("WARNING: You need to implement ORTHANC_PLUGINS_DEPRECATED for this compiler") |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
179 # define ORTHANC_PLUGIN_DEPRECATED |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
180 # endif |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
181 #endif |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
182 |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
183 |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
184 |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
185 /******************************************************************** |
| 907 | 186 ** Inclusion of standard libraries. |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
187 ********************************************************************/ |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
188 |
|
1322
f497a72d9f71
fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1313
diff
changeset
|
189 /** |
|
f497a72d9f71
fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1313
diff
changeset
|
190 * 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
|
191 * downloaded at the following URL: |
|
5432
59e3b6f8c5be
migration to UCLouvain servers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5399
diff
changeset
|
192 * https://orthanc.uclouvain.be/hg/orthanc/raw-file/default/OrthancFramework/Resources/ThirdParty/VisualStudio/stdint.h |
|
1322
f497a72d9f71
fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1313
diff
changeset
|
193 **/ |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
194 #include <stdint.h> |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
195 |
| 886 | 196 #include <stdlib.h> |
| 197 | |
| 198 | |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
199 |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
200 /******************************************************************** |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
201 ** Definition of the Orthanc Plugin API. |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
202 ********************************************************************/ |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
203 |
| 900 | 204 /** @{ */ |
| 205 | |
| 886 | 206 #ifdef __cplusplus |
| 207 extern "C" | |
| 208 { | |
| 209 #endif | |
| 210 | |
| 907 | 211 /** |
| 1578 | 212 * The various error codes that can be returned by the Orthanc core. |
| 213 **/ | |
| 214 typedef enum | |
| 215 { | |
|
1579
b93c398f934d
check the size of the enumerations in the plugin engine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1578
diff
changeset
|
216 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
|
217 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
|
218 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
|
219 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
|
220 OrthancPluginErrorCode_ParameterOutOfRange = 3 /*!< Parameter out of range */, |
| 2133 | 221 OrthancPluginErrorCode_NotEnoughMemory = 4 /*!< The server hosting Orthanc is running out of memory */, |
|
1579
b93c398f934d
check the size of the enumerations in the plugin engine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1578
diff
changeset
|
222 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
|
223 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
|
224 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
|
225 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
|
226 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
|
227 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
|
228 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
|
229 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
|
230 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
|
231 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
|
232 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
|
233 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
|
234 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
|
235 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
|
236 OrthancPluginErrorCode_FullStorage = 19 /*!< The file storage is full */, |
|
1582
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
237 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
|
238 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
|
239 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
|
240 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
|
241 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
|
242 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
|
243 OrthancPluginErrorCode_UnknownPluginService = 26 /*!< Plugin invoking an unknown service */, |
|
1582
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
244 OrthancPluginErrorCode_UnknownDicomTag = 27 /*!< Unknown DICOM tag */, |
|
1596
f2e3d030ea59
BadJson error code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1595
diff
changeset
|
245 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
|
246 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
|
247 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
|
248 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
|
249 OrthancPluginErrorCode_StorageAreaPlugin = 32 /*!< Error in the plugin implementing a custom storage area */, |
| 1746 | 250 OrthancPluginErrorCode_EmptyRequest = 33 /*!< The request is empty */, |
|
1781
5ad4e4d92ecb
AcceptMediaDispatcher bootstrap
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1780
diff
changeset
|
251 OrthancPluginErrorCode_NotAcceptable = 34 /*!< Cannot send a response which is acceptable according to the Accept HTTP header */, |
| 2133 | 252 OrthancPluginErrorCode_NullPointer = 35 /*!< Cannot handle a NULL pointer */, |
|
2486
ad8f30fc28d1
new error code: DatabaseUnavailable
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2447
diff
changeset
|
253 OrthancPluginErrorCode_DatabaseUnavailable = 36 /*!< The database is currently not available (probably a transient situation) */, |
|
2581
8da2cffc2378
JobsRegistry::Cancel()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2486
diff
changeset
|
254 OrthancPluginErrorCode_CanceledJob = 37 /*!< This job was canceled */, |
|
3376
56ea9c476dba
new error code for Stone: BadGeometry
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3220
diff
changeset
|
255 OrthancPluginErrorCode_BadGeometry = 38 /*!< Geometry error encountered in Stone */, |
|
3801
9fe1d64a748c
upgrade to civetweb 1.12, error reporting if OpenSSL failure
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3797
diff
changeset
|
256 OrthancPluginErrorCode_SslInitialization = 39 /*!< Cannot initialize SSL encryption, check out your certificates */, |
|
4347
3dffe8f7af48
new error code: ErrorCode_DiscontinuedAbi
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4343
diff
changeset
|
257 OrthancPluginErrorCode_DiscontinuedAbi = 40 /*!< Calling a function that has been removed from the Orthanc Framework */, |
|
4442
f77ee6e6cf47
new error code: ErrorCode_BadRange
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4440
diff
changeset
|
258 OrthancPluginErrorCode_BadRange = 41 /*!< Incorrect range request */, |
|
4551
350a22c094f2
testing replay of transactions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4516
diff
changeset
|
259 OrthancPluginErrorCode_DatabaseCannotSerialize = 42 /*!< Database could not serialize access due to concurrent update, the transaction should be retried */, |
|
4623
95ffe3b6ef7c
handling of revisions for metadata
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4608
diff
changeset
|
260 OrthancPluginErrorCode_Revision = 43 /*!< A bad revision number was provided, which might indicate conflict between multiple writers */, |
|
4932
b7ce2bb6b881
refactored the list of MainDicomTags to be able to change it dynamicaly. Unit tests and Integration tests ok
Alain Mazy <am@osimis.io>
parents:
4921
diff
changeset
|
261 OrthancPluginErrorCode_MainDicomTagsMultiplyDefined = 44 /*!< A main DICOM Tag has been defined multiple times for the same resource level */, |
| 5383 | 262 OrthancPluginErrorCode_ForbiddenAccess = 45 /*!< Access to a resource is forbidden */, |
|
5464
38f1d06875ad
delete attachment in case of same instance being uploaded multiple times at the same time
Alain Mazy <am@osimis.io>
parents:
5452
diff
changeset
|
263 OrthancPluginErrorCode_DuplicateResource = 46 /*!< Duplicate resource */, |
|
1582
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
264 OrthancPluginErrorCode_SQLiteNotOpened = 1000 /*!< SQLite: The database is not opened */, |
|
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
265 OrthancPluginErrorCode_SQLiteAlreadyOpened = 1001 /*!< SQLite: Connection is already open */, |
|
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
266 OrthancPluginErrorCode_SQLiteCannotOpen = 1002 /*!< SQLite: Unable to open the database */, |
|
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
267 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
|
268 OrthancPluginErrorCode_SQLiteExecute = 1004 /*!< SQLite: Cannot execute a command */, |
|
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
269 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
|
270 OrthancPluginErrorCode_SQLiteCommitWithoutTransaction = 1006 /*!< SQLite: Committing a nonexistent transaction */, |
|
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
271 OrthancPluginErrorCode_SQLiteRegisterFunction = 1007 /*!< SQLite: Unable to register a function */, |
|
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
272 OrthancPluginErrorCode_SQLiteFlush = 1008 /*!< SQLite: Unable to flush the database */, |
|
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
273 OrthancPluginErrorCode_SQLiteCannotRun = 1009 /*!< SQLite: Cannot run a cached statement */, |
|
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
274 OrthancPluginErrorCode_SQLiteCannotStep = 1010 /*!< SQLite: Cannot step over a cached statement */, |
|
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
275 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
|
276 OrthancPluginErrorCode_SQLitePrepareStatement = 1012 /*!< SQLite: Cannot prepare a cached statement */, |
|
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
277 OrthancPluginErrorCode_SQLiteTransactionAlreadyStarted = 1013 /*!< SQLite: Beginning the same transaction twice */, |
|
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
278 OrthancPluginErrorCode_SQLiteTransactionCommit = 1014 /*!< SQLite: Failure when committing the transaction */, |
|
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
279 OrthancPluginErrorCode_SQLiteTransactionBegin = 1015 /*!< SQLite: Cannot start a transaction */, |
|
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
280 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
|
281 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
|
282 OrthancPluginErrorCode_DirectoryExpected = 2002 /*!< The specified path does not point to a directory */, |
|
1949
d90f737f2dde
warn about the use of privileged ports
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1912
diff
changeset
|
283 OrthancPluginErrorCode_HttpPortInUse = 2003 /*!< The TCP port of the HTTP server is privileged or already in use */, |
|
d90f737f2dde
warn about the use of privileged ports
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1912
diff
changeset
|
284 OrthancPluginErrorCode_DicomPortInUse = 2004 /*!< The TCP port of the DICOM server is privileged or already in use */, |
|
1582
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
285 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
|
286 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
|
287 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
|
288 OrthancPluginErrorCode_MakeDirectory = 2008 /*!< Cannot create a directory */, |
|
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
289 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
|
290 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
|
291 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
|
292 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
|
293 OrthancPluginErrorCode_NoApplicationEntityFilter = 2013 /*!< No application entity filter */, |
|
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
294 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
|
295 OrthancPluginErrorCode_NoPresentationContext = 2015 /*!< DicomUserConnection: No acceptable presentation context for modality */, |
|
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
296 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
|
297 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
|
298 OrthancPluginErrorCode_CannotStoreInstance = 2018 /*!< Cannot store an instance */, |
|
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
299 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
|
300 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
|
301 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
|
302 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
|
303 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
|
304 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
|
305 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
|
306 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
|
307 OrthancPluginErrorCode_UnknownModality = 2027 /*!< Unknown modality */, |
|
bd1889029cbb
encoding of exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1581
diff
changeset
|
308 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
|
309 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
|
310 OrthancPluginErrorCode_CannotCreateLua = 2030 /*!< Cannot create the Lua context */, |
|
9ea3d082b064
got rid of custom exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1582
diff
changeset
|
311 OrthancPluginErrorCode_CannotExecuteLua = 2031 /*!< Cannot execute a Lua command */, |
|
9ea3d082b064
got rid of custom exceptions
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1582
diff
changeset
|
312 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
|
313 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
|
314 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
|
315 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
|
316 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
|
317 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
|
318 OrthancPluginErrorCode_DatabaseNotInitialized = 2038 /*!< Plugin trying to call the database during its initialization */, |
|
1674
4fc502d469f4
fix build if SSL is disabled
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1673
diff
changeset
|
319 OrthancPluginErrorCode_SslDisabled = 2039 /*!< Orthanc has been built without SSL support */, |
|
1703
b80e76dd1d56
ordered-slices continued
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1674
diff
changeset
|
320 OrthancPluginErrorCode_CannotOrderSlices = 2040 /*!< Unable to order the slices of the series */, |
|
1786
164d78911382
primitives to handle dicom worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1781
diff
changeset
|
321 OrthancPluginErrorCode_NoWorklistHandler = 2041 /*!< No request handler factory for DICOM C-Find Modality SCP */, |
|
1980
ebce5f456b8e
new error code: ErrorCode_AlreadyExistingTag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1962
diff
changeset
|
322 OrthancPluginErrorCode_AlreadyExistingTag = 2042 /*!< Cannot override the value of a tag that already exists */, |
|
3603
7e303ba837d9
NoStorageCommitmentHandler error code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3584
diff
changeset
|
323 OrthancPluginErrorCode_NoStorageCommitmentHandler = 2043 /*!< No request handler factory for DICOM N-ACTION SCP (storage commitment) */, |
|
3818
4f78da5613a1
Add C-GET SCP support
Stacy Loesch <stacy.loesch@varian.com>
parents:
3801
diff
changeset
|
324 OrthancPluginErrorCode_NoCGetHandler = 2044 /*!< No request handler factory for DICOM C-GET SCP */, |
|
3404
e280ced38a4c
ErrorCode_UnsupportedMediaType
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3401
diff
changeset
|
325 OrthancPluginErrorCode_UnsupportedMediaType = 3000 /*!< Unsupported media type */, |
|
1580
bf502300c52e
force the size of the enumerations in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1579
diff
changeset
|
326 |
|
bf502300c52e
force the size of the enumerations in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1579
diff
changeset
|
327 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff |
| 1578 | 328 } OrthancPluginErrorCode; |
| 329 | |
| 330 | |
| 331 /** | |
|
1232
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
332 * 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
|
333 * plugins. |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
334 **/ |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
335 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
|
336 |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
337 |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
338 /** |
| 907 | 339 * The various HTTP methods for a REST call. |
| 340 **/ | |
| 894 | 341 typedef enum |
| 342 { | |
| 907 | 343 OrthancPluginHttpMethod_Get = 1, /*!< GET request */ |
| 344 OrthancPluginHttpMethod_Post = 2, /*!< POST request */ | |
| 345 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
|
346 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
|
347 |
|
bf502300c52e
force the size of the enumerations in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1579
diff
changeset
|
348 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff |
| 896 | 349 } OrthancPluginHttpMethod; |
| 886 | 350 |
| 907 | 351 |
| 352 /** | |
| 353 * @brief The parameters of a REST request. | |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
354 * @ingroup Callbacks |
| 907 | 355 **/ |
| 899 | 356 typedef struct |
| 357 { | |
| 907 | 358 /** |
| 359 * @brief The HTTP method. | |
| 360 **/ | |
|
3396
4981405e6c5c
new sdk: OrthancPluginRegisterMultipartRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3393
diff
changeset
|
361 OrthancPluginHttpMethod method; |
| 899 | 362 |
| 907 | 363 /** |
| 364 * @brief The number of groups of the regular expression. | |
| 365 **/ | |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
366 uint32_t groupsCount; |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
367 |
| 907 | 368 /** |
| 369 * @brief The matched values for the groups of the regular expression. | |
| 370 **/ | |
| 371 const char* const* groups; | |
| 372 | |
| 373 /** | |
| 374 * @brief For a GET request, the number of GET parameters. | |
| 375 **/ | |
| 899 | 376 uint32_t getCount; |
| 377 | |
| 907 | 378 /** |
| 379 * @brief For a GET request, the keys of the GET parameters. | |
| 380 **/ | |
| 381 const char* const* getKeys; | |
| 382 | |
| 383 /** | |
| 384 * @brief For a GET request, the values of the GET parameters. | |
| 385 **/ | |
| 386 const char* const* getValues; | |
| 387 | |
| 388 /** | |
| 389 * @brief For a PUT or POST request, the content of the body. | |
| 390 **/ | |
| 3401 | 391 const void* body; |
| 907 | 392 |
| 393 /** | |
| 394 * @brief For a PUT or POST request, the number of bytes of the body. | |
| 395 **/ | |
| 899 | 396 uint32_t bodySize; |
|
1041
2c49b7dffcec
plugins have access to the HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1040
diff
changeset
|
397 |
|
2c49b7dffcec
plugins have access to the HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1040
diff
changeset
|
398 |
|
2c49b7dffcec
plugins have access to the HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1040
diff
changeset
|
399 /* -------------------------------------------------- |
|
2c49b7dffcec
plugins have access to the HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1040
diff
changeset
|
400 New in version 0.8.1 |
|
2c49b7dffcec
plugins have access to the HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1040
diff
changeset
|
401 -------------------------------------------------- */ |
|
2c49b7dffcec
plugins have access to the HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1040
diff
changeset
|
402 |
|
2c49b7dffcec
plugins have access to the HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1040
diff
changeset
|
403 /** |
|
2c49b7dffcec
plugins have access to the HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1040
diff
changeset
|
404 * @brief The number of HTTP headers. |
|
2c49b7dffcec
plugins have access to the HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1040
diff
changeset
|
405 **/ |
|
2c49b7dffcec
plugins have access to the HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1040
diff
changeset
|
406 uint32_t headersCount; |
|
2c49b7dffcec
plugins have access to the HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1040
diff
changeset
|
407 |
|
2c49b7dffcec
plugins have access to the HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1040
diff
changeset
|
408 /** |
|
2c49b7dffcec
plugins have access to the HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1040
diff
changeset
|
409 * @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
|
410 **/ |
|
2c49b7dffcec
plugins have access to the HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1040
diff
changeset
|
411 const char* const* headersKeys; |
|
2c49b7dffcec
plugins have access to the HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1040
diff
changeset
|
412 |
|
2c49b7dffcec
plugins have access to the HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1040
diff
changeset
|
413 /** |
|
2c49b7dffcec
plugins have access to the HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1040
diff
changeset
|
414 * @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
|
415 **/ |
|
2c49b7dffcec
plugins have access to the HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1040
diff
changeset
|
416 const char* const* headersValues; |
|
2c49b7dffcec
plugins have access to the HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1040
diff
changeset
|
417 |
| 899 | 418 } OrthancPluginHttpRequest; |
| 419 | |
|
1041
2c49b7dffcec
plugins have access to the HTTP headers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1040
diff
changeset
|
420 |
| 900 | 421 typedef enum |
| 886 | 422 { |
| 900 | 423 /* Generic services */ |
| 907 | 424 _OrthancPluginService_LogInfo = 1, |
| 425 _OrthancPluginService_LogWarning = 2, | |
| 426 _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
|
427 _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
|
428 _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
|
429 _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
|
430 _OrthancPluginService_SetPluginProperty = 7, |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
431 _OrthancPluginService_GetGlobalProperty = 8, |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
432 _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
|
433 _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
|
434 _OrthancPluginService_GetCommandLineArgument = 11, |
|
1407
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
435 _OrthancPluginService_GetExpectedDatabaseVersion = 12, |
|
1424
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
436 _OrthancPluginService_GetConfiguration = 13, |
|
1554
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
437 _OrthancPluginService_BufferCompression = 14, |
|
1588
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
438 _OrthancPluginService_ReadFile = 15, |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
439 _OrthancPluginService_WriteFile = 16, |
|
1593
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
440 _OrthancPluginService_GetErrorDescription = 17, |
|
1606
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
441 _OrthancPluginService_CallHttpClient = 18, |
|
1649
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
442 _OrthancPluginService_RegisterErrorCode = 19, |
|
1657
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
443 _OrthancPluginService_RegisterDictionaryTag = 20, |
|
1740
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
444 _OrthancPluginService_DicomBufferToJson = 21, |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
445 _OrthancPluginService_DicomInstanceToJson = 22, |
|
1827
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
446 _OrthancPluginService_CreateDicom = 23, |
|
1833
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
447 _OrthancPluginService_ComputeMd5 = 24, |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
448 _OrthancPluginService_ComputeSha1 = 25, |
|
1861
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
449 _OrthancPluginService_LookupDictionary = 26, |
|
1987
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
450 _OrthancPluginService_CallHttpClient2 = 27, |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
451 _OrthancPluginService_GenerateUuid = 28, |
|
2115
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
452 _OrthancPluginService_RegisterPrivateDictionaryTag = 29, |
|
2984
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
453 _OrthancPluginService_AutodetectMimeType = 30, |
|
3179
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
454 _OrthancPluginService_SetMetricsValue = 31, |
|
3205
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
455 _OrthancPluginService_EncodeDicomWebJson = 32, |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
456 _OrthancPluginService_EncodeDicomWebXml = 33, |
|
3924
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
457 _OrthancPluginService_ChunkedHttpClient = 34, /* New in Orthanc 1.5.7 */ |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
458 _OrthancPluginService_GetTagName = 35, /* New in Orthanc 1.5.7 */ |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
459 _OrthancPluginService_EncodeDicomWebJson2 = 36, /* New in Orthanc 1.7.0 */ |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
460 _OrthancPluginService_EncodeDicomWebXml2 = 37, /* New in Orthanc 1.7.0 */ |
|
3930
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
461 _OrthancPluginService_CreateMemoryBuffer = 38, /* New in Orthanc 1.7.0 */ |
|
4343
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
462 _OrthancPluginService_GenerateRestApiAuthorizationToken = 39, /* New in Orthanc 1.8.1 */ |
|
4440
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
463 _OrthancPluginService_CreateMemoryBuffer64 = 40, /* New in Orthanc 1.9.0 */ |
|
4477
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
464 _OrthancPluginService_CreateDicom2 = 41, /* New in Orthanc 1.9.0 */ |
|
5030
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
465 _OrthancPluginService_GetDatabaseServerIdentifier = 42, /* New in Orthanc 1.11.1 */ |
|
5326
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
466 _OrthancPluginService_SetMetricsIntegerValue = 43, /* New in Orthanc 1.12.1 */ |
|
5452
8345267e8de5
Added OrthancPluginSetCurrentThreadName() in the plugin SDK
Alain Mazy <am@osimis.io>
parents:
5432
diff
changeset
|
467 _OrthancPluginService_SetCurrentThreadName = 44, /* New in Orthanc 1.12.2 */ |
|
5561
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
468 _OrthancPluginService_LogMessage = 45, /* New in Orthanc 1.12.4 */ |
|
5452
8345267e8de5
Added OrthancPluginSetCurrentThreadName() in the plugin SDK
Alain Mazy <am@osimis.io>
parents:
5432
diff
changeset
|
469 |
|
5030
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
470 |
| 900 | 471 /* Registration of callbacks */ |
| 907 | 472 _OrthancPluginService_RegisterRestCallback = 1000, |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
473 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001, |
|
1135
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
474 _OrthancPluginService_RegisterStorageArea = 1002, |
|
1177
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
475 _OrthancPluginService_RegisterOnChangeCallback = 1003, |
|
1595
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
476 _OrthancPluginService_RegisterRestCallbackNoLock = 1004, |
|
1800
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
477 _OrthancPluginService_RegisterWorklistCallback = 1005, |
|
1826
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
478 _OrthancPluginService_RegisterDecodeImageCallback = 1006, |
|
1961
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
479 _OrthancPluginService_RegisterIncomingHttpRequestFilter = 1007, |
|
1995
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
480 _OrthancPluginService_RegisterFindCallback = 1008, |
|
1999
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
481 _OrthancPluginService_RegisterMoveCallback = 1009, |
|
2268
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
482 _OrthancPluginService_RegisterIncomingHttpRequestFilter2 = 1010, |
|
3179
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
483 _OrthancPluginService_RegisterRefreshMetricsCallback = 1011, |
| 3414 | 484 _OrthancPluginService_RegisterChunkedRestCallback = 1012, /* New in Orthanc 1.5.7 */ |
|
3662
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
485 _OrthancPluginService_RegisterStorageCommitmentScpCallback = 1013, |
|
3846
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
486 _OrthancPluginService_RegisterIncomingDicomInstanceFilter = 1014, |
|
3930
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
487 _OrthancPluginService_RegisterTranscoderCallback = 1015, /* New in Orthanc 1.7.0 */ |
|
4440
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
488 _OrthancPluginService_RegisterStorageArea2 = 1016, /* New in Orthanc 1.9.0 */ |
|
4902
df86d2505df8
Orthanc 1.9.8 is now known as Orthanc 1.10.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4870
diff
changeset
|
489 _OrthancPluginService_RegisterIncomingCStoreInstanceFilter = 1017, /* New in Orthanc 1.10.0 */ |
|
df86d2505df8
Orthanc 1.9.8 is now known as Orthanc 1.10.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4870
diff
changeset
|
490 _OrthancPluginService_RegisterReceivedInstanceCallback = 1018, /* New in Orthanc 1.10.0 */ |
|
4943
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
491 _OrthancPluginService_RegisterWebDavCollection = 1019, /* New in Orthanc 1.10.1 */ |
|
4796
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
492 |
| 900 | 493 /* Sending answers to REST calls */ |
| 907 | 494 _OrthancPluginService_AnswerBuffer = 2000, |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
495 _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
|
496 _OrthancPluginService_Redirect = 2002, |
|
1042
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
497 _OrthancPluginService_SendHttpStatusCode = 2003, |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
498 _OrthancPluginService_SendUnauthorized = 2004, |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
499 _OrthancPluginService_SendMethodNotAllowed = 2005, |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
500 _OrthancPluginService_SetCookie = 2006, |
|
1137
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
501 _OrthancPluginService_SetHttpHeader = 2007, |
|
1430
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
502 _OrthancPluginService_StartMultipartAnswer = 2008, |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
503 _OrthancPluginService_SendMultipartItem = 2009, |
|
1593
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
504 _OrthancPluginService_SendHttpStatus = 2010, |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
505 _OrthancPluginService_CompressAndAnswerImage = 2011, |
|
1882
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
506 _OrthancPluginService_SendMultipartItem2 = 2012, |
|
2957
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
507 _OrthancPluginService_SetHttpErrorDetails = 2013, |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
508 |
|
912
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
509 /* Access to the Orthanc database and API */ |
|
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
510 _OrthancPluginService_GetDicomForInstance = 3000, |
|
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
511 _OrthancPluginService_RestApiGet = 3001, |
|
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
512 _OrthancPluginService_RestApiPost = 3002, |
|
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
513 _OrthancPluginService_RestApiDelete = 3003, |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
514 _OrthancPluginService_RestApiPut = 3004, |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
515 _OrthancPluginService_LookupPatient = 3005, |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
516 _OrthancPluginService_LookupStudy = 3006, |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
517 _OrthancPluginService_LookupSeries = 3007, |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
518 _OrthancPluginService_LookupInstance = 3008, |
|
1069
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
519 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009, |
|
1282
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
520 _OrthancPluginService_RestApiGetAfterPlugins = 3010, |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
521 _OrthancPluginService_RestApiPostAfterPlugins = 3011, |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
522 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012, |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
523 _OrthancPluginService_RestApiPutAfterPlugins = 3013, |
|
1669
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
524 _OrthancPluginService_ReconstructMainDicomTags = 3014, |
|
1780
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
525 _OrthancPluginService_RestApiGet2 = 3015, |
|
4605
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
526 _OrthancPluginService_CallRestApi = 3016, /* New in Orthanc 1.9.2 */ |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
527 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
528 /* Access to DICOM instances */ |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
529 _OrthancPluginService_GetInstanceRemoteAet = 4000, |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
530 _OrthancPluginService_GetInstanceSize = 4001, |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
531 _OrthancPluginService_GetInstanceData = 4002, |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
532 _OrthancPluginService_GetInstanceJson = 4003, |
|
1067
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
533 _OrthancPluginService_GetInstanceSimplifiedJson = 4004, |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
534 _OrthancPluginService_HasInstanceMetadata = 4005, |
|
1309
8f4487d8f79e
new files for custom database back-end
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1303
diff
changeset
|
535 _OrthancPluginService_GetInstanceMetadata = 4006, |
|
1815
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
536 _OrthancPluginService_GetInstanceOrigin = 4007, |
|
3846
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
537 _OrthancPluginService_GetInstanceTransferSyntaxUid = 4008, |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
538 _OrthancPluginService_HasInstancePixelData = 4009, |
|
3916
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
539 _OrthancPluginService_CreateDicomInstance = 4010, /* New in Orthanc 1.7.0 */ |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
540 _OrthancPluginService_FreeDicomInstance = 4011, /* New in Orthanc 1.7.0 */ |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
541 _OrthancPluginService_GetInstanceFramesCount = 4012, /* New in Orthanc 1.7.0 */ |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
542 _OrthancPluginService_GetInstanceRawFrame = 4013, /* New in Orthanc 1.7.0 */ |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
543 _OrthancPluginService_GetInstanceDecodedFrame = 4014, /* New in Orthanc 1.7.0 */ |
|
3919
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
544 _OrthancPluginService_TranscodeDicomInstance = 4015, /* New in Orthanc 1.7.0 */ |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
545 _OrthancPluginService_SerializeDicomInstance = 4016, /* New in Orthanc 1.7.0 */ |
|
3925
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
546 _OrthancPluginService_GetInstanceAdvancedJson = 4017, /* New in Orthanc 1.7.0 */ |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
547 _OrthancPluginService_GetInstanceDicomWebJson = 4018, /* New in Orthanc 1.7.0 */ |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
548 _OrthancPluginService_GetInstanceDicomWebXml = 4019, /* New in Orthanc 1.7.0 */ |
|
5319
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
549 _OrthancPluginService_LoadDicomInstance = 4020, /* New in Orthanc 1.12.1 */ |
|
3916
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
550 |
|
1309
8f4487d8f79e
new files for custom database back-end
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1303
diff
changeset
|
551 /* Services for plugins implementing a database back-end */ |
|
4595
cc64385593ef
added OrthancPluginRegisterDatabaseBackendV3() to plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4551
diff
changeset
|
552 _OrthancPluginService_RegisterDatabaseBackend = 5000, /* New in Orthanc 0.8.6 */ |
|
1580
bf502300c52e
force the size of the enumerations in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1579
diff
changeset
|
553 _OrthancPluginService_DatabaseAnswer = 5001, |
|
4595
cc64385593ef
added OrthancPluginRegisterDatabaseBackendV3() to plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4551
diff
changeset
|
554 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002, /* New in Orthanc 0.9.4 */ |
|
1615
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
555 _OrthancPluginService_StorageAreaCreate = 5003, |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
556 _OrthancPluginService_StorageAreaRead = 5004, |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
557 _OrthancPluginService_StorageAreaRemove = 5005, |
|
4603
c125bfd31023
rename 1.10.0 as 1.9.2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4599
diff
changeset
|
558 _OrthancPluginService_RegisterDatabaseBackendV3 = 5006, /* New in Orthanc 1.9.2 */ |
| 5218 | 559 _OrthancPluginService_RegisterDatabaseBackendV4 = 5007, /* New in Orthanc 1.12.0 */ |
|
5194
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
560 |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
561 /* Primitives for handling images */ |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
562 _OrthancPluginService_GetImagePixelFormat = 6000, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
563 _OrthancPluginService_GetImageWidth = 6001, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
564 _OrthancPluginService_GetImageHeight = 6002, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
565 _OrthancPluginService_GetImagePitch = 6003, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
566 _OrthancPluginService_GetImageBuffer = 6004, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
567 _OrthancPluginService_UncompressImage = 6005, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
568 _OrthancPluginService_FreeImage = 6006, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
569 _OrthancPluginService_CompressImage = 6007, |
|
1608
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
570 _OrthancPluginService_ConvertPixelFormat = 6008, |
|
1613
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
571 _OrthancPluginService_GetFontsCount = 6009, |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
572 _OrthancPluginService_GetFontInfo = 6010, |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
573 _OrthancPluginService_DrawText = 6011, |
|
1827
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
574 _OrthancPluginService_CreateImage = 6012, |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
575 _OrthancPluginService_CreateImageAccessor = 6013, |
|
1829
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
576 _OrthancPluginService_DecodeDicomImage = 6014, |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
577 |
|
1995
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
578 /* Primitives for handling C-Find, C-Move and worklists */ |
|
1810
796d0b087fb8
more consistent naming in worklist primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1803
diff
changeset
|
579 _OrthancPluginService_WorklistAddAnswer = 7000, |
|
796d0b087fb8
more consistent naming in worklist primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1803
diff
changeset
|
580 _OrthancPluginService_WorklistMarkIncomplete = 7001, |
|
796d0b087fb8
more consistent naming in worklist primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1803
diff
changeset
|
581 _OrthancPluginService_WorklistIsMatch = 7002, |
|
796d0b087fb8
more consistent naming in worklist primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1803
diff
changeset
|
582 _OrthancPluginService_WorklistGetDicomQuery = 7003, |
|
1995
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
583 _OrthancPluginService_FindAddAnswer = 7004, |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
584 _OrthancPluginService_FindMarkIncomplete = 7005, |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
585 _OrthancPluginService_GetFindQuerySize = 7006, |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
586 _OrthancPluginService_GetFindQueryTag = 7007, |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
587 _OrthancPluginService_GetFindQueryTagName = 7008, |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
588 _OrthancPluginService_GetFindQueryValue = 7009, |
|
2210
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
589 _OrthancPluginService_CreateFindMatcher = 7010, |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
590 _OrthancPluginService_FreeFindMatcher = 7011, |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
591 _OrthancPluginService_FindMatcherIsMatch = 7012, |
|
1800
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
592 |
|
2799
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
593 /* Primitives for accessing Orthanc Peers (new in 1.4.2) */ |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
594 _OrthancPluginService_GetPeers = 8000, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
595 _OrthancPluginService_FreePeers = 8001, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
596 _OrthancPluginService_GetPeersCount = 8003, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
597 _OrthancPluginService_GetPeerName = 8004, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
598 _OrthancPluginService_GetPeerUrl = 8005, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
599 _OrthancPluginService_CallPeerApi = 8006, |
|
2823
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
600 _OrthancPluginService_GetPeerUserProperty = 8007, |
|
2815
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
601 |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
602 /* Primitives for handling jobs (new in 1.4.2) */ |
|
5138
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
603 _OrthancPluginService_CreateJob = 9000, /* Deprecated since SDK 1.11.3 */ |
|
2815
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
604 _OrthancPluginService_FreeJob = 9001, |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
605 _OrthancPluginService_SubmitJob = 9002, |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
606 _OrthancPluginService_RegisterJobsUnserializer = 9003, |
|
5138
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
607 _OrthancPluginService_CreateJob2 = 9004, /* New in SDK 1.11.3 */ |
|
2799
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
608 |
|
1580
bf502300c52e
force the size of the enumerations in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1579
diff
changeset
|
609 _OrthancPluginService_INTERNAL = 0x7fffffff |
| 907 | 610 } _OrthancPluginService; |
| 900 | 611 |
| 612 | |
|
1232
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
613 typedef enum |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
614 { |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
615 _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
|
616 _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
|
617 _OrthancPluginProperty_OrthancExplorer = 3, |
|
bf502300c52e
force the size of the enumerations in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1579
diff
changeset
|
618 |
|
bf502300c52e
force the size of the enumerations in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1579
diff
changeset
|
619 _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
|
620 } _OrthancPluginProperty; |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
621 |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
622 |
| 900 | 623 |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
624 /** |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
625 * 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
|
626 * @ingroup Images |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
627 **/ |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
628 typedef enum |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
629 { |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
630 /** |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
631 * @brief Graylevel 8bpp image. |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
632 * |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
633 * 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
|
634 * one byte. |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
635 **/ |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
636 OrthancPluginPixelFormat_Grayscale8 = 1, |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
637 |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
638 /** |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
639 * @brief Graylevel, unsigned 16bpp image. |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
640 * |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
641 * 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
|
642 * two bytes. |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
643 **/ |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
644 OrthancPluginPixelFormat_Grayscale16 = 2, |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
645 |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
646 /** |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
647 * @brief Graylevel, signed 16bpp image. |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
648 * |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
649 * 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
|
650 * bytes. |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
651 **/ |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
652 OrthancPluginPixelFormat_SignedGrayscale16 = 3, |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
653 |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
654 /** |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
655 * @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
|
656 * |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
657 * 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
|
658 * 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
|
659 **/ |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
660 OrthancPluginPixelFormat_RGB24 = 4, |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
661 |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
662 /** |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
663 * @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
|
664 * |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
665 * 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
|
666 * 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
|
667 **/ |
|
1580
bf502300c52e
force the size of the enumerations in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1579
diff
changeset
|
668 OrthancPluginPixelFormat_RGBA32 = 5, |
|
bf502300c52e
force the size of the enumerations in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1579
diff
changeset
|
669 |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
670 OrthancPluginPixelFormat_Unknown = 6, /*!< Unknown pixel format */ |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
671 |
|
2424
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
672 /** |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
673 * @brief Color image in RGB48 format. |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
674 * |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
675 * This format describes a color image. The pixels are stored in 6 |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
676 * consecutive bytes. The memory layout is RRGGBB. |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
677 **/ |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
678 OrthancPluginPixelFormat_RGB48 = 7, |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
679 |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
680 /** |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
681 * @brief Graylevel, unsigned 32bpp image. |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
682 * |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
683 * The image is graylevel. Each pixel is unsigned and stored in |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
684 * four bytes. |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
685 **/ |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
686 OrthancPluginPixelFormat_Grayscale32 = 8, |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
687 |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
688 /** |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
689 * @brief Graylevel, floating-point 32bpp image. |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
690 * |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
691 * The image is graylevel. Each pixel is floating-point and stored |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
692 * in four bytes. |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
693 **/ |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
694 OrthancPluginPixelFormat_Float32 = 9, |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
695 |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
696 /** |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
697 * @brief Color image in BGRA32 format. |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
698 * |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
699 * This format describes a color image. The pixels are stored in 4 |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
700 * consecutive bytes. The memory layout is BGRA. |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
701 **/ |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
702 OrthancPluginPixelFormat_BGRA32 = 10, |
|
7ef9207f31d4
New pixel formats exposed in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2354
diff
changeset
|
703 |
|
2645
89b789366596
Grayscale64 pixel format
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2615
diff
changeset
|
704 /** |
|
89b789366596
Grayscale64 pixel format
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2615
diff
changeset
|
705 * @brief Graylevel, unsigned 64bpp image. |
|
89b789366596
Grayscale64 pixel format
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2615
diff
changeset
|
706 * |
|
89b789366596
Grayscale64 pixel format
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2615
diff
changeset
|
707 * The image is graylevel. Each pixel is unsigned and stored in |
|
89b789366596
Grayscale64 pixel format
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2615
diff
changeset
|
708 * eight bytes. |
|
89b789366596
Grayscale64 pixel format
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2615
diff
changeset
|
709 **/ |
|
89b789366596
Grayscale64 pixel format
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2615
diff
changeset
|
710 OrthancPluginPixelFormat_Grayscale64 = 11, |
|
89b789366596
Grayscale64 pixel format
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2615
diff
changeset
|
711 |
|
1580
bf502300c52e
force the size of the enumerations in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1579
diff
changeset
|
712 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
713 } OrthancPluginPixelFormat; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
714 |
| 894 | 715 |
|
1135
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 /** |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
718 * 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
|
719 **/ |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
720 typedef enum |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
721 { |
|
4596
2b64cc3cea99
added OrthancPluginContentType_DicomUntilPixelData
Alain Mazy <am@osimis.io>
parents:
4516
diff
changeset
|
722 OrthancPluginContentType_Unknown = 0, /*!< Unknown content type */ |
|
2b64cc3cea99
added OrthancPluginContentType_DicomUntilPixelData
Alain Mazy <am@osimis.io>
parents:
4516
diff
changeset
|
723 OrthancPluginContentType_Dicom = 1, /*!< DICOM */ |
|
2b64cc3cea99
added OrthancPluginContentType_DicomUntilPixelData
Alain Mazy <am@osimis.io>
parents:
4516
diff
changeset
|
724 OrthancPluginContentType_DicomAsJson = 2, /*!< JSON summary of a DICOM file */ |
|
2b64cc3cea99
added OrthancPluginContentType_DicomUntilPixelData
Alain Mazy <am@osimis.io>
parents:
4516
diff
changeset
|
725 OrthancPluginContentType_DicomUntilPixelData = 3, /*!< DICOM Header till pixel data */ |
|
1580
bf502300c52e
force the size of the enumerations in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1579
diff
changeset
|
726 |
|
bf502300c52e
force the size of the enumerations in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1579
diff
changeset
|
727 _OrthancPluginContentType_INTERNAL = 0x7fffffff |
|
1135
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
728 } OrthancPluginContentType; |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
729 |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
730 |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
731 |
| 907 | 732 /** |
|
1554
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
733 * The supported types of DICOM resources. |
|
1177
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
734 **/ |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
735 typedef enum |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
736 { |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
737 OrthancPluginResourceType_Patient = 0, /*!< Patient */ |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
738 OrthancPluginResourceType_Study = 1, /*!< Study */ |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
739 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
|
740 OrthancPluginResourceType_Instance = 3, /*!< Instance */ |
|
1741
06addfcd1d4c
OrthancStarted and OrthancStopped events in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1740
diff
changeset
|
741 OrthancPluginResourceType_None = 4, /*!< Unavailable resource type */ |
|
1580
bf502300c52e
force the size of the enumerations in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1579
diff
changeset
|
742 |
|
bf502300c52e
force the size of the enumerations in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1579
diff
changeset
|
743 _OrthancPluginResourceType_INTERNAL = 0x7fffffff |
|
1177
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
744 } OrthancPluginResourceType; |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
745 |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
746 |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
747 |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
748 /** |
|
4024
1d2b31fc782f
new 'changes': JobSubmitted, JobSuccess, JobFailure
Alain Mazy <alain@mazy.be>
parents:
3963
diff
changeset
|
749 * The supported types of changes that can be signaled to the change callback. |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
750 * @ingroup Callbacks |
|
1177
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
751 **/ |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
752 typedef enum |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
753 { |
| 1198 | 754 OrthancPluginChangeType_CompletedSeries = 0, /*!< Series is now complete */ |
| 755 OrthancPluginChangeType_Deleted = 1, /*!< Deleted resource */ | |
| 756 OrthancPluginChangeType_NewChildInstance = 2, /*!< A new instance was added to this resource */ | |
| 757 OrthancPluginChangeType_NewInstance = 3, /*!< New instance received */ | |
| 758 OrthancPluginChangeType_NewPatient = 4, /*!< New patient created */ | |
| 759 OrthancPluginChangeType_NewSeries = 5, /*!< New series created */ | |
| 760 OrthancPluginChangeType_NewStudy = 6, /*!< New study created */ | |
| 761 OrthancPluginChangeType_StablePatient = 7, /*!< Timeout: No new instance in this patient */ | |
| 762 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
|
763 OrthancPluginChangeType_StableStudy = 9, /*!< Timeout: No new instance in this study */ |
|
1741
06addfcd1d4c
OrthancStarted and OrthancStopped events in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1740
diff
changeset
|
764 OrthancPluginChangeType_OrthancStarted = 10, /*!< Orthanc has started */ |
|
06addfcd1d4c
OrthancStarted and OrthancStopped events in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1740
diff
changeset
|
765 OrthancPluginChangeType_OrthancStopped = 11, /*!< Orthanc is stopping */ |
|
1773
613df4362575
New UpdatedAttachment and UpdatedMetadata events in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1765
diff
changeset
|
766 OrthancPluginChangeType_UpdatedAttachment = 12, /*!< Some user-defined attachment has changed for this resource */ |
|
613df4362575
New UpdatedAttachment and UpdatedMetadata events in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1765
diff
changeset
|
767 OrthancPluginChangeType_UpdatedMetadata = 13, /*!< Some user-defined metadata has changed for this resource */ |
|
2801
3ee82c7313e7
New events in change callbacks: "UpdatedPeers" and "UpdatedModalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2799
diff
changeset
|
768 OrthancPluginChangeType_UpdatedPeers = 14, /*!< The list of Orthanc peers has changed */ |
|
3ee82c7313e7
New events in change callbacks: "UpdatedPeers" and "UpdatedModalities"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2799
diff
changeset
|
769 OrthancPluginChangeType_UpdatedModalities = 15, /*!< The list of DICOM modalities has changed */ |
|
4024
1d2b31fc782f
new 'changes': JobSubmitted, JobSuccess, JobFailure
Alain Mazy <alain@mazy.be>
parents:
3963
diff
changeset
|
770 OrthancPluginChangeType_JobSubmitted = 16, /*!< New Job submitted */ |
|
1d2b31fc782f
new 'changes': JobSubmitted, JobSuccess, JobFailure
Alain Mazy <alain@mazy.be>
parents:
3963
diff
changeset
|
771 OrthancPluginChangeType_JobSuccess = 17, /*!< A Job has completed successfully */ |
|
1d2b31fc782f
new 'changes': JobSubmitted, JobSuccess, JobFailure
Alain Mazy <alain@mazy.be>
parents:
3963
diff
changeset
|
772 OrthancPluginChangeType_JobFailure = 18, /*!< A Job has failed */ |
|
1580
bf502300c52e
force the size of the enumerations in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1579
diff
changeset
|
773 |
|
bf502300c52e
force the size of the enumerations in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1579
diff
changeset
|
774 _OrthancPluginChangeType_INTERNAL = 0x7fffffff |
|
1177
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
775 } OrthancPluginChangeType; |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
776 |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
777 |
|
1554
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
778 /** |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
779 * 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
|
780 * @ingroup Images |
|
1554
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
781 **/ |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
782 typedef enum |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
783 { |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
784 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
|
785 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
|
786 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
|
787 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
|
788 |
|
bf502300c52e
force the size of the enumerations in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1579
diff
changeset
|
789 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff |
|
1554
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
790 } OrthancPluginCompressionType; |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
791 |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
792 |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
793 /** |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
794 * 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
|
795 * @ingroup Images |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
796 **/ |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
797 typedef enum |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
798 { |
|
1829
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
799 OrthancPluginImageFormat_Png = 0, /*!< Image compressed using PNG */ |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
800 OrthancPluginImageFormat_Jpeg = 1, /*!< Image compressed using JPEG */ |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
801 OrthancPluginImageFormat_Dicom = 2, /*!< Image compressed using DICOM */ |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
802 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
803 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
804 } OrthancPluginImageFormat; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
805 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
806 |
|
1657
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
807 /** |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
808 * The value representations present in the DICOM standard (version 2013). |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
809 * @ingroup Toolbox |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
810 **/ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
811 typedef enum |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
812 { |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
813 OrthancPluginValueRepresentation_AE = 1, /*!< Application Entity */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
814 OrthancPluginValueRepresentation_AS = 2, /*!< Age String */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
815 OrthancPluginValueRepresentation_AT = 3, /*!< Attribute Tag */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
816 OrthancPluginValueRepresentation_CS = 4, /*!< Code String */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
817 OrthancPluginValueRepresentation_DA = 5, /*!< Date */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
818 OrthancPluginValueRepresentation_DS = 6, /*!< Decimal String */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
819 OrthancPluginValueRepresentation_DT = 7, /*!< Date Time */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
820 OrthancPluginValueRepresentation_FD = 8, /*!< Floating Point Double */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
821 OrthancPluginValueRepresentation_FL = 9, /*!< Floating Point Single */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
822 OrthancPluginValueRepresentation_IS = 10, /*!< Integer String */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
823 OrthancPluginValueRepresentation_LO = 11, /*!< Long String */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
824 OrthancPluginValueRepresentation_LT = 12, /*!< Long Text */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
825 OrthancPluginValueRepresentation_OB = 13, /*!< Other Byte String */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
826 OrthancPluginValueRepresentation_OF = 14, /*!< Other Float String */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
827 OrthancPluginValueRepresentation_OW = 15, /*!< Other Word String */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
828 OrthancPluginValueRepresentation_PN = 16, /*!< Person Name */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
829 OrthancPluginValueRepresentation_SH = 17, /*!< Short String */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
830 OrthancPluginValueRepresentation_SL = 18, /*!< Signed Long */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
831 OrthancPluginValueRepresentation_SQ = 19, /*!< Sequence of Items */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
832 OrthancPluginValueRepresentation_SS = 20, /*!< Signed Short */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
833 OrthancPluginValueRepresentation_ST = 21, /*!< Short Text */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
834 OrthancPluginValueRepresentation_TM = 22, /*!< Time */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
835 OrthancPluginValueRepresentation_UI = 23, /*!< Unique Identifier (UID) */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
836 OrthancPluginValueRepresentation_UL = 24, /*!< Unsigned Long */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
837 OrthancPluginValueRepresentation_UN = 25, /*!< Unknown */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
838 OrthancPluginValueRepresentation_US = 26, /*!< Unsigned Short */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
839 OrthancPluginValueRepresentation_UT = 27, /*!< Unlimited Text */ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
840 |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
841 _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
842 } OrthancPluginValueRepresentation; |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
843 |
|
1177
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
844 |
| 1743 | 845 /** |
| 846 * The possible output formats for a DICOM-to-JSON conversion. | |
| 847 * @ingroup Toolbox | |
|
1827
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
848 * @see OrthancPluginDicomToJson() |
| 1743 | 849 **/ |
|
1740
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
850 typedef enum |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
851 { |
| 1743 | 852 OrthancPluginDicomToJsonFormat_Full = 1, /*!< Full output, with most details */ |
| 853 OrthancPluginDicomToJsonFormat_Short = 2, /*!< Tags output as hexadecimal numbers */ | |
|
1860
c7d70f659190
DicomToJsonFormat_Simple -> DicomToJsonFormat_Human
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1833
diff
changeset
|
854 OrthancPluginDicomToJsonFormat_Human = 3, /*!< Human-readable JSON */ |
|
1740
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
855 |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
856 _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
857 } OrthancPluginDicomToJsonFormat; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
858 |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
859 |
| 1743 | 860 /** |
| 861 * Flags to customize a DICOM-to-JSON conversion. By default, binary | |
| 862 * tags are formatted using Data URI scheme. | |
| 863 * @ingroup Toolbox | |
| 864 **/ | |
|
1740
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
865 typedef enum |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
866 { |
|
5399
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
867 OrthancPluginDicomToJsonFlags_None = 0, /*!< Default formatting */ |
| 1743 | 868 OrthancPluginDicomToJsonFlags_IncludeBinary = (1 << 0), /*!< Include the binary tags */ |
| 869 OrthancPluginDicomToJsonFlags_IncludePrivateTags = (1 << 1), /*!< Include the private tags */ | |
| 870 OrthancPluginDicomToJsonFlags_IncludeUnknownTags = (1 << 2), /*!< Include the tags unknown by the dictionary */ | |
| 871 OrthancPluginDicomToJsonFlags_IncludePixelData = (1 << 3), /*!< Include the pixel data */ | |
| 872 OrthancPluginDicomToJsonFlags_ConvertBinaryToAscii = (1 << 4), /*!< Output binary tags as-is, dropping non-ASCII */ | |
| 873 OrthancPluginDicomToJsonFlags_ConvertBinaryToNull = (1 << 5), /*!< Signal binary tags as null values */ | |
|
4514
5b929e6b3c36
removal of "dicom-as-json" attachments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4483
diff
changeset
|
874 OrthancPluginDicomToJsonFlags_StopAfterPixelData = (1 << 6), /*!< Stop processing after pixel data (new in 1.9.1) */ |
|
4516
671ee7c1fd46
added DicomToJsonFlags_SkipGroupLengths
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4514
diff
changeset
|
875 OrthancPluginDicomToJsonFlags_SkipGroupLengths = (1 << 7), /*!< Skip tags whose element is zero (new in 1.9.1) */ |
|
1740
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
876 |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
877 _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
878 } OrthancPluginDicomToJsonFlags; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
879 |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
880 |
|
1177
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
881 /** |
|
5399
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
882 * Flags for the creation of a DICOM file. |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
883 * @ingroup Toolbox |
|
1827
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
884 * @see OrthancPluginCreateDicom() |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
885 **/ |
|
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
886 typedef enum |
|
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
887 { |
|
5399
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
888 OrthancPluginCreateDicomFlags_None = 0, /*!< Default mode */ |
|
1827
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
889 OrthancPluginCreateDicomFlags_DecodeDataUriScheme = (1 << 0), /*!< Decode fields encoded using data URI scheme */ |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
890 OrthancPluginCreateDicomFlags_GenerateIdentifiers = (1 << 1), /*!< Automatically generate DICOM identifiers */ |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
891 |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
892 _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
893 } OrthancPluginCreateDicomFlags; |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
894 |
|
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
895 |
|
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
896 /** |
|
1760
51db4a25a741
LookupIdentifier is plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1746
diff
changeset
|
897 * The constraints on the DICOM identifiers that must be supported |
|
51db4a25a741
LookupIdentifier is plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1746
diff
changeset
|
898 * by the database plugins. |
|
3074
495c5edce708
new extension for database plugin SDK: lookupResources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
899 * @deprecated Plugins using OrthancPluginConstraintType will be faster |
|
1760
51db4a25a741
LookupIdentifier is plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1746
diff
changeset
|
900 **/ |
|
51db4a25a741
LookupIdentifier is plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1746
diff
changeset
|
901 typedef enum |
|
51db4a25a741
LookupIdentifier is plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1746
diff
changeset
|
902 { |
|
1815
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
903 OrthancPluginIdentifierConstraint_Equal = 1, /*!< Equal */ |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
904 OrthancPluginIdentifierConstraint_SmallerOrEqual = 2, /*!< Less or equal */ |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
905 OrthancPluginIdentifierConstraint_GreaterOrEqual = 3, /*!< More or equal */ |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
906 OrthancPluginIdentifierConstraint_Wildcard = 4, /*!< Case-sensitive wildcard matching (with * and ?) */ |
|
1760
51db4a25a741
LookupIdentifier is plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1746
diff
changeset
|
907 |
|
51db4a25a741
LookupIdentifier is plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1746
diff
changeset
|
908 _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff |
|
51db4a25a741
LookupIdentifier is plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1746
diff
changeset
|
909 } OrthancPluginIdentifierConstraint; |
|
51db4a25a741
LookupIdentifier is plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1746
diff
changeset
|
910 |
|
51db4a25a741
LookupIdentifier is plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1746
diff
changeset
|
911 |
|
1815
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
912 /** |
|
3074
495c5edce708
new extension for database plugin SDK: lookupResources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
913 * The constraints on the tags (main DICOM tags and identifier tags) |
|
495c5edce708
new extension for database plugin SDK: lookupResources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
914 * that must be supported by the database plugins. |
|
495c5edce708
new extension for database plugin SDK: lookupResources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
915 **/ |
|
495c5edce708
new extension for database plugin SDK: lookupResources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
916 typedef enum |
|
495c5edce708
new extension for database plugin SDK: lookupResources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
917 { |
|
495c5edce708
new extension for database plugin SDK: lookupResources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
918 OrthancPluginConstraintType_Equal = 1, /*!< Equal */ |
|
495c5edce708
new extension for database plugin SDK: lookupResources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
919 OrthancPluginConstraintType_SmallerOrEqual = 2, /*!< Less or equal */ |
|
495c5edce708
new extension for database plugin SDK: lookupResources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
920 OrthancPluginConstraintType_GreaterOrEqual = 3, /*!< More or equal */ |
|
495c5edce708
new extension for database plugin SDK: lookupResources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
921 OrthancPluginConstraintType_Wildcard = 4, /*!< Wildcard matching */ |
|
495c5edce708
new extension for database plugin SDK: lookupResources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
922 OrthancPluginConstraintType_List = 5, /*!< List of values */ |
|
495c5edce708
new extension for database plugin SDK: lookupResources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
923 |
|
495c5edce708
new extension for database plugin SDK: lookupResources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
924 _OrthancPluginConstraintType_INTERNAL = 0x7fffffff |
|
495c5edce708
new extension for database plugin SDK: lookupResources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
925 } OrthancPluginConstraintType; |
|
495c5edce708
new extension for database plugin SDK: lookupResources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
926 |
|
495c5edce708
new extension for database plugin SDK: lookupResources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
927 |
|
495c5edce708
new extension for database plugin SDK: lookupResources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
928 /** |
|
1815
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
929 * The origin of a DICOM instance that has been received by Orthanc. |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
930 **/ |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
931 typedef enum |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
932 { |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
933 OrthancPluginInstanceOrigin_Unknown = 1, /*!< Unknown origin */ |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
934 OrthancPluginInstanceOrigin_DicomProtocol = 2, /*!< Instance received through DICOM protocol */ |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
935 OrthancPluginInstanceOrigin_RestApi = 3, /*!< Instance received through REST API of Orthanc */ |
|
1816
87c069c94ac9
plugin sample: automated jpeg2k compression
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1815
diff
changeset
|
936 OrthancPluginInstanceOrigin_Plugin = 4, /*!< Instance added to Orthanc by a plugin */ |
|
1815
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
937 OrthancPluginInstanceOrigin_Lua = 5, /*!< Instance added to Orthanc by a Lua script */ |
|
4245
c70df925151e
RequestOrigin_WebDav
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4181
diff
changeset
|
938 OrthancPluginInstanceOrigin_WebDav = 6, /*!< Instance received through WebDAV (new in 1.8.0) */ |
|
1815
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
939 |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
940 _OrthancPluginInstanceOrigin_INTERNAL = 0x7fffffff |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
941 } OrthancPluginInstanceOrigin; |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
942 |
|
1760
51db4a25a741
LookupIdentifier is plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1746
diff
changeset
|
943 |
|
51db4a25a741
LookupIdentifier is plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1746
diff
changeset
|
944 /** |
|
2808
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
945 * The possible status for one single step of a job. |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
946 **/ |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
947 typedef enum |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
948 { |
|
2811
7cfc8d266f41
reason for releasing resources in jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2808
diff
changeset
|
949 OrthancPluginJobStepStatus_Success = 1, /*!< The job has successfully executed all its steps */ |
|
7cfc8d266f41
reason for releasing resources in jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2808
diff
changeset
|
950 OrthancPluginJobStepStatus_Failure = 2, /*!< The job has failed while executing this step */ |
|
7cfc8d266f41
reason for releasing resources in jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2808
diff
changeset
|
951 OrthancPluginJobStepStatus_Continue = 3 /*!< The job has still data to process after this step */ |
|
2808
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
952 } OrthancPluginJobStepStatus; |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
953 |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
954 |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
955 /** |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
956 * Explains why the job should stop and release the resources it has |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
957 * allocated. This is especially important to disambiguate between |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
958 * the "paused" condition and the "final" conditions (success, |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
959 * failure, or canceled). |
|
2811
7cfc8d266f41
reason for releasing resources in jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2808
diff
changeset
|
960 **/ |
|
7cfc8d266f41
reason for releasing resources in jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2808
diff
changeset
|
961 typedef enum |
|
7cfc8d266f41
reason for releasing resources in jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2808
diff
changeset
|
962 { |
|
2812
ea7aea6f6a95
improved naming of methods in IJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2811
diff
changeset
|
963 OrthancPluginJobStopReason_Success = 1, /*!< The job has succeeded */ |
|
ea7aea6f6a95
improved naming of methods in IJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2811
diff
changeset
|
964 OrthancPluginJobStopReason_Paused = 2, /*!< The job was paused, and will be resumed later */ |
|
ea7aea6f6a95
improved naming of methods in IJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2811
diff
changeset
|
965 OrthancPluginJobStopReason_Failure = 3, /*!< The job has failed, and might be resubmitted later */ |
|
ea7aea6f6a95
improved naming of methods in IJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2811
diff
changeset
|
966 OrthancPluginJobStopReason_Canceled = 4 /*!< The job was canceled, and might be resubmitted later */ |
|
ea7aea6f6a95
improved naming of methods in IJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2811
diff
changeset
|
967 } OrthancPluginJobStopReason; |
|
2811
7cfc8d266f41
reason for releasing resources in jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2808
diff
changeset
|
968 |
|
7cfc8d266f41
reason for releasing resources in jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2808
diff
changeset
|
969 |
|
7cfc8d266f41
reason for releasing resources in jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2808
diff
changeset
|
970 /** |
|
3209
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
971 * The available types of metrics. |
|
3179
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
972 **/ |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
973 typedef enum |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
974 { |
|
3662
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
975 OrthancPluginMetricsType_Default = 0, /*!< Default metrics */ |
|
3179
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
976 |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
977 /** |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
978 * This metrics represents a time duration. Orthanc will keep the |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
979 * maximum value of the metrics over a sliding window of ten |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
980 * seconds, which is useful if the metrics is sampled frequently. |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
981 **/ |
|
3662
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
982 OrthancPluginMetricsType_Timer = 1 |
|
3179
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
983 } OrthancPluginMetricsType; |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
984 |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
985 |
|
3209
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
986 /** |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
987 * The available modes to export a binary DICOM tag into a DICOMweb |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
988 * JSON or XML document. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
989 **/ |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
990 typedef enum |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
991 { |
|
3662
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
992 OrthancPluginDicomWebBinaryMode_Ignore = 0, /*!< Don't include binary tags */ |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
993 OrthancPluginDicomWebBinaryMode_InlineBinary = 1, /*!< Inline encoding using Base64 */ |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
994 OrthancPluginDicomWebBinaryMode_BulkDataUri = 2 /*!< Use a bulk data URI field */ |
|
3209
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
995 } OrthancPluginDicomWebBinaryMode; |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
996 |
|
3662
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
997 |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
998 /** |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
999 * The available values for the Failure Reason (0008,1197) during |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
1000 * storage commitment. |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
1001 * http://dicom.nema.org/medical/dicom/2019e/output/chtml/part03/sect_C.14.html#sect_C.14.1.1 |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
1002 **/ |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
1003 typedef enum |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
1004 { |
|
5399
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1005 /** |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1006 * Success: The DICOM instance is properly stored in the SCP |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1007 **/ |
|
3662
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
1008 OrthancPluginStorageCommitmentFailureReason_Success = 0, |
|
5399
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1009 |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1010 /** |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1011 * 0110H: A general failure in processing the operation was encountered |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1012 **/ |
|
3662
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
1013 OrthancPluginStorageCommitmentFailureReason_ProcessingFailure = 1, |
|
5399
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1014 |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1015 /** |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1016 * 0112H: One or more of the elements in the Referenced SOP |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1017 * Instance Sequence was not available |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1018 **/ |
|
3662
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
1019 OrthancPluginStorageCommitmentFailureReason_NoSuchObjectInstance = 2, |
|
5399
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1020 |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1021 /** |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1022 * 0213H: The SCP does not currently have enough resources to |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1023 * store the requested SOP Instance(s) |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1024 **/ |
|
3662
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
1025 OrthancPluginStorageCommitmentFailureReason_ResourceLimitation = 3, |
|
5399
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1026 |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1027 /** |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1028 * 0122H: Storage Commitment has been requested for a SOP Instance |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1029 * with a SOP Class that is not supported by the SCP |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1030 **/ |
|
3662
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
1031 OrthancPluginStorageCommitmentFailureReason_ReferencedSOPClassNotSupported = 4, |
|
5399
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1032 |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1033 /** |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1034 * 0119H: The SOP Class of an element in the Referenced SOP |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1035 * Instance Sequence did not correspond to the SOP class |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1036 * registered for this SOP Instance at the SCP |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1037 **/ |
|
3662
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
1038 OrthancPluginStorageCommitmentFailureReason_ClassInstanceConflict = 5, |
|
5399
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1039 |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1040 /** |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1041 * 0131H: The Transaction UID of the Storage Commitment Request is |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1042 * already in use |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1043 **/ |
|
3662
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
1044 OrthancPluginStorageCommitmentFailureReason_DuplicateTransactionUID = 6 |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
1045 } OrthancPluginStorageCommitmentFailureReason; |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
1046 |
|
4845
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
1047 |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
1048 /** |
|
4919
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
1049 * The action to be taken after ReceivedInstanceCallback is triggered |
|
4845
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
1050 **/ |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
1051 typedef enum |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
1052 { |
|
4919
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
1053 OrthancPluginReceivedInstanceAction_KeepAsIs = 1, /*!< Keep the instance as is */ |
|
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
1054 OrthancPluginReceivedInstanceAction_Modify = 2, /*!< Modify the instance */ |
|
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
1055 OrthancPluginReceivedInstanceAction_Discard = 3, /*!< Discard the instance */ |
|
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
1056 |
|
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
1057 _OrthancPluginReceivedInstanceAction_INTERNAL = 0x7fffffff |
|
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
1058 } OrthancPluginReceivedInstanceAction; |
|
4845
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
1059 |
|
3179
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
1060 |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
1061 /** |
|
5319
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
1062 * Mode specifying how to load a DICOM instance. |
|
5327
f01c06f75d67
sanitizing @see in OrthancCPlugin.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5326
diff
changeset
|
1063 * @see OrthancPluginLoadDicomInstance() |
|
5319
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
1064 **/ |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
1065 typedef enum |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
1066 { |
|
5399
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1067 /** |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1068 * Load the whole DICOM file, including pixel data |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1069 **/ |
|
5319
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
1070 OrthancPluginLoadDicomInstanceMode_WholeDicom = 1, |
|
5399
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1071 |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1072 /** |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1073 * Load the whole DICOM file until pixel data, which speeds up the |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1074 * loading |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1075 **/ |
|
5319
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
1076 OrthancPluginLoadDicomInstanceMode_UntilPixelData = 2, |
|
5399
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1077 |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1078 /** |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1079 * Load the whole DICOM file until pixel data, and replace pixel |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1080 * data by an empty tag whose VR (value representation) is the |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1081 * same as those of the original DICOM file |
|
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
1082 **/ |
|
5319
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
1083 OrthancPluginLoadDicomInstanceMode_EmptyPixelData = 3, |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
1084 |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
1085 _OrthancPluginLoadDicomInstanceMode_INTERNAL = 0x7fffffff |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
1086 } OrthancPluginLoadDicomInstanceMode; |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
1087 |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
1088 |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
1089 /** |
|
5575
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1090 * The log levels supported by Orthanc. |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1091 * |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1092 * These values must match those of enumeration "LogLevel" in the |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1093 * Orthanc Core. |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1094 **/ |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1095 typedef enum |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1096 { |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1097 OrthancPluginLogLevel_Error = 0, /*!< Error log level */ |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1098 OrthancPluginLogLevel_Warning = 1, /*!< Warning log level */ |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1099 OrthancPluginLogLevel_Info = 2, /*!< Info log level */ |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1100 OrthancPluginLogLevel_Trace = 3, /*!< Trace log level */ |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1101 |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1102 _OrthancPluginLogLevel_INTERNAL = 0x7fffffff |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1103 } OrthancPluginLogLevel; |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1104 |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1105 |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1106 /** |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1107 * The log categories supported by Orthanc. |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1108 * |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1109 * These values must match those of enumeration "LogCategory" in the |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1110 * Orthanc Core. |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1111 **/ |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1112 typedef enum |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1113 { |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1114 OrthancPluginLogCategory_Generic = (1 << 0), /*!< Generic (default) category */ |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1115 OrthancPluginLogCategory_Plugins = (1 << 1), /*!< Plugin engine related logs (shall not be used by plugins) */ |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1116 OrthancPluginLogCategory_Http = (1 << 2), /*!< HTTP related logs */ |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1117 OrthancPluginLogCategory_Sqlite = (1 << 3), /*!< SQLite related logs (shall not be used by plugins) */ |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1118 OrthancPluginLogCategory_Dicom = (1 << 4), /*!< DICOM related logs */ |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1119 OrthancPluginLogCategory_Jobs = (1 << 5), /*!< jobs related logs */ |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1120 OrthancPluginLogCategory_Lua = (1 << 6), /*!< Lua related logs (shall not be used by plugins) */ |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1121 |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1122 _OrthancPluginLogCategory_INTERNAL = 0x7fffffff |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1123 } OrthancPluginLogCategory; |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1124 |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1125 |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
1126 /** |
|
4440
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1127 * @brief A 32-bit memory buffer allocated by the core system of Orthanc. |
| 907 | 1128 * |
| 1129 * A memory buffer allocated by the core system of Orthanc. When the | |
| 1130 * content of the buffer is not useful anymore, it must be free by a | |
| 1131 * call to ::OrthancPluginFreeMemoryBuffer(). | |
| 1132 **/ | |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
1133 typedef struct |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
1134 { |
| 907 | 1135 /** |
| 1136 * @brief The content of the buffer. | |
| 1137 **/ | |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
1138 void* data; |
| 907 | 1139 |
| 1140 /** | |
| 1141 * @brief The number of bytes in the buffer. | |
| 1142 **/ | |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
1143 uint32_t size; |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
1144 } OrthancPluginMemoryBuffer; |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
1145 |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
1146 |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
1147 |
|
4440
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1148 /** |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1149 * @brief A 64-bit memory buffer allocated by the core system of Orthanc. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1150 * |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1151 * A memory buffer allocated by the core system of Orthanc. When the |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1152 * content of the buffer is not useful anymore, it must be free by a |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1153 * call to ::OrthancPluginFreeMemoryBuffer64(). |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1154 **/ |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1155 typedef struct |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1156 { |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1157 /** |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1158 * @brief The content of the buffer. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1159 **/ |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1160 void* data; |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1161 |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1162 /** |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1163 * @brief The number of bytes in the buffer. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1164 **/ |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1165 uint64_t size; |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1166 } OrthancPluginMemoryBuffer64; |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1167 |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1168 |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1169 |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
1170 |
| 907 | 1171 /** |
| 1172 * @brief Opaque structure that represents the HTTP connection to the client application. | |
|
4943
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
1173 * @ingroup Callbacks |
| 907 | 1174 **/ |
| 900 | 1175 typedef struct _OrthancPluginRestOutput_t OrthancPluginRestOutput; |
| 1176 | |
| 907 | 1177 |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
1178 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
1179 /** |
| 3936 | 1180 * @brief Opaque structure that represents a DICOM instance that is managed by the Orthanc core. |
| 1181 * @ingroup DicomInstance | |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
1182 **/ |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
1183 typedef struct _OrthancPluginDicomInstance_t OrthancPluginDicomInstance; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
1184 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
1185 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
1186 |
| 907 | 1187 /** |
|
1615
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
1188 * @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
|
1189 * @ingroup Images |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
1190 **/ |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
1191 typedef struct _OrthancPluginImage_t OrthancPluginImage; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
1192 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
1193 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
1194 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
1195 /** |
|
1615
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
1196 * @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
|
1197 * @ingroup Images |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
1198 **/ |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
1199 typedef struct _OrthancPluginStorageArea_t OrthancPluginStorageArea; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
1200 |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
1201 |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
1202 |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
1203 /** |
|
1995
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1204 * @brief Opaque structure to an object that represents a C-Find query for worklists. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1205 * @ingroup DicomCallbacks |
|
1799
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1206 **/ |
|
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1207 typedef struct _OrthancPluginWorklistQuery_t OrthancPluginWorklistQuery; |
|
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1208 |
|
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1209 |
|
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1210 |
|
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1211 /** |
|
1995
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1212 * @brief Opaque structure to an object that represents the answers to a C-Find query for worklists. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1213 * @ingroup DicomCallbacks |
|
1799
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1214 **/ |
|
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1215 typedef struct _OrthancPluginWorklistAnswers_t OrthancPluginWorklistAnswers; |
|
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1216 |
|
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1217 |
|
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1218 |
|
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1219 /** |
|
1995
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1220 * @brief Opaque structure to an object that represents a C-Find query. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1221 * @ingroup DicomCallbacks |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1222 **/ |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1223 typedef struct _OrthancPluginFindQuery_t OrthancPluginFindQuery; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1224 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1225 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1226 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1227 /** |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1228 * @brief Opaque structure to an object that represents the answers to a C-Find query for worklists. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1229 * @ingroup DicomCallbacks |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1230 **/ |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1231 typedef struct _OrthancPluginFindAnswers_t OrthancPluginFindAnswers; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1232 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1233 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1234 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1235 /** |
|
2210
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
1236 * @brief Opaque structure to an object that can be used to check whether a DICOM instance matches a C-Find query. |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
1237 * @ingroup Toolbox |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
1238 **/ |
|
3790
59704c124722
fix typo in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3707
diff
changeset
|
1239 typedef struct _OrthancPluginFindMatcher_t OrthancPluginFindMatcher; |
|
2210
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
1240 |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
1241 |
|
2799
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
1242 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
1243 /** |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
1244 * @brief Opaque structure to the set of remote Orthanc Peers that are known to the local Orthanc server. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
1245 * @ingroup Toolbox |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
1246 **/ |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
1247 typedef struct _OrthancPluginPeers_t OrthancPluginPeers; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
1248 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
1249 |
|
2210
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
1250 |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
1251 /** |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1252 * @brief Opaque structure to a job to be executed by Orthanc. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1253 * @ingroup Toolbox |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1254 **/ |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1255 typedef struct _OrthancPluginJob_t OrthancPluginJob; |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1256 |
|
3209
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1257 |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1258 |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1259 /** |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1260 * @brief Opaque structure that represents a node in a JSON or XML |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1261 * document used in DICOMweb. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1262 * @ingroup Toolbox |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1263 **/ |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1264 typedef struct _OrthancPluginDicomWebNode_t OrthancPluginDicomWebNode; |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1265 |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1266 |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1267 |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1268 /** |
|
908
e078ea944089
refactoring HttpOutput
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
907
diff
changeset
|
1269 * @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
|
1270 * @ingroup Callbacks |
| 907 | 1271 **/ |
|
1628
77c4cc4def0f
OrthancPluginErrorCode in REST callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1627
diff
changeset
|
1272 typedef OrthancPluginErrorCode (*OrthancPluginRestCallback) ( |
| 900 | 1273 OrthancPluginRestOutput* output, |
| 1274 const char* url, | |
| 1275 const OrthancPluginHttpRequest* request); | |
| 1276 | |
| 907 | 1277 |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
1278 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
1279 /** |
|
3847
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
1280 * @brief Signature of a callback function that is triggered when Orthanc stores a new DICOM instance. |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
1281 * @ingroup Callbacks |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
1282 **/ |
|
1627
da7854deb662
Plugin callbacks must now return explicit "OrthancPluginErrorCode" instead of integers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1615
diff
changeset
|
1283 typedef OrthancPluginErrorCode (*OrthancPluginOnStoredInstanceCallback) ( |
|
3847
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
1284 const OrthancPluginDicomInstance* instance, |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
1285 const char* instanceId); |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
1286 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
1287 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
1288 |
| 907 | 1289 /** |
|
1177
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
1290 * @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
|
1291 * @ingroup Callbacks |
|
1177
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
1292 **/ |
|
1627
da7854deb662
Plugin callbacks must now return explicit "OrthancPluginErrorCode" instead of integers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1615
diff
changeset
|
1293 typedef OrthancPluginErrorCode (*OrthancPluginOnChangeCallback) ( |
|
1177
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
1294 OrthancPluginChangeType changeType, |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
1295 OrthancPluginResourceType resourceType, |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
1296 const char* resourceId); |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
1297 |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
1298 |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
1299 |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
1300 /** |
|
1826
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
1301 * @brief Signature of a callback function to decode a DICOM instance as an image. |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
1302 * @ingroup Callbacks |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
1303 **/ |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
1304 typedef OrthancPluginErrorCode (*OrthancPluginDecodeImageCallback) ( |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
1305 OrthancPluginImage** target, |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
1306 const void* dicom, |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
1307 const uint32_t size, |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
1308 uint32_t frameIndex); |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
1309 |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
1310 |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
1311 |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
1312 /** |
|
1135
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1313 * @brief Signature of a function to free dynamic memory. |
|
3209
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1314 * @ingroup Callbacks |
|
1135
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1315 **/ |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1316 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
|
1317 |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1318 |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1319 |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1320 /** |
|
3209
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1321 * @brief Signature of a function to set the content of a node |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1322 * encoding a binary DICOM tag, into a JSON or XML document |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1323 * generated for DICOMweb. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1324 * @ingroup Callbacks |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1325 **/ |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1326 typedef void (*OrthancPluginDicomWebSetBinaryNode) ( |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1327 OrthancPluginDicomWebNode* node, |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1328 OrthancPluginDicomWebBinaryMode mode, |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1329 const char* bulkDataUri); |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1330 |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1331 |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1332 |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1333 /** |
|
1135
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1334 * @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
|
1335 * |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1336 * 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
|
1337 * |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1338 * @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
|
1339 * @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
|
1340 * @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
|
1341 * @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
|
1342 * @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
|
1343 * @ingroup Callbacks |
|
1135
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1344 **/ |
|
1627
da7854deb662
Plugin callbacks must now return explicit "OrthancPluginErrorCode" instead of integers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1615
diff
changeset
|
1345 typedef OrthancPluginErrorCode (*OrthancPluginStorageCreate) ( |
|
1135
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1346 const char* uuid, |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1347 const void* content, |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1348 int64_t size, |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1349 OrthancPluginContentType type); |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1350 |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1351 |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1352 |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1353 /** |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1354 * @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
|
1355 * |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1356 * 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
|
1357 * |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1358 * @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
|
1359 * @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
|
1360 * @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
|
1361 * @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
|
1362 * @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
|
1363 * @ingroup Callbacks |
|
4440
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1364 * @deprecated New plugins should use OrthancPluginStorageRead2 |
|
3569
367a3afa05a7
note about OrthancPluginStorageRead()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3514
diff
changeset
|
1365 * |
|
367a3afa05a7
note about OrthancPluginStorageRead()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3514
diff
changeset
|
1366 * @warning The "content" buffer *must* have been allocated using |
|
367a3afa05a7
note about OrthancPluginStorageRead()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3514
diff
changeset
|
1367 * the "malloc()" function of your C standard library (i.e. nor |
|
367a3afa05a7
note about OrthancPluginStorageRead()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3514
diff
changeset
|
1368 * "new[]", neither a pointer to a buffer). The "free()" function of |
|
367a3afa05a7
note about OrthancPluginStorageRead()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3514
diff
changeset
|
1369 * your C standard library will automatically be invoked on the |
|
367a3afa05a7
note about OrthancPluginStorageRead()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3514
diff
changeset
|
1370 * "content" pointer. |
|
1135
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1371 **/ |
|
1627
da7854deb662
Plugin callbacks must now return explicit "OrthancPluginErrorCode" instead of integers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1615
diff
changeset
|
1372 typedef OrthancPluginErrorCode (*OrthancPluginStorageRead) ( |
|
1135
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1373 void** content, |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1374 int64_t* size, |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1375 const char* uuid, |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1376 OrthancPluginContentType type); |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1377 |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1378 |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1379 |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1380 /** |
|
4440
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1381 * @brief Callback for reading a whole file from the storage area. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1382 * |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1383 * Signature of a callback function that is triggered when Orthanc |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1384 * reads a whole file from the storage area. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1385 * |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1386 * @param target Memory buffer where to store the content of the file. It must be allocated by the |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1387 * plugin using OrthancPluginCreateMemoryBuffer64(). The core of Orthanc will free it. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1388 * @param uuid The UUID of the file of interest. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1389 * @param type The content type corresponding to this file. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1390 * @ingroup Callbacks |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1391 **/ |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1392 typedef OrthancPluginErrorCode (*OrthancPluginStorageReadWhole) ( |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1393 OrthancPluginMemoryBuffer64* target, |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1394 const char* uuid, |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1395 OrthancPluginContentType type); |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1396 |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1397 |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1398 |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1399 /** |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1400 * @brief Callback for reading a range of a file from the storage area. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1401 * |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1402 * Signature of a callback function that is triggered when Orthanc |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1403 * reads a portion of a file from the storage area. Orthanc |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1404 * indicates the start position and the length of the range. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1405 * |
|
4483
a926f8995d0b
sample for OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4477
diff
changeset
|
1406 * @param target Memory buffer where to store the content of the range. |
|
a926f8995d0b
sample for OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4477
diff
changeset
|
1407 * The memory buffer is allocated and freed by Orthanc. The length of the range |
|
a926f8995d0b
sample for OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4477
diff
changeset
|
1408 * of interest corresponds to the size of this buffer. |
|
4440
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1409 * @param uuid The UUID of the file of interest. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1410 * @param type The content type corresponding to this file. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1411 * @param rangeStart Start position of the requested range in the file. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1412 * @return 0 if success, other value if error. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1413 * @ingroup Callbacks |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1414 **/ |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1415 typedef OrthancPluginErrorCode (*OrthancPluginStorageReadRange) ( |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1416 OrthancPluginMemoryBuffer64* target, |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1417 const char* uuid, |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1418 OrthancPluginContentType type, |
|
4483
a926f8995d0b
sample for OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4477
diff
changeset
|
1419 uint64_t rangeStart); |
|
4440
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1420 |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1421 |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1422 |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
1423 /** |
|
1135
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1424 * @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
|
1425 * |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1426 * 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
|
1427 * |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1428 * @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
|
1429 * @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
|
1430 * @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
|
1431 * @ingroup Callbacks |
|
1135
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1432 **/ |
|
1627
da7854deb662
Plugin callbacks must now return explicit "OrthancPluginErrorCode" instead of integers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1615
diff
changeset
|
1433 typedef OrthancPluginErrorCode (*OrthancPluginStorageRemove) ( |
|
1135
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1434 const char* uuid, |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1435 OrthancPluginContentType type); |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1436 |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1437 |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1438 |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
1439 /** |
|
1995
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1440 * @brief Callback to handle the C-Find SCP requests for worklists. |
|
1799
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1441 * |
| 1803 | 1442 * Signature of a callback function that is triggered when Orthanc |
| 1443 * receives a C-Find SCP request against modality worklists. | |
|
1799
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1444 * |
|
1800
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
1445 * @param answers The target structure where answers must be stored. |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
1446 * @param query The worklist query. |
|
1999
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1447 * @param issuerAet The Application Entity Title (AET) of the modality from which the request originates. |
|
1800
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
1448 * @param calledAet The Application Entity Title (AET) of the modality that is called by the request. |
|
1799
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1449 * @return 0 if success, other value if error. |
|
1995
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
1450 * @ingroup DicomCallbacks |
|
1799
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1451 **/ |
|
1800
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
1452 typedef OrthancPluginErrorCode (*OrthancPluginWorklistCallback) ( |
|
1799
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1453 OrthancPluginWorklistAnswers* answers, |
|
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1454 const OrthancPluginWorklistQuery* query, |
|
1999
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1455 const char* issuerAet, |
|
1800
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
1456 const char* calledAet); |
|
1799
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1457 |
|
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1458 |
|
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1459 |
|
4f01c9d73f02
calledAet made available to all the handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1786
diff
changeset
|
1460 /** |
|
1961
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1461 * @brief Callback to filter incoming HTTP requests received by Orthanc. |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1462 * |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1463 * Signature of a callback function that is triggered whenever |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1464 * Orthanc receives an HTTP/REST request, and that answers whether |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1465 * this request should be allowed. If the callback returns "0" |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1466 * ("false"), the server answers with HTTP status code 403 |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1467 * (Forbidden). |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1468 * |
|
4364
d527a081f92d
Allow concurrency on the OrthancPluginRegisterIncomingHttpRequestFilter() callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4347
diff
changeset
|
1469 * Pay attention to the fact that this function may be invoked |
|
d527a081f92d
Allow concurrency on the OrthancPluginRegisterIncomingHttpRequestFilter() callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4347
diff
changeset
|
1470 * concurrently by different threads of the Web server of |
|
d527a081f92d
Allow concurrency on the OrthancPluginRegisterIncomingHttpRequestFilter() callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4347
diff
changeset
|
1471 * Orthanc. You must implement proper locking if applicable. |
|
d527a081f92d
Allow concurrency on the OrthancPluginRegisterIncomingHttpRequestFilter() callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4347
diff
changeset
|
1472 * |
|
1961
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1473 * @param method The HTTP method used by the request. |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1474 * @param uri The URI of interest. |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1475 * @param ip The IP address of the HTTP client. |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1476 * @param headersCount The number of HTTP headers. |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1477 * @param headersKeys The keys of the HTTP headers (always converted to low-case). |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1478 * @param headersValues The values of the HTTP headers. |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1479 * @return 0 if forbidden access, 1 if allowed access, -1 if error. |
|
4943
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
1480 * @ingroup Callbacks |
|
2268
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1481 * @deprecated Please instead use OrthancPluginIncomingHttpRequestFilter2() |
|
1961
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1482 **/ |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1483 typedef int32_t (*OrthancPluginIncomingHttpRequestFilter) ( |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1484 OrthancPluginHttpMethod method, |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1485 const char* uri, |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1486 const char* ip, |
| 1962 | 1487 uint32_t headersCount, |
|
1961
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1488 const char* const* headersKeys, |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1489 const char* const* headersValues); |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1490 |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1491 |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1492 |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
1493 /** |
|
2268
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1494 * @brief Callback to filter incoming HTTP requests received by Orthanc. |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1495 * |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1496 * Signature of a callback function that is triggered whenever |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1497 * Orthanc receives an HTTP/REST request, and that answers whether |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1498 * this request should be allowed. If the callback returns "0" |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1499 * ("false"), the server answers with HTTP status code 403 |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1500 * (Forbidden). |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1501 * |
|
4364
d527a081f92d
Allow concurrency on the OrthancPluginRegisterIncomingHttpRequestFilter() callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4347
diff
changeset
|
1502 * Pay attention to the fact that this function may be invoked |
|
d527a081f92d
Allow concurrency on the OrthancPluginRegisterIncomingHttpRequestFilter() callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4347
diff
changeset
|
1503 * concurrently by different threads of the Web server of |
|
d527a081f92d
Allow concurrency on the OrthancPluginRegisterIncomingHttpRequestFilter() callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4347
diff
changeset
|
1504 * Orthanc. You must implement proper locking if applicable. |
|
d527a081f92d
Allow concurrency on the OrthancPluginRegisterIncomingHttpRequestFilter() callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4347
diff
changeset
|
1505 * |
|
2268
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1506 * @param method The HTTP method used by the request. |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1507 * @param uri The URI of interest. |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1508 * @param ip The IP address of the HTTP client. |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1509 * @param headersCount The number of HTTP headers. |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1510 * @param headersKeys The keys of the HTTP headers (always converted to low-case). |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1511 * @param headersValues The values of the HTTP headers. |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1512 * @param getArgumentsCount The number of GET arguments (only for the GET HTTP method). |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1513 * @param getArgumentsKeys The keys of the GET arguments (only for the GET HTTP method). |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1514 * @param getArgumentsValues The values of the GET arguments (only for the GET HTTP method). |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1515 * @return 0 if forbidden access, 1 if allowed access, -1 if error. |
|
4943
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
1516 * @ingroup Callbacks |
|
2268
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1517 **/ |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1518 typedef int32_t (*OrthancPluginIncomingHttpRequestFilter2) ( |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1519 OrthancPluginHttpMethod method, |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1520 const char* uri, |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1521 const char* ip, |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1522 uint32_t headersCount, |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1523 const char* const* headersKeys, |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1524 const char* const* headersValues, |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1525 uint32_t getArgumentsCount, |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1526 const char* const* getArgumentsKeys, |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1527 const char* const* getArgumentsValues); |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1528 |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1529 |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1530 |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
1531 /** |
|
1999
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1532 * @brief Callback to handle incoming C-Find SCP requests. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1533 * |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1534 * Signature of a callback function that is triggered whenever |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1535 * Orthanc receives a C-Find SCP request not concerning modality |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1536 * worklists. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1537 * |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1538 * @param answers The target structure where answers must be stored. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1539 * @param query The worklist query. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1540 * @param issuerAet The Application Entity Title (AET) of the modality from which the request originates. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1541 * @param calledAet The Application Entity Title (AET) of the modality that is called by the request. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1542 * @return 0 if success, other value if error. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1543 * @ingroup DicomCallbacks |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1544 **/ |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1545 typedef OrthancPluginErrorCode (*OrthancPluginFindCallback) ( |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1546 OrthancPluginFindAnswers* answers, |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1547 const OrthancPluginFindQuery* query, |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1548 const char* issuerAet, |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1549 const char* calledAet); |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1550 |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1551 |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1552 |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1553 /** |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1554 * @brief Callback to handle incoming C-Move SCP requests. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1555 * |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1556 * Signature of a callback function that is triggered whenever |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1557 * Orthanc receives a C-Move SCP request. The callback receives the |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1558 * type of the resource of interest (study, series, instance...) |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1559 * together with the DICOM tags containing its identifiers. In turn, |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1560 * the plugin must create a driver object that will be responsible |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1561 * for driving the successive move suboperations. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1562 * |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1563 * @param resourceType The type of the resource of interest. Note |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1564 * that this might be set to ResourceType_None if the |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1565 * QueryRetrieveLevel (0008,0052) tag was not provided by the |
|
2222
21713ce8717b
Fix handling of Move Originator AET and ID in C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2216
diff
changeset
|
1566 * issuer (i.e. the originator modality). |
|
1999
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1567 * @param patientId Content of the PatientID (0x0010, 0x0020) tag of the resource of interest. Might be NULL. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1568 * @param accessionNumber Content of the AccessionNumber (0x0008, 0x0050) tag. Might be NULL. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1569 * @param studyInstanceUid Content of the StudyInstanceUID (0x0020, 0x000d) tag. Might be NULL. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1570 * @param seriesInstanceUid Content of the SeriesInstanceUID (0x0020, 0x000e) tag. Might be NULL. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1571 * @param sopInstanceUid Content of the SOPInstanceUID (0x0008, 0x0018) tag. Might be NULL. |
|
2222
21713ce8717b
Fix handling of Move Originator AET and ID in C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2216
diff
changeset
|
1572 * @param originatorAet The Application Entity Title (AET) of the |
|
1999
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1573 * modality from which the request originates. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1574 * @param sourceAet The Application Entity Title (AET) of the |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1575 * modality that should send its DICOM files to another modality. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1576 * @param targetAet The Application Entity Title (AET) of the |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1577 * modality that should receive the DICOM files. |
|
2222
21713ce8717b
Fix handling of Move Originator AET and ID in C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2216
diff
changeset
|
1578 * @param originatorId The Message ID issued by the originator modality, |
|
21713ce8717b
Fix handling of Move Originator AET and ID in C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2216
diff
changeset
|
1579 * as found in tag (0000,0110) of the DICOM query emitted by the issuer. |
|
1999
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1580 * |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1581 * @return The NULL value if the plugin cannot deal with this query, |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1582 * or a pointer to the driver object that is responsible for |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1583 * handling the successive move suboperations. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1584 * |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1585 * @note If targetAet equals sourceAet, this is actually a query/retrieve operation. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1586 * @ingroup DicomCallbacks |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1587 **/ |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1588 typedef void* (*OrthancPluginMoveCallback) ( |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1589 OrthancPluginResourceType resourceType, |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1590 const char* patientId, |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1591 const char* accessionNumber, |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1592 const char* studyInstanceUid, |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1593 const char* seriesInstanceUid, |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1594 const char* sopInstanceUid, |
|
2222
21713ce8717b
Fix handling of Move Originator AET and ID in C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2216
diff
changeset
|
1595 const char* originatorAet, |
|
1999
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1596 const char* sourceAet, |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1597 const char* targetAet, |
|
2222
21713ce8717b
Fix handling of Move Originator AET and ID in C-MOVE SCP
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2216
diff
changeset
|
1598 uint16_t originatorId); |
|
1999
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1599 |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1600 |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1601 /** |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1602 * @brief Callback to read the size of a C-Move driver. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1603 * |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1604 * Signature of a callback function that returns the number of |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1605 * C-Move suboperations that are to be achieved by the given C-Move |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1606 * driver. This driver is the return value of a previous call to the |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1607 * OrthancPluginMoveCallback() callback. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1608 * |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1609 * @param moveDriver The C-Move driver of interest. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1610 * @return The number of suboperations. |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1611 * @ingroup DicomCallbacks |
|
1999
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1612 **/ |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1613 typedef uint32_t (*OrthancPluginGetMoveSize) (void* moveDriver); |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1614 |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1615 |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1616 /** |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1617 * @brief Callback to apply one C-Move suboperation. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1618 * |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1619 * Signature of a callback function that applies the next C-Move |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1620 * suboperation that os to be achieved by the given C-Move |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1621 * driver. This driver is the return value of a previous call to the |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1622 * OrthancPluginMoveCallback() callback. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1623 * |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1624 * @param moveDriver The C-Move driver of interest. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1625 * @return 0 if success, or the error code if failure. |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1626 * @ingroup DicomCallbacks |
|
1999
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1627 **/ |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1628 typedef OrthancPluginErrorCode (*OrthancPluginApplyMove) (void* moveDriver); |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1629 |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1630 |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1631 /** |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1632 * @brief Callback to free one C-Move driver. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1633 * |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1634 * Signature of a callback function that releases the resources |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1635 * allocated by the given C-Move driver. This driver is the return |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1636 * value of a previous call to the OrthancPluginMoveCallback() |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1637 * callback. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1638 * |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1639 * @param moveDriver The C-Move driver of interest. |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1640 * @ingroup DicomCallbacks |
|
1999
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1641 **/ |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1642 typedef void (*OrthancPluginFreeMove) (void* moveDriver); |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1643 |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1644 |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1645 /** |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1646 * @brief Callback to finalize one custom job. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1647 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1648 * Signature of a callback function that releases all the resources |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1649 * allocated by the given job. This job is the argument provided to |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1650 * OrthancPluginCreateJob(). |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1651 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1652 * @param job The job of interest. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1653 * @ingroup Toolbox |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1654 **/ |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1655 typedef void (*OrthancPluginJobFinalize) (void* job); |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1656 |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1657 |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1658 /** |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1659 * @brief Callback to check the progress of one custom job. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1660 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1661 * Signature of a callback function that returns the progress of the |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1662 * job. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1663 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1664 * @param job The job of interest. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1665 * @return The progress, as a floating-point number ranging from 0 to 1. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1666 * @ingroup Toolbox |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1667 **/ |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1668 typedef float (*OrthancPluginJobGetProgress) (void* job); |
|
2815
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
1669 |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
1670 |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1671 /** |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1672 * @brief Callback to retrieve the content of one custom job. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1673 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1674 * Signature of a callback function that returns human-readable |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1675 * statistics about the job. This statistics must be formatted as a |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1676 * JSON object. This information is notably displayed in the "Jobs" |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1677 * tab of "Orthanc Explorer". |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1678 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1679 * @param job The job of interest. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1680 * @return The statistics, as a JSON object encoded as a string. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1681 * @ingroup Toolbox |
|
5138
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1682 * @deprecated This signature should not be used anymore since Orthanc SDK 1.11.3. |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1683 **/ |
|
2814
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
1684 typedef const char* (*OrthancPluginJobGetContent) (void* job); |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1685 |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1686 |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1687 /** |
|
5138
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1688 * @brief Callback to retrieve the content of one custom job. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1689 * |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1690 * Signature of a callback function that returns human-readable |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1691 * statistics about the job. This statistics must be formatted as a |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1692 * JSON object. This information is notably displayed in the "Jobs" |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1693 * tab of "Orthanc Explorer". |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1694 * |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1695 * @param target The target memory buffer where to store the JSON string. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1696 * This buffer must be allocated using OrthancPluginCreateMemoryBuffer() |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1697 * and will be freed by the Orthanc core. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1698 * @param job The job of interest. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1699 * @return 0 if success, other value if error. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1700 * @ingroup Toolbox |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1701 **/ |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1702 typedef OrthancPluginErrorCode (*OrthancPluginJobGetContent2) (OrthancPluginMemoryBuffer* target, |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1703 void* job); |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1704 |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1705 |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1706 /** |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1707 * @brief Callback to serialize one custom job. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1708 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1709 * Signature of a callback function that returns a serialized |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1710 * version of the job, formatted as a JSON object. This |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1711 * serialization is stored in the Orthanc database, and is used to |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1712 * reload the job on the restart of Orthanc. The "unserialization" |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1713 * callback (with OrthancPluginJobsUnserializer signature) will |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1714 * receive this serialized object. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1715 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1716 * @param job The job of interest. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1717 * @return The serialized job, as a JSON object encoded as a string. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1718 * @see OrthancPluginRegisterJobsUnserializer() |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1719 * @ingroup Toolbox |
|
5138
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1720 * @deprecated This signature should not be used anymore since Orthanc SDK 1.11.3. |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1721 **/ |
|
2814
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
1722 typedef const char* (*OrthancPluginJobGetSerialized) (void* job); |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1723 |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1724 |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1725 /** |
|
5138
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1726 * @brief Callback to serialize one custom job. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1727 * |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1728 * Signature of a callback function that returns a serialized |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1729 * version of the job, formatted as a JSON object. This |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1730 * serialization is stored in the Orthanc database, and is used to |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1731 * reload the job on the restart of Orthanc. The "unserialization" |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1732 * callback (with OrthancPluginJobsUnserializer signature) will |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1733 * receive this serialized object. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1734 * |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1735 * @param target The target memory buffer where to store the JSON string. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1736 * This buffer must be allocated using OrthancPluginCreateMemoryBuffer() |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1737 * and will be freed by the Orthanc core. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1738 * @param job The job of interest. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1739 * @return 1 if the serialization has succeeded, 0 if serialization is |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1740 * not implemented for this type of job, or -1 in case of error. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1741 **/ |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1742 typedef int32_t (*OrthancPluginJobGetSerialized2) (OrthancPluginMemoryBuffer* target, |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1743 void* job); |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1744 |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1745 |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
1746 /** |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1747 * @brief Callback to execute one step of a custom job. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1748 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1749 * Signature of a callback function that executes one step in the |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1750 * job. The jobs engine of Orthanc will make successive calls to |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1751 * this method, as long as it returns |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1752 * OrthancPluginJobStepStatus_Continue. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1753 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1754 * @param job The job of interest. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1755 * @return The status of execution. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1756 * @ingroup Toolbox |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1757 **/ |
|
2808
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
1758 typedef OrthancPluginJobStepStatus (*OrthancPluginJobStep) (void* job); |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1759 |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1760 |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1761 /** |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1762 * @brief Callback executed once one custom job leaves the "running" state. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1763 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1764 * Signature of a callback function that is invoked once a job |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1765 * leaves the "running" state. This can happen if the previous call |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1766 * to OrthancPluginJobStep has failed/succeeded, if the host Orthanc |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1767 * server is being stopped, or if the user manually tags the job as |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1768 * paused/canceled. This callback allows the plugin to free |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1769 * resources allocated for running this custom job (e.g. to stop |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1770 * threads, or to remove temporary files). |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1771 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1772 * Note that handling pauses might involves a specific treatment |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1773 * (such a stopping threads, but keeping temporary files on the |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1774 * disk). This "paused" situation can be checked by looking at the |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1775 * "reason" parameter. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1776 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1777 * @param job The job of interest. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1778 * @param reason The reason for leaving the "running" state. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1779 * @return 0 if success, or the error code if failure. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1780 * @ingroup Toolbox |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1781 **/ |
|
2812
ea7aea6f6a95
improved naming of methods in IJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2811
diff
changeset
|
1782 typedef OrthancPluginErrorCode (*OrthancPluginJobStop) (void* job, |
|
ea7aea6f6a95
improved naming of methods in IJob
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2811
diff
changeset
|
1783 OrthancPluginJobStopReason reason); |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1784 |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1785 |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1786 /** |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1787 * @brief Callback executed once one stopped custom job is started again. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1788 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1789 * Signature of a callback function that is invoked once a job |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1790 * leaves the "failure/canceled" state, to be started again. This |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1791 * function will typically reset the progress to zero. Note that |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1792 * before being actually executed, the job would first be tagged as |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1793 * "pending" in the Orthanc jobs engine. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1794 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1795 * @param job The job of interest. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1796 * @return 0 if success, or the error code if failure. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1797 * @ingroup Toolbox |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1798 **/ |
|
2808
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
1799 typedef OrthancPluginErrorCode (*OrthancPluginJobReset) (void* job); |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1800 |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1801 |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1802 /** |
|
3179
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
1803 * @brief Callback executed to unserialize a custom job. |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1804 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1805 * Signature of a callback function that unserializes a job that was |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1806 * saved in the Orthanc database. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1807 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1808 * @param jobType The type of the job, as provided to OrthancPluginCreateJob(). |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1809 * @param serialized The serialization of the job, as provided by OrthancPluginJobGetSerialized. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1810 * @return The unserialized job (as created by OrthancPluginCreateJob()), or NULL |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1811 * if this unserializer cannot handle this job type. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1812 * @see OrthancPluginRegisterJobsUnserializer() |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1813 * @ingroup Callbacks |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
1814 **/ |
|
2815
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
1815 typedef OrthancPluginJob* (*OrthancPluginJobsUnserializer) (const char* jobType, |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
1816 const char* serialized); |
|
2808
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
1817 |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
1818 |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
1819 |
|
1999
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
1820 /** |
|
3179
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
1821 * @brief Callback executed to update the metrics of the plugin. |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
1822 * |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
1823 * Signature of a callback function that is called by Orthanc |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
1824 * whenever a monitoring tool (such as Prometheus) asks the current |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
1825 * values of the metrics. This callback gives the plugin a chance to |
|
5326
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
1826 * update its metrics, by calling OrthancPluginSetMetricsValue() or |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
1827 * OrthancPluginSetMetricsIntegerValue(). |
|
3179
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
1828 * This is typically useful for metrics that are expensive to |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
1829 * acquire. |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
1830 * |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
1831 * @see OrthancPluginRegisterRefreshMetrics() |
|
3209
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1832 * @ingroup Callbacks |
|
3179
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
1833 **/ |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
1834 typedef void (*OrthancPluginRefreshMetricsCallback) (); |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
1835 |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
1836 |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
1837 |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
1838 /** |
|
3209
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1839 * @brief Callback executed to encode a binary tag in DICOMweb. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1840 * |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1841 * Signature of a callback function that is called by Orthanc |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1842 * whenever a DICOM tag that contains a binary value must be written |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1843 * to a JSON or XML node, while a DICOMweb document is being |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1844 * generated. The value representation (VR) of the DICOM tag can be |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1845 * OB, OD, OF, OL, OW, or UN. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1846 * |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1847 * @see OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml() |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1848 * @param node The node being generated, as provided by Orthanc. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1849 * @param setter The setter to be used to encode the content of the node. If |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1850 * the setter is not called, the binary tag is not written to the output document. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1851 * @param levelDepth The depth of the node in the DICOM hierarchy of sequences. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1852 * This parameter gives the number of elements in the "levelTagGroup", |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1853 * "levelTagElement", and "levelIndex" arrays. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1854 * @param levelTagGroup The group of the parent DICOM tags in the hierarchy. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1855 * @param levelTagElement The element of the parent DICOM tags in the hierarchy. |
| 3583 | 1856 * @param levelIndex The index of the node in the parent sequences of the hierarchy. |
|
3209
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1857 * @param tagGroup The group of the DICOM tag of interest. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1858 * @param tagElement The element of the DICOM tag of interest. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1859 * @param vr The value representation of the binary DICOM node. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1860 * @ingroup Callbacks |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1861 **/ |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1862 typedef void (*OrthancPluginDicomWebBinaryCallback) ( |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1863 OrthancPluginDicomWebNode* node, |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1864 OrthancPluginDicomWebSetBinaryNode setter, |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1865 uint32_t levelDepth, |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1866 const uint16_t* levelTagGroup, |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1867 const uint16_t* levelTagElement, |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1868 const uint32_t* levelIndex, |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1869 uint16_t tagGroup, |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1870 uint16_t tagElement, |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1871 OrthancPluginValueRepresentation vr); |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1872 |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1873 |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1874 |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
1875 /** |
|
3924
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1876 * @brief Callback executed to encode a binary tag in DICOMweb. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1877 * |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1878 * Signature of a callback function that is called by Orthanc |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1879 * whenever a DICOM tag that contains a binary value must be written |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1880 * to a JSON or XML node, while a DICOMweb document is being |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1881 * generated. The value representation (VR) of the DICOM tag can be |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1882 * OB, OD, OF, OL, OW, or UN. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1883 * |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1884 * @see OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml() |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1885 * @param node The node being generated, as provided by Orthanc. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1886 * @param setter The setter to be used to encode the content of the node. If |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1887 * the setter is not called, the binary tag is not written to the output document. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1888 * @param levelDepth The depth of the node in the DICOM hierarchy of sequences. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1889 * This parameter gives the number of elements in the "levelTagGroup", |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1890 * "levelTagElement", and "levelIndex" arrays. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1891 * @param levelTagGroup The group of the parent DICOM tags in the hierarchy. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1892 * @param levelTagElement The element of the parent DICOM tags in the hierarchy. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1893 * @param levelIndex The index of the node in the parent sequences of the hierarchy. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1894 * @param tagGroup The group of the DICOM tag of interest. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1895 * @param tagElement The element of the DICOM tag of interest. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1896 * @param vr The value representation of the binary DICOM node. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1897 * @param payload The user payload. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1898 * @ingroup Callbacks |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1899 **/ |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1900 typedef void (*OrthancPluginDicomWebBinaryCallback2) ( |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1901 OrthancPluginDicomWebNode* node, |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1902 OrthancPluginDicomWebSetBinaryNode setter, |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1903 uint32_t levelDepth, |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1904 const uint16_t* levelTagGroup, |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1905 const uint16_t* levelTagElement, |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1906 const uint32_t* levelIndex, |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1907 uint16_t tagGroup, |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1908 uint16_t tagElement, |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1909 OrthancPluginValueRepresentation vr, |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1910 void* payload); |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1911 |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1912 |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1913 |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
1914 /** |
| 1297 | 1915 * @brief Data structure that contains information about the Orthanc core. |
| 907 | 1916 **/ |
| 900 | 1917 typedef struct _OrthancPluginContext_t |
| 1918 { | |
|
1581
357c4bb15701
Plugins have access to explicit error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1580
diff
changeset
|
1919 void* pluginsManager; |
|
357c4bb15701
Plugins have access to explicit error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1580
diff
changeset
|
1920 const char* orthancVersion; |
|
357c4bb15701
Plugins have access to explicit error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1580
diff
changeset
|
1921 OrthancPluginFree Free; |
|
357c4bb15701
Plugins have access to explicit error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1580
diff
changeset
|
1922 OrthancPluginErrorCode (*InvokeService) (struct _OrthancPluginContext_t* context, |
|
357c4bb15701
Plugins have access to explicit error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1580
diff
changeset
|
1923 _OrthancPluginService service, |
|
357c4bb15701
Plugins have access to explicit error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1580
diff
changeset
|
1924 const void* params); |
| 899 | 1925 } OrthancPluginContext; |
| 1926 | |
| 886 | 1927 |
|
1861
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
1928 |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
1929 /** |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
1930 * @brief An entry in the dictionary of DICOM tags. |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
1931 **/ |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
1932 typedef struct |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
1933 { |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
1934 uint16_t group; /*!< The group of the tag */ |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
1935 uint16_t element; /*!< The element of the tag */ |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
1936 OrthancPluginValueRepresentation vr; /*!< The value representation of the tag */ |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
1937 uint32_t minMultiplicity; /*!< The minimum multiplicity of the tag */ |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
1938 uint32_t maxMultiplicity; /*!< The maximum multiplicity of the tag (0 means arbitrary) */ |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
1939 } OrthancPluginDictionaryEntry; |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
1940 |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
1941 |
| 907 | 1942 |
| 1943 /** | |
| 1944 * @brief Free a string. | |
| 1945 * | |
| 1946 * Free a string that was allocated by the core system of Orthanc. | |
| 1947 * | |
| 1948 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 1949 * @param str The string to be freed. | |
| 1950 **/ | |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
1951 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeString( |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
1952 OrthancPluginContext* context, |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
1953 char* str) |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
1954 { |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
1955 if (str != NULL) |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
1956 { |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
1957 context->Free(str); |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
1958 } |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
1959 } |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
1960 |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
1961 |
| 907 | 1962 /** |
|
2719
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
1963 * @brief Check that the version of the hosting Orthanc is above a given version. |
|
1039
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
1964 * |
|
2719
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
1965 * This function checks whether the version of the Orthanc server |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
1966 * running this plugin, is above the given version. Contrarily to |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
1967 * OrthancPluginCheckVersion(), it is up to the developer of the |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
1968 * plugin to make sure that all the Orthanc SDK services called by |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
1969 * the plugin are actually implemented in the given version of |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
1970 * Orthanc. |
|
1039
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
1971 * |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
1972 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
2799
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
1973 * @param expectedMajor Expected major version. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
1974 * @param expectedMinor Expected minor version. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
1975 * @param expectedRevision Expected revision. |
|
1039
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
1976 * @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
|
1977 * result is 0, the initialization of the plugin should fail. |
|
5327
f01c06f75d67
sanitizing @see in OrthancCPlugin.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5326
diff
changeset
|
1978 * @see OrthancPluginCheckVersion() |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
1979 * @ingroup Callbacks |
|
1039
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
1980 **/ |
|
5389
0e5e675b9750
replaced "int" by "int32_t" in the SDK to prevent any ABI issue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5383
diff
changeset
|
1981 ORTHANC_PLUGIN_INLINE int32_t OrthancPluginCheckVersionAdvanced( |
|
2719
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
1982 OrthancPluginContext* context, |
|
5389
0e5e675b9750
replaced "int" by "int32_t" in the SDK to prevent any ABI issue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5383
diff
changeset
|
1983 int32_t expectedMajor, |
|
0e5e675b9750
replaced "int" by "int32_t" in the SDK to prevent any ABI issue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5383
diff
changeset
|
1984 int32_t expectedMinor, |
|
0e5e675b9750
replaced "int" by "int32_t" in the SDK to prevent any ABI issue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5383
diff
changeset
|
1985 int32_t expectedRevision) |
|
0e5e675b9750
replaced "int" by "int32_t" in the SDK to prevent any ABI issue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5383
diff
changeset
|
1986 { |
|
0e5e675b9750
replaced "int" by "int32_t" in the SDK to prevent any ABI issue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5383
diff
changeset
|
1987 int32_t major, minor, revision; |
|
0e5e675b9750
replaced "int" by "int32_t" in the SDK to prevent any ABI issue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5383
diff
changeset
|
1988 |
|
0e5e675b9750
replaced "int" by "int32_t" in the SDK to prevent any ABI issue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5383
diff
changeset
|
1989 if (sizeof(int) != sizeof(int32_t) || /* Ensure binary compatibility with Orthanc SDK <= 1.12.1 */ |
|
0e5e675b9750
replaced "int" by "int32_t" in the SDK to prevent any ABI issue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5383
diff
changeset
|
1990 sizeof(int32_t) != sizeof(OrthancPluginErrorCode) || |
|
1579
b93c398f934d
check the size of the enumerations in the plugin engine
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1578
diff
changeset
|
1991 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
|
1992 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
|
1993 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
|
1994 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
|
1995 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
|
1996 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
|
1997 sizeof(int32_t) != sizeof(OrthancPluginChangeType) || |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
1998 sizeof(int32_t) != sizeof(OrthancPluginCompressionType) || |
|
1657
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
1999 sizeof(int32_t) != sizeof(OrthancPluginImageFormat) || |
|
1740
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
2000 sizeof(int32_t) != sizeof(OrthancPluginValueRepresentation) || |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
2001 sizeof(int32_t) != sizeof(OrthancPluginDicomToJsonFormat) || |
|
1760
51db4a25a741
LookupIdentifier is plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1746
diff
changeset
|
2002 sizeof(int32_t) != sizeof(OrthancPluginDicomToJsonFlags) || |
|
1827
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
2003 sizeof(int32_t) != sizeof(OrthancPluginCreateDicomFlags) || |
|
1815
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
2004 sizeof(int32_t) != sizeof(OrthancPluginIdentifierConstraint) || |
|
2808
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
2005 sizeof(int32_t) != sizeof(OrthancPluginInstanceOrigin) || |
|
3074
495c5edce708
new extension for database plugin SDK: lookupResources
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3060
diff
changeset
|
2006 sizeof(int32_t) != sizeof(OrthancPluginJobStepStatus) || |
|
3179
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
2007 sizeof(int32_t) != sizeof(OrthancPluginConstraintType) || |
|
3209
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
2008 sizeof(int32_t) != sizeof(OrthancPluginMetricsType) || |
|
3662
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
2009 sizeof(int32_t) != sizeof(OrthancPluginDicomWebBinaryMode) || |
|
4919
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
2010 sizeof(int32_t) != sizeof(OrthancPluginStorageCommitmentFailureReason) || |
|
5575
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
2011 sizeof(int32_t) != sizeof(OrthancPluginLoadDicomInstanceMode) || |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
2012 sizeof(int32_t) != sizeof(OrthancPluginLogLevel) || |
|
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
2013 sizeof(int32_t) != sizeof(OrthancPluginLogCategory)) |
| 1578 | 2014 { |
| 2015 /* Mismatch in the size of the enumerations */ | |
| 2016 return 0; | |
| 2017 } | |
| 2018 | |
|
1039
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2019 /* Assume compatibility with the mainline */ |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2020 if (!strcmp(context->orthancVersion, "mainline")) |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2021 { |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2022 return 1; |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2023 } |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2024 |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2025 /* Parse the version of the Orthanc core */ |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2026 if ( |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2027 #ifdef _MSC_VER |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2028 sscanf_s |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2029 #else |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2030 sscanf |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2031 #endif |
| 1303 | 2032 (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
|
2033 { |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2034 return 0; |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2035 } |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2036 |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2037 /* Check the major number of the version */ |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2038 |
|
2719
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2039 if (major > expectedMajor) |
|
1039
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2040 { |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2041 return 1; |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2042 } |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2043 |
|
2719
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2044 if (major < expectedMajor) |
|
1039
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2045 { |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2046 return 0; |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2047 } |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2048 |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2049 /* Check the minor number of the version */ |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2050 |
|
2719
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2051 if (minor > expectedMinor) |
|
1039
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2052 { |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2053 return 1; |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2054 } |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2055 |
|
2719
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2056 if (minor < expectedMinor) |
|
1039
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2057 { |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2058 return 0; |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2059 } |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2060 |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2061 /* Check the revision number of the version */ |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2062 |
|
2719
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2063 if (revision >= expectedRevision) |
|
1039
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2064 { |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2065 return 1; |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2066 } |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2067 else |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2068 { |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2069 return 0; |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2070 } |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2071 } |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2072 |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2073 |
|
5a5a4890ffca
check version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1037
diff
changeset
|
2074 /** |
|
2719
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2075 * @brief Check the compatibility of the plugin wrt. the version of its hosting Orthanc. |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2076 * |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2077 * This function checks whether the version of the Orthanc server |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2078 * running this plugin, is above the version of the current Orthanc |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2079 * SDK header. This guarantees that the plugin is compatible with |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2080 * the hosting Orthanc (i.e. it will not call unavailable services). |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2081 * The result of this function should always be checked in the |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2082 * OrthancPluginInitialize() entry point of the plugin. |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2083 * |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2084 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2085 * @return 1 if and only if the versions are compatible. If the |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2086 * result is 0, the initialization of the plugin should fail. |
|
5327
f01c06f75d67
sanitizing @see in OrthancCPlugin.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5326
diff
changeset
|
2087 * @see OrthancPluginCheckVersionAdvanced() |
|
2719
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2088 * @ingroup Callbacks |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2089 **/ |
|
5389
0e5e675b9750
replaced "int" by "int32_t" in the SDK to prevent any ABI issue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5383
diff
changeset
|
2090 ORTHANC_PLUGIN_INLINE int32_t OrthancPluginCheckVersion( |
|
2719
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2091 OrthancPluginContext* context) |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2092 { |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2093 return OrthancPluginCheckVersionAdvanced( |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2094 context, |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2095 ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER, |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2096 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER, |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2097 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER); |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2098 } |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2099 |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2100 |
|
0bd1dfb14272
OrthancPluginCheckVersionAdvanced
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2698
diff
changeset
|
2101 /** |
| 907 | 2102 * @brief Free a memory buffer. |
| 2103 * | |
| 2104 * Free a memory buffer that was allocated by the core system of Orthanc. | |
| 2105 * | |
| 2106 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 2107 * @param buffer The memory buffer to release. | |
| 2108 **/ | |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2109 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeMemoryBuffer( |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2110 OrthancPluginContext* context, |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2111 OrthancPluginMemoryBuffer* buffer) |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2112 { |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2113 context->Free(buffer->data); |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2114 } |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2115 |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2116 |
| 907 | 2117 /** |
|
4440
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
2118 * @brief Free a memory buffer. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
2119 * |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
2120 * Free a memory buffer that was allocated by the core system of Orthanc. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
2121 * |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
2122 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
2123 * @param buffer The memory buffer to release. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
2124 **/ |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
2125 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeMemoryBuffer64( |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
2126 OrthancPluginContext* context, |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
2127 OrthancPluginMemoryBuffer64* buffer) |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
2128 { |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
2129 context->Free(buffer->data); |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
2130 } |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
2131 |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
2132 |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
2133 /** |
| 907 | 2134 * @brief Log an error. |
| 2135 * | |
| 2136 * Log an error message using the Orthanc logging system. | |
| 2137 * | |
| 2138 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 2139 * @param message The message to be logged. | |
| 2140 **/ | |
| 900 | 2141 ORTHANC_PLUGIN_INLINE void OrthancPluginLogError( |
| 2142 OrthancPluginContext* context, | |
| 907 | 2143 const char* message) |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
2144 { |
| 907 | 2145 context->InvokeService(context, _OrthancPluginService_LogError, message); |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
2146 } |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
2147 |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
2148 |
| 907 | 2149 /** |
| 2150 * @brief Log a warning. | |
| 2151 * | |
| 2152 * Log a warning message using the Orthanc logging system. | |
| 2153 * | |
| 2154 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 2155 * @param message The message to be logged. | |
| 2156 **/ | |
| 900 | 2157 ORTHANC_PLUGIN_INLINE void OrthancPluginLogWarning( |
| 2158 OrthancPluginContext* context, | |
| 907 | 2159 const char* message) |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
2160 { |
| 907 | 2161 context->InvokeService(context, _OrthancPluginService_LogWarning, message); |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
2162 } |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
2163 |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
2164 |
| 907 | 2165 /** |
| 2166 * @brief Log an information. | |
| 2167 * | |
| 2168 * Log an information message using the Orthanc logging system. | |
| 2169 * | |
| 2170 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 2171 * @param message The message to be logged. | |
| 2172 **/ | |
| 900 | 2173 ORTHANC_PLUGIN_INLINE void OrthancPluginLogInfo( |
| 2174 OrthancPluginContext* context, | |
| 907 | 2175 const char* message) |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
2176 { |
| 907 | 2177 context->InvokeService(context, _OrthancPluginService_LogInfo, message); |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
2178 } |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
2179 |
|
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
2180 |
|
913
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2181 |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2182 typedef struct |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2183 { |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2184 const char* pathRegularExpression; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2185 OrthancPluginRestCallback callback; |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2186 } _OrthancPluginRestCallback; |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2187 |
| 907 | 2188 /** |
| 2189 * @brief Register a REST callback. | |
| 2190 * | |
| 2191 * This function registers a REST callback against a regular | |
| 2192 * expression for a URI. This function must be called during the | |
| 2193 * initialization of the plugin, i.e. inside the | |
| 2194 * OrthancPluginInitialize() public function. | |
|
1595
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2195 * |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2196 * Each REST callback is guaranteed to run in mutual exclusion. |
|
2927
9f48722e8508
note about Perl regex syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2823
diff
changeset
|
2197 * |
| 907 | 2198 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
2927
9f48722e8508
note about Perl regex syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2823
diff
changeset
|
2199 * @param pathRegularExpression Regular expression for the URI. May contain groups. |
| 907 | 2200 * @param callback The callback function to handle the REST call. |
|
1595
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2201 * @see OrthancPluginRegisterRestCallbackNoLock() |
|
2927
9f48722e8508
note about Perl regex syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2823
diff
changeset
|
2202 * |
|
9f48722e8508
note about Perl regex syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2823
diff
changeset
|
2203 * @note |
|
9f48722e8508
note about Perl regex syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2823
diff
changeset
|
2204 * The regular expression is case sensitive and must follow the |
|
9f48722e8508
note about Perl regex syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2823
diff
changeset
|
2205 * [Perl syntax](https://www.boost.org/doc/libs/1_67_0/libs/regex/doc/html/boost_regex/syntax/perl_syntax.html). |
|
9f48722e8508
note about Perl regex syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2823
diff
changeset
|
2206 * |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
2207 * @ingroup Callbacks |
| 907 | 2208 **/ |
| 900 | 2209 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterRestCallback( |
| 2210 OrthancPluginContext* context, | |
| 2211 const char* pathRegularExpression, | |
| 2212 OrthancPluginRestCallback callback) | |
| 899 | 2213 { |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2214 _OrthancPluginRestCallback params; |
| 899 | 2215 params.pathRegularExpression = pathRegularExpression; |
| 2216 params.callback = callback; | |
| 907 | 2217 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms); |
| 899 | 2218 } |
| 2219 | |
| 2220 | |
|
913
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2221 |
|
1595
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2222 /** |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2223 * @brief Register a REST callback, without locking. |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2224 * |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2225 * This function registers a REST callback against a regular |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2226 * expression for a URI. This function must be called during the |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2227 * initialization of the plugin, i.e. inside the |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2228 * OrthancPluginInitialize() public function. |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2229 * |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2230 * Contrarily to OrthancPluginRegisterRestCallback(), the callback |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2231 * 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
|
2232 * high-performance plugins that must handle concurrent requests |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2233 * (Orthanc uses a pool of threads, one thread being assigned to |
|
2927
9f48722e8508
note about Perl regex syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2823
diff
changeset
|
2234 * each incoming HTTP request). Of course, if using this function, |
|
9f48722e8508
note about Perl regex syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2823
diff
changeset
|
2235 * it is up to the plugin to implement the required locking |
|
9f48722e8508
note about Perl regex syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2823
diff
changeset
|
2236 * mechanisms. |
|
1595
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2237 * |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2238 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2239 * @param pathRegularExpression Regular expression for the URI. May contain groups. |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2240 * @param callback The callback function to handle the REST call. |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2241 * @see OrthancPluginRegisterRestCallback() |
|
2927
9f48722e8508
note about Perl regex syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2823
diff
changeset
|
2242 * |
|
9f48722e8508
note about Perl regex syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2823
diff
changeset
|
2243 * @note |
|
9f48722e8508
note about Perl regex syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2823
diff
changeset
|
2244 * The regular expression is case sensitive and must follow the |
|
9f48722e8508
note about Perl regex syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2823
diff
changeset
|
2245 * [Perl syntax](https://www.boost.org/doc/libs/1_67_0/libs/regex/doc/html/boost_regex/syntax/perl_syntax.html). |
|
9f48722e8508
note about Perl regex syntax
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2823
diff
changeset
|
2246 * |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
2247 * @ingroup Callbacks |
|
1595
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2248 **/ |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2249 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterRestCallbackNoLock( |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2250 OrthancPluginContext* context, |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2251 const char* pathRegularExpression, |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2252 OrthancPluginRestCallback callback) |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2253 { |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2254 _OrthancPluginRestCallback params; |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2255 params.pathRegularExpression = pathRegularExpression; |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2256 params.callback = callback; |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2257 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms); |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2258 } |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2259 |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2260 |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
2261 |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2262 typedef struct |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2263 { |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2264 OrthancPluginOnStoredInstanceCallback callback; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2265 } _OrthancPluginOnStoredInstanceCallback; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2266 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2267 /** |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2268 * @brief Register a callback for received instances. |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2269 * |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2270 * This function registers a callback function that is called |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2271 * whenever a new DICOM instance is stored into the Orthanc core. |
|
4179
669f588a14b3
warn about possible deadlocks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4131
diff
changeset
|
2272 * |
|
4181
b416b6bf129b
clarification of sdk doc about deadlocks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4179
diff
changeset
|
2273 * @warning Your callback function will be called synchronously with |
|
b416b6bf129b
clarification of sdk doc about deadlocks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4179
diff
changeset
|
2274 * the core of Orthanc. This implies that deadlocks might emerge if |
|
b416b6bf129b
clarification of sdk doc about deadlocks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4179
diff
changeset
|
2275 * you call other core primitives of Orthanc in your callback (such |
|
4919
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
2276 * deadlocks are particularly visible in the presence of other plugins |
|
4181
b416b6bf129b
clarification of sdk doc about deadlocks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4179
diff
changeset
|
2277 * or Lua scripts). It is thus strongly advised to avoid any call to |
|
b416b6bf129b
clarification of sdk doc about deadlocks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4179
diff
changeset
|
2278 * the REST API of Orthanc in the callback. If you have to call |
|
b416b6bf129b
clarification of sdk doc about deadlocks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4179
diff
changeset
|
2279 * other primitives of Orthanc, you should make these calls in a |
|
b416b6bf129b
clarification of sdk doc about deadlocks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4179
diff
changeset
|
2280 * separate thread, passing the pending events to be processed |
|
b416b6bf129b
clarification of sdk doc about deadlocks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4179
diff
changeset
|
2281 * through a message queue. |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2282 * |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2283 * @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
|
2284 * @param callback The callback function. |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
2285 * @ingroup Callbacks |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2286 **/ |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2287 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterOnStoredInstanceCallback( |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2288 OrthancPluginContext* context, |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2289 OrthancPluginOnStoredInstanceCallback callback) |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2290 { |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2291 _OrthancPluginOnStoredInstanceCallback params; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2292 params.callback = callback; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2293 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2294 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms); |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2295 } |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2296 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2297 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2298 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2299 typedef struct |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
2300 { |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2301 OrthancPluginRestOutput* output; |
| 3514 | 2302 const void* answer; |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2303 uint32_t answerSize; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2304 const char* mimeType; |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2305 } _OrthancPluginAnswerBuffer; |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2306 |
| 907 | 2307 /** |
| 2308 * @brief Answer to a REST request. | |
| 2309 * | |
| 2310 * This function answers to a REST request with the content of a memory buffer. | |
| 2311 * | |
| 2312 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 2313 * @param output The HTTP connection to the client application. | |
| 2314 * @param answer Pointer to the memory buffer containing the answer. | |
| 2315 * @param answerSize Number of bytes of the answer. | |
| 2316 * @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
|
2317 * @ingroup REST |
| 907 | 2318 **/ |
| 900 | 2319 ORTHANC_PLUGIN_INLINE void OrthancPluginAnswerBuffer( |
| 2320 OrthancPluginContext* context, | |
| 2321 OrthancPluginRestOutput* output, | |
| 3514 | 2322 const void* answer, |
| 900 | 2323 uint32_t answerSize, |
| 2324 const char* mimeType) | |
| 899 | 2325 { |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2326 _OrthancPluginAnswerBuffer params; |
| 899 | 2327 params.output = output; |
| 2328 params.answer = answer; | |
| 2329 params.answerSize = answerSize; | |
| 2330 params.mimeType = mimeType; | |
| 907 | 2331 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms); |
| 899 | 2332 } |
| 2333 | |
| 2334 | |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2335 typedef struct |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2336 { |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2337 OrthancPluginRestOutput* output; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2338 OrthancPluginPixelFormat format; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2339 uint32_t width; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2340 uint32_t height; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2341 uint32_t pitch; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2342 const void* buffer; |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2343 } _OrthancPluginCompressAndAnswerPngImage; |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2344 |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
2345 typedef struct |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
2346 { |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
2347 OrthancPluginRestOutput* output; |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
2348 OrthancPluginImageFormat imageFormat; |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
2349 OrthancPluginPixelFormat pixelFormat; |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
2350 uint32_t width; |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
2351 uint32_t height; |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
2352 uint32_t pitch; |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
2353 const void* buffer; |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
2354 uint8_t quality; |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
2355 } _OrthancPluginCompressAndAnswerImage; |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
2356 |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
2357 |
| 907 | 2358 /** |
| 2359 * @brief Answer to a REST request with a PNG image. | |
| 2360 * | |
| 2361 * This function answers to a REST request with a PNG image. The | |
| 2362 * parameters of this function describe a memory buffer that | |
| 2363 * contains an uncompressed image. The image will be automatically compressed | |
| 2364 * as a PNG image by the core system of Orthanc. | |
| 2365 * | |
| 2366 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 2367 * @param output The HTTP connection to the client application. | |
| 2368 * @param format The memory layout of the uncompressed image. | |
| 2369 * @param width The width of the image. | |
| 2370 * @param height The height of the image. | |
| 2371 * @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
|
2372 * between 2 successive lines of the image in the memory buffer). |
| 907 | 2373 * @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
|
2374 * @ingroup REST |
| 907 | 2375 **/ |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2376 ORTHANC_PLUGIN_INLINE void OrthancPluginCompressAndAnswerPngImage( |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2377 OrthancPluginContext* context, |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2378 OrthancPluginRestOutput* output, |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2379 OrthancPluginPixelFormat format, |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2380 uint32_t width, |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2381 uint32_t height, |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2382 uint32_t pitch, |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2383 const void* buffer) |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2384 { |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
2385 _OrthancPluginCompressAndAnswerImage params; |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2386 params.output = output; |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
2387 params.imageFormat = OrthancPluginImageFormat_Png; |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
2388 params.pixelFormat = format; |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2389 params.width = width; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2390 params.height = height; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2391 params.pitch = pitch; |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2392 params.buffer = buffer; |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
2393 params.quality = 0; /* No quality for PNG */ |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
2394 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms); |
|
901
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2395 } |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2396 |
|
7d88f3f4a3b3
refactoring IsServedUri, answer PNG images, regular expression groups
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
900
diff
changeset
|
2397 |
|
913
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2398 |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2399 typedef struct |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2400 { |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2401 OrthancPluginMemoryBuffer* target; |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2402 const char* instanceId; |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2403 } _OrthancPluginGetDicomForInstance; |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2404 |
| 907 | 2405 /** |
| 2406 * @brief Retrieve a DICOM instance using its Orthanc identifier. | |
| 2407 * | |
| 2408 * Retrieve a DICOM instance using its Orthanc identifier. The DICOM | |
| 2409 * file is stored into a newly allocated memory buffer. | |
| 2410 * | |
| 2411 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
2412 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). |
| 907 | 2413 * @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
|
2414 * @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
|
2415 * @ingroup Orthanc |
| 907 | 2416 **/ |
|
1581
357c4bb15701
Plugins have access to explicit error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1580
diff
changeset
|
2417 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginGetDicomForInstance( |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2418 OrthancPluginContext* context, |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2419 OrthancPluginMemoryBuffer* target, |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2420 const char* instanceId) |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2421 { |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2422 _OrthancPluginGetDicomForInstance params; |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2423 params.target = target; |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2424 params.instanceId = instanceId; |
| 907 | 2425 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms); |
|
904
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2426 } |
|
2732b5f57d9c
sample to forward dicom data
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
901
diff
changeset
|
2427 |
|
898
7000fc86fe62
improved plugin api
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
897
diff
changeset
|
2428 |
|
912
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
2429 |
|
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
2430 typedef struct |
|
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
2431 { |
|
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
2432 OrthancPluginMemoryBuffer* target; |
|
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
2433 const char* uri; |
|
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
2434 } _OrthancPluginRestApiGet; |
|
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
2435 |
|
913
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2436 /** |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2437 * @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
|
2438 * |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2439 * 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
|
2440 * 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
|
2441 * |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2442 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
2443 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). |
|
913
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2444 * @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
|
2445 * @return 0 if success, or the error code if failure. |
| 2044 | 2446 * @note If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource. |
|
5327
f01c06f75d67
sanitizing @see in OrthancCPlugin.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5326
diff
changeset
|
2447 * @see OrthancPluginRestApiGetAfterPlugins() |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
2448 * @ingroup Orthanc |
|
913
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2449 **/ |
|
1581
357c4bb15701
Plugins have access to explicit error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1580
diff
changeset
|
2450 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiGet( |
|
912
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
2451 OrthancPluginContext* context, |
|
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
2452 OrthancPluginMemoryBuffer* target, |
|
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
2453 const char* uri) |
|
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
2454 { |
|
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
2455 _OrthancPluginRestApiGet params; |
|
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
2456 params.target = target; |
|
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
2457 params.uri = uri; |
|
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
2458 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms); |
|
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
2459 } |
|
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
2460 |
|
dcb2469f00f4
PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
908
diff
changeset
|
2461 |
|
913
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2462 |
|
1282
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2463 /** |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2464 * @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
|
2465 * |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2466 * 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
|
2467 * 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
|
2468 * 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
|
2469 * 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
|
2470 * 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
|
2471 * |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2472 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
2473 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). |
|
1282
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2474 * @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
|
2475 * @return 0 if success, or the error code if failure. |
| 2044 | 2476 * @note If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource. |
|
5327
f01c06f75d67
sanitizing @see in OrthancCPlugin.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5326
diff
changeset
|
2477 * @see OrthancPluginRestApiGet() |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
2478 * @ingroup Orthanc |
|
1282
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2479 **/ |
|
1581
357c4bb15701
Plugins have access to explicit error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1580
diff
changeset
|
2480 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
|
2481 OrthancPluginContext* context, |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2482 OrthancPluginMemoryBuffer* target, |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2483 const char* uri) |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2484 { |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2485 _OrthancPluginRestApiGet params; |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2486 params.target = target; |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2487 params.uri = uri; |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2488 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms); |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2489 } |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2490 |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2491 |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2492 |
|
913
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2493 typedef struct |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2494 { |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2495 OrthancPluginMemoryBuffer* target; |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2496 const char* uri; |
|
3400
0faae6f6e3c5
fixed some inconsistencies with pointer types in the plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3399
diff
changeset
|
2497 const void* body; |
|
913
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2498 uint32_t bodySize; |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2499 } _OrthancPluginRestApiPostPut; |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2500 |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2501 /** |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2502 * @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
|
2503 * |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2504 * 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
|
2505 * 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
|
2506 * |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2507 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
2508 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). |
|
913
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2509 * @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
|
2510 * @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
|
2511 * @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
|
2512 * @return 0 if success, or the error code if failure. |
| 2044 | 2513 * @note If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource. |
|
5327
f01c06f75d67
sanitizing @see in OrthancCPlugin.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5326
diff
changeset
|
2514 * @see OrthancPluginRestApiPostAfterPlugins() |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
2515 * @ingroup Orthanc |
|
913
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2516 **/ |
|
1581
357c4bb15701
Plugins have access to explicit error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1580
diff
changeset
|
2517 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPost( |
|
913
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2518 OrthancPluginContext* context, |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2519 OrthancPluginMemoryBuffer* target, |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2520 const char* uri, |
|
3400
0faae6f6e3c5
fixed some inconsistencies with pointer types in the plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3399
diff
changeset
|
2521 const void* body, |
|
913
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2522 uint32_t bodySize) |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2523 { |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2524 _OrthancPluginRestApiPostPut params; |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2525 params.target = target; |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2526 params.uri = uri; |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2527 params.body = body; |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2528 params.bodySize = bodySize; |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2529 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms); |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2530 } |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2531 |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2532 |
|
1282
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2533 /** |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2534 * @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
|
2535 * |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2536 * 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
|
2537 * 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
|
2538 * 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
|
2539 * 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
|
2540 * 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
|
2541 * |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2542 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
2543 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). |
|
1282
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2544 * @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
|
2545 * @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
|
2546 * @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
|
2547 * @return 0 if success, or the error code if failure. |
| 2044 | 2548 * @note If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource. |
|
5327
f01c06f75d67
sanitizing @see in OrthancCPlugin.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5326
diff
changeset
|
2549 * @see OrthancPluginRestApiPost() |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
2550 * @ingroup Orthanc |
|
1282
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2551 **/ |
|
1581
357c4bb15701
Plugins have access to explicit error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1580
diff
changeset
|
2552 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
|
2553 OrthancPluginContext* context, |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2554 OrthancPluginMemoryBuffer* target, |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2555 const char* uri, |
|
3400
0faae6f6e3c5
fixed some inconsistencies with pointer types in the plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3399
diff
changeset
|
2556 const void* body, |
|
1282
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2557 uint32_t bodySize) |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2558 { |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2559 _OrthancPluginRestApiPostPut params; |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2560 params.target = target; |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2561 params.uri = uri; |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2562 params.body = body; |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2563 params.bodySize = bodySize; |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2564 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms); |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2565 } |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2566 |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2567 |
|
913
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2568 |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2569 /** |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2570 * @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
|
2571 * |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2572 * 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
|
2573 * |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2574 * @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
|
2575 * @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
|
2576 * @return 0 if success, or the error code if failure. |
| 2044 | 2577 * @note If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource. |
|
5327
f01c06f75d67
sanitizing @see in OrthancCPlugin.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5326
diff
changeset
|
2578 * @see OrthancPluginRestApiDeleteAfterPlugins() |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
2579 * @ingroup Orthanc |
|
913
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2580 **/ |
|
1581
357c4bb15701
Plugins have access to explicit error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1580
diff
changeset
|
2581 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiDelete( |
|
913
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2582 OrthancPluginContext* context, |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2583 const char* uri) |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2584 { |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2585 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri); |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2586 } |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2587 |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2588 |
|
1282
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2589 /** |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2590 * @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
|
2591 * |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2592 * 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
|
2593 * 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
|
2594 * 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
|
2595 * 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
|
2596 * |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2597 * @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
|
2598 * @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
|
2599 * @return 0 if success, or the error code if failure. |
| 2044 | 2600 * @note If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource. |
|
5327
f01c06f75d67
sanitizing @see in OrthancCPlugin.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5326
diff
changeset
|
2601 * @see OrthancPluginRestApiDelete() |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
2602 * @ingroup Orthanc |
|
1282
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2603 **/ |
|
1581
357c4bb15701
Plugins have access to explicit error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1580
diff
changeset
|
2604 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
|
2605 OrthancPluginContext* context, |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2606 const char* uri) |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2607 { |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2608 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
|
2609 } |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2610 |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2611 |
|
913
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2612 |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2613 /** |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2614 * @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
|
2615 * |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2616 * 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
|
2617 * 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
|
2618 * |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2619 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
2620 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). |
|
913
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2621 * @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
|
2622 * @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
|
2623 * @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
|
2624 * @return 0 if success, or the error code if failure. |
| 2044 | 2625 * @note If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource. |
|
5327
f01c06f75d67
sanitizing @see in OrthancCPlugin.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5326
diff
changeset
|
2626 * @see OrthancPluginRestApiPutAfterPlugins() |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
2627 * @ingroup Orthanc |
|
913
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2628 **/ |
|
1581
357c4bb15701
Plugins have access to explicit error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1580
diff
changeset
|
2629 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiPut( |
|
913
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2630 OrthancPluginContext* context, |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2631 OrthancPluginMemoryBuffer* target, |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2632 const char* uri, |
|
3400
0faae6f6e3c5
fixed some inconsistencies with pointer types in the plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3399
diff
changeset
|
2633 const void* body, |
|
913
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2634 uint32_t bodySize) |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2635 { |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2636 _OrthancPluginRestApiPostPut params; |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2637 params.target = target; |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2638 params.uri = uri; |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2639 params.body = body; |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2640 params.bodySize = bodySize; |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2641 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms); |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2642 } |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2643 |
|
3e43de893d88
POST, DELETE, PUT from Orthanc plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
912
diff
changeset
|
2644 |
|
1042
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2645 |
|
1282
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2646 /** |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2647 * @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
|
2648 * |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2649 * 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
|
2650 * 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
|
2651 * 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
|
2652 * 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
|
2653 * 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
|
2654 * |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2655 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
2656 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). |
|
1282
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2657 * @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
|
2658 * @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
|
2659 * @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
|
2660 * @return 0 if success, or the error code if failure. |
| 2044 | 2661 * @note If the resource is not existing (error 404), the error code will be OrthancPluginErrorCode_UnknownResource. |
|
5327
f01c06f75d67
sanitizing @see in OrthancCPlugin.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5326
diff
changeset
|
2662 * @see OrthancPluginRestApiPut() |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
2663 * @ingroup Orthanc |
|
1282
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2664 **/ |
|
1581
357c4bb15701
Plugins have access to explicit error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1580
diff
changeset
|
2665 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
|
2666 OrthancPluginContext* context, |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2667 OrthancPluginMemoryBuffer* target, |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2668 const char* uri, |
|
3400
0faae6f6e3c5
fixed some inconsistencies with pointer types in the plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3399
diff
changeset
|
2669 const void* body, |
|
1282
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2670 uint32_t bodySize) |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2671 { |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2672 _OrthancPluginRestApiPostPut params; |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2673 params.target = target; |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2674 params.uri = uri; |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2675 params.body = body; |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2676 params.bodySize = bodySize; |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2677 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms); |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2678 } |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2679 |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2680 |
|
7bccdd221e2b
Plugins can do REST calls to other plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1280
diff
changeset
|
2681 |
|
993
501880d76474
improvements to GDCM plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
913
diff
changeset
|
2682 typedef struct |
|
501880d76474
improvements to GDCM plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
913
diff
changeset
|
2683 { |
|
501880d76474
improvements to GDCM plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
913
diff
changeset
|
2684 OrthancPluginRestOutput* output; |
|
1042
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2685 const char* argument; |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2686 } _OrthancPluginOutputPlusArgument; |
|
993
501880d76474
improvements to GDCM plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
913
diff
changeset
|
2687 |
|
501880d76474
improvements to GDCM plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
913
diff
changeset
|
2688 /** |
|
1042
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2689 * @brief Redirect a REST request. |
|
993
501880d76474
improvements to GDCM plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
913
diff
changeset
|
2690 * |
|
501880d76474
improvements to GDCM plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
913
diff
changeset
|
2691 * 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
|
2692 * to another URI using HTTP status 301. |
|
501880d76474
improvements to GDCM plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
913
diff
changeset
|
2693 * |
|
501880d76474
improvements to GDCM plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
913
diff
changeset
|
2694 * @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
|
2695 * @param output The HTTP connection to the client application. |
|
501880d76474
improvements to GDCM plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
913
diff
changeset
|
2696 * @param redirection Where to redirect. |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
2697 * @ingroup REST |
|
993
501880d76474
improvements to GDCM plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
913
diff
changeset
|
2698 **/ |
|
501880d76474
improvements to GDCM plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
913
diff
changeset
|
2699 ORTHANC_PLUGIN_INLINE void OrthancPluginRedirect( |
|
501880d76474
improvements to GDCM plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
913
diff
changeset
|
2700 OrthancPluginContext* context, |
|
501880d76474
improvements to GDCM plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
913
diff
changeset
|
2701 OrthancPluginRestOutput* output, |
|
501880d76474
improvements to GDCM plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
913
diff
changeset
|
2702 const char* redirection) |
|
501880d76474
improvements to GDCM plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
913
diff
changeset
|
2703 { |
|
1042
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2704 _OrthancPluginOutputPlusArgument params; |
|
993
501880d76474
improvements to GDCM plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
913
diff
changeset
|
2705 params.output = output; |
|
1042
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2706 params.argument = redirection; |
|
993
501880d76474
improvements to GDCM plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
913
diff
changeset
|
2707 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms); |
|
501880d76474
improvements to GDCM plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
913
diff
changeset
|
2708 } |
|
501880d76474
improvements to GDCM plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
913
diff
changeset
|
2709 |
|
501880d76474
improvements to GDCM plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
913
diff
changeset
|
2710 |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2711 |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2712 typedef struct |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2713 { |
|
1145
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
2714 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
|
2715 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
|
2716 } _OrthancPluginRetrieveDynamicString; |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2717 |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2718 /** |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2719 * @brief Look for a patient. |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2720 * |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2721 * 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
|
2722 * 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
|
2723 * over all the stored patients). |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2724 * |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2725 * @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
|
2726 * @param patientID The Patient ID of interest. |
|
1068
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
2727 * @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
|
2728 * 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
|
2729 * @ingroup Orthanc |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2730 **/ |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2731 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupPatient( |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2732 OrthancPluginContext* context, |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2733 const char* patientID) |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2734 { |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2735 char* result; |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2736 |
|
1145
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
2737 _OrthancPluginRetrieveDynamicString params; |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2738 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
|
2739 params.argument = patientID; |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2740 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
2741 if (context->InvokeService(context, _OrthancPluginService_LookupPatient, ¶ms) != OrthancPluginErrorCode_Success) |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2742 { |
|
1067
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
2743 /* Error */ |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2744 return NULL; |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2745 } |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2746 else |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2747 { |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2748 return result; |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2749 } |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2750 } |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2751 |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2752 |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2753 /** |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2754 * @brief Look for a study. |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2755 * |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2756 * 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
|
2757 * 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
|
2758 * over all the stored studies). |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2759 * |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2760 * @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
|
2761 * @param studyUID The Study Instance UID of interest. |
|
1068
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
2762 * @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
|
2763 * 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
|
2764 * @ingroup Orthanc |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2765 **/ |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2766 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupStudy( |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2767 OrthancPluginContext* context, |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2768 const char* studyUID) |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2769 { |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2770 char* result; |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2771 |
|
1145
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
2772 _OrthancPluginRetrieveDynamicString params; |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2773 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
|
2774 params.argument = studyUID; |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2775 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
2776 if (context->InvokeService(context, _OrthancPluginService_LookupStudy, ¶ms) != OrthancPluginErrorCode_Success) |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2777 { |
|
1067
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
2778 /* Error */ |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2779 return NULL; |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2780 } |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2781 else |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2782 { |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2783 return result; |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2784 } |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2785 } |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2786 |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2787 |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2788 /** |
|
1069
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2789 * @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
|
2790 * |
|
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2791 * 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
|
2792 * 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
|
2793 * over all the stored studies). |
|
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2794 * |
|
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2795 * @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
|
2796 * @param accessionNumber The Accession Number of interest. |
|
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2797 * @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
|
2798 * 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
|
2799 * @ingroup Orthanc |
|
1069
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2800 **/ |
|
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2801 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupStudyWithAccessionNumber( |
|
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2802 OrthancPluginContext* context, |
|
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2803 const char* accessionNumber) |
|
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2804 { |
|
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2805 char* result; |
|
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2806 |
|
1145
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
2807 _OrthancPluginRetrieveDynamicString params; |
|
1069
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2808 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
|
2809 params.argument = accessionNumber; |
|
1069
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2810 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
2811 if (context->InvokeService(context, _OrthancPluginService_LookupStudyWithAccessionNumber, ¶ms) != OrthancPluginErrorCode_Success) |
|
1069
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2812 { |
|
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2813 /* Error */ |
|
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2814 return NULL; |
|
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2815 } |
|
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2816 else |
|
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2817 { |
|
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2818 return result; |
|
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2819 } |
|
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2820 } |
|
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2821 |
|
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2822 |
|
a91b4900f06a
plugin lookup using accession number
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1068
diff
changeset
|
2823 /** |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2824 * @brief Look for a series. |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2825 * |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2826 * 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
|
2827 * 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
|
2828 * over all the stored series). |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2829 * |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2830 * @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
|
2831 * @param seriesUID The Series Instance UID of interest. |
|
1068
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
2832 * @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
|
2833 * 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
|
2834 * @ingroup Orthanc |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2835 **/ |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2836 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupSeries( |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2837 OrthancPluginContext* context, |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2838 const char* seriesUID) |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2839 { |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2840 char* result; |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2841 |
|
1145
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
2842 _OrthancPluginRetrieveDynamicString params; |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2843 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
|
2844 params.argument = seriesUID; |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2845 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
2846 if (context->InvokeService(context, _OrthancPluginService_LookupSeries, ¶ms) != OrthancPluginErrorCode_Success) |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2847 { |
|
1067
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
2848 /* Error */ |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2849 return NULL; |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2850 } |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2851 else |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2852 { |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2853 return result; |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2854 } |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2855 } |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2856 |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2857 |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2858 /** |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2859 * @brief Look for an instance. |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2860 * |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2861 * 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
|
2862 * 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
|
2863 * over all the stored instances). |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2864 * |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2865 * @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
|
2866 * @param sopInstanceUID The SOP Instance UID of interest. |
|
1068
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
2867 * @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
|
2868 * 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
|
2869 * @ingroup Orthanc |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2870 **/ |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2871 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupInstance( |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2872 OrthancPluginContext* context, |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2873 const char* sopInstanceUID) |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2874 { |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2875 char* result; |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2876 |
|
1145
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
2877 _OrthancPluginRetrieveDynamicString params; |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2878 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
|
2879 params.argument = sopInstanceUID; |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2880 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
2881 if (context->InvokeService(context, _OrthancPluginService_LookupInstance, ¶ms) != OrthancPluginErrorCode_Success) |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2882 { |
|
1067
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
2883 /* Error */ |
|
1037
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2884 return NULL; |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2885 } |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2886 else |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2887 { |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2888 return result; |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2889 } |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2890 } |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2891 |
|
6208ab500ffd
LookupResource service in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1027
diff
changeset
|
2892 |
|
1042
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2893 |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2894 typedef struct |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2895 { |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2896 OrthancPluginRestOutput* output; |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2897 uint16_t status; |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2898 } _OrthancPluginSendHttpStatusCode; |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2899 |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2900 /** |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2901 * @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
|
2902 * |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2903 * 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
|
2904 * 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
|
2905 * - 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
|
2906 * - 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
|
2907 * - 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
|
2908 * - 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
|
2909 * |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2910 * @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
|
2911 * @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
|
2912 * @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
|
2913 * @ingroup REST |
|
1594
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
2914 * @see OrthancPluginSendHttpStatus() |
|
1042
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2915 **/ |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2916 ORTHANC_PLUGIN_INLINE void OrthancPluginSendHttpStatusCode( |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2917 OrthancPluginContext* context, |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2918 OrthancPluginRestOutput* output, |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2919 uint16_t status) |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2920 { |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2921 _OrthancPluginSendHttpStatusCode params; |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2922 params.output = output; |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2923 params.status = status; |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2924 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms); |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2925 } |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2926 |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2927 |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2928 /** |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2929 * @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
|
2930 * |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2931 * 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
|
2932 * not authorized. |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2933 * |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2934 * @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
|
2935 * @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
|
2936 * @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
|
2937 * @ingroup REST |
|
1042
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2938 **/ |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2939 ORTHANC_PLUGIN_INLINE void OrthancPluginSendUnauthorized( |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2940 OrthancPluginContext* context, |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2941 OrthancPluginRestOutput* output, |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2942 const char* realm) |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2943 { |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2944 _OrthancPluginOutputPlusArgument params; |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2945 params.output = output; |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2946 params.argument = realm; |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2947 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms); |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2948 } |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2949 |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2950 |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2951 /** |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2952 * @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
|
2953 * |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2954 * 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
|
2955 * 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
|
2956 * |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2957 * @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
|
2958 * @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
|
2959 * @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
|
2960 * @ingroup REST |
|
1042
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2961 **/ |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2962 ORTHANC_PLUGIN_INLINE void OrthancPluginSendMethodNotAllowed( |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2963 OrthancPluginContext* context, |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2964 OrthancPluginRestOutput* output, |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2965 const char* allowedMethods) |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2966 { |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2967 _OrthancPluginOutputPlusArgument params; |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2968 params.output = output; |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2969 params.argument = allowedMethods; |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2970 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms); |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2971 } |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2972 |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2973 |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2974 typedef struct |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2975 { |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2976 OrthancPluginRestOutput* output; |
|
1137
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
2977 const char* key; |
|
1042
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2978 const char* value; |
|
1137
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
2979 } _OrthancPluginSetHttpHeader; |
|
1042
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2980 |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2981 /** |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2982 * @brief Set a cookie. |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2983 * |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2984 * 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
|
2985 * |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2986 * @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
|
2987 * @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
|
2988 * @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
|
2989 * @param value The value of the cookie. |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
2990 * @ingroup REST |
|
1042
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2991 **/ |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2992 ORTHANC_PLUGIN_INLINE void OrthancPluginSetCookie( |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2993 OrthancPluginContext* context, |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2994 OrthancPluginRestOutput* output, |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2995 const char* cookie, |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2996 const char* value) |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2997 { |
|
1137
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
2998 _OrthancPluginSetHttpHeader params; |
|
1042
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
2999 params.output = output; |
|
1137
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3000 params.key = cookie; |
|
1042
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
3001 params.value = value; |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
3002 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms); |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
3003 } |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
3004 |
|
8d1845feb277
set cookies, not allowed methods, unauthorized in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1041
diff
changeset
|
3005 |
|
1137
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3006 /** |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3007 * @brief Set some HTTP header. |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3008 * |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3009 * This function sets a HTTP header in the HTTP answer. |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3010 * |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3011 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3012 * @param output The HTTP connection to the client application. |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3013 * @param key The HTTP header to be set. |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3014 * @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
|
3015 * @ingroup REST |
|
1137
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3016 **/ |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3017 ORTHANC_PLUGIN_INLINE void OrthancPluginSetHttpHeader( |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3018 OrthancPluginContext* context, |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3019 OrthancPluginRestOutput* output, |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3020 const char* key, |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3021 const char* value) |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3022 { |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3023 _OrthancPluginSetHttpHeader params; |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3024 params.output = output; |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3025 params.key = key; |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3026 params.value = value; |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3027 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms); |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3028 } |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3029 |
|
d9c27f9f1a51
OrthancPluginSetHttpHeader
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1136
diff
changeset
|
3030 |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3031 typedef struct |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3032 { |
|
3847
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3033 char** resultStringToFree; |
|
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3034 const char** resultString; |
|
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3035 int64_t* resultInt64; |
|
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3036 const char* key; |
|
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3037 const OrthancPluginDicomInstance* instance; |
|
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3038 OrthancPluginInstanceOrigin* resultOrigin; /* New in Orthanc 0.9.5 SDK */ |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3039 } _OrthancPluginAccessDicomInstance; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3040 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3041 |
|
1068
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3042 /** |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3043 * @brief Get the AET of a DICOM instance. |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3044 * |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3045 * 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
|
3046 * DICOM modality from which a DICOM instance originates. |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3047 * |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3048 * @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
|
3049 * @param instance The instance of interest. |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3050 * @return The AET if success, NULL if error. |
| 3936 | 3051 * @ingroup DicomInstance |
|
1068
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3052 **/ |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3053 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceRemoteAet( |
|
3847
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3054 OrthancPluginContext* context, |
|
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3055 const OrthancPluginDicomInstance* instance) |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3056 { |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3057 const char* result; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3058 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3059 _OrthancPluginAccessDicomInstance params; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3060 memset(¶ms, 0, sizeof(params)); |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3061 params.resultString = &result; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3062 params.instance = instance; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3063 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
3064 if (context->InvokeService(context, _OrthancPluginService_GetInstanceRemoteAet, ¶ms) != OrthancPluginErrorCode_Success) |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3065 { |
|
1067
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3066 /* Error */ |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3067 return NULL; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3068 } |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3069 else |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3070 { |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3071 return result; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3072 } |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3073 } |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3074 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3075 |
|
1068
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3076 /** |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3077 * @brief Get the size of a DICOM file. |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3078 * |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3079 * 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
|
3080 * |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3081 * @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
|
3082 * @param instance The instance of interest. |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3083 * @return The size of the file, -1 in case of error. |
| 3936 | 3084 * @ingroup DicomInstance |
|
1068
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3085 **/ |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3086 ORTHANC_PLUGIN_INLINE int64_t OrthancPluginGetInstanceSize( |
|
3847
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3087 OrthancPluginContext* context, |
|
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3088 const OrthancPluginDicomInstance* instance) |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3089 { |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3090 int64_t size; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3091 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3092 _OrthancPluginAccessDicomInstance params; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3093 memset(¶ms, 0, sizeof(params)); |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3094 params.resultInt64 = &size; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3095 params.instance = instance; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3096 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
3097 if (context->InvokeService(context, _OrthancPluginService_GetInstanceSize, ¶ms) != OrthancPluginErrorCode_Success) |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3098 { |
|
1067
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3099 /* Error */ |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3100 return -1; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3101 } |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3102 else |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3103 { |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3104 return size; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3105 } |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3106 } |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3107 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3108 |
|
1068
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3109 /** |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3110 * @brief Get the data of a DICOM file. |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3111 * |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3112 * 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
|
3113 * |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3114 * @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
|
3115 * @param instance The instance of interest. |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3116 * @return The pointer to the DICOM data, NULL in case of error. |
| 3936 | 3117 * @ingroup DicomInstance |
|
1068
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3118 **/ |
|
3791
a22717e68d9b
fixed signature of OrthancPluginGetInstanceData()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3790
diff
changeset
|
3119 ORTHANC_PLUGIN_INLINE const void* OrthancPluginGetInstanceData( |
|
3847
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3120 OrthancPluginContext* context, |
|
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3121 const OrthancPluginDicomInstance* instance) |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3122 { |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3123 const char* result; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3124 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3125 _OrthancPluginAccessDicomInstance params; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3126 memset(¶ms, 0, sizeof(params)); |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3127 params.resultString = &result; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3128 params.instance = instance; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3129 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
3130 if (context->InvokeService(context, _OrthancPluginService_GetInstanceData, ¶ms) != OrthancPluginErrorCode_Success) |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3131 { |
|
1067
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3132 /* Error */ |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3133 return NULL; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3134 } |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3135 else |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3136 { |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3137 return result; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3138 } |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3139 } |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3140 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3141 |
|
1068
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3142 /** |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3143 * @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
|
3144 * |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3145 * 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
|
3146 * 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
|
3147 * of the given DICOM instance. |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3148 * |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3149 * @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
|
3150 * @param instance The instance of interest. |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3151 * @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
|
3152 * This string must be freed by OrthancPluginFreeString(). |
| 3936 | 3153 * @ingroup DicomInstance |
|
1068
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3154 **/ |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3155 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceJson( |
|
3847
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3156 OrthancPluginContext* context, |
|
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3157 const OrthancPluginDicomInstance* instance) |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3158 { |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3159 char* result; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3160 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3161 _OrthancPluginAccessDicomInstance params; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3162 memset(¶ms, 0, sizeof(params)); |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3163 params.resultStringToFree = &result; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3164 params.instance = instance; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3165 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
3166 if (context->InvokeService(context, _OrthancPluginService_GetInstanceJson, ¶ms) != OrthancPluginErrorCode_Success) |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3167 { |
|
1067
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3168 /* Error */ |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3169 return NULL; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3170 } |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3171 else |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3172 { |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3173 return result; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3174 } |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3175 } |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3176 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3177 |
|
1068
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3178 /** |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3179 * @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
|
3180 * |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3181 * 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
|
3182 * 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
|
3183 * of the given DICOM instance. In contrast with |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3184 * ::OrthancPluginGetInstanceJson(), the returned JSON file is in |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3185 * its simplified version. |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3186 * |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3187 * @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
|
3188 * @param instance The instance of interest. |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3189 * @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
|
3190 * This string must be freed by OrthancPluginFreeString(). |
| 3936 | 3191 * @ingroup DicomInstance |
|
1068
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3192 **/ |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3193 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceSimplifiedJson( |
|
3847
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3194 OrthancPluginContext* context, |
|
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3195 const OrthancPluginDicomInstance* instance) |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3196 { |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3197 char* result; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3198 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3199 _OrthancPluginAccessDicomInstance params; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3200 memset(¶ms, 0, sizeof(params)); |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3201 params.resultStringToFree = &result; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3202 params.instance = instance; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3203 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
3204 if (context->InvokeService(context, _OrthancPluginService_GetInstanceSimplifiedJson, ¶ms) != OrthancPluginErrorCode_Success) |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3205 { |
|
1067
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3206 /* Error */ |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3207 return NULL; |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3208 } |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3209 else |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3210 { |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3211 return result; |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3212 } |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3213 } |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3214 |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3215 |
|
1068
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3216 /** |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3217 * @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
|
3218 * |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3219 * 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
|
3220 * 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
|
3221 * callbacks registered by |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3222 * ::OrthancPluginRegisterOnStoredInstanceCallback(), the only |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3223 * possibly available metadata are "ReceptionDate", "RemoteAET" and |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3224 * "IndexInSeries". |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3225 * |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3226 * @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
|
3227 * @param instance The instance of interest. |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3228 * @param metadata The metadata of interest. |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3229 * @return 1 if the metadata is present, 0 if it is absent, -1 in case of error. |
| 3936 | 3230 * @ingroup DicomInstance |
|
1068
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3231 **/ |
|
5389
0e5e675b9750
replaced "int" by "int32_t" in the SDK to prevent any ABI issue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5383
diff
changeset
|
3232 ORTHANC_PLUGIN_INLINE int32_t OrthancPluginHasInstanceMetadata( |
|
3847
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3233 OrthancPluginContext* context, |
|
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3234 const OrthancPluginDicomInstance* instance, |
|
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3235 const char* metadata) |
|
1067
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3236 { |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3237 int64_t result; |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3238 |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3239 _OrthancPluginAccessDicomInstance params; |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3240 memset(¶ms, 0, sizeof(params)); |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3241 params.resultInt64 = &result; |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3242 params.instance = instance; |
|
1068
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3243 params.key = metadata; |
|
1067
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3244 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
3245 if (context->InvokeService(context, _OrthancPluginService_HasInstanceMetadata, ¶ms) != OrthancPluginErrorCode_Success) |
|
1067
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3246 { |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3247 /* Error */ |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3248 return -1; |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3249 } |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3250 else |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3251 { |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3252 return (result != 0); |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3253 } |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3254 } |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3255 |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3256 |
|
1068
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3257 /** |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3258 * @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
|
3259 * |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3260 * 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
|
3261 * 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
|
3262 * ::OrthancPluginHasInstanceMetadata(). |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3263 * |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3264 * @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
|
3265 * @param instance The instance of interest. |
|
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3266 * @param metadata The metadata of interest. |
|
3584
75268c1ea309
Added note about metadata returned string lifetime
Benjamin Golinvaux <bgo@osimis.io>
parents:
3583
diff
changeset
|
3267 * @return The metadata value if success, NULL if error. Please note that the |
|
75268c1ea309
Added note about metadata returned string lifetime
Benjamin Golinvaux <bgo@osimis.io>
parents:
3583
diff
changeset
|
3268 * returned string belongs to the instance object and must NOT be |
|
75268c1ea309
Added note about metadata returned string lifetime
Benjamin Golinvaux <bgo@osimis.io>
parents:
3583
diff
changeset
|
3269 * deallocated. Please make a copy of the string if you wish to access |
|
75268c1ea309
Added note about metadata returned string lifetime
Benjamin Golinvaux <bgo@osimis.io>
parents:
3583
diff
changeset
|
3270 * it later. |
| 3936 | 3271 * @ingroup DicomInstance |
|
1068
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3272 **/ |
|
1067
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3273 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceMetadata( |
|
3847
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3274 OrthancPluginContext* context, |
|
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3275 const OrthancPluginDicomInstance* instance, |
|
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
3276 const char* metadata) |
|
1067
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3277 { |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3278 const char* result; |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3279 |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3280 _OrthancPluginAccessDicomInstance params; |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3281 memset(¶ms, 0, sizeof(params)); |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3282 params.resultString = &result; |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3283 params.instance = instance; |
|
1068
f54a9c6fea5d
documentation of plugin sdk
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1067
diff
changeset
|
3284 params.key = metadata; |
|
1067
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3285 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
3286 if (context->InvokeService(context, _OrthancPluginService_GetInstanceMetadata, ¶ms) != OrthancPluginErrorCode_Success) |
|
1067
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3287 { |
|
ace99e272203
access metadata in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1066
diff
changeset
|
3288 /* Error */ |
|
1066
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3289 return NULL; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3290 } |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3291 else |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3292 { |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3293 return result; |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3294 } |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3295 } |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3296 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3297 |
|
bb82e5e818e9
OnStoredInstance callback in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1042
diff
changeset
|
3298 |
|
1135
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
3299 typedef struct |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
3300 { |
| 1295 | 3301 OrthancPluginStorageCreate create; |
| 3302 OrthancPluginStorageRead read; | |
| 3303 OrthancPluginStorageRemove remove; | |
| 3304 OrthancPluginFree free; | |
|
1135
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
3305 } _OrthancPluginRegisterStorageArea; |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
3306 |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
3307 /** |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
3308 * @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
|
3309 * |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
3310 * 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
|
3311 * 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
|
3312 * 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
|
3313 * 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
|
3314 * |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
3315 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
| 1141 | 3316 * @param create The callback function to store a file on the custom storage area. |
| 3317 * @param read The callback function to read a file from the custom storage area. | |
| 3318 * @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
|
3319 * @ingroup Callbacks |
|
4440
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
3320 * @deprecated Please use OrthancPluginRegisterStorageArea2() |
|
1135
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
3321 **/ |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3322 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterStorageArea( |
|
1135
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
3323 OrthancPluginContext* context, |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
3324 OrthancPluginStorageCreate create, |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
3325 OrthancPluginStorageRead read, |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
3326 OrthancPluginStorageRemove remove) |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
3327 { |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
3328 _OrthancPluginRegisterStorageArea params; |
| 1295 | 3329 params.create = create; |
| 3330 params.read = read; | |
| 3331 params.remove = remove; | |
|
1136
208dc67b9bab
sample custom storage plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1135
diff
changeset
|
3332 |
|
208dc67b9bab
sample custom storage plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1135
diff
changeset
|
3333 #ifdef __cplusplus |
| 1295 | 3334 params.free = ::free; |
|
1136
208dc67b9bab
sample custom storage plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1135
diff
changeset
|
3335 #else |
| 1295 | 3336 params.free = free; |
|
1136
208dc67b9bab
sample custom storage plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1135
diff
changeset
|
3337 #endif |
|
208dc67b9bab
sample custom storage plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1135
diff
changeset
|
3338 |
|
1135
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
3339 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms); |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
3340 } |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
3341 |
|
67c3c1e4a6e0
index-only mode, and custom storage area with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1069
diff
changeset
|
3342 |
|
1145
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3343 |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3344 /** |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3345 * @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
|
3346 * |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3347 * 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
|
3348 * |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3349 * @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
|
3350 * @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
|
3351 * 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
|
3352 * OrthancPluginFreeString(). |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3353 **/ |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3354 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
|
3355 { |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3356 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
|
3357 |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3358 _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
|
3359 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
|
3360 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
|
3361 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
3362 if (context->InvokeService(context, _OrthancPluginService_GetOrthancPath, ¶ms) != 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
|
3363 { |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3364 /* Error */ |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3365 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
|
3366 } |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3367 else |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3368 { |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3369 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
|
3370 } |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3371 } |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3372 |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3373 |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3374 /** |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3375 * @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
|
3376 * |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3377 * 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
|
3378 * |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3379 * @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
|
3380 * @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
|
3381 * 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
|
3382 * OrthancPluginFreeString(). |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3383 **/ |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3384 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
|
3385 { |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3386 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
|
3387 |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3388 _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
|
3389 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
|
3390 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
|
3391 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
3392 if (context->InvokeService(context, _OrthancPluginService_GetOrthancDirectory, ¶ms) != 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
|
3393 { |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3394 /* Error */ |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3395 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
|
3396 } |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3397 else |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3398 { |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3399 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
|
3400 } |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3401 } |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3402 |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3403 |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3404 /** |
|
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
|
3405 * @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
|
3406 * |
|
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
|
3407 * 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
|
3408 * 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
|
3409 * 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
|
3410 * files. This function is deprecated in favor of |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3411 * 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
|
3412 * |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3413 * @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
|
3414 * @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
|
3415 * 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
|
3416 * OrthancPluginFreeString(). |
|
1424
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3417 * @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
|
3418 **/ |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3419 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE char *OrthancPluginGetConfigurationPath(OrthancPluginContext* context) |
|
1145
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3420 { |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3421 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
|
3422 |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3423 _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
|
3424 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
|
3425 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
|
3426 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
3427 if (context->InvokeService(context, _OrthancPluginService_GetConfigurationPath, ¶ms) != 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
|
3428 { |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3429 /* Error */ |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3430 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
|
3431 } |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3432 else |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3433 { |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3434 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
|
3435 } |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3436 } |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3437 |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3438 |
|
0479d02c6778
Plugins can retrieve the path to Orthanc and to its configuration file
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1141
diff
changeset
|
3439 |
|
1177
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3440 typedef struct |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3441 { |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3442 OrthancPluginOnChangeCallback callback; |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3443 } _OrthancPluginOnChangeCallback; |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3444 |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3445 /** |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3446 * @brief Register a callback to monitor changes. |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3447 * |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3448 * 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
|
3449 * whenever a change happens to some DICOM resource. |
|
1642
0669d05b6de1
warning about OrthancPluginRegisterOnChangeCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1630
diff
changeset
|
3450 * |
|
4181
b416b6bf129b
clarification of sdk doc about deadlocks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4179
diff
changeset
|
3451 * @warning Your callback function will be called synchronously with |
|
b416b6bf129b
clarification of sdk doc about deadlocks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4179
diff
changeset
|
3452 * the core of Orthanc. This implies that deadlocks might emerge if |
|
b416b6bf129b
clarification of sdk doc about deadlocks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4179
diff
changeset
|
3453 * you call other core primitives of Orthanc in your callback (such |
|
4919
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
3454 * deadlocks are particularly visible in the presence of other plugins |
|
4181
b416b6bf129b
clarification of sdk doc about deadlocks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4179
diff
changeset
|
3455 * or Lua scripts). It is thus strongly advised to avoid any call to |
|
b416b6bf129b
clarification of sdk doc about deadlocks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4179
diff
changeset
|
3456 * the REST API of Orthanc in the callback. If you have to call |
|
b416b6bf129b
clarification of sdk doc about deadlocks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4179
diff
changeset
|
3457 * other primitives of Orthanc, you should make these calls in a |
|
b416b6bf129b
clarification of sdk doc about deadlocks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4179
diff
changeset
|
3458 * separate thread, passing the pending events to be processed |
|
b416b6bf129b
clarification of sdk doc about deadlocks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4179
diff
changeset
|
3459 * through a message queue. |
|
1177
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3460 * |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3461 * @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
|
3462 * @param callback The callback function. |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
3463 * @ingroup Callbacks |
|
1177
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3464 **/ |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3465 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterOnChangeCallback( |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3466 OrthancPluginContext* context, |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3467 OrthancPluginOnChangeCallback callback) |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3468 { |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3469 _OrthancPluginOnChangeCallback params; |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3470 params.callback = callback; |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3471 |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3472 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms); |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3473 } |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3474 |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3475 |
|
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3476 |
|
1232
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3477 typedef struct |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3478 { |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3479 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
|
3480 _OrthancPluginProperty property; |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3481 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
|
3482 } _OrthancPluginSetPluginProperty; |
|
1232
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3483 |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3484 |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3485 /** |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3486 * @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
|
3487 * |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3488 * 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
|
3489 * 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
|
3490 * 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
|
3491 * Explorer. |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3492 * |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3493 * @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
|
3494 * @param uri The root URI for this plugin. |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3495 * |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3496 * @deprecated This function should not be used anymore because the |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3497 * result of the call to "OrthancPluginGetName()" depends on the |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3498 * system. Use "OrthancPluginSetRootUri2()" instead. |
|
1232
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3499 **/ |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3500 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE void OrthancPluginSetRootUri( |
|
1232
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3501 OrthancPluginContext* context, |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3502 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
|
3503 { |
|
1249
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3504 _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
|
3505 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
|
3506 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
|
3507 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
|
3508 |
|
1249
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3509 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms); |
|
1232
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3510 } |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3511 |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3512 |
| 1233 | 3513 /** |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3514 * @brief Set the URI where the plugin provides its Web interface. |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3515 * |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3516 * For plugins that come with a Web interface, this function |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3517 * declares the entry path where to find this interface. This |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3518 * information is notably used in the "Plugins" page of Orthanc |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3519 * Explorer. |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3520 * |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3521 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3522 * @param plugin Identifier of your plugin (it must match "OrthancPluginGetName()"). |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3523 * @param uri The root URI for this plugin. |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3524 **/ |
|
5538
6ce05f8b5b13
deprecating OrthancPluginSetDescription2(), OrthancPluginExtendOrthancExplorer2() and OrthancPluginSetRootUri2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5537
diff
changeset
|
3525 ORTHANC_PLUGIN_INLINE void OrthancPluginSetRootUri2( |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3526 OrthancPluginContext* context, |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3527 const char* plugin, |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3528 const char* uri) |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3529 { |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3530 _OrthancPluginSetPluginProperty params; |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3531 params.plugin = plugin; |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3532 params.property = _OrthancPluginProperty_RootUri; |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3533 params.value = uri; |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3534 |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3535 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms); |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3536 } |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3537 |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3538 |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3539 /** |
| 1233 | 3540 * @brief Set a description for this plugin. |
| 3541 * | |
| 3542 * Set a description for this plugin. It is displayed in the | |
| 3543 * "Plugins" page of Orthanc Explorer. | |
| 3544 * | |
| 3545 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 3546 * @param description The description. | |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3547 * |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3548 * @deprecated This function should not be used anymore because the |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3549 * result of the call to "OrthancPluginGetName()" depends on the |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3550 * system. Use "OrthancPluginSetDescription2()" instead. |
| 1233 | 3551 **/ |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3552 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE void OrthancPluginSetDescription( |
|
1232
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3553 OrthancPluginContext* context, |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3554 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
|
3555 { |
|
1249
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3556 _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
|
3557 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
|
3558 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
|
3559 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
|
3560 |
|
1249
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3561 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms); |
|
1232
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3562 } |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3563 |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3564 |
| 1233 | 3565 /** |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3566 * @brief Set a description for this plugin. |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3567 * |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3568 * Set a description for this plugin. It is displayed in the |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3569 * "Plugins" page of Orthanc Explorer. |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3570 * |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3571 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3572 * @param plugin Identifier of your plugin (it must match "OrthancPluginGetName()"). |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3573 * @param description The description. |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3574 **/ |
|
5538
6ce05f8b5b13
deprecating OrthancPluginSetDescription2(), OrthancPluginExtendOrthancExplorer2() and OrthancPluginSetRootUri2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5537
diff
changeset
|
3575 ORTHANC_PLUGIN_INLINE void OrthancPluginSetDescription2( |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3576 OrthancPluginContext* context, |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3577 const char* plugin, |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3578 const char* description) |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3579 { |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3580 _OrthancPluginSetPluginProperty params; |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3581 params.plugin = plugin; |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3582 params.property = _OrthancPluginProperty_Description; |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3583 params.value = description; |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3584 |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3585 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms); |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3586 } |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3587 |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3588 |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3589 /** |
| 1233 | 3590 * @brief Extend the JavaScript code of Orthanc Explorer. |
| 3591 * | |
| 3592 * Add JavaScript code to customize the default behavior of Orthanc | |
| 3593 * Explorer. This can for instance be used to add new buttons. | |
| 3594 * | |
| 3595 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 3596 * @param javascript The custom JavaScript code. | |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3597 * |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3598 * @deprecated This function should not be used anymore because the |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3599 * result of the call to "OrthancPluginGetName()" depends on the |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3600 * system. Use "OrthancPluginExtendOrthancExplorer2()" instead. |
| 1233 | 3601 **/ |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3602 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE void OrthancPluginExtendOrthancExplorer( |
|
1232
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3603 OrthancPluginContext* context, |
|
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3604 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
|
3605 { |
|
1249
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3606 _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
|
3607 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
|
3608 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
|
3609 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
|
3610 |
|
1249
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3611 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms); |
|
1232
f1c01451a8ee
Introspection of plugins, Plugins can extend Orthanc Explorer with custom JavaScript
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1198
diff
changeset
|
3612 } |
|
1177
5b2d8c280ac2
Plugins can monitor changes through callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1145
diff
changeset
|
3613 |
|
1249
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3614 |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3615 /** |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3616 * @brief Extend the JavaScript code of Orthanc Explorer. |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3617 * |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3618 * Add JavaScript code to customize the default behavior of Orthanc |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3619 * Explorer. This can for instance be used to add new buttons. |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3620 * |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3621 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3622 * @param plugin Identifier of your plugin (it must match "OrthancPluginGetName()"). |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3623 * @param javascript The custom JavaScript code. |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3624 **/ |
|
5538
6ce05f8b5b13
deprecating OrthancPluginSetDescription2(), OrthancPluginExtendOrthancExplorer2() and OrthancPluginSetRootUri2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5537
diff
changeset
|
3625 ORTHANC_PLUGIN_INLINE void OrthancPluginExtendOrthancExplorer2( |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3626 OrthancPluginContext* context, |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3627 const char* plugin, |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3628 const char* javascript) |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3629 { |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3630 _OrthancPluginSetPluginProperty params; |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3631 params.plugin = plugin; |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3632 params.property = _OrthancPluginProperty_OrthancExplorer; |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3633 params.value = javascript; |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3634 |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3635 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms); |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3636 } |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3637 |
|
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
3638 |
|
1249
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3639 typedef struct |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3640 { |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3641 char** result; |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3642 int32_t property; |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3643 const char* value; |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3644 } _OrthancPluginGlobalProperty; |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3645 |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3646 |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3647 /** |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3648 * @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
|
3649 * |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3650 * 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
|
3651 * 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
|
3652 * |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3653 * @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
|
3654 * @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
|
3655 * @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
|
3656 * @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
|
3657 * string must be freed by OrthancPluginFreeString(). |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
3658 * @ingroup Orthanc |
|
1249
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3659 **/ |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3660 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
|
3661 OrthancPluginContext* context, |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3662 int32_t property, |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3663 const char* defaultValue) |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3664 { |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3665 char* result; |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3666 |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3667 _OrthancPluginGlobalProperty params; |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3668 params.result = &result; |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3669 params.property = property; |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3670 params.value = defaultValue; |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3671 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
3672 if (context->InvokeService(context, _OrthancPluginService_GetGlobalProperty, ¶ms) != OrthancPluginErrorCode_Success) |
|
1249
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3673 { |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3674 /* Error */ |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3675 return NULL; |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3676 } |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3677 else |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3678 { |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3679 return result; |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3680 } |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3681 } |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3682 |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3683 |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3684 /** |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3685 * @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
|
3686 * |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3687 * 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
|
3688 * 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
|
3689 * 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
|
3690 * 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
|
3691 * 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
|
3692 * |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3693 * @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
|
3694 * @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
|
3695 * @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
|
3696 * @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
|
3697 * @ingroup Orthanc |
|
1249
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3698 **/ |
|
1581
357c4bb15701
Plugins have access to explicit error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1580
diff
changeset
|
3699 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
|
3700 OrthancPluginContext* context, |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3701 int32_t property, |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3702 const char* value) |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3703 { |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3704 _OrthancPluginGlobalProperty params; |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3705 params.result = NULL; |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3706 params.property = property; |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3707 params.value = value; |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3708 |
|
1581
357c4bb15701
Plugins have access to explicit error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1580
diff
changeset
|
3709 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms); |
|
1249
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3710 } |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3711 |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3712 |
|
40725595aaf0
Plugins can get/set global properties to save their configuration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1233
diff
changeset
|
3713 |
|
1280
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3714 typedef struct |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3715 { |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3716 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
|
3717 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
|
3718 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
|
3719 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
|
3720 } _OrthancPluginReturnSingleValue; |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3721 |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3722 /** |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3723 * @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
|
3724 * |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3725 * 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
|
3726 * |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3727 * @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
|
3728 * @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
|
3729 **/ |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3730 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
|
3731 OrthancPluginContext* context) |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3732 { |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3733 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
|
3734 |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3735 _OrthancPluginReturnSingleValue params; |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3736 memset(¶ms, 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
|
3737 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
|
3738 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
3739 if (context->InvokeService(context, _OrthancPluginService_GetCommandLineArgumentsCount, ¶ms) != 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
|
3740 { |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3741 /* Error */ |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3742 return 0; |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3743 } |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3744 else |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3745 { |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3746 return count; |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3747 } |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3748 } |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3749 |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3750 |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3751 |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3752 /** |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3753 * @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
|
3754 * |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3755 * 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
|
3756 * 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
|
3757 * 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
|
3758 * |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3759 * @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
|
3760 * @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
|
3761 * @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
|
3762 * 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
|
3763 **/ |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3764 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
|
3765 OrthancPluginContext* context, |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3766 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
|
3767 { |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3768 char* result; |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3769 |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3770 _OrthancPluginGlobalProperty params; |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3771 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
|
3772 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
|
3773 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
|
3774 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
3775 if (context->InvokeService(context, _OrthancPluginService_GetCommandLineArgument, ¶ms) != 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
|
3776 { |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3777 /* Error */ |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3778 return NULL; |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3779 } |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3780 else |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3781 { |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3782 return result; |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3783 } |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3784 } |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3785 |
|
d6a65dc6d0ac
Plugins can access the command-line arguments used to launch Orthanc
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1249
diff
changeset
|
3786 |
|
1407
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3787 /** |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3788 * @brief Get the expected version of the database schema. |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3789 * |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3790 * Retrieve the expected version of the database schema. |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3791 * |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3792 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3793 * @return The version. |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
3794 * @ingroup Callbacks |
|
1407
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3795 **/ |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3796 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetExpectedDatabaseVersion( |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3797 OrthancPluginContext* context) |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3798 { |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3799 uint32_t count = 0; |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3800 |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3801 _OrthancPluginReturnSingleValue params; |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3802 memset(¶ms, 0, sizeof(params)); |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3803 params.resultUint32 = &count; |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3804 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
3805 if (context->InvokeService(context, _OrthancPluginService_GetExpectedDatabaseVersion, ¶ms) != OrthancPluginErrorCode_Success) |
|
1407
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3806 { |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3807 /* Error */ |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3808 return 0; |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3809 } |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3810 else |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3811 { |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3812 return count; |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3813 } |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3814 } |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3815 |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3816 |
|
d371a66972a4
OrthancPluginGetExpectedDatabaseVersion
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1322
diff
changeset
|
3817 |
|
1424
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3818 /** |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3819 * @brief Return the content of the configuration file(s). |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3820 * |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3821 * This function returns the content of the configuration that is |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3822 * used by Orthanc, formatted as a JSON string. |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3823 * |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3824 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3825 * @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
|
3826 * containing the configuration. This string must be freed by |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3827 * OrthancPluginFreeString(). |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3828 **/ |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3829 ORTHANC_PLUGIN_INLINE char *OrthancPluginGetConfiguration(OrthancPluginContext* context) |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3830 { |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3831 char* result; |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3832 |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3833 _OrthancPluginRetrieveDynamicString params; |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3834 params.result = &result; |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3835 params.argument = NULL; |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3836 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
3837 if (context->InvokeService(context, _OrthancPluginService_GetConfiguration, ¶ms) != OrthancPluginErrorCode_Success) |
|
1424
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3838 { |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3839 /* Error */ |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3840 return NULL; |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3841 } |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3842 else |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3843 { |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3844 return result; |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3845 } |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3846 } |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3847 |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3848 |
|
fe384a9d3b51
OrthancPluginGetConfiguration
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1423
diff
changeset
|
3849 |
|
1430
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3850 typedef struct |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3851 { |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3852 OrthancPluginRestOutput* output; |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3853 const char* subType; |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3854 const char* contentType; |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3855 } _OrthancPluginStartMultipartAnswer; |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3856 |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3857 /** |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3858 * @brief Start an HTTP multipart answer. |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3859 * |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3860 * 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
|
3861 * |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3862 * @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
|
3863 * @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
|
3864 * @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
|
3865 * @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
|
3866 * @return 0 if success, or the error code if failure. |
|
1882
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
3867 * @see OrthancPluginSendMultipartItem(), OrthancPluginSendMultipartItem2() |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
3868 * @ingroup REST |
|
1430
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3869 **/ |
|
1581
357c4bb15701
Plugins have access to explicit error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1580
diff
changeset
|
3870 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStartMultipartAnswer( |
|
1430
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3871 OrthancPluginContext* context, |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3872 OrthancPluginRestOutput* output, |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3873 const char* subType, |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3874 const char* contentType) |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3875 { |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3876 _OrthancPluginStartMultipartAnswer params; |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3877 params.output = output; |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3878 params.subType = subType; |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3879 params.contentType = contentType; |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3880 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms); |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3881 } |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3882 |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3883 |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3884 /** |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3885 * @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
|
3886 * |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3887 * 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
|
3888 * answer that was initiated by OrthancPluginStartMultipartAnswer(). |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3889 * |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3890 * @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
|
3891 * @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
|
3892 * @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
|
3893 * @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
|
3894 * @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
|
3895 * if the connection is closed by the client). |
|
1882
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
3896 * @see OrthancPluginSendMultipartItem2() |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
3897 * @ingroup REST |
|
1430
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3898 **/ |
|
1581
357c4bb15701
Plugins have access to explicit error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1580
diff
changeset
|
3899 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginSendMultipartItem( |
|
1430
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3900 OrthancPluginContext* context, |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3901 OrthancPluginRestOutput* output, |
|
4077
ae7ebd5b0443
fix signature of OrthancPluginSendMultipartItem[2]()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4024
diff
changeset
|
3902 const void* answer, |
|
1430
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3903 uint32_t answerSize) |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3904 { |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3905 _OrthancPluginAnswerBuffer params; |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3906 params.output = output; |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3907 params.answer = answer; |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3908 params.answerSize = answerSize; |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3909 params.mimeType = NULL; |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3910 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms); |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3911 } |
|
ad94a3583b07
Plugins can send answers as multipart messages
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1426
diff
changeset
|
3912 |
|
1554
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3913 |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3914 |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3915 typedef struct |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3916 { |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3917 OrthancPluginMemoryBuffer* target; |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3918 const void* source; |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3919 uint32_t size; |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3920 OrthancPluginCompressionType compression; |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3921 uint8_t uncompress; |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3922 } _OrthancPluginBufferCompression; |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3923 |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3924 |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3925 /** |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3926 * @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
|
3927 * |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3928 * 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
|
3929 * 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
|
3930 * |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3931 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
3932 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). |
|
1554
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3933 * @param source The source buffer. |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3934 * @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
|
3935 * @param compression The compression algorithm. |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3936 * @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
|
3937 * 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
|
3938 * @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
|
3939 * @ingroup Images |
|
1554
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3940 **/ |
|
1581
357c4bb15701
Plugins have access to explicit error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1580
diff
changeset
|
3941 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
|
3942 OrthancPluginContext* context, |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3943 OrthancPluginMemoryBuffer* target, |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3944 const void* source, |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3945 uint32_t size, |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3946 OrthancPluginCompressionType compression, |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3947 uint8_t uncompress) |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3948 { |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3949 _OrthancPluginBufferCompression params; |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3950 params.target = target; |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3951 params.source = source; |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3952 params.size = size; |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3953 params.compression = compression; |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3954 params.uncompress = uncompress; |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3955 |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3956 return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms); |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3957 } |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3958 |
|
89ab71a68fcf
New function OrthancPluginBufferCompression() to (un)compress memory buffers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1466
diff
changeset
|
3959 |
|
1588
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3960 |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3961 typedef struct |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3962 { |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3963 OrthancPluginMemoryBuffer* target; |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3964 const char* path; |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3965 } _OrthancPluginReadFile; |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3966 |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3967 /** |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3968 * @brief Read a file. |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3969 * |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3970 * 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
|
3971 * a newly allocated memory buffer. |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3972 * |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3973 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
3974 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). |
|
1588
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3975 * @param path The path of the file to be read. |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3976 * @return 0 if success, or the error code if failure. |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3977 **/ |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3978 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginReadFile( |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3979 OrthancPluginContext* context, |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3980 OrthancPluginMemoryBuffer* target, |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3981 const char* path) |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3982 { |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3983 _OrthancPluginReadFile params; |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3984 params.target = target; |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3985 params.path = path; |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3986 return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms); |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3987 } |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3988 |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3989 |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3990 |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3991 typedef struct |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3992 { |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3993 const char* path; |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3994 const void* data; |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3995 uint32_t size; |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3996 } _OrthancPluginWriteFile; |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3997 |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3998 /** |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
3999 * @brief Write a file. |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4000 * |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4001 * Write the content of a memory buffer to the filesystem. |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4002 * |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4003 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4004 * @param path The path of the file to be written. |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4005 * @param data The content of the memory buffer. |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4006 * @param size The size of the memory buffer. |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4007 * @return 0 if success, or the error code if failure. |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4008 **/ |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4009 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginWriteFile( |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4010 OrthancPluginContext* context, |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4011 const char* path, |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4012 const void* data, |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4013 uint32_t size) |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4014 { |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4015 _OrthancPluginWriteFile params; |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4016 params.path = path; |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4017 params.data = data; |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4018 params.size = size; |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4019 return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms); |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4020 } |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4021 |
|
b5bc87a7212d
OrthancPluginReadFile, OrthancPluginWriteFile
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1583
diff
changeset
|
4022 |
|
1593
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4023 |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4024 typedef struct |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4025 { |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4026 const char** target; |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4027 OrthancPluginErrorCode error; |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4028 } _OrthancPluginGetErrorDescription; |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4029 |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4030 /** |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4031 * @brief Get the description of a given error code. |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4032 * |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4033 * This function returns the description of a given error code. |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4034 * |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4035 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
1595
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
4036 * @param error The error code of interest. |
|
1593
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4037 * @return The error description. This is a statically-allocated |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4038 * string, do not free it. |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4039 **/ |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4040 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetErrorDescription( |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4041 OrthancPluginContext* context, |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4042 OrthancPluginErrorCode error) |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4043 { |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4044 const char* result = NULL; |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4045 |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4046 _OrthancPluginGetErrorDescription params; |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4047 params.target = &result; |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4048 params.error = error; |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4049 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
4050 if (context->InvokeService(context, _OrthancPluginService_GetErrorDescription, ¶ms) != OrthancPluginErrorCode_Success || |
|
1593
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4051 result == NULL) |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4052 { |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4053 return "Unknown error code"; |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4054 } |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4055 else |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4056 { |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4057 return result; |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4058 } |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4059 } |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4060 |
|
235d89817b89
OrthancPluginGetErrorDescription
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1588
diff
changeset
|
4061 |
|
1594
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4062 |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4063 typedef struct |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4064 { |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4065 OrthancPluginRestOutput* output; |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4066 uint16_t status; |
|
5076
25844bc0b2cb
fix signature of OrthancPluginSendHttpStatus() for the "body" argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5051
diff
changeset
|
4067 const void* body; |
|
1594
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4068 uint32_t bodySize; |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4069 } _OrthancPluginSendHttpStatus; |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4070 |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4071 /** |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4072 * @brief Send a HTTP status, with a custom body. |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4073 * |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4074 * This function answers to a HTTP request by sending a HTTP status |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4075 * code (such as "400 - Bad Request"), together with a body |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4076 * describing the error. The body will only be returned if the |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4077 * configuration option "HttpDescribeErrors" of Orthanc is set to "true". |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4078 * |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4079 * Note that: |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4080 * - Successful requests (status 200) must use ::OrthancPluginAnswerBuffer(). |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4081 * - Redirections (status 301) must use ::OrthancPluginRedirect(). |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4082 * - Unauthorized access (status 401) must use ::OrthancPluginSendUnauthorized(). |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4083 * - Methods not allowed (status 405) must use ::OrthancPluginSendMethodNotAllowed(). |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4084 * |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4085 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4086 * @param output The HTTP connection to the client application. |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4087 * @param status The HTTP status code to be sent. |
|
1595
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
4088 * @param body The body of the answer. |
|
e1e54a73ba8b
OrthancPluginRegisterRestCallbackNoLock, documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1594
diff
changeset
|
4089 * @param bodySize The size of the body. |
|
1594
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4090 * @see OrthancPluginSendHttpStatusCode() |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
4091 * @ingroup REST |
|
1594
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4092 **/ |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4093 ORTHANC_PLUGIN_INLINE void OrthancPluginSendHttpStatus( |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4094 OrthancPluginContext* context, |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4095 OrthancPluginRestOutput* output, |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4096 uint16_t status, |
|
5076
25844bc0b2cb
fix signature of OrthancPluginSendHttpStatus() for the "body" argument
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5051
diff
changeset
|
4097 const void* body, |
|
1594
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4098 uint32_t bodySize) |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4099 { |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4100 _OrthancPluginSendHttpStatus params; |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4101 params.output = output; |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4102 params.status = status; |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4103 params.body = body; |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4104 params.bodySize = bodySize; |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4105 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms); |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4106 } |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4107 |
|
2bac60a4f584
OrthancPluginSendHttpStatus
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1593
diff
changeset
|
4108 |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4109 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4110 typedef struct |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4111 { |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4112 const OrthancPluginImage* image; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4113 uint32_t* resultUint32; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4114 OrthancPluginPixelFormat* resultPixelFormat; |
|
1828
a71d74987090
sample plugin: CustomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1827
diff
changeset
|
4115 void** resultBuffer; |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4116 } _OrthancPluginGetImageInfo; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4117 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4118 |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4119 /** |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4120 * @brief Return the pixel format of an image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4121 * |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4122 * 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
|
4123 * |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4124 * @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
|
4125 * @param image The image of interest. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4126 * @return The pixel format. |
|
1613
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4127 * @ingroup Images |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4128 **/ |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4129 ORTHANC_PLUGIN_INLINE OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat( |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4130 OrthancPluginContext* context, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4131 const OrthancPluginImage* image) |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4132 { |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4133 OrthancPluginPixelFormat target; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4134 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4135 _OrthancPluginGetImageInfo params; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4136 memset(¶ms, 0, sizeof(params)); |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4137 params.image = image; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4138 params.resultPixelFormat = ⌖ |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4139 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
4140 if (context->InvokeService(context, _OrthancPluginService_GetImagePixelFormat, ¶ms) != OrthancPluginErrorCode_Success) |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4141 { |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4142 return OrthancPluginPixelFormat_Unknown; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4143 } |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4144 else |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4145 { |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
4146 return (OrthancPluginPixelFormat) target; |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4147 } |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4148 } |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4149 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4150 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4151 |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4152 /** |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4153 * @brief Return the width of an image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4154 * |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4155 * This function returns the width of the given image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4156 * |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4157 * @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
|
4158 * @param image The image of interest. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4159 * @return The width. |
|
1613
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4160 * @ingroup Images |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4161 **/ |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4162 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetImageWidth( |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4163 OrthancPluginContext* context, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4164 const OrthancPluginImage* image) |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4165 { |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4166 uint32_t width; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4167 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4168 _OrthancPluginGetImageInfo params; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4169 memset(¶ms, 0, sizeof(params)); |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4170 params.image = image; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4171 params.resultUint32 = &width; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4172 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
4173 if (context->InvokeService(context, _OrthancPluginService_GetImageWidth, ¶ms) != OrthancPluginErrorCode_Success) |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4174 { |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4175 return 0; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4176 } |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4177 else |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4178 { |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4179 return width; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4180 } |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4181 } |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4182 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4183 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4184 |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4185 /** |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4186 * @brief Return the height of an image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4187 * |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4188 * This function returns the height of the given image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4189 * |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4190 * @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
|
4191 * @param image The image of interest. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4192 * @return The height. |
|
1613
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4193 * @ingroup Images |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4194 **/ |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4195 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetImageHeight( |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4196 OrthancPluginContext* context, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4197 const OrthancPluginImage* image) |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4198 { |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4199 uint32_t height; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4200 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4201 _OrthancPluginGetImageInfo params; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4202 memset(¶ms, 0, sizeof(params)); |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4203 params.image = image; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4204 params.resultUint32 = &height; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4205 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
4206 if (context->InvokeService(context, _OrthancPluginService_GetImageHeight, ¶ms) != OrthancPluginErrorCode_Success) |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4207 { |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4208 return 0; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4209 } |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4210 else |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4211 { |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4212 return height; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4213 } |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4214 } |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4215 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4216 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4217 |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4218 /** |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4219 * @brief Return the pitch of an image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4220 * |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4221 * 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
|
4222 * 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
|
4223 * image in the memory buffer. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4224 * |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4225 * @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
|
4226 * @param image The image of interest. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4227 * @return The pitch. |
|
1613
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4228 * @ingroup Images |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4229 **/ |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4230 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetImagePitch( |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4231 OrthancPluginContext* context, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4232 const OrthancPluginImage* image) |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4233 { |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4234 uint32_t pitch; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4235 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4236 _OrthancPluginGetImageInfo params; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4237 memset(¶ms, 0, sizeof(params)); |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4238 params.image = image; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4239 params.resultUint32 = &pitch; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4240 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
4241 if (context->InvokeService(context, _OrthancPluginService_GetImagePitch, ¶ms) != OrthancPluginErrorCode_Success) |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4242 { |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4243 return 0; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4244 } |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4245 else |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4246 { |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4247 return pitch; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4248 } |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4249 } |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4250 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4251 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4252 |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4253 /** |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4254 * @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
|
4255 * |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4256 * 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
|
4257 * contains the pixels of the image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4258 * |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4259 * @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
|
4260 * @param image The image of interest. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4261 * @return The pointer. |
|
1613
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4262 * @ingroup Images |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4263 **/ |
|
1828
a71d74987090
sample plugin: CustomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1827
diff
changeset
|
4264 ORTHANC_PLUGIN_INLINE void* OrthancPluginGetImageBuffer( |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4265 OrthancPluginContext* context, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4266 const OrthancPluginImage* image) |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4267 { |
|
1828
a71d74987090
sample plugin: CustomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1827
diff
changeset
|
4268 void* target = NULL; |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4269 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4270 _OrthancPluginGetImageInfo params; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4271 memset(¶ms, 0, sizeof(params)); |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4272 params.resultBuffer = ⌖ |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4273 params.image = image; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4274 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
4275 if (context->InvokeService(context, _OrthancPluginService_GetImageBuffer, ¶ms) != OrthancPluginErrorCode_Success) |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4276 { |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4277 return NULL; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4278 } |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4279 else |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4280 { |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4281 return target; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4282 } |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4283 } |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4284 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4285 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4286 typedef struct |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4287 { |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4288 OrthancPluginImage** target; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4289 const void* data; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4290 uint32_t size; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4291 OrthancPluginImageFormat format; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4292 } _OrthancPluginUncompressImage; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4293 |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4294 |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4295 /** |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4296 * @brief Decode a compressed image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4297 * |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4298 * 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
|
4299 * |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4300 * @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
|
4301 * @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
|
4302 * @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
|
4303 * @param format The file format of the compressed image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4304 * @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
|
4305 * @ingroup Images |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4306 **/ |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4307 ORTHANC_PLUGIN_INLINE OrthancPluginImage *OrthancPluginUncompressImage( |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4308 OrthancPluginContext* context, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4309 const void* data, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4310 uint32_t size, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4311 OrthancPluginImageFormat format) |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4312 { |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4313 OrthancPluginImage* target = NULL; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4314 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4315 _OrthancPluginUncompressImage params; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4316 memset(¶ms, 0, sizeof(params)); |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4317 params.target = ⌖ |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4318 params.data = data; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4319 params.size = size; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4320 params.format = format; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4321 |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
4322 if (context->InvokeService(context, _OrthancPluginService_UncompressImage, ¶ms) != OrthancPluginErrorCode_Success) |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4323 { |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4324 return NULL; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4325 } |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4326 else |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4327 { |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4328 return target; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4329 } |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4330 } |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4331 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4332 |
| 1605 | 4333 |
| 4334 | |
| 4335 typedef struct | |
| 4336 { | |
| 4337 OrthancPluginImage* image; | |
| 4338 } _OrthancPluginFreeImage; | |
| 4339 | |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4340 /** |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4341 * @brief Free an image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4342 * |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4343 * 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
|
4344 * |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4345 * @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
|
4346 * @param image The image. |
|
1613
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4347 * @ingroup Images |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4348 **/ |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4349 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeImage( |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4350 OrthancPluginContext* context, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4351 OrthancPluginImage* image) |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4352 { |
| 1605 | 4353 _OrthancPluginFreeImage params; |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4354 params.image = image; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4355 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4356 context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms); |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4357 } |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4358 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4359 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4360 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4361 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4362 typedef struct |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4363 { |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4364 OrthancPluginMemoryBuffer* target; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4365 OrthancPluginImageFormat imageFormat; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4366 OrthancPluginPixelFormat pixelFormat; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4367 uint32_t width; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4368 uint32_t height; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4369 uint32_t pitch; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4370 const void* buffer; |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
4371 uint8_t quality; |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4372 } _OrthancPluginCompressImage; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4373 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4374 |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4375 /** |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
4376 * @brief Encode a PNG image. |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4377 * |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4378 * This function compresses the given memory buffer containing an |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4379 * 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
|
4380 * compression into a newly allocated memory buffer. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4381 * |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4382 * @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
|
4383 * @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
|
4384 * @param format The memory layout of the uncompressed image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4385 * @param width The width of the image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4386 * @param height The height of the image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4387 * @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
|
4388 * 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
|
4389 * @param buffer The memory buffer containing the uncompressed image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4390 * @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
|
4391 * @see OrthancPluginCompressAndAnswerPngImage() |
|
1613
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4392 * @ingroup Images |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4393 **/ |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4394 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCompressPngImage( |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4395 OrthancPluginContext* context, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4396 OrthancPluginMemoryBuffer* target, |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4397 OrthancPluginPixelFormat format, |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4398 uint32_t width, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4399 uint32_t height, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4400 uint32_t pitch, |
|
1599
dd1f9e81f891
fixes to image primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1598
diff
changeset
|
4401 const void* buffer) |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4402 { |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4403 _OrthancPluginCompressImage params; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4404 memset(¶ms, 0, sizeof(params)); |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4405 params.target = target; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4406 params.imageFormat = OrthancPluginImageFormat_Png; |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4407 params.pixelFormat = format; |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4408 params.width = width; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4409 params.height = height; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4410 params.pitch = pitch; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4411 params.buffer = buffer; |
|
1613
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4412 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
|
4413 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4414 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms); |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4415 } |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4416 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4417 |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4418 /** |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
4419 * @brief Encode a JPEG image. |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4420 * |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4421 * This function compresses the given memory buffer containing an |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4422 * 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
|
4423 * compression into a newly allocated memory buffer. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4424 * |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4425 * @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
|
4426 * @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
|
4427 * @param format The memory layout of the uncompressed image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4428 * @param width The width of the image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4429 * @param height The height of the image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4430 * @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
|
4431 * 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
|
4432 * @param buffer The memory buffer containing the uncompressed image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4433 * @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
|
4434 * quality, best compression) and 100 (best quality, worst |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4435 * compression). |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4436 * @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
|
4437 * @ingroup Images |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4438 **/ |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4439 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCompressJpegImage( |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4440 OrthancPluginContext* context, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4441 OrthancPluginMemoryBuffer* target, |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4442 OrthancPluginPixelFormat format, |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4443 uint32_t width, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4444 uint32_t height, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4445 uint32_t pitch, |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4446 const void* buffer, |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4447 uint8_t quality) |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4448 { |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4449 _OrthancPluginCompressImage params; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4450 memset(¶ms, 0, sizeof(params)); |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4451 params.target = target; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4452 params.imageFormat = OrthancPluginImageFormat_Jpeg; |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4453 params.pixelFormat = format; |
|
1598
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4454 params.width = width; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4455 params.height = height; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4456 params.pitch = pitch; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4457 params.buffer = buffer; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4458 params.quality = quality; |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4459 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4460 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms); |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4461 } |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4462 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4463 |
|
c6b50b803387
primitives for image encoding/decoding in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1596
diff
changeset
|
4464 |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4465 /** |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4466 * @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
|
4467 * |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4468 * 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
|
4469 * parameters of this function describe a memory buffer that |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4470 * 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
|
4471 * 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
|
4472 * |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4473 * @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
|
4474 * @param output The HTTP connection to the client application. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4475 * @param format The memory layout of the uncompressed image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4476 * @param width The width of the image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4477 * @param height The height of the image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4478 * @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
|
4479 * 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
|
4480 * @param buffer The memory buffer containing the uncompressed image. |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4481 * @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
|
4482 * quality, best compression) and 100 (best quality, worst |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4483 * compression). |
|
1601
6cccf1da35c6
groups in the plugin documentation
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1600
diff
changeset
|
4484 * @ingroup REST |
|
1600
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4485 **/ |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4486 ORTHANC_PLUGIN_INLINE void OrthancPluginCompressAndAnswerJpegImage( |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4487 OrthancPluginContext* context, |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4488 OrthancPluginRestOutput* output, |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4489 OrthancPluginPixelFormat format, |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4490 uint32_t width, |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4491 uint32_t height, |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4492 uint32_t pitch, |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4493 const void* buffer, |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4494 uint8_t quality) |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4495 { |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4496 _OrthancPluginCompressAndAnswerImage params; |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4497 params.output = output; |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4498 params.imageFormat = OrthancPluginImageFormat_Jpeg; |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4499 params.pixelFormat = format; |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4500 params.width = width; |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4501 params.height = height; |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4502 params.pitch = pitch; |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4503 params.buffer = buffer; |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4504 params.quality = quality; |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4505 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms); |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4506 } |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4507 |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4508 |
|
7151d63e6d81
documentation, primitives for jpeg
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1599
diff
changeset
|
4509 |
|
1606
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4510 |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4511 typedef struct |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4512 { |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4513 OrthancPluginMemoryBuffer* target; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4514 OrthancPluginHttpMethod method; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4515 const char* url; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4516 const char* username; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4517 const char* password; |
| 3401 | 4518 const void* body; |
|
1606
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4519 uint32_t bodySize; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4520 } _OrthancPluginCallHttpClient; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4521 |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4522 |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4523 /** |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4524 * @brief Issue a HTTP GET call. |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4525 * |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4526 * 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
|
4527 * 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
|
4528 * 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
|
4529 * Orthanc instance that hosts this plugin. |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4530 * |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4531 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
4532 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). |
|
1606
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4533 * @param url The URL of interest. |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4534 * @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
|
4535 * @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
|
4536 * @return 0 if success, or the error code if failure. |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
4537 * @ingroup Toolbox |
|
1606
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4538 **/ |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4539 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpGet( |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4540 OrthancPluginContext* context, |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4541 OrthancPluginMemoryBuffer* target, |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4542 const char* url, |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4543 const char* username, |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4544 const char* password) |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4545 { |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4546 _OrthancPluginCallHttpClient params; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4547 memset(¶ms, 0, sizeof(params)); |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4548 |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4549 params.target = target; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4550 params.method = OrthancPluginHttpMethod_Get; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4551 params.url = url; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4552 params.username = username; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4553 params.password = password; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4554 |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4555 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms); |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4556 } |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4557 |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4558 |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4559 /** |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4560 * @brief Issue a HTTP POST call. |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4561 * |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4562 * 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
|
4563 * 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
|
4564 * 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
|
4565 * 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
|
4566 * |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4567 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
4568 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). |
|
1606
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4569 * @param url The URL of interest. |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4570 * @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
|
4571 * @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
|
4572 * @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
|
4573 * @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
|
4574 * @return 0 if success, or the error code if failure. |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
4575 * @ingroup Toolbox |
|
1606
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4576 **/ |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4577 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpPost( |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4578 OrthancPluginContext* context, |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4579 OrthancPluginMemoryBuffer* target, |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4580 const char* url, |
| 3401 | 4581 const void* body, |
|
1606
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4582 uint32_t bodySize, |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4583 const char* username, |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4584 const char* password) |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4585 { |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4586 _OrthancPluginCallHttpClient params; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4587 memset(¶ms, 0, sizeof(params)); |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4588 |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4589 params.target = target; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4590 params.method = OrthancPluginHttpMethod_Post; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4591 params.url = url; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4592 params.body = body; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4593 params.bodySize = bodySize; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4594 params.username = username; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4595 params.password = password; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4596 |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4597 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms); |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4598 } |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4599 |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4600 |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4601 /** |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4602 * @brief Issue a HTTP PUT call. |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4603 * |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4604 * 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
|
4605 * 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
|
4606 * 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
|
4607 * Orthanc instance that hosts this plugin. |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4608 * |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4609 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
4610 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). |
|
1606
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4611 * @param url The URL of interest. |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4612 * @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
|
4613 * @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
|
4614 * @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
|
4615 * @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
|
4616 * @return 0 if success, or the error code if failure. |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
4617 * @ingroup Toolbox |
|
1606
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4618 **/ |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4619 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpPut( |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4620 OrthancPluginContext* context, |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4621 OrthancPluginMemoryBuffer* target, |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4622 const char* url, |
| 3401 | 4623 const void* body, |
|
1606
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4624 uint32_t bodySize, |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4625 const char* username, |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4626 const char* password) |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4627 { |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4628 _OrthancPluginCallHttpClient params; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4629 memset(¶ms, 0, sizeof(params)); |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4630 |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4631 params.target = target; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4632 params.method = OrthancPluginHttpMethod_Put; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4633 params.url = url; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4634 params.body = body; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4635 params.bodySize = bodySize; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4636 params.username = username; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4637 params.password = password; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4638 |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4639 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms); |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4640 } |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4641 |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4642 |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4643 /** |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4644 * @brief Issue a HTTP DELETE call. |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4645 * |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4646 * 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
|
4647 * 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
|
4648 * 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
|
4649 * |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4650 * @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
|
4651 * @param url The URL of interest. |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4652 * @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
|
4653 * @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
|
4654 * @return 0 if success, or the error code if failure. |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
4655 * @ingroup Toolbox |
|
1606
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4656 **/ |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4657 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpDelete( |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4658 OrthancPluginContext* context, |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4659 const char* url, |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4660 const char* username, |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4661 const char* password) |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4662 { |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4663 _OrthancPluginCallHttpClient params; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4664 memset(¶ms, 0, sizeof(params)); |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4665 |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4666 params.method = OrthancPluginHttpMethod_Delete; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4667 params.url = url; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4668 params.username = username; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4669 params.password = password; |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4670 |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4671 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms); |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4672 } |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4673 |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4674 |
|
31f4adefb88f
issuing HTTP requests from the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1605
diff
changeset
|
4675 |
|
1608
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4676 typedef struct |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4677 { |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4678 OrthancPluginImage** target; |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4679 const OrthancPluginImage* source; |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4680 OrthancPluginPixelFormat targetFormat; |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4681 } _OrthancPluginConvertPixelFormat; |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4682 |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4683 |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4684 /** |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4685 * @brief Change the pixel format of an image. |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4686 * |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4687 * 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
|
4688 * |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4689 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4690 * @param source The source image. |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4691 * @param targetFormat The target pixel format. |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4692 * @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
|
4693 * @ingroup Images |
|
1608
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4694 **/ |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4695 ORTHANC_PLUGIN_INLINE OrthancPluginImage *OrthancPluginConvertPixelFormat( |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4696 OrthancPluginContext* context, |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4697 const OrthancPluginImage* source, |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4698 OrthancPluginPixelFormat targetFormat) |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4699 { |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4700 OrthancPluginImage* target = NULL; |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4701 |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4702 _OrthancPluginConvertPixelFormat params; |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4703 params.target = ⌖ |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4704 params.source = source; |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4705 params.targetFormat = targetFormat; |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4706 |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4707 if (context->InvokeService(context, _OrthancPluginService_ConvertPixelFormat, ¶ms) != OrthancPluginErrorCode_Success) |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4708 { |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4709 return NULL; |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4710 } |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4711 else |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4712 { |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4713 return target; |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4714 } |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4715 } |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4716 |
|
adc6a5704cdb
OrthancPluginConvertPixelFormat
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1606
diff
changeset
|
4717 |
|
1613
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4718 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4719 /** |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4720 * @brief Return the number of available fonts. |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4721 * |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4722 * 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
|
4723 * 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
|
4724 * through OrthancPluginDrawText(). |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4725 * |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4726 * @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
|
4727 * @return The number of fonts. |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4728 * @ingroup Images |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4729 **/ |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4730 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetFontsCount( |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4731 OrthancPluginContext* context) |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4732 { |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4733 uint32_t count = 0; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4734 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4735 _OrthancPluginReturnSingleValue params; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4736 memset(¶ms, 0, sizeof(params)); |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4737 params.resultUint32 = &count; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4738 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4739 if (context->InvokeService(context, _OrthancPluginService_GetFontsCount, ¶ms) != OrthancPluginErrorCode_Success) |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4740 { |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4741 /* Error */ |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4742 return 0; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4743 } |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4744 else |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4745 { |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4746 return count; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4747 } |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4748 } |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4749 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4750 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4751 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4752 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4753 typedef struct |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4754 { |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4755 uint32_t fontIndex; /* in */ |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4756 const char** name; /* out */ |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4757 uint32_t* size; /* out */ |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4758 } _OrthancPluginGetFontInfo; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4759 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4760 /** |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4761 * @brief Return the name of a font. |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4762 * |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4763 * 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
|
4764 * |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4765 * @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
|
4766 * @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
|
4767 * @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
|
4768 * @ingroup Images |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4769 **/ |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4770 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetFontName( |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4771 OrthancPluginContext* context, |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4772 uint32_t fontIndex) |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4773 { |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4774 const char* result = NULL; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4775 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4776 _OrthancPluginGetFontInfo params; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4777 memset(¶ms, 0, sizeof(params)); |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4778 params.name = &result; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4779 params.fontIndex = fontIndex; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4780 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4781 if (context->InvokeService(context, _OrthancPluginService_GetFontInfo, ¶ms) != OrthancPluginErrorCode_Success) |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4782 { |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4783 return NULL; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4784 } |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4785 else |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4786 { |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4787 return result; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4788 } |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4789 } |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4790 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4791 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4792 /** |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4793 * @brief Return the size of a font. |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4794 * |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4795 * 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
|
4796 * |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4797 * @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
|
4798 * @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
|
4799 * @return The font size. |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4800 * @ingroup Images |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4801 **/ |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4802 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetFontSize( |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4803 OrthancPluginContext* context, |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4804 uint32_t fontIndex) |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4805 { |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4806 uint32_t result; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4807 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4808 _OrthancPluginGetFontInfo params; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4809 memset(¶ms, 0, sizeof(params)); |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4810 params.size = &result; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4811 params.fontIndex = fontIndex; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4812 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4813 if (context->InvokeService(context, _OrthancPluginService_GetFontInfo, ¶ms) != OrthancPluginErrorCode_Success) |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4814 { |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4815 return 0; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4816 } |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4817 else |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4818 { |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4819 return result; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4820 } |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4821 } |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4822 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4823 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4824 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4825 typedef struct |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4826 { |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4827 OrthancPluginImage* image; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4828 uint32_t fontIndex; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4829 const char* utf8Text; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4830 int32_t x; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4831 int32_t y; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4832 uint8_t r; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4833 uint8_t g; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4834 uint8_t b; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4835 } _OrthancPluginDrawText; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4836 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4837 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4838 /** |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4839 * @brief Draw text on an image. |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4840 * |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4841 * 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
|
4842 * |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4843 * @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
|
4844 * @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
|
4845 * @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
|
4846 * @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
|
4847 * @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
|
4848 * @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
|
4849 * @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
|
4850 * @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
|
4851 * @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
|
4852 * @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
|
4853 * @ingroup Images |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4854 **/ |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4855 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginDrawText( |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4856 OrthancPluginContext* context, |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4857 OrthancPluginImage* image, |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4858 uint32_t fontIndex, |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4859 const char* utf8Text, |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4860 int32_t x, |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4861 int32_t y, |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4862 uint8_t r, |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4863 uint8_t g, |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4864 uint8_t b) |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4865 { |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4866 _OrthancPluginDrawText params; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4867 memset(¶ms, 0, sizeof(params)); |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4868 params.image = image; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4869 params.fontIndex = fontIndex; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4870 params.utf8Text = utf8Text; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4871 params.x = x; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4872 params.y = y; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4873 params.r = r; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4874 params.g = g; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4875 params.b = b; |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4876 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4877 return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms); |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4878 } |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4879 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4880 |
|
1ec254a7c645
drawing texts on image from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1610
diff
changeset
|
4881 |
|
1615
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4882 typedef struct |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4883 { |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4884 OrthancPluginStorageArea* storageArea; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4885 const char* uuid; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4886 const void* content; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4887 uint64_t size; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4888 OrthancPluginContentType type; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4889 } _OrthancPluginStorageAreaCreate; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4890 |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4891 |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4892 /** |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4893 * @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
|
4894 * |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4895 * 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
|
4896 * currently used by Orthanc. |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4897 * |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4898 * @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
|
4899 * @param storageArea The storage area. |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4900 * @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
|
4901 * @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
|
4902 * @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
|
4903 * @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
|
4904 * @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
|
4905 * @ingroup Callbacks |
|
4440
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
4906 * @deprecated This function should not be used anymore. Use "OrthancPluginRestApiPut()" on |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
4907 * "/{patients|studies|series|instances}/{id}/attachments/{name}" instead. |
|
1615
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4908 **/ |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
4909 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStorageAreaCreate( |
|
1615
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4910 OrthancPluginContext* context, |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4911 OrthancPluginStorageArea* storageArea, |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4912 const char* uuid, |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4913 const void* content, |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4914 uint64_t size, |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4915 OrthancPluginContentType type) |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4916 { |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4917 _OrthancPluginStorageAreaCreate params; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4918 params.storageArea = storageArea; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4919 params.uuid = uuid; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4920 params.content = content; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4921 params.size = size; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4922 params.type = type; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4923 |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4924 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms); |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4925 } |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4926 |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4927 |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4928 typedef struct |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4929 { |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4930 OrthancPluginMemoryBuffer* target; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4931 OrthancPluginStorageArea* storageArea; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4932 const char* uuid; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4933 OrthancPluginContentType type; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4934 } _OrthancPluginStorageAreaRead; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4935 |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4936 |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4937 /** |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4938 * @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
|
4939 * |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4940 * 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
|
4941 * 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
|
4942 * |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4943 * @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
|
4944 * @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
|
4945 * @param storageArea The storage area. |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4946 * @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
|
4947 * @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
|
4948 * @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
|
4949 * @ingroup Callbacks |
|
4440
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
4950 * @deprecated This function should not be used anymore. Use "OrthancPluginRestApiGet()" on |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
4951 * "/{patients|studies|series|instances}/{id}/attachments/{name}" instead. |
|
1615
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4952 **/ |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
4953 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStorageAreaRead( |
|
1615
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4954 OrthancPluginContext* context, |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4955 OrthancPluginMemoryBuffer* target, |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4956 OrthancPluginStorageArea* storageArea, |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4957 const char* uuid, |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4958 OrthancPluginContentType type) |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4959 { |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4960 _OrthancPluginStorageAreaRead params; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4961 params.target = target; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4962 params.storageArea = storageArea; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4963 params.uuid = uuid; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4964 params.type = type; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4965 |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4966 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms); |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4967 } |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4968 |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4969 |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4970 typedef struct |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4971 { |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4972 OrthancPluginStorageArea* storageArea; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4973 const char* uuid; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4974 OrthancPluginContentType type; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4975 } _OrthancPluginStorageAreaRemove; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4976 |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4977 /** |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4978 * @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
|
4979 * |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4980 * 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
|
4981 * currently used by Orthanc. |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4982 * |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4983 * @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
|
4984 * @param storageArea The storage area. |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4985 * @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
|
4986 * @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
|
4987 * @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
|
4988 * @ingroup Callbacks |
|
4440
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
4989 * @deprecated This function should not be used anymore. Use "OrthancPluginRestApiDelete()" on |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
4990 * "/{patients|studies|series|instances}/{id}/attachments/{name}" instead. |
|
1615
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4991 **/ |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
4992 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStorageAreaRemove( |
|
1615
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4993 OrthancPluginContext* context, |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4994 OrthancPluginStorageArea* storageArea, |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4995 const char* uuid, |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4996 OrthancPluginContentType type) |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4997 { |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4998 _OrthancPluginStorageAreaRemove params; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
4999 params.storageArea = storageArea; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
5000 params.uuid = uuid; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
5001 params.type = type; |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
5002 |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
5003 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms); |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
5004 } |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
5005 |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
5006 |
|
c40fe92a68e7
Primitives to upgrade the database version in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1613
diff
changeset
|
5007 |
|
1649
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5008 typedef struct |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5009 { |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5010 OrthancPluginErrorCode* target; |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5011 int32_t code; |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5012 uint16_t httpStatus; |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5013 const char* message; |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5014 } _OrthancPluginRegisterErrorCode; |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5015 |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5016 /** |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5017 * @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
|
5018 * |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5019 * 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
|
5020 * 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
|
5021 * 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
|
5022 * HTTP status code. |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5023 * |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5024 * @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
|
5025 * @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
|
5026 * @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
|
5027 * @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
|
5028 * @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
|
5029 * @ingroup Toolbox |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5030 **/ |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5031 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterErrorCode( |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5032 OrthancPluginContext* context, |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5033 int32_t code, |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5034 uint16_t httpStatus, |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5035 const char* message) |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5036 { |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5037 OrthancPluginErrorCode target; |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5038 |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5039 _OrthancPluginRegisterErrorCode params; |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5040 params.target = ⌖ |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5041 params.code = code; |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5042 params.httpStatus = httpStatus; |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5043 params.message = message; |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5044 |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5045 if (context->InvokeService(context, _OrthancPluginService_RegisterErrorCode, ¶ms) == OrthancPluginErrorCode_Success) |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5046 { |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5047 return target; |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5048 } |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5049 else |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5050 { |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5051 /* 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
|
5052 return OrthancPluginErrorCode_Plugin; |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5053 } |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5054 } |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5055 |
|
8040d56cb0b3
New function "OrthancPluginRegisterErrorCode()" to declare custom error codes
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1643
diff
changeset
|
5056 |
|
1657
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5057 |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5058 typedef struct |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5059 { |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5060 uint16_t group; |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5061 uint16_t element; |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5062 OrthancPluginValueRepresentation vr; |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5063 const char* name; |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5064 uint32_t minMultiplicity; |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5065 uint32_t maxMultiplicity; |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5066 } _OrthancPluginRegisterDictionaryTag; |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5067 |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5068 /** |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5069 * @brief Register a new tag into the DICOM dictionary. |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5070 * |
|
2115
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5071 * This function declares a new public tag in the dictionary of |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5072 * DICOM tags that are known to Orthanc. This function should be |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5073 * used in the OrthancPluginInitialize() callback. |
|
1657
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5074 * |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5075 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5076 * @param group The group of the tag. |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5077 * @param element The element of the tag. |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5078 * @param vr The value representation of the tag. |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5079 * @param name The nickname of the tag. |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5080 * @param minMultiplicity The minimum multiplicity of the tag (must be above 0). |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5081 * @param maxMultiplicity The maximum multiplicity of the tag. A value of 0 means |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5082 * an arbitrary multiplicity ("<tt>n</tt>"). |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5083 * @return 0 if success, other value if error. |
|
2115
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5084 * @see OrthancPluginRegisterPrivateDictionaryTag() |
|
1657
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5085 * @ingroup Toolbox |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5086 **/ |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5087 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterDictionaryTag( |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5088 OrthancPluginContext* context, |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5089 uint16_t group, |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5090 uint16_t element, |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5091 OrthancPluginValueRepresentation vr, |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5092 const char* name, |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5093 uint32_t minMultiplicity, |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5094 uint32_t maxMultiplicity) |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5095 { |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5096 _OrthancPluginRegisterDictionaryTag params; |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5097 params.group = group; |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5098 params.element = element; |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5099 params.vr = vr; |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5100 params.name = name; |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5101 params.minMultiplicity = minMultiplicity; |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5102 params.maxMultiplicity = maxMultiplicity; |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5103 |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5104 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, ¶ms); |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5105 } |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5106 |
|
5360cdba70d8
New function "OrthancPluginRegisterDictionaryTag()" to declare DICOM tags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1649
diff
changeset
|
5107 |
|
1669
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
5108 |
|
2115
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5109 typedef struct |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5110 { |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5111 uint16_t group; |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5112 uint16_t element; |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5113 OrthancPluginValueRepresentation vr; |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5114 const char* name; |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5115 uint32_t minMultiplicity; |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5116 uint32_t maxMultiplicity; |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5117 const char* privateCreator; |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5118 } _OrthancPluginRegisterPrivateDictionaryTag; |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5119 |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5120 /** |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5121 * @brief Register a new private tag into the DICOM dictionary. |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5122 * |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5123 * This function declares a new private tag in the dictionary of |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5124 * DICOM tags that are known to Orthanc. This function should be |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5125 * used in the OrthancPluginInitialize() callback. |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5126 * |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5127 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5128 * @param group The group of the tag. |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5129 * @param element The element of the tag. |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5130 * @param vr The value representation of the tag. |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5131 * @param name The nickname of the tag. |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5132 * @param minMultiplicity The minimum multiplicity of the tag (must be above 0). |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5133 * @param maxMultiplicity The maximum multiplicity of the tag. A value of 0 means |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5134 * an arbitrary multiplicity ("<tt>n</tt>"). |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5135 * @param privateCreator The private creator of this private tag. |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5136 * @return 0 if success, other value if error. |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5137 * @see OrthancPluginRegisterDictionaryTag() |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5138 * @ingroup Toolbox |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5139 **/ |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5140 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterPrivateDictionaryTag( |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5141 OrthancPluginContext* context, |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5142 uint16_t group, |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5143 uint16_t element, |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5144 OrthancPluginValueRepresentation vr, |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5145 const char* name, |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5146 uint32_t minMultiplicity, |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5147 uint32_t maxMultiplicity, |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5148 const char* privateCreator) |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5149 { |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5150 _OrthancPluginRegisterPrivateDictionaryTag params; |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5151 params.group = group; |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5152 params.element = element; |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5153 params.vr = vr; |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5154 params.name = name; |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5155 params.minMultiplicity = minMultiplicity; |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5156 params.maxMultiplicity = maxMultiplicity; |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5157 params.privateCreator = privateCreator; |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5158 |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5159 return context->InvokeService(context, _OrthancPluginService_RegisterPrivateDictionaryTag, ¶ms); |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5160 } |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5161 |
|
a657f7772e69
Handling of private tags/creators in the "Dictionary" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2051
diff
changeset
|
5162 |
|
1669
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
5163 |
|
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
5164 typedef struct |
|
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
5165 { |
|
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
5166 OrthancPluginStorageArea* storageArea; |
|
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
5167 OrthancPluginResourceType level; |
|
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
5168 } _OrthancPluginReconstructMainDicomTags; |
|
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
5169 |
|
1673
0bbcfd9695e5
UpgradeDatabase in the sample plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1669
diff
changeset
|
5170 /** |
|
0bbcfd9695e5
UpgradeDatabase in the sample plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1669
diff
changeset
|
5171 * @brief Reconstruct the main DICOM tags. |
|
0bbcfd9695e5
UpgradeDatabase in the sample plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1669
diff
changeset
|
5172 * |
|
0bbcfd9695e5
UpgradeDatabase in the sample plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1669
diff
changeset
|
5173 * This function requests the Orthanc core to reconstruct the main |
|
0bbcfd9695e5
UpgradeDatabase in the sample plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1669
diff
changeset
|
5174 * DICOM tags of all the resources of the given type. This function |
|
0bbcfd9695e5
UpgradeDatabase in the sample plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1669
diff
changeset
|
5175 * can only be used as a part of the upgrade of a custom database |
| 2698 | 5176 * back-end. A database transaction will be automatically setup. |
|
1673
0bbcfd9695e5
UpgradeDatabase in the sample plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1669
diff
changeset
|
5177 * |
|
0bbcfd9695e5
UpgradeDatabase in the sample plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1669
diff
changeset
|
5178 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
0bbcfd9695e5
UpgradeDatabase in the sample plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1669
diff
changeset
|
5179 * @param storageArea The storage area. |
|
0bbcfd9695e5
UpgradeDatabase in the sample plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1669
diff
changeset
|
5180 * @param level The type of the resources of interest. |
|
0bbcfd9695e5
UpgradeDatabase in the sample plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1669
diff
changeset
|
5181 * @return 0 if success, other value if error. |
|
0bbcfd9695e5
UpgradeDatabase in the sample plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1669
diff
changeset
|
5182 * @ingroup Callbacks |
|
0bbcfd9695e5
UpgradeDatabase in the sample plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1669
diff
changeset
|
5183 **/ |
|
1669
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
5184 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags( |
|
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
5185 OrthancPluginContext* context, |
|
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
5186 OrthancPluginStorageArea* storageArea, |
|
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
5187 OrthancPluginResourceType level) |
|
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
5188 { |
|
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
5189 _OrthancPluginReconstructMainDicomTags params; |
|
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
5190 params.level = level; |
|
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
5191 params.storageArea = storageArea; |
|
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
5192 |
|
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
5193 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, ¶ms); |
|
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
5194 } |
|
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
5195 |
|
a412ad57f0f9
refactoring of sample plugins, OrthancPluginReconstructMainDicomTags
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1657
diff
changeset
|
5196 |
|
1740
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5197 typedef struct |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5198 { |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5199 char** result; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5200 const char* instanceId; |
| 1910 | 5201 const void* buffer; |
|
1740
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5202 uint32_t size; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5203 OrthancPluginDicomToJsonFormat format; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5204 OrthancPluginDicomToJsonFlags flags; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5205 uint32_t maxStringLength; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5206 } _OrthancPluginDicomToJson; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5207 |
| 1743 | 5208 |
| 5209 /** | |
| 5210 * @brief Format a DICOM memory buffer as a JSON string. | |
| 5211 * | |
| 5212 * This function takes as input a memory buffer containing a DICOM | |
| 5213 * file, and outputs a JSON string representing the tags of this | |
| 5214 * DICOM file. | |
| 5215 * | |
| 5216 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 5217 * @param buffer The memory buffer containing the DICOM file. | |
| 5218 * @param size The size of the memory buffer. | |
| 5219 * @param format The output format. | |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5220 * @param flags Flags governing the output. |
| 1743 | 5221 * @param maxStringLength The maximum length of a field. Too long fields will |
| 5222 * be output as "null". The 0 value means no maximum length. | |
| 5223 * @return The NULL value if the case of an error, or the JSON | |
| 5224 * string. This string must be freed by OrthancPluginFreeString(). | |
| 5225 * @ingroup Toolbox | |
|
5327
f01c06f75d67
sanitizing @see in OrthancCPlugin.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5326
diff
changeset
|
5226 * @see OrthancPluginDicomInstanceToJson() |
| 1743 | 5227 **/ |
|
1740
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5228 ORTHANC_PLUGIN_INLINE char* OrthancPluginDicomBufferToJson( |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5229 OrthancPluginContext* context, |
| 1910 | 5230 const void* buffer, |
|
1740
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5231 uint32_t size, |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5232 OrthancPluginDicomToJsonFormat format, |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5233 OrthancPluginDicomToJsonFlags flags, |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5234 uint32_t maxStringLength) |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5235 { |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5236 char* result; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5237 |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5238 _OrthancPluginDicomToJson params; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5239 memset(¶ms, 0, sizeof(params)); |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5240 params.result = &result; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5241 params.buffer = buffer; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5242 params.size = size; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5243 params.format = format; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5244 params.flags = flags; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5245 params.maxStringLength = maxStringLength; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5246 |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5247 if (context->InvokeService(context, _OrthancPluginService_DicomBufferToJson, ¶ms) != OrthancPluginErrorCode_Success) |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5248 { |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5249 /* Error */ |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5250 return NULL; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5251 } |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5252 else |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5253 { |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5254 return result; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5255 } |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5256 } |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5257 |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5258 |
| 1743 | 5259 /** |
| 5260 * @brief Format a DICOM instance as a JSON string. | |
| 5261 * | |
| 5262 * This function formats a DICOM instance that is stored in Orthanc, | |
| 5263 * and outputs a JSON string representing the tags of this DICOM | |
| 5264 * instance. | |
| 5265 * | |
| 5266 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 5267 * @param instanceId The Orthanc identifier of the instance. | |
| 5268 * @param format The output format. | |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5269 * @param flags Flags governing the output. |
| 1743 | 5270 * @param maxStringLength The maximum length of a field. Too long fields will |
| 5271 * be output as "null". The 0 value means no maximum length. | |
| 5272 * @return The NULL value if the case of an error, or the JSON | |
| 5273 * string. This string must be freed by OrthancPluginFreeString(). | |
| 5274 * @ingroup Toolbox | |
|
5327
f01c06f75d67
sanitizing @see in OrthancCPlugin.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5326
diff
changeset
|
5275 * @see OrthancPluginDicomInstanceToJson() |
| 1743 | 5276 **/ |
|
1740
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5277 ORTHANC_PLUGIN_INLINE char* OrthancPluginDicomInstanceToJson( |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5278 OrthancPluginContext* context, |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5279 const char* instanceId, |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5280 OrthancPluginDicomToJsonFormat format, |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5281 OrthancPluginDicomToJsonFlags flags, |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5282 uint32_t maxStringLength) |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5283 { |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5284 char* result; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5285 |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5286 _OrthancPluginDicomToJson params; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5287 memset(¶ms, 0, sizeof(params)); |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5288 params.result = &result; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5289 params.instanceId = instanceId; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5290 params.format = format; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5291 params.flags = flags; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5292 params.maxStringLength = maxStringLength; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5293 |
|
1741
06addfcd1d4c
OrthancStarted and OrthancStopped events in plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1740
diff
changeset
|
5294 if (context->InvokeService(context, _OrthancPluginService_DicomInstanceToJson, ¶ms) != OrthancPluginErrorCode_Success) |
|
1740
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5295 { |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5296 /* Error */ |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5297 return NULL; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5298 } |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5299 else |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5300 { |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5301 return result; |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5302 } |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5303 } |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5304 |
|
5e99a70b0635
DicomToJson callable from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1703
diff
changeset
|
5305 |
|
1780
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5306 typedef struct |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5307 { |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5308 OrthancPluginMemoryBuffer* target; |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5309 const char* uri; |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5310 uint32_t headersCount; |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5311 const char* const* headersKeys; |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5312 const char* const* headersValues; |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5313 int32_t afterPlugins; |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5314 } _OrthancPluginRestApiGet2; |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5315 |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5316 /** |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5317 * @brief Make a GET call to the Orthanc REST API, with custom HTTP headers. |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5318 * |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5319 * Make a GET call to the Orthanc REST API with extended |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5320 * parameters. The result to the query is stored into a newly |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5321 * allocated memory buffer. |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5322 * |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5323 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5324 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). |
|
1780
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5325 * @param uri The URI in the built-in Orthanc API. |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5326 * @param headersCount The number of HTTP headers. |
|
1987
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
5327 * @param headersKeys Array containing the keys of the HTTP headers (can be <tt>NULL</tt> if no header). |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
5328 * @param headersValues Array containing the values of the HTTP headers (can be <tt>NULL</tt> if no header). |
|
1780
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5329 * @param afterPlugins If 0, the built-in API of Orthanc is used. |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5330 * If 1, the API is tainted by the plugins. |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5331 * @return 0 if success, or the error code if failure. |
|
5327
f01c06f75d67
sanitizing @see in OrthancCPlugin.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5326
diff
changeset
|
5332 * @see OrthancPluginRestApiGet(), OrthancPluginRestApiGetAfterPlugins() |
|
1780
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5333 * @ingroup Orthanc |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5334 **/ |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5335 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRestApiGet2( |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5336 OrthancPluginContext* context, |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5337 OrthancPluginMemoryBuffer* target, |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5338 const char* uri, |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5339 uint32_t headersCount, |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5340 const char* const* headersKeys, |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5341 const char* const* headersValues, |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5342 int32_t afterPlugins) |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5343 { |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5344 _OrthancPluginRestApiGet2 params; |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5345 params.target = target; |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5346 params.uri = uri; |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5347 params.headersCount = headersCount; |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5348 params.headersKeys = headersKeys; |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5349 params.headersValues = headersValues; |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5350 params.afterPlugins = afterPlugins; |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5351 |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5352 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, ¶ms); |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5353 } |
|
94990da8710e
OrthancPluginRestApiGet2
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1773
diff
changeset
|
5354 |
|
1800
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5355 |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5356 |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5357 typedef struct |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5358 { |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5359 OrthancPluginWorklistCallback callback; |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5360 } _OrthancPluginWorklistCallback; |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5361 |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5362 /** |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5363 * @brief Register a callback to handle modality worklists requests. |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5364 * |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5365 * This function registers a callback to handle C-Find SCP requests |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5366 * on modality worklists. |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5367 * |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5368 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5369 * @param callback The callback. |
|
1833
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5370 * @return 0 if success, other value if error. |
|
1995
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
5371 * @ingroup DicomCallbacks |
|
1800
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5372 **/ |
|
1833
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5373 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterWorklistCallback( |
|
1800
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5374 OrthancPluginContext* context, |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5375 OrthancPluginWorklistCallback callback) |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5376 { |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5377 _OrthancPluginWorklistCallback params; |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5378 params.callback = callback; |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5379 |
|
1833
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5380 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, ¶ms); |
|
1800
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5381 } |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5382 |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5383 |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5384 |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5385 typedef struct |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5386 { |
|
1802
138664eb59de
sample worklist plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1801
diff
changeset
|
5387 OrthancPluginWorklistAnswers* answers; |
|
138664eb59de
sample worklist plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1801
diff
changeset
|
5388 const OrthancPluginWorklistQuery* query; |
|
138664eb59de
sample worklist plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1801
diff
changeset
|
5389 const void* dicom; |
|
138664eb59de
sample worklist plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1801
diff
changeset
|
5390 uint32_t size; |
|
1801
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5391 } _OrthancPluginWorklistAnswersOperation; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5392 |
| 1803 | 5393 /** |
| 5394 * @brief Add one answer to some modality worklist request. | |
| 5395 * | |
| 5396 * This function adds one worklist (encoded as a DICOM file) to the | |
| 5397 * set of answers corresponding to some C-Find SCP request against | |
| 5398 * modality worklists. | |
| 5399 * | |
| 5400 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 5401 * @param answers The set of answers. | |
| 5402 * @param query The worklist query, as received by the callback. | |
| 5403 * @param dicom The worklist to answer, encoded as a DICOM file. | |
| 5404 * @param size The size of the DICOM file. | |
| 5405 * @return 0 if success, other value if error. | |
|
1995
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
5406 * @ingroup DicomCallbacks |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
5407 * @see OrthancPluginCreateDicom() |
| 1803 | 5408 **/ |
|
1810
796d0b087fb8
more consistent naming in worklist primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1803
diff
changeset
|
5409 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginWorklistAddAnswer( |
|
1802
138664eb59de
sample worklist plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1801
diff
changeset
|
5410 OrthancPluginContext* context, |
|
138664eb59de
sample worklist plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1801
diff
changeset
|
5411 OrthancPluginWorklistAnswers* answers, |
|
138664eb59de
sample worklist plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1801
diff
changeset
|
5412 const OrthancPluginWorklistQuery* query, |
|
138664eb59de
sample worklist plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1801
diff
changeset
|
5413 const void* dicom, |
|
138664eb59de
sample worklist plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1801
diff
changeset
|
5414 uint32_t size) |
|
1800
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5415 { |
|
1801
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5416 _OrthancPluginWorklistAnswersOperation params; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5417 params.answers = answers; |
|
1802
138664eb59de
sample worklist plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1801
diff
changeset
|
5418 params.query = query; |
|
1801
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5419 params.dicom = dicom; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5420 params.size = size; |
|
1800
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5421 |
|
1810
796d0b087fb8
more consistent naming in worklist primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1803
diff
changeset
|
5422 return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, ¶ms); |
|
1800
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5423 } |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5424 |
|
30e97a1f4093
callback for handling worklists with plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1799
diff
changeset
|
5425 |
| 1803 | 5426 /** |
| 5427 * @brief Mark the set of worklist answers as incomplete. | |
| 5428 * | |
| 5429 * This function marks as incomplete the set of answers | |
| 5430 * corresponding to some C-Find SCP request against modality | |
| 5431 * worklists. This must be used if canceling the handling of a | |
| 5432 * request when too many answers are to be returned. | |
| 5433 * | |
| 5434 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 5435 * @param answers The set of answers. | |
| 5436 * @return 0 if success, other value if error. | |
|
1995
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
5437 * @ingroup DicomCallbacks |
| 1803 | 5438 **/ |
|
1810
796d0b087fb8
more consistent naming in worklist primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1803
diff
changeset
|
5439 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginWorklistMarkIncomplete( |
|
1801
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5440 OrthancPluginContext* context, |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5441 OrthancPluginWorklistAnswers* answers) |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5442 { |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5443 _OrthancPluginWorklistAnswersOperation params; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5444 params.answers = answers; |
|
1802
138664eb59de
sample worklist plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1801
diff
changeset
|
5445 params.query = NULL; |
|
1801
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5446 params.dicom = NULL; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5447 params.size = 0; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5448 |
|
1810
796d0b087fb8
more consistent naming in worklist primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1803
diff
changeset
|
5449 return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, ¶ms); |
|
1801
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5450 } |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5451 |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5452 |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5453 typedef struct |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5454 { |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5455 const OrthancPluginWorklistQuery* query; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5456 const void* dicom; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5457 uint32_t size; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5458 int32_t* isMatch; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5459 OrthancPluginMemoryBuffer* target; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5460 } _OrthancPluginWorklistQueryOperation; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5461 |
| 1803 | 5462 /** |
| 5463 * @brief Test whether a worklist matches the query. | |
| 5464 * | |
| 5465 * This function checks whether one worklist (encoded as a DICOM | |
| 5466 * file) matches the C-Find SCP query against modality | |
| 5467 * worklists. This function must be called before adding the | |
|
1810
796d0b087fb8
more consistent naming in worklist primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1803
diff
changeset
|
5468 * worklist as an answer through OrthancPluginWorklistAddAnswer(). |
| 1803 | 5469 * |
| 5470 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 5471 * @param query The worklist query, as received by the callback. | |
| 5472 * @param dicom The worklist to answer, encoded as a DICOM file. | |
| 5473 * @param size The size of the DICOM file. | |
| 5474 * @return 1 if the worklist matches the query, 0 otherwise. | |
|
1995
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
5475 * @ingroup DicomCallbacks |
| 1803 | 5476 **/ |
|
1810
796d0b087fb8
more consistent naming in worklist primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1803
diff
changeset
|
5477 ORTHANC_PLUGIN_INLINE int32_t OrthancPluginWorklistIsMatch( |
|
1801
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5478 OrthancPluginContext* context, |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5479 const OrthancPluginWorklistQuery* query, |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5480 const void* dicom, |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5481 uint32_t size) |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5482 { |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5483 int32_t isMatch = 0; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5484 |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5485 _OrthancPluginWorklistQueryOperation params; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5486 params.query = query; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5487 params.dicom = dicom; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5488 params.size = size; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5489 params.isMatch = &isMatch; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5490 params.target = NULL; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5491 |
|
1810
796d0b087fb8
more consistent naming in worklist primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1803
diff
changeset
|
5492 if (context->InvokeService(context, _OrthancPluginService_WorklistIsMatch, ¶ms) == OrthancPluginErrorCode_Success) |
|
1801
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5493 { |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5494 return isMatch; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5495 } |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5496 else |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5497 { |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5498 /* Error: Assume non-match */ |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5499 return 0; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5500 } |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5501 } |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5502 |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5503 |
| 1803 | 5504 /** |
| 5505 * @brief Retrieve the worklist query as a DICOM file. | |
| 5506 * | |
| 5507 * This function retrieves the DICOM file that underlies a C-Find | |
| 5508 * SCP query against modality worklists. | |
| 5509 * | |
| 5510 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 5511 * @param target Memory buffer where to store the DICOM file. It must be freed with OrthancPluginFreeMemoryBuffer(). | |
| 5512 * @param query The worklist query, as received by the callback. | |
| 5513 * @return 0 if success, other value if error. | |
|
1995
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
5514 * @ingroup DicomCallbacks |
| 1803 | 5515 **/ |
|
1810
796d0b087fb8
more consistent naming in worklist primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1803
diff
changeset
|
5516 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginWorklistGetDicomQuery( |
|
1801
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5517 OrthancPluginContext* context, |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5518 OrthancPluginMemoryBuffer* target, |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5519 const OrthancPluginWorklistQuery* query) |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5520 { |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5521 _OrthancPluginWorklistQueryOperation params; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5522 params.query = query; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5523 params.dicom = NULL; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5524 params.size = 0; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5525 params.isMatch = NULL; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5526 params.target = target; |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5527 |
|
1810
796d0b087fb8
more consistent naming in worklist primitives
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1803
diff
changeset
|
5528 return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, ¶ms); |
|
1801
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5529 } |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5530 |
|
2c60c357ee3e
sdk primitives to handle worklists
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1800
diff
changeset
|
5531 |
|
1815
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5532 /** |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5533 * @brief Get the origin of a DICOM file. |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5534 * |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5535 * This function returns the origin of a DICOM instance that has been received by Orthanc. |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5536 * |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5537 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5538 * @param instance The instance of interest. |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5539 * @return The origin of the instance. |
| 3936 | 5540 * @ingroup DicomInstance |
|
1815
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5541 **/ |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5542 ORTHANC_PLUGIN_INLINE OrthancPluginInstanceOrigin OrthancPluginGetInstanceOrigin( |
|
3847
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
5543 OrthancPluginContext* context, |
|
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
5544 const OrthancPluginDicomInstance* instance) |
|
1815
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5545 { |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5546 OrthancPluginInstanceOrigin origin; |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5547 |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5548 _OrthancPluginAccessDicomInstance params; |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5549 memset(¶ms, 0, sizeof(params)); |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5550 params.resultOrigin = &origin; |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5551 params.instance = instance; |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5552 |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5553 if (context->InvokeService(context, _OrthancPluginService_GetInstanceOrigin, ¶ms) != OrthancPluginErrorCode_Success) |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5554 { |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5555 /* Error */ |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5556 return OrthancPluginInstanceOrigin_Unknown; |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5557 } |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5558 else |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5559 { |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5560 return origin; |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5561 } |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5562 } |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5563 |
|
2abfdca9b915
OrthancPluginGetInstanceOrigin
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1810
diff
changeset
|
5564 |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5565 typedef struct |
|
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5566 { |
|
1827
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5567 OrthancPluginMemoryBuffer* target; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5568 const char* json; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5569 const OrthancPluginImage* pixelData; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5570 OrthancPluginCreateDicomFlags flags; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5571 } _OrthancPluginCreateDicom; |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5572 |
|
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5573 /** |
|
1827
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5574 * @brief Create a DICOM instance from a JSON string and an image. |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5575 * |
|
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5576 * This function takes as input a string containing a JSON file |
|
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5577 * describing the content of a DICOM instance. As an output, it |
|
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5578 * writes the corresponding DICOM instance to a newly allocated |
|
1827
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5579 * memory buffer. Additionally, an image to be encoded within the |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5580 * DICOM instance can also be provided. |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5581 * |
|
4477
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
5582 * Private tags will be associated with the private creator whose |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
5583 * value is specified in the "DefaultPrivateCreator" configuration |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
5584 * option of Orthanc. The function OrthancPluginCreateDicom2() can |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
5585 * be used if another private creator must be used to create this |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
5586 * instance. |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
5587 * |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5588 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5589 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). |
|
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5590 * @param json The input JSON file. |
|
1827
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5591 * @param pixelData The image. Can be NULL, if the pixel data is encoded inside the JSON with the data URI scheme. |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5592 * @param flags Flags governing the output. |
|
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5593 * @return 0 if success, other value if error. |
|
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5594 * @ingroup Toolbox |
|
5327
f01c06f75d67
sanitizing @see in OrthancCPlugin.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5326
diff
changeset
|
5595 * @see OrthancPluginCreateDicom2() |
|
f01c06f75d67
sanitizing @see in OrthancCPlugin.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5326
diff
changeset
|
5596 * @see OrthancPluginDicomBufferToJson() |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5597 **/ |
|
1827
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5598 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCreateDicom( |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5599 OrthancPluginContext* context, |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5600 OrthancPluginMemoryBuffer* target, |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5601 const char* json, |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5602 const OrthancPluginImage* pixelData, |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5603 OrthancPluginCreateDicomFlags flags) |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5604 { |
|
1827
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5605 _OrthancPluginCreateDicom params; |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5606 params.target = target; |
|
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5607 params.json = json; |
|
1827
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5608 params.pixelData = pixelData; |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5609 params.flags = flags; |
|
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5610 |
|
1827
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5611 return context->InvokeService(context, _OrthancPluginService_CreateDicom, ¶ms); |
|
1821
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5612 } |
|
580951a33583
OrthancPluginDicomFromJson
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1816
diff
changeset
|
5613 |
|
1826
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5614 |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5615 typedef struct |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5616 { |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5617 OrthancPluginDecodeImageCallback callback; |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5618 } _OrthancPluginDecodeImageCallback; |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5619 |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5620 /** |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5621 * @brief Register a callback to handle the decoding of DICOM images. |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5622 * |
|
3937
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
5623 * This function registers a custom callback to decode DICOM images, |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
5624 * extending the built-in decoder of Orthanc that uses |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
5625 * DCMTK. Starting with Orthanc 1.7.0, the exact behavior is |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
5626 * affected by the configuration option |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
5627 * "BuiltinDecoderTranscoderOrder" of Orthanc. |
|
1826
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5628 * |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5629 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5630 * @param callback The callback. |
|
1833
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5631 * @return 0 if success, other value if error. |
|
1826
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5632 * @ingroup Callbacks |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5633 **/ |
|
1833
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5634 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterDecodeImageCallback( |
|
1826
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5635 OrthancPluginContext* context, |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5636 OrthancPluginDecodeImageCallback callback) |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5637 { |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5638 _OrthancPluginDecodeImageCallback params; |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5639 params.callback = callback; |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5640 |
|
1833
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5641 return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, ¶ms); |
|
1826
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5642 } |
|
ac5b0b4e2434
refactoring of DicomImageDecoder
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1821
diff
changeset
|
5643 |
|
1827
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5644 |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5645 |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5646 typedef struct |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5647 { |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5648 OrthancPluginImage** target; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5649 OrthancPluginPixelFormat format; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5650 uint32_t width; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5651 uint32_t height; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5652 uint32_t pitch; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5653 void* buffer; |
|
1829
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5654 const void* constBuffer; |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5655 uint32_t bufferSize; |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5656 uint32_t frameIndex; |
|
1827
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5657 } _OrthancPluginCreateImage; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5658 |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5659 |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5660 /** |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5661 * @brief Create an image. |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5662 * |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5663 * This function creates an image of given size and format. |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5664 * |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5665 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5666 * @param format The format of the pixels. |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5667 * @param width The width of the image. |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5668 * @param height The height of the image. |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5669 * @return The newly allocated image. It must be freed with OrthancPluginFreeImage(). |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5670 * @ingroup Images |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5671 **/ |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5672 ORTHANC_PLUGIN_INLINE OrthancPluginImage* OrthancPluginCreateImage( |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5673 OrthancPluginContext* context, |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5674 OrthancPluginPixelFormat format, |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5675 uint32_t width, |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5676 uint32_t height) |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5677 { |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5678 OrthancPluginImage* target = NULL; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5679 |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5680 _OrthancPluginCreateImage params; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5681 memset(¶ms, 0, sizeof(params)); |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5682 params.target = ⌖ |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5683 params.format = format; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5684 params.width = width; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5685 params.height = height; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5686 |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5687 if (context->InvokeService(context, _OrthancPluginService_CreateImage, ¶ms) != OrthancPluginErrorCode_Success) |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5688 { |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5689 return NULL; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5690 } |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5691 else |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5692 { |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5693 return target; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5694 } |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5695 } |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5696 |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5697 |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5698 /** |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5699 * @brief Create an image pointing to a memory buffer. |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5700 * |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5701 * This function creates an image whose content points to a memory |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5702 * buffer managed by the plugin. Note that the buffer is directly |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5703 * accessed, no memory is allocated and no data is copied. |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5704 * |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5705 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5706 * @param format The format of the pixels. |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5707 * @param width The width of the image. |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5708 * @param height The height of the image. |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5709 * @param pitch The pitch of the image (i.e. the number of bytes |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5710 * between 2 successive lines of the image in the memory buffer). |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5711 * @param buffer The memory buffer. |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5712 * @return The newly allocated image. It must be freed with OrthancPluginFreeImage(). |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5713 * @ingroup Images |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5714 **/ |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5715 ORTHANC_PLUGIN_INLINE OrthancPluginImage* OrthancPluginCreateImageAccessor( |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5716 OrthancPluginContext* context, |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5717 OrthancPluginPixelFormat format, |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5718 uint32_t width, |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5719 uint32_t height, |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5720 uint32_t pitch, |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5721 void* buffer) |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5722 { |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5723 OrthancPluginImage* target = NULL; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5724 |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5725 _OrthancPluginCreateImage params; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5726 memset(¶ms, 0, sizeof(params)); |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5727 params.target = ⌖ |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5728 params.format = format; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5729 params.width = width; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5730 params.height = height; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5731 params.pitch = pitch; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5732 params.buffer = buffer; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5733 |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5734 if (context->InvokeService(context, _OrthancPluginService_CreateImageAccessor, ¶ms) != OrthancPluginErrorCode_Success) |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5735 { |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5736 return NULL; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5737 } |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5738 else |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5739 { |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5740 return target; |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5741 } |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5742 } |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5743 |
|
4b6673e828f4
"OrthancPluginCreateImage()" and "OrthancPluginCreateImageAccessor()" to create images
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1826
diff
changeset
|
5744 |
|
1829
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5745 |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5746 /** |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5747 * @brief Decode one frame from a DICOM instance. |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5748 * |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5749 * This function decodes one frame of a DICOM image that is stored |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5750 * in a memory buffer. This function will give the same result as |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5751 * OrthancPluginUncompressImage() for single-frame DICOM images. |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5752 * |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5753 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5754 * @param buffer Pointer to a memory buffer containing the DICOM image. |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5755 * @param bufferSize Size of the memory buffer containing the DICOM image. |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5756 * @param frameIndex The index of the frame of interest in a multi-frame image. |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5757 * @return The uncompressed image. It must be freed with OrthancPluginFreeImage(). |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5758 * @ingroup Images |
|
3937
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
5759 * @see OrthancPluginGetInstanceDecodedFrame() |
|
1829
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5760 **/ |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5761 ORTHANC_PLUGIN_INLINE OrthancPluginImage* OrthancPluginDecodeDicomImage( |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5762 OrthancPluginContext* context, |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5763 const void* buffer, |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5764 uint32_t bufferSize, |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5765 uint32_t frameIndex) |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5766 { |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5767 OrthancPluginImage* target = NULL; |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5768 |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5769 _OrthancPluginCreateImage params; |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5770 memset(¶ms, 0, sizeof(params)); |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5771 params.target = ⌖ |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5772 params.constBuffer = buffer; |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5773 params.bufferSize = bufferSize; |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5774 params.frameIndex = frameIndex; |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5775 |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5776 if (context->InvokeService(context, _OrthancPluginService_DecodeDicomImage, ¶ms) != OrthancPluginErrorCode_Success) |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5777 { |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5778 return NULL; |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5779 } |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5780 else |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5781 { |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5782 return target; |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5783 } |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5784 } |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5785 |
|
31df3b48925e
OrthancPluginDecodeDicomImage
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1828
diff
changeset
|
5786 |
|
1833
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5787 |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5788 typedef struct |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5789 { |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5790 char** result; |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5791 const void* buffer; |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5792 uint32_t size; |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5793 } _OrthancPluginComputeHash; |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5794 |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5795 /** |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5796 * @brief Compute an MD5 hash. |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5797 * |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5798 * This functions computes the MD5 cryptographic hash of the given memory buffer. |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5799 * |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5800 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5801 * @param buffer The source memory buffer. |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5802 * @param size The size in bytes of the source buffer. |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5803 * @return The NULL value in case of error, or a string containing the cryptographic hash. |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5804 * This string must be freed by OrthancPluginFreeString(). |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5805 * @ingroup Toolbox |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5806 **/ |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5807 ORTHANC_PLUGIN_INLINE char* OrthancPluginComputeMd5( |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5808 OrthancPluginContext* context, |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5809 const void* buffer, |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5810 uint32_t size) |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5811 { |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5812 char* result; |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5813 |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5814 _OrthancPluginComputeHash params; |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5815 params.result = &result; |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5816 params.buffer = buffer; |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5817 params.size = size; |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5818 |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5819 if (context->InvokeService(context, _OrthancPluginService_ComputeMd5, ¶ms) != OrthancPluginErrorCode_Success) |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5820 { |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5821 /* Error */ |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5822 return NULL; |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5823 } |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5824 else |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5825 { |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5826 return result; |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5827 } |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5828 } |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5829 |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5830 |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5831 /** |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5832 * @brief Compute a SHA-1 hash. |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5833 * |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5834 * This functions computes the SHA-1 cryptographic hash of the given memory buffer. |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5835 * |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5836 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5837 * @param buffer The source memory buffer. |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5838 * @param size The size in bytes of the source buffer. |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5839 * @return The NULL value in case of error, or a string containing the cryptographic hash. |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5840 * This string must be freed by OrthancPluginFreeString(). |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5841 * @ingroup Toolbox |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5842 **/ |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5843 ORTHANC_PLUGIN_INLINE char* OrthancPluginComputeSha1( |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5844 OrthancPluginContext* context, |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5845 const void* buffer, |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5846 uint32_t size) |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5847 { |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5848 char* result; |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5849 |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5850 _OrthancPluginComputeHash params; |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5851 params.result = &result; |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5852 params.buffer = buffer; |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5853 params.size = size; |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5854 |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5855 if (context->InvokeService(context, _OrthancPluginService_ComputeSha1, ¶ms) != OrthancPluginErrorCode_Success) |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5856 { |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5857 /* Error */ |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5858 return NULL; |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5859 } |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5860 else |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5861 { |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5862 return result; |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5863 } |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5864 } |
|
47d032c48818
"OrthancPluginComputeMd5()" and "OrthancPluginComputeSha1()" to compute MD5/SHA-1 hash
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1829
diff
changeset
|
5865 |
|
1861
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5866 |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5867 |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5868 typedef struct |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5869 { |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5870 OrthancPluginDictionaryEntry* target; |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5871 const char* name; |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5872 } _OrthancPluginLookupDictionary; |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5873 |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5874 /** |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5875 * @brief Get information about the given DICOM tag. |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5876 * |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5877 * This functions makes a lookup in the dictionary of DICOM tags |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5878 * that are known to Orthanc, and returns information about this |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5879 * tag. The tag can be specified using its human-readable name |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5880 * (e.g. "PatientName") or a set of two hexadecimal numbers |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5881 * (e.g. "0010-0020"). |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5882 * |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5883 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5884 * @param target Where to store the information about the tag. |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5885 * @param name The name of the DICOM tag. |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5886 * @return 0 if success, other value if error. |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5887 * @ingroup Toolbox |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5888 **/ |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5889 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginLookupDictionary( |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5890 OrthancPluginContext* context, |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5891 OrthancPluginDictionaryEntry* target, |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5892 const char* name) |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5893 { |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5894 _OrthancPluginLookupDictionary params; |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5895 params.target = target; |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5896 params.name = name; |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5897 return context->InvokeService(context, _OrthancPluginService_LookupDictionary, ¶ms); |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5898 } |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5899 |
|
a7bea843a7bc
"OrthancPluginLookupDictionary()" to get information about some DICOM tag
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1860
diff
changeset
|
5900 |
|
1882
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5901 |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5902 typedef struct |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5903 { |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5904 OrthancPluginRestOutput* output; |
|
4077
ae7ebd5b0443
fix signature of OrthancPluginSendMultipartItem[2]()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4024
diff
changeset
|
5905 const void* answer; |
|
1882
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5906 uint32_t answerSize; |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5907 uint32_t headersCount; |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5908 const char* const* headersKeys; |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5909 const char* const* headersValues; |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5910 } _OrthancPluginSendMultipartItem2; |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5911 |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5912 /** |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5913 * @brief Send an item as a part of some HTTP multipart answer, with custom headers. |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5914 * |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5915 * This function sends an item as a part of some HTTP multipart |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5916 * answer that was initiated by OrthancPluginStartMultipartAnswer(). In addition to |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5917 * OrthancPluginSendMultipartItem(), this function will set HTTP header associated |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5918 * with the item. |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5919 * |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5920 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5921 * @param output The HTTP connection to the client application. |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5922 * @param answer Pointer to the memory buffer containing the item. |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5923 * @param answerSize Number of bytes of the item. |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5924 * @param headersCount The number of HTTP headers. |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5925 * @param headersKeys Array containing the keys of the HTTP headers. |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5926 * @param headersValues Array containing the values of the HTTP headers. |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5927 * @return 0 if success, or the error code if failure (this notably happens |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5928 * if the connection is closed by the client). |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5929 * @see OrthancPluginSendMultipartItem() |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5930 * @ingroup REST |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5931 **/ |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5932 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginSendMultipartItem2( |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5933 OrthancPluginContext* context, |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5934 OrthancPluginRestOutput* output, |
|
4077
ae7ebd5b0443
fix signature of OrthancPluginSendMultipartItem[2]()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4024
diff
changeset
|
5935 const void* answer, |
|
1882
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5936 uint32_t answerSize, |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5937 uint32_t headersCount, |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5938 const char* const* headersKeys, |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5939 const char* const* headersValues) |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5940 { |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5941 _OrthancPluginSendMultipartItem2 params; |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5942 params.output = output; |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5943 params.answer = answer; |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5944 params.answerSize = answerSize; |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5945 params.headersCount = headersCount; |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5946 params.headersKeys = headersKeys; |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5947 params.headersValues = headersValues; |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5948 |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5949 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem2, ¶ms); |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5950 } |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5951 |
|
5cf2bd0abfa2
OrthancPluginSendMultipartItem2 for DICOMweb
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1861
diff
changeset
|
5952 |
|
1961
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5953 typedef struct |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5954 { |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5955 OrthancPluginIncomingHttpRequestFilter callback; |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5956 } _OrthancPluginIncomingHttpRequestFilter; |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5957 |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5958 /** |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5959 * @brief Register a callback to filter incoming HTTP requests. |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5960 * |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5961 * This function registers a custom callback to filter incoming HTTP/REST |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5962 * requests received by the HTTP server of Orthanc. |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5963 * |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5964 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5965 * @param callback The callback. |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5966 * @return 0 if success, other value if error. |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5967 * @ingroup Callbacks |
|
2268
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
5968 * @deprecated Please instead use OrthancPluginRegisterIncomingHttpRequestFilter2() |
|
1961
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5969 **/ |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
5970 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter( |
|
1961
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5971 OrthancPluginContext* context, |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5972 OrthancPluginIncomingHttpRequestFilter callback) |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5973 { |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5974 _OrthancPluginIncomingHttpRequestFilter params; |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5975 params.callback = callback; |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5976 |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5977 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter, ¶ms); |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5978 } |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5979 |
|
ef1e9856c26f
New callback to filter incoming HTTP requests: OrthancPluginRegisterIncomingHttpRequestFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1949
diff
changeset
|
5980 |
|
1987
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
5981 |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
5982 typedef struct |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
5983 { |
|
2041
9f61ca1e3eb3
OrthancPluginHttpClient can return the HTTP headers of the answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2022
diff
changeset
|
5984 OrthancPluginMemoryBuffer* answerBody; |
|
9f61ca1e3eb3
OrthancPluginHttpClient can return the HTTP headers of the answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2022
diff
changeset
|
5985 OrthancPluginMemoryBuffer* answerHeaders; |
|
1987
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
5986 uint16_t* httpStatus; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
5987 OrthancPluginHttpMethod method; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
5988 const char* url; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
5989 uint32_t headersCount; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
5990 const char* const* headersKeys; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
5991 const char* const* headersValues; |
| 3401 | 5992 const void* body; |
|
1987
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
5993 uint32_t bodySize; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
5994 const char* username; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
5995 const char* password; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
5996 uint32_t timeout; |
|
2019
9c9332e486ca
HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1999
diff
changeset
|
5997 const char* certificateFile; |
|
9c9332e486ca
HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1999
diff
changeset
|
5998 const char* certificateKeyFile; |
|
9c9332e486ca
HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1999
diff
changeset
|
5999 const char* certificateKeyPassword; |
|
2022
fefbe71c2272
Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2019
diff
changeset
|
6000 uint8_t pkcs11; |
|
1987
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6001 } _OrthancPluginCallHttpClient2; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6002 |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6003 |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6004 |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6005 /** |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6006 * @brief Issue a HTTP call with full flexibility. |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6007 * |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6008 * Make a HTTP call to the given URL. The result to the query is |
|
2041
9f61ca1e3eb3
OrthancPluginHttpClient can return the HTTP headers of the answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2022
diff
changeset
|
6009 * stored into a newly allocated memory buffer. The HTTP request |
|
9f61ca1e3eb3
OrthancPluginHttpClient can return the HTTP headers of the answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2022
diff
changeset
|
6010 * will be done accordingly to the global configuration of Orthanc |
|
9f61ca1e3eb3
OrthancPluginHttpClient can return the HTTP headers of the answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2022
diff
changeset
|
6011 * (in particular, the options "HttpProxy", "HttpTimeout", |
|
9f61ca1e3eb3
OrthancPluginHttpClient can return the HTTP headers of the answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2022
diff
changeset
|
6012 * "HttpsVerifyPeers", "HttpsCACertificates", and "Pkcs11" will be |
|
9f61ca1e3eb3
OrthancPluginHttpClient can return the HTTP headers of the answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2022
diff
changeset
|
6013 * taken into account). |
|
1987
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6014 * |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6015 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
2041
9f61ca1e3eb3
OrthancPluginHttpClient can return the HTTP headers of the answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2022
diff
changeset
|
6016 * @param answerBody The target memory buffer (out argument). |
|
9f61ca1e3eb3
OrthancPluginHttpClient can return the HTTP headers of the answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2022
diff
changeset
|
6017 * It must be freed with OrthancPluginFreeMemoryBuffer(). |
|
4605
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
6018 * The value of this argument is ignored if the HTTP method is DELETE. |
|
2041
9f61ca1e3eb3
OrthancPluginHttpClient can return the HTTP headers of the answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2022
diff
changeset
|
6019 * @param answerHeaders The target memory buffer for the HTTP headers in the answers (out argument). |
|
9f61ca1e3eb3
OrthancPluginHttpClient can return the HTTP headers of the answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2022
diff
changeset
|
6020 * The answer headers are formatted as a JSON object (associative array). |
|
9f61ca1e3eb3
OrthancPluginHttpClient can return the HTTP headers of the answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2022
diff
changeset
|
6021 * The buffer must be freed with OrthancPluginFreeMemoryBuffer(). |
|
9f61ca1e3eb3
OrthancPluginHttpClient can return the HTTP headers of the answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2022
diff
changeset
|
6022 * This argument can be set to NULL if the plugin has no interest in the HTTP headers. |
|
1987
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6023 * @param httpStatus The HTTP status after the execution of the request (out argument). |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6024 * @param method HTTP method to be used. |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6025 * @param url The URL of interest. |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6026 * @param headersCount The number of HTTP headers. |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6027 * @param headersKeys Array containing the keys of the HTTP headers (can be <tt>NULL</tt> if no header). |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6028 * @param headersValues Array containing the values of the HTTP headers (can be <tt>NULL</tt> if no header). |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6029 * @param username The username (can be <tt>NULL</tt> if no password protection). |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6030 * @param password The password (can be <tt>NULL</tt> if no password protection). |
|
2799
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6031 * @param body The HTTP body for a POST or PUT request. |
|
1987
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6032 * @param bodySize The size of the body. |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6033 * @param timeout Timeout in seconds (0 for default timeout). |
|
2019
9c9332e486ca
HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1999
diff
changeset
|
6034 * @param certificateFile Path to the client certificate for HTTPS, in PEM format |
|
9c9332e486ca
HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1999
diff
changeset
|
6035 * (can be <tt>NULL</tt> if no client certificate or if not using HTTPS). |
|
9c9332e486ca
HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1999
diff
changeset
|
6036 * @param certificateKeyFile Path to the key of the client certificate for HTTPS, in PEM format |
|
9c9332e486ca
HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1999
diff
changeset
|
6037 * (can be <tt>NULL</tt> if no client certificate or if not using HTTPS). |
|
9c9332e486ca
HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1999
diff
changeset
|
6038 * @param certificateKeyPassword Password to unlock the key of the client certificate |
|
9c9332e486ca
HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1999
diff
changeset
|
6039 * (can be <tt>NULL</tt> if no client certificate or if not using HTTPS). |
|
2022
fefbe71c2272
Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2019
diff
changeset
|
6040 * @param pkcs11 Enable PKCS#11 client authentication for hardware security modules and smart cards. |
|
1987
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6041 * @return 0 if success, or the error code if failure. |
|
2799
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6042 * @see OrthancPluginCallPeerApi() |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
6043 * @ingroup Toolbox |
|
1987
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6044 **/ |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6045 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginHttpClient( |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6046 OrthancPluginContext* context, |
|
2041
9f61ca1e3eb3
OrthancPluginHttpClient can return the HTTP headers of the answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2022
diff
changeset
|
6047 OrthancPluginMemoryBuffer* answerBody, |
|
9f61ca1e3eb3
OrthancPluginHttpClient can return the HTTP headers of the answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2022
diff
changeset
|
6048 OrthancPluginMemoryBuffer* answerHeaders, |
|
1987
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6049 uint16_t* httpStatus, |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6050 OrthancPluginHttpMethod method, |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6051 const char* url, |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6052 uint32_t headersCount, |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6053 const char* const* headersKeys, |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6054 const char* const* headersValues, |
| 3401 | 6055 const void* body, |
|
1987
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6056 uint32_t bodySize, |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6057 const char* username, |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6058 const char* password, |
|
2019
9c9332e486ca
HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1999
diff
changeset
|
6059 uint32_t timeout, |
|
9c9332e486ca
HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1999
diff
changeset
|
6060 const char* certificateFile, |
|
9c9332e486ca
HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1999
diff
changeset
|
6061 const char* certificateKeyFile, |
|
2022
fefbe71c2272
Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2019
diff
changeset
|
6062 const char* certificateKeyPassword, |
|
fefbe71c2272
Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2019
diff
changeset
|
6063 uint8_t pkcs11) |
|
1987
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6064 { |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6065 _OrthancPluginCallHttpClient2 params; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6066 memset(¶ms, 0, sizeof(params)); |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6067 |
|
2041
9f61ca1e3eb3
OrthancPluginHttpClient can return the HTTP headers of the answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2022
diff
changeset
|
6068 params.answerBody = answerBody; |
|
9f61ca1e3eb3
OrthancPluginHttpClient can return the HTTP headers of the answer
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2022
diff
changeset
|
6069 params.answerHeaders = answerHeaders; |
|
1987
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6070 params.httpStatus = httpStatus; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6071 params.method = method; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6072 params.url = url; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6073 params.headersCount = headersCount; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6074 params.headersKeys = headersKeys; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6075 params.headersValues = headersValues; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6076 params.body = body; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6077 params.bodySize = bodySize; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6078 params.username = username; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6079 params.password = password; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6080 params.timeout = timeout; |
|
2019
9c9332e486ca
HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1999
diff
changeset
|
6081 params.certificateFile = certificateFile; |
|
9c9332e486ca
HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1999
diff
changeset
|
6082 params.certificateKeyFile = certificateKeyFile; |
|
9c9332e486ca
HTTPS client certificates can be associated with Orthanc peers to enhance security over Internet
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1999
diff
changeset
|
6083 params.certificateKeyPassword = certificateKeyPassword; |
|
2022
fefbe71c2272
Possibility to use PKCS#11 authentication for hardware security modules with Orthanc peers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2019
diff
changeset
|
6084 params.pkcs11 = pkcs11; |
|
1987
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6085 |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6086 return context->InvokeService(context, _OrthancPluginService_CallHttpClient2, ¶ms); |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6087 } |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6088 |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6089 |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6090 /** |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6091 * @brief Generate an UUID. |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6092 * |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6093 * Generate a random GUID/UUID (globally unique identifier). |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6094 * |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6095 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6096 * @return NULL in the case of an error, or a newly allocated string |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6097 * containing the UUID. This string must be freed by OrthancPluginFreeString(). |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6098 * @ingroup Toolbox |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6099 **/ |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6100 ORTHANC_PLUGIN_INLINE char* OrthancPluginGenerateUuid( |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6101 OrthancPluginContext* context) |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6102 { |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6103 char* result; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6104 |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6105 _OrthancPluginRetrieveDynamicString params; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6106 params.result = &result; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6107 params.argument = NULL; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6108 |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6109 if (context->InvokeService(context, _OrthancPluginService_GenerateUuid, ¶ms) != OrthancPluginErrorCode_Success) |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6110 { |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6111 /* Error */ |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6112 return NULL; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6113 } |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6114 else |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6115 { |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6116 return result; |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6117 } |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6118 } |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6119 |
|
ce90d109bb64
new plugin functions: OrthancPluginHttpClient and OrthancPluginGenerateUuid
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1980
diff
changeset
|
6120 |
|
1995
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6121 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6122 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6123 typedef struct |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6124 { |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6125 OrthancPluginFindCallback callback; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6126 } _OrthancPluginFindCallback; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6127 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6128 /** |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6129 * @brief Register a callback to handle C-Find requests. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6130 * |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6131 * This function registers a callback to handle C-Find SCP requests |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6132 * that are not related to modality worklists. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6133 * |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6134 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6135 * @param callback The callback. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6136 * @return 0 if success, other value if error. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6137 * @ingroup DicomCallbacks |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6138 **/ |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6139 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterFindCallback( |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6140 OrthancPluginContext* context, |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6141 OrthancPluginFindCallback callback) |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6142 { |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6143 _OrthancPluginFindCallback params; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6144 params.callback = callback; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6145 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6146 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback, ¶ms); |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6147 } |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6148 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6149 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6150 typedef struct |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6151 { |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6152 OrthancPluginFindAnswers *answers; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6153 const OrthancPluginFindQuery *query; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6154 const void *dicom; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6155 uint32_t size; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6156 uint32_t index; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6157 uint32_t *resultUint32; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6158 uint16_t *resultGroup; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6159 uint16_t *resultElement; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6160 char **resultString; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6161 } _OrthancPluginFindOperation; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6162 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6163 /** |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6164 * @brief Add one answer to some C-Find request. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6165 * |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6166 * This function adds one answer (encoded as a DICOM file) to the |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6167 * set of answers corresponding to some C-Find SCP request that is |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6168 * not related to modality worklists. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6169 * |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6170 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6171 * @param answers The set of answers. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6172 * @param dicom The answer to be added, encoded as a DICOM file. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6173 * @param size The size of the DICOM file. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6174 * @return 0 if success, other value if error. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6175 * @ingroup DicomCallbacks |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6176 * @see OrthancPluginCreateDicom() |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6177 **/ |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6178 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginFindAddAnswer( |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6179 OrthancPluginContext* context, |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6180 OrthancPluginFindAnswers* answers, |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6181 const void* dicom, |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6182 uint32_t size) |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6183 { |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6184 _OrthancPluginFindOperation params; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6185 memset(¶ms, 0, sizeof(params)); |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6186 params.answers = answers; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6187 params.dicom = dicom; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6188 params.size = size; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6189 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6190 return context->InvokeService(context, _OrthancPluginService_FindAddAnswer, ¶ms); |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6191 } |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6192 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6193 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6194 /** |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6195 * @brief Mark the set of C-Find answers as incomplete. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6196 * |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6197 * This function marks as incomplete the set of answers |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6198 * corresponding to some C-Find SCP request that is not related to |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6199 * modality worklists. This must be used if canceling the handling |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6200 * of a request when too many answers are to be returned. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6201 * |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6202 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6203 * @param answers The set of answers. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6204 * @return 0 if success, other value if error. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6205 * @ingroup DicomCallbacks |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6206 **/ |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6207 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginFindMarkIncomplete( |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6208 OrthancPluginContext* context, |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6209 OrthancPluginFindAnswers* answers) |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6210 { |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6211 _OrthancPluginFindOperation params; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6212 memset(¶ms, 0, sizeof(params)); |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6213 params.answers = answers; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6214 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6215 return context->InvokeService(context, _OrthancPluginService_FindMarkIncomplete, ¶ms); |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6216 } |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6217 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6218 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6219 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6220 /** |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6221 * @brief Get the number of tags in a C-Find query. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6222 * |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6223 * This function returns the number of tags that are contained in |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6224 * the given C-Find query. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6225 * |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6226 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6227 * @param query The C-Find query. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6228 * @return The number of tags. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6229 * @ingroup DicomCallbacks |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6230 **/ |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6231 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetFindQuerySize( |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6232 OrthancPluginContext* context, |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6233 const OrthancPluginFindQuery* query) |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6234 { |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6235 uint32_t count = 0; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6236 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6237 _OrthancPluginFindOperation params; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6238 memset(¶ms, 0, sizeof(params)); |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6239 params.query = query; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6240 params.resultUint32 = &count; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6241 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6242 if (context->InvokeService(context, _OrthancPluginService_GetFindQuerySize, ¶ms) != OrthancPluginErrorCode_Success) |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6243 { |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6244 /* Error */ |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6245 return 0; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6246 } |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6247 else |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6248 { |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6249 return count; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6250 } |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6251 } |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6252 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6253 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6254 /** |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6255 * @brief Get one tag in a C-Find query. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6256 * |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6257 * This function returns the group and the element of one DICOM tag |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6258 * in the given C-Find query. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6259 * |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6260 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6261 * @param group The group of the tag (output). |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6262 * @param element The element of the tag (output). |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6263 * @param query The C-Find query. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6264 * @param index The index of the tag of interest. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6265 * @return 0 if success, other value if error. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6266 * @ingroup DicomCallbacks |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6267 **/ |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6268 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginGetFindQueryTag( |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6269 OrthancPluginContext* context, |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6270 uint16_t* group, |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6271 uint16_t* element, |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6272 const OrthancPluginFindQuery* query, |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6273 uint32_t index) |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6274 { |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6275 _OrthancPluginFindOperation params; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6276 memset(¶ms, 0, sizeof(params)); |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6277 params.query = query; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6278 params.index = index; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6279 params.resultGroup = group; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6280 params.resultElement = element; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6281 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6282 return context->InvokeService(context, _OrthancPluginService_GetFindQueryTag, ¶ms); |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6283 } |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6284 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6285 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6286 /** |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6287 * @brief Get the symbolic name of one tag in a C-Find query. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6288 * |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6289 * This function returns the symbolic name of one DICOM tag in the |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6290 * given C-Find query. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6291 * |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6292 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6293 * @param query The C-Find query. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6294 * @param index The index of the tag of interest. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6295 * @return The NULL value in case of error, or a string containing the name of the tag. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6296 * @return 0 if success, other value if error. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6297 * @ingroup DicomCallbacks |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6298 **/ |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6299 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetFindQueryTagName( |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6300 OrthancPluginContext* context, |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6301 const OrthancPluginFindQuery* query, |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6302 uint32_t index) |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6303 { |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6304 char* result; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6305 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6306 _OrthancPluginFindOperation params; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6307 memset(¶ms, 0, sizeof(params)); |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6308 params.query = query; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6309 params.index = index; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6310 params.resultString = &result; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6311 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6312 if (context->InvokeService(context, _OrthancPluginService_GetFindQueryTagName, ¶ms) != OrthancPluginErrorCode_Success) |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6313 { |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6314 /* Error */ |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6315 return NULL; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6316 } |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6317 else |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6318 { |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6319 return result; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6320 } |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6321 } |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6322 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6323 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6324 /** |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6325 * @brief Get the value associated with one tag in a C-Find query. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6326 * |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6327 * This function returns the value associated with one tag in the |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6328 * given C-Find query. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6329 * |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6330 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6331 * @param query The C-Find query. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6332 * @param index The index of the tag of interest. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6333 * @return The NULL value in case of error, or a string containing the value of the tag. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6334 * @return 0 if success, other value if error. |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6335 * @ingroup DicomCallbacks |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6336 **/ |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6337 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetFindQueryValue( |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6338 OrthancPluginContext* context, |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6339 const OrthancPluginFindQuery* query, |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6340 uint32_t index) |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6341 { |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6342 char* result; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6343 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6344 _OrthancPluginFindOperation params; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6345 memset(¶ms, 0, sizeof(params)); |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6346 params.query = query; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6347 params.index = index; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6348 params.resultString = &result; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6349 |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6350 if (context->InvokeService(context, _OrthancPluginService_GetFindQueryValue, ¶ms) != OrthancPluginErrorCode_Success) |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6351 { |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6352 /* Error */ |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6353 return NULL; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6354 } |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6355 else |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6356 { |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6357 return result; |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6358 } |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6359 } |
|
f0acfa753973
New callback to handle non-worklists C-Find requests: OrthancPluginRegisterCFindCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1987
diff
changeset
|
6360 |
|
1999
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6361 |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6362 |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6363 |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6364 typedef struct |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6365 { |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6366 OrthancPluginMoveCallback callback; |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6367 OrthancPluginGetMoveSize getMoveSize; |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6368 OrthancPluginApplyMove applyMove; |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6369 OrthancPluginFreeMove freeMove; |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6370 } _OrthancPluginMoveCallback; |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6371 |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6372 /** |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6373 * @brief Register a callback to handle C-Move requests. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6374 * |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6375 * This function registers a callback to handle C-Move SCP requests. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6376 * |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6377 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6378 * @param callback The main callback. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6379 * @param getMoveSize Callback to read the number of C-Move suboperations. |
| 3220 | 6380 * @param applyMove Callback to apply one C-Move suboperation. |
|
1999
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6381 * @param freeMove Callback to free the C-Move driver. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6382 * @return 0 if success, other value if error. |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6383 * @ingroup DicomCallbacks |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6384 **/ |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6385 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterMoveCallback( |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6386 OrthancPluginContext* context, |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6387 OrthancPluginMoveCallback callback, |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6388 OrthancPluginGetMoveSize getMoveSize, |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6389 OrthancPluginApplyMove applyMove, |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6390 OrthancPluginFreeMove freeMove) |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6391 { |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6392 _OrthancPluginMoveCallback params; |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6393 params.callback = callback; |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6394 params.getMoveSize = getMoveSize; |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6395 params.applyMove = applyMove; |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6396 params.freeMove = freeMove; |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6397 |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6398 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback, ¶ms); |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6399 } |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6400 |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6401 |
|
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6402 |
|
2210
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6403 typedef struct |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6404 { |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6405 OrthancPluginFindMatcher** target; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6406 const void* query; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6407 uint32_t size; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6408 } _OrthancPluginCreateFindMatcher; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6409 |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6410 |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6411 /** |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6412 * @brief Create a C-Find matcher. |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6413 * |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6414 * This function creates a "matcher" object that can be used to |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6415 * check whether a DICOM instance matches a C-Find query. The C-Find |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6416 * query must be expressed as a DICOM buffer. |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6417 * |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6418 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6419 * @param query The C-Find DICOM query. |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6420 * @param size The size of the DICOM query. |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6421 * @return The newly allocated matcher. It must be freed with OrthancPluginFreeFindMatcher(). |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6422 * @ingroup Toolbox |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6423 **/ |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6424 ORTHANC_PLUGIN_INLINE OrthancPluginFindMatcher* OrthancPluginCreateFindMatcher( |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6425 OrthancPluginContext* context, |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6426 const void* query, |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6427 uint32_t size) |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6428 { |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6429 OrthancPluginFindMatcher* target = NULL; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6430 |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6431 _OrthancPluginCreateFindMatcher params; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6432 memset(¶ms, 0, sizeof(params)); |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6433 params.target = ⌖ |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6434 params.query = query; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6435 params.size = size; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6436 |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6437 if (context->InvokeService(context, _OrthancPluginService_CreateFindMatcher, ¶ms) != OrthancPluginErrorCode_Success) |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6438 { |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6439 return NULL; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6440 } |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6441 else |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6442 { |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6443 return target; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6444 } |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6445 } |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6446 |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6447 |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6448 typedef struct |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6449 { |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6450 OrthancPluginFindMatcher* matcher; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6451 } _OrthancPluginFreeFindMatcher; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6452 |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6453 /** |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6454 * @brief Free a C-Find matcher. |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6455 * |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6456 * This function frees a matcher that was created using OrthancPluginCreateFindMatcher(). |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6457 * |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6458 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6459 * @param matcher The matcher of interest. |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6460 * @ingroup Toolbox |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6461 **/ |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6462 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeFindMatcher( |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6463 OrthancPluginContext* context, |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6464 OrthancPluginFindMatcher* matcher) |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6465 { |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6466 _OrthancPluginFreeFindMatcher params; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6467 params.matcher = matcher; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6468 |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6469 context->InvokeService(context, _OrthancPluginService_FreeFindMatcher, ¶ms); |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6470 } |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6471 |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6472 |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6473 typedef struct |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6474 { |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6475 const OrthancPluginFindMatcher* matcher; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6476 const void* dicom; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6477 uint32_t size; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6478 int32_t* isMatch; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6479 } _OrthancPluginFindMatcherIsMatch; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6480 |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6481 /** |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6482 * @brief Test whether a DICOM instance matches a C-Find query. |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6483 * |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6484 * This function checks whether one DICOM instance matches C-Find |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6485 * matcher that was previously allocated using |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6486 * OrthancPluginCreateFindMatcher(). |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6487 * |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6488 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6489 * @param matcher The matcher of interest. |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6490 * @param dicom The DICOM instance to be matched. |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6491 * @param size The size of the DICOM instance. |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6492 * @return 1 if the DICOM instance matches the query, 0 otherwise. |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6493 * @ingroup Toolbox |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6494 **/ |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6495 ORTHANC_PLUGIN_INLINE int32_t OrthancPluginFindMatcherIsMatch( |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6496 OrthancPluginContext* context, |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6497 const OrthancPluginFindMatcher* matcher, |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6498 const void* dicom, |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6499 uint32_t size) |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6500 { |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6501 int32_t isMatch = 0; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6502 |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6503 _OrthancPluginFindMatcherIsMatch params; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6504 params.matcher = matcher; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6505 params.dicom = dicom; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6506 params.size = size; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6507 params.isMatch = &isMatch; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6508 |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6509 if (context->InvokeService(context, _OrthancPluginService_FindMatcherIsMatch, ¶ms) == OrthancPluginErrorCode_Success) |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6510 { |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6511 return isMatch; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6512 } |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6513 else |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6514 { |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6515 /* Error: Assume non-match */ |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6516 return 0; |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6517 } |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6518 } |
|
7bcff7bb7cbf
OrthancPluginFindMatcher
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2133
diff
changeset
|
6519 |
|
1999
364cc624eb65
New URI "/modalities/.../move" to issue C-Move SCU requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
1995
diff
changeset
|
6520 |
|
2268
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6521 typedef struct |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6522 { |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6523 OrthancPluginIncomingHttpRequestFilter2 callback; |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6524 } _OrthancPluginIncomingHttpRequestFilter2; |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6525 |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6526 /** |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6527 * @brief Register a callback to filter incoming HTTP requests. |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6528 * |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6529 * This function registers a custom callback to filter incoming HTTP/REST |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6530 * requests received by the HTTP server of Orthanc. |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6531 * |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6532 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6533 * @param callback The callback. |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6534 * @return 0 if success, other value if error. |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6535 * @ingroup Callbacks |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6536 **/ |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6537 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter2( |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6538 OrthancPluginContext* context, |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6539 OrthancPluginIncomingHttpRequestFilter2 callback) |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6540 { |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6541 _OrthancPluginIncomingHttpRequestFilter2 params; |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6542 params.callback = callback; |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6543 |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6544 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter2, ¶ms); |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6545 } |
|
ce5c13b95dac
New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2244
diff
changeset
|
6546 |
|
2799
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6547 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6548 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6549 typedef struct |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6550 { |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6551 OrthancPluginPeers** peers; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6552 } _OrthancPluginGetPeers; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6553 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6554 /** |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6555 * @brief Return the list of available Orthanc peers. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6556 * |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6557 * This function returns the parameters of the Orthanc peers that are known to |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6558 * the Orthanc server hosting the plugin. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6559 * |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6560 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6561 * @return NULL if error, or a newly allocated opaque data structure containing the peers. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6562 * This structure must be freed with OrthancPluginFreePeers(). |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6563 * @ingroup Toolbox |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6564 **/ |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6565 ORTHANC_PLUGIN_INLINE OrthancPluginPeers* OrthancPluginGetPeers( |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6566 OrthancPluginContext* context) |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6567 { |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6568 OrthancPluginPeers* peers = NULL; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6569 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6570 _OrthancPluginGetPeers params; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6571 memset(¶ms, 0, sizeof(params)); |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6572 params.peers = &peers; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6573 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6574 if (context->InvokeService(context, _OrthancPluginService_GetPeers, ¶ms) != OrthancPluginErrorCode_Success) |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6575 { |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6576 return NULL; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6577 } |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6578 else |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6579 { |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6580 return peers; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6581 } |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6582 } |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6583 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6584 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6585 typedef struct |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6586 { |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6587 OrthancPluginPeers* peers; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6588 } _OrthancPluginFreePeers; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6589 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6590 /** |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6591 * @brief Free the list of available Orthanc peers. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6592 * |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6593 * This function frees the data structure returned by OrthancPluginGetPeers(). |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6594 * |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6595 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6596 * @param peers The data structure describing the Orthanc peers. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6597 * @ingroup Toolbox |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6598 **/ |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6599 ORTHANC_PLUGIN_INLINE void OrthancPluginFreePeers( |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6600 OrthancPluginContext* context, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6601 OrthancPluginPeers* peers) |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6602 { |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6603 _OrthancPluginFreePeers params; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6604 params.peers = peers; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6605 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6606 context->InvokeService(context, _OrthancPluginService_FreePeers, ¶ms); |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6607 } |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6608 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6609 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6610 typedef struct |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6611 { |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6612 uint32_t* target; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6613 const OrthancPluginPeers* peers; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6614 } _OrthancPluginGetPeersCount; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6615 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6616 /** |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6617 * @brief Get the number of Orthanc peers. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6618 * |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6619 * This function returns the number of Orthanc peers. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6620 * |
| 2802 | 6621 * This function is thread-safe: Several threads sharing the same |
| 6622 * OrthancPluginPeers object can simultaneously call this function. | |
| 6623 * | |
|
2799
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6624 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6625 * @param peers The data structure describing the Orthanc peers. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6626 * @result The number of peers. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6627 * @ingroup Toolbox |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6628 **/ |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6629 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetPeersCount( |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6630 OrthancPluginContext* context, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6631 const OrthancPluginPeers* peers) |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6632 { |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6633 uint32_t target = 0; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6634 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6635 _OrthancPluginGetPeersCount params; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6636 memset(¶ms, 0, sizeof(params)); |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6637 params.target = ⌖ |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6638 params.peers = peers; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6639 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6640 if (context->InvokeService(context, _OrthancPluginService_GetPeersCount, ¶ms) != OrthancPluginErrorCode_Success) |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6641 { |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6642 /* Error */ |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6643 return 0; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6644 } |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6645 else |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6646 { |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6647 return target; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6648 } |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6649 } |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6650 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6651 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6652 typedef struct |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6653 { |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6654 const char** target; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6655 const OrthancPluginPeers* peers; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6656 uint32_t peerIndex; |
|
2823
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6657 const char* userProperty; |
|
2799
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6658 } _OrthancPluginGetPeerProperty; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6659 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6660 /** |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6661 * @brief Get the symbolic name of an Orthanc peer. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6662 * |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6663 * This function returns the symbolic name of the Orthanc peer, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6664 * which corresponds to the key of the "OrthancPeers" configuration |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6665 * option of Orthanc. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6666 * |
| 2802 | 6667 * This function is thread-safe: Several threads sharing the same |
| 6668 * OrthancPluginPeers object can simultaneously call this function. | |
| 6669 * | |
|
2799
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6670 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6671 * @param peers The data structure describing the Orthanc peers. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6672 * @param peerIndex The index of the peer of interest. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6673 * This value must be lower than OrthancPluginGetPeersCount(). |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6674 * @result The symbolic name, or NULL in the case of an error. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6675 * @ingroup Toolbox |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6676 **/ |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6677 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetPeerName( |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6678 OrthancPluginContext* context, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6679 const OrthancPluginPeers* peers, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6680 uint32_t peerIndex) |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6681 { |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6682 const char* target = NULL; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6683 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6684 _OrthancPluginGetPeerProperty params; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6685 memset(¶ms, 0, sizeof(params)); |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6686 params.target = ⌖ |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6687 params.peers = peers; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6688 params.peerIndex = peerIndex; |
|
2823
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6689 params.userProperty = NULL; |
|
2799
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6690 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6691 if (context->InvokeService(context, _OrthancPluginService_GetPeerName, ¶ms) != OrthancPluginErrorCode_Success) |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6692 { |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6693 /* Error */ |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6694 return NULL; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6695 } |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6696 else |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6697 { |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6698 return target; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6699 } |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6700 } |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6701 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6702 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6703 /** |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6704 * @brief Get the base URL of an Orthanc peer. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6705 * |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6706 * This function returns the base URL to the REST API of some Orthanc peer. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6707 * |
| 2802 | 6708 * This function is thread-safe: Several threads sharing the same |
| 6709 * OrthancPluginPeers object can simultaneously call this function. | |
| 6710 * | |
|
2799
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6711 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6712 * @param peers The data structure describing the Orthanc peers. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6713 * @param peerIndex The index of the peer of interest. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6714 * This value must be lower than OrthancPluginGetPeersCount(). |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6715 * @result The URL, or NULL in the case of an error. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6716 * @ingroup Toolbox |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6717 **/ |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6718 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetPeerUrl( |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6719 OrthancPluginContext* context, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6720 const OrthancPluginPeers* peers, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6721 uint32_t peerIndex) |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6722 { |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6723 const char* target = NULL; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6724 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6725 _OrthancPluginGetPeerProperty params; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6726 memset(¶ms, 0, sizeof(params)); |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6727 params.target = ⌖ |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6728 params.peers = peers; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6729 params.peerIndex = peerIndex; |
|
2823
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6730 params.userProperty = NULL; |
|
2799
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6731 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6732 if (context->InvokeService(context, _OrthancPluginService_GetPeerUrl, ¶ms) != OrthancPluginErrorCode_Success) |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6733 { |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6734 /* Error */ |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6735 return NULL; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6736 } |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6737 else |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6738 { |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6739 return target; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6740 } |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6741 } |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6742 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6743 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6744 |
|
2823
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6745 /** |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6746 * @brief Get some user-defined property of an Orthanc peer. |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6747 * |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6748 * This function returns some user-defined property of some Orthanc |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6749 * peer. An user-defined property is a property that is associated |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6750 * with the peer in the Orthanc configuration file, but that is not |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6751 * recognized by the Orthanc core. |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6752 * |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6753 * This function is thread-safe: Several threads sharing the same |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6754 * OrthancPluginPeers object can simultaneously call this function. |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6755 * |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6756 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6757 * @param peers The data structure describing the Orthanc peers. |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6758 * @param peerIndex The index of the peer of interest. |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6759 * This value must be lower than OrthancPluginGetPeersCount(). |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6760 * @param userProperty The user property of interest. |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6761 * @result The value of the user property, or NULL if it is not defined. |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6762 * @ingroup Toolbox |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6763 **/ |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6764 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetPeerUserProperty( |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6765 OrthancPluginContext* context, |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6766 const OrthancPluginPeers* peers, |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6767 uint32_t peerIndex, |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6768 const char* userProperty) |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6769 { |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6770 const char* target = NULL; |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6771 |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6772 _OrthancPluginGetPeerProperty params; |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6773 memset(¶ms, 0, sizeof(params)); |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6774 params.target = ⌖ |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6775 params.peers = peers; |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6776 params.peerIndex = peerIndex; |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6777 params.userProperty = userProperty; |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6778 |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6779 if (context->InvokeService(context, _OrthancPluginService_GetPeerUserProperty, ¶ms) != OrthancPluginErrorCode_Success) |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6780 { |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6781 /* No such user property */ |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6782 return NULL; |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6783 } |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6784 else |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6785 { |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6786 return target; |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6787 } |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6788 } |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6789 |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6790 |
|
807169f85ba9
OrthancPluginGetPeerUserProperty()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2819
diff
changeset
|
6791 |
|
2799
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6792 typedef struct |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6793 { |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6794 OrthancPluginMemoryBuffer* answerBody; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6795 OrthancPluginMemoryBuffer* answerHeaders; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6796 uint16_t* httpStatus; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6797 const OrthancPluginPeers* peers; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6798 uint32_t peerIndex; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6799 OrthancPluginHttpMethod method; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6800 const char* uri; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6801 uint32_t additionalHeadersCount; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6802 const char* const* additionalHeadersKeys; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6803 const char* const* additionalHeadersValues; |
| 3401 | 6804 const void* body; |
|
2799
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6805 uint32_t bodySize; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6806 uint32_t timeout; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6807 } _OrthancPluginCallPeerApi; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6808 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6809 /** |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6810 * @brief Call the REST API of an Orthanc peer. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6811 * |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6812 * Make a REST call to the given URI in the REST API of a remote |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6813 * Orthanc peer. The result to the query is stored into a newly |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6814 * allocated memory buffer. The HTTP request will be done according |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6815 * to the "OrthancPeers" configuration option of Orthanc. |
| 2802 | 6816 * |
| 6817 * This function is thread-safe: Several threads sharing the same | |
| 6818 * OrthancPluginPeers object can simultaneously call this function. | |
|
2799
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6819 * |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6820 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6821 * @param answerBody The target memory buffer (out argument). |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6822 * It must be freed with OrthancPluginFreeMemoryBuffer(). |
|
4605
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
6823 * The value of this argument is ignored if the HTTP method is DELETE. |
|
2799
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6824 * @param answerHeaders The target memory buffer for the HTTP headers in the answers (out argument). |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6825 * The answer headers are formatted as a JSON object (associative array). |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6826 * The buffer must be freed with OrthancPluginFreeMemoryBuffer(). |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6827 * This argument can be set to NULL if the plugin has no interest in the HTTP headers. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6828 * @param httpStatus The HTTP status after the execution of the request (out argument). |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6829 * @param peers The data structure describing the Orthanc peers. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6830 * @param peerIndex The index of the peer of interest. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6831 * This value must be lower than OrthancPluginGetPeersCount(). |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6832 * @param method HTTP method to be used. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6833 * @param uri The URI of interest in the REST API. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6834 * @param additionalHeadersCount The number of HTTP headers to be added to the |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6835 * HTTP headers provided in the global configuration of Orthanc. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6836 * @param additionalHeadersKeys Array containing the keys of the HTTP headers (can be <tt>NULL</tt> if no header). |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6837 * @param additionalHeadersValues Array containing the values of the HTTP headers (can be <tt>NULL</tt> if no header). |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6838 * @param body The HTTP body for a POST or PUT request. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6839 * @param bodySize The size of the body. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6840 * @param timeout Timeout in seconds (0 for default timeout). |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6841 * @return 0 if success, or the error code if failure. |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6842 * @see OrthancPluginHttpClient() |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6843 * @ingroup Toolbox |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6844 **/ |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6845 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCallPeerApi( |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6846 OrthancPluginContext* context, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6847 OrthancPluginMemoryBuffer* answerBody, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6848 OrthancPluginMemoryBuffer* answerHeaders, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6849 uint16_t* httpStatus, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6850 const OrthancPluginPeers* peers, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6851 uint32_t peerIndex, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6852 OrthancPluginHttpMethod method, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6853 const char* uri, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6854 uint32_t additionalHeadersCount, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6855 const char* const* additionalHeadersKeys, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6856 const char* const* additionalHeadersValues, |
| 3401 | 6857 const void* body, |
|
2799
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6858 uint32_t bodySize, |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6859 uint32_t timeout) |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6860 { |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6861 _OrthancPluginCallPeerApi params; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6862 memset(¶ms, 0, sizeof(params)); |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6863 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6864 params.answerBody = answerBody; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6865 params.answerHeaders = answerHeaders; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6866 params.httpStatus = httpStatus; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6867 params.peers = peers; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6868 params.peerIndex = peerIndex; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6869 params.method = method; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6870 params.uri = uri; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6871 params.additionalHeadersCount = additionalHeadersCount; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6872 params.additionalHeadersKeys = additionalHeadersKeys; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6873 params.additionalHeadersValues = additionalHeadersValues; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6874 params.body = body; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6875 params.bodySize = bodySize; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6876 params.timeout = timeout; |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6877 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6878 return context->InvokeService(context, _OrthancPluginService_CallPeerApi, ¶ms); |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
6879 } |
|
2808
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
6880 |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
6881 |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
6882 |
|
2815
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6883 |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6884 |
|
2808
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
6885 typedef struct |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
6886 { |
|
2815
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6887 OrthancPluginJob** target; |
|
2814
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
6888 void *job; |
|
2815
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6889 OrthancPluginJobFinalize finalize; |
|
2814
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
6890 const char *type; |
|
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
6891 OrthancPluginJobGetProgress getProgress; |
|
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
6892 OrthancPluginJobGetContent getContent; |
|
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
6893 OrthancPluginJobGetSerialized getSerialized; |
|
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
6894 OrthancPluginJobStep step; |
|
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
6895 OrthancPluginJobStop stop; |
|
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
6896 OrthancPluginJobReset reset; |
|
2815
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6897 } _OrthancPluginCreateJob; |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6898 |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
6899 /** |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
6900 * @brief Create a custom job. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
6901 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
6902 * This function creates a custom job to be run by the jobs engine |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
6903 * of Orthanc. |
| 2819 | 6904 * |
| 6905 * Orthanc starts one dedicated thread per custom job that is | |
| 6906 * running. It is guaranteed that all the callbacks will only be | |
| 6907 * called from this single dedicated thread, in mutual exclusion: As | |
| 6908 * a consequence, it is *not* mandatory to protect the various | |
| 6909 * callbacks by mutexes. | |
| 6910 * | |
| 6911 * The custom job can nonetheless launch its own processing threads | |
| 6912 * on the first call to the "step()" callback, and stop them once | |
| 6913 * the "stop()" callback is called. | |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
6914 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
6915 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
6916 * @param job The job to be executed. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
6917 * @param finalize The finalization callback. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
6918 * @param type The type of the job, provided to the job unserializer. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
6919 * See OrthancPluginRegisterJobsUnserializer(). |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
6920 * @param getProgress The progress callback. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
6921 * @param getContent The content callback. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
6922 * @param getSerialized The serialization callback. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
6923 * @param step The callback to execute the individual steps of the job. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
6924 * @param stop The callback that is invoked once the job leaves the "running" state. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
6925 * @param reset The callback that is invoked if a stopped job is started again. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
6926 * @return The newly allocated job. It must be freed with OrthancPluginFreeJob(), |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
6927 * as long as it is not submitted with OrthancPluginSubmitJob(). |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
6928 * @ingroup Toolbox |
|
5138
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6929 * @deprecated This signature should not be used anymore since Orthanc SDK 1.11.3. |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
6930 **/ |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
6931 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE OrthancPluginJob *OrthancPluginCreateJob( |
|
2814
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
6932 OrthancPluginContext *context, |
|
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
6933 void *job, |
|
2815
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6934 OrthancPluginJobFinalize finalize, |
|
2814
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
6935 const char *type, |
|
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
6936 OrthancPluginJobGetProgress getProgress, |
|
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
6937 OrthancPluginJobGetContent getContent, |
|
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
6938 OrthancPluginJobGetSerialized getSerialized, |
|
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
6939 OrthancPluginJobStep step, |
|
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
6940 OrthancPluginJobStop stop, |
|
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
6941 OrthancPluginJobReset reset) |
|
2808
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
6942 { |
|
2815
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6943 OrthancPluginJob* target = NULL; |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6944 |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6945 _OrthancPluginCreateJob params; |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6946 memset(¶ms, 0, sizeof(params)); |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6947 |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6948 params.target = ⌖ |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6949 params.job = job; |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6950 params.finalize = finalize; |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6951 params.type = type; |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6952 params.getProgress = getProgress; |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6953 params.getContent = getContent; |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6954 params.getSerialized = getSerialized; |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6955 params.step = step; |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6956 params.stop = stop; |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6957 params.reset = reset; |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6958 |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6959 if (context->InvokeService(context, _OrthancPluginService_CreateJob, ¶ms) != OrthancPluginErrorCode_Success || |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6960 target == NULL) |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6961 { |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6962 /* Error */ |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6963 return NULL; |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6964 } |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6965 else |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6966 { |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6967 return target; |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6968 } |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6969 } |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6970 |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6971 |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6972 typedef struct |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
6973 { |
|
5138
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6974 OrthancPluginJob** target; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6975 void *job; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6976 OrthancPluginJobFinalize finalize; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6977 const char *type; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6978 OrthancPluginJobGetProgress getProgress; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6979 OrthancPluginJobGetContent2 getContent; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6980 OrthancPluginJobGetSerialized2 getSerialized; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6981 OrthancPluginJobStep step; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6982 OrthancPluginJobStop stop; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6983 OrthancPluginJobReset reset; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6984 } _OrthancPluginCreateJob2; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6985 |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6986 /** |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6987 * @brief Create a custom job. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6988 * |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6989 * This function creates a custom job to be run by the jobs engine |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6990 * of Orthanc. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6991 * |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6992 * Orthanc starts one dedicated thread per custom job that is |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6993 * running. It is guaranteed that all the callbacks will only be |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6994 * called from this single dedicated thread, in mutual exclusion: As |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6995 * a consequence, it is *not* mandatory to protect the various |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6996 * callbacks by mutexes. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6997 * |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6998 * The custom job can nonetheless launch its own processing threads |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
6999 * on the first call to the "step()" callback, and stop them once |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7000 * the "stop()" callback is called. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7001 * |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7002 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7003 * @param job The job to be executed. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7004 * @param finalize The finalization callback. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7005 * @param type The type of the job, provided to the job unserializer. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7006 * See OrthancPluginRegisterJobsUnserializer(). |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7007 * @param getProgress The progress callback. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7008 * @param getContent The content callback. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7009 * @param getSerialized The serialization callback. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7010 * @param step The callback to execute the individual steps of the job. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7011 * @param stop The callback that is invoked once the job leaves the "running" state. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7012 * @param reset The callback that is invoked if a stopped job is started again. |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7013 * @return The newly allocated job. It must be freed with OrthancPluginFreeJob(), |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7014 * as long as it is not submitted with OrthancPluginSubmitJob(). |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7015 * @ingroup Toolbox |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7016 **/ |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7017 ORTHANC_PLUGIN_INLINE OrthancPluginJob *OrthancPluginCreateJob2( |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7018 OrthancPluginContext *context, |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7019 void *job, |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7020 OrthancPluginJobFinalize finalize, |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7021 const char *type, |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7022 OrthancPluginJobGetProgress getProgress, |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7023 OrthancPluginJobGetContent2 getContent, |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7024 OrthancPluginJobGetSerialized2 getSerialized, |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7025 OrthancPluginJobStep step, |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7026 OrthancPluginJobStop stop, |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7027 OrthancPluginJobReset reset) |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7028 { |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7029 OrthancPluginJob* target = NULL; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7030 |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7031 _OrthancPluginCreateJob2 params; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7032 memset(¶ms, 0, sizeof(params)); |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7033 |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7034 params.target = ⌖ |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7035 params.job = job; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7036 params.finalize = finalize; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7037 params.type = type; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7038 params.getProgress = getProgress; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7039 params.getContent = getContent; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7040 params.getSerialized = getSerialized; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7041 params.step = step; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7042 params.stop = stop; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7043 params.reset = reset; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7044 |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7045 if (context->InvokeService(context, _OrthancPluginService_CreateJob2, ¶ms) != OrthancPluginErrorCode_Success || |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7046 target == NULL) |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7047 { |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7048 /* Error */ |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7049 return NULL; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7050 } |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7051 else |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7052 { |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7053 return target; |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7054 } |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7055 } |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7056 |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7057 |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7058 typedef struct |
|
d00db9fb48fb
added OrthancPluginCreateJob2() in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5078
diff
changeset
|
7059 { |
|
2815
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7060 OrthancPluginJob* job; |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7061 } _OrthancPluginFreeJob; |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7062 |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7063 /** |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7064 * @brief Free a custom job. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7065 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7066 * This function frees an image that was created with OrthancPluginCreateJob(). |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7067 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7068 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7069 * @param job The job. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7070 * @ingroup Toolbox |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7071 **/ |
|
2815
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7072 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeJob( |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7073 OrthancPluginContext* context, |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7074 OrthancPluginJob* job) |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7075 { |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7076 _OrthancPluginFreeJob params; |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7077 params.job = job; |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7078 |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7079 context->InvokeService(context, _OrthancPluginService_FreeJob, ¶ms); |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7080 } |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7081 |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7082 |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7083 |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7084 typedef struct |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7085 { |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7086 char** resultId; |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7087 OrthancPluginJob *job; |
|
5389
0e5e675b9750
replaced "int" by "int32_t" in the SDK to prevent any ABI issue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5383
diff
changeset
|
7088 int32_t priority; |
|
2815
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7089 } _OrthancPluginSubmitJob; |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7090 |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7091 /** |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7092 * @brief Submit a new job to the jobs engine of Orthanc. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7093 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7094 * This function adds the given job to the pending jobs of |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7095 * Orthanc. Orthanc will take take of freeing it by invoking the |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7096 * finalization callback provided to OrthancPluginCreateJob(). |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7097 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7098 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7099 * @param job The job, as received by OrthancPluginCreateJob(). |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7100 * @param priority The priority of the job. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7101 * @return ID of the newly-submitted job. This string must be freed by OrthancPluginFreeString(). |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7102 * @ingroup Toolbox |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7103 **/ |
|
2815
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7104 ORTHANC_PLUGIN_INLINE char *OrthancPluginSubmitJob( |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7105 OrthancPluginContext *context, |
|
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7106 OrthancPluginJob *job, |
|
5389
0e5e675b9750
replaced "int" by "int32_t" in the SDK to prevent any ABI issue
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5383
diff
changeset
|
7107 int32_t priority) |
|
2815
925d8dc03a23
unserialization of jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2814
diff
changeset
|
7108 { |
|
2808
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7109 char* resultId = NULL; |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7110 |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7111 _OrthancPluginSubmitJob params; |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7112 memset(¶ms, 0, sizeof(params)); |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7113 |
|
2814
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
7114 params.resultId = &resultId; |
|
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
7115 params.job = job; |
|
7d1d3136f6cf
more generic handling of content and serialization in plugin jobs
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2812
diff
changeset
|
7116 params.priority = priority; |
|
2808
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7117 |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7118 if (context->InvokeService(context, _OrthancPluginService_SubmitJob, ¶ms) != OrthancPluginErrorCode_Success || |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7119 resultId == NULL) |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7120 { |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7121 /* Error */ |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7122 return NULL; |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7123 } |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7124 else |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7125 { |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7126 return resultId; |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7127 } |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7128 } |
|
2799
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
7129 |
|
6e3a60b85da6
New primitives to access Orthanc peers from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2719
diff
changeset
|
7130 |
|
2808
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7131 |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7132 typedef struct |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7133 { |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7134 OrthancPluginJobsUnserializer unserializer; |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7135 } _OrthancPluginJobsUnserializer; |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7136 |
|
2818
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7137 /** |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7138 * @brief Register an unserializer for custom jobs. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7139 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7140 * This function registers an unserializer that decodes custom jobs |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7141 * from a JSON string. This callback is invoked when the jobs engine |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7142 * of Orthanc is started (on Orthanc initialization), for each job |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7143 * that is stored in the Orthanc database. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7144 * |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7145 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7146 * @param unserializer The job unserializer. |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7147 * @ingroup Callbacks |
|
a47938d99dfa
documentation of the jobs SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2815
diff
changeset
|
7148 **/ |
|
2808
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7149 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterJobsUnserializer( |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7150 OrthancPluginContext* context, |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7151 OrthancPluginJobsUnserializer unserializer) |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7152 { |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7153 _OrthancPluginJobsUnserializer params; |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7154 params.unserializer = unserializer; |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7155 |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7156 context->InvokeService(context, _OrthancPluginService_RegisterJobsUnserializer, ¶ms); |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7157 } |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7158 |
|
37583cd183ed
primitives to create jobs from plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2802
diff
changeset
|
7159 |
|
2957
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7160 |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7161 typedef struct |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7162 { |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7163 OrthancPluginRestOutput* output; |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7164 const char* details; |
|
2960
74a5a7fd6e0e
log flag to OrthancPluginSetHttpErrorDetails
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2957
diff
changeset
|
7165 uint8_t log; |
|
2957
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7166 } _OrthancPluginSetHttpErrorDetails; |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7167 |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7168 /** |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7169 * @brief Provide a detailed description for an HTTP error. |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7170 * |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7171 * This function sets the detailed description associated with an |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7172 * HTTP error. This description will be displayed in the "Details" |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7173 * field of the JSON body of the HTTP answer. It is only taken into |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7174 * consideration if the REST callback returns an error code that is |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7175 * different from "OrthancPluginErrorCode_Success", and if the |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7176 * "HttpDescribeErrors" configuration option of Orthanc is set to |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7177 * "true". |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7178 * |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7179 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7180 * @param output The HTTP connection to the client application. |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7181 * @param details The details of the error message. |
|
2960
74a5a7fd6e0e
log flag to OrthancPluginSetHttpErrorDetails
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2957
diff
changeset
|
7182 * @param log Whether to also write the detailed error to the Orthanc logs. |
|
2957
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7183 * @ingroup REST |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7184 **/ |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7185 ORTHANC_PLUGIN_INLINE void OrthancPluginSetHttpErrorDetails( |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7186 OrthancPluginContext* context, |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7187 OrthancPluginRestOutput* output, |
|
2960
74a5a7fd6e0e
log flag to OrthancPluginSetHttpErrorDetails
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2957
diff
changeset
|
7188 const char* details, |
|
74a5a7fd6e0e
log flag to OrthancPluginSetHttpErrorDetails
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2957
diff
changeset
|
7189 uint8_t log) |
|
2957
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7190 { |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7191 _OrthancPluginSetHttpErrorDetails params; |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7192 params.output = output; |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7193 params.details = details; |
| 2962 | 7194 params.log = log; |
|
2957
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7195 context->InvokeService(context, _OrthancPluginService_SetHttpErrorDetails, ¶ms); |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7196 } |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7197 |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7198 |
|
ccf61f6e22ef
New function in the SDK: "OrthancPluginSetHttpErrorDetails()"
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2927
diff
changeset
|
7199 |
|
2984
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7200 typedef struct |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7201 { |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7202 const char** result; |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7203 const char* argument; |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7204 } _OrthancPluginRetrieveStaticString; |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7205 |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7206 /** |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7207 * @brief Detect the MIME type of a file. |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7208 * |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7209 * This function returns the MIME type of a file by inspecting its extension. |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7210 * |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7211 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7212 * @param path Path to the file. |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7213 * @return The MIME type. This is a statically-allocated |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7214 * string, do not free it. |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7215 * @ingroup Toolbox |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7216 **/ |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7217 ORTHANC_PLUGIN_INLINE const char* OrthancPluginAutodetectMimeType( |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7218 OrthancPluginContext* context, |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7219 const char* path) |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7220 { |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7221 const char* result = NULL; |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7222 |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7223 _OrthancPluginRetrieveStaticString params; |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7224 params.result = &result; |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7225 params.argument = path; |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7226 |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7227 if (context->InvokeService(context, _OrthancPluginService_AutodetectMimeType, ¶ms) != OrthancPluginErrorCode_Success) |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7228 { |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7229 /* Error */ |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7230 return NULL; |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7231 } |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7232 else |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7233 { |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7234 return result; |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7235 } |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7236 } |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7237 |
|
db8f360fcb41
OrthancPluginAutodetectMimeType()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
2962
diff
changeset
|
7238 |
|
3179
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7239 |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7240 typedef struct |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7241 { |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7242 const char* name; |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7243 float value; |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7244 OrthancPluginMetricsType type; |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7245 } _OrthancPluginSetMetricsValue; |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7246 |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7247 /** |
|
5326
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
7248 * @brief Set the value of a floating-point metrics. |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
7249 * |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
7250 * This function sets the value of a floating-point metrics to |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
7251 * monitor the behavior of the plugin through tools such as |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
7252 * Prometheus. The values of all the metrics are stored within the |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
7253 * Orthanc context. |
|
3179
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7254 * |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7255 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7256 * @param name The name of the metrics to be set. |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7257 * @param value The value of the metrics. |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7258 * @param type The type of the metrics. This parameter is only taken into consideration |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7259 * the first time this metrics is set. |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7260 * @ingroup Toolbox |
|
5326
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
7261 * @see OrthancPluginSetMetricsIntegerValue() |
|
3179
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7262 **/ |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7263 ORTHANC_PLUGIN_INLINE void OrthancPluginSetMetricsValue( |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7264 OrthancPluginContext* context, |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7265 const char* name, |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7266 float value, |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7267 OrthancPluginMetricsType type) |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7268 { |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7269 _OrthancPluginSetMetricsValue params; |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7270 params.name = name; |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7271 params.value = value; |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7272 params.type = type; |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7273 context->InvokeService(context, _OrthancPluginService_SetMetricsValue, ¶ms); |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7274 } |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7275 |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7276 |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7277 |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7278 typedef struct |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7279 { |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7280 OrthancPluginRefreshMetricsCallback callback; |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7281 } _OrthancPluginRegisterRefreshMetricsCallback; |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7282 |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7283 /** |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7284 * @brief Register a callback to refresh the metrics. |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7285 * |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7286 * This function registers a callback to refresh the metrics. The |
|
5326
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
7287 * callback must make calls to OrthancPluginSetMetricsValue() or |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
7288 * OrthancPluginSetMetricsIntegerValue(). |
|
3179
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7289 * |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7290 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7291 * @param callback The callback function to handle the refresh. |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7292 * @ingroup Callbacks |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7293 **/ |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7294 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterRefreshMetricsCallback( |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7295 OrthancPluginContext* context, |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7296 OrthancPluginRefreshMetricsCallback callback) |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7297 { |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7298 _OrthancPluginRegisterRefreshMetricsCallback params; |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7299 params.callback = callback; |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7300 context->InvokeService(context, _OrthancPluginService_RegisterRefreshMetricsCallback, ¶ms); |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7301 } |
|
fca730c267d7
New primitives to set and refresh metrics
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3074
diff
changeset
|
7302 |
|
3205
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7303 |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7304 |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7305 |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7306 typedef struct |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7307 { |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7308 char** target; |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7309 const void* dicom; |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7310 uint32_t dicomSize; |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7311 OrthancPluginDicomWebBinaryCallback callback; |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7312 } _OrthancPluginEncodeDicomWeb; |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7313 |
|
3209
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7314 /** |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7315 * @brief Convert a DICOM instance to DICOMweb JSON. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7316 * |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7317 * This function converts a memory buffer containing a DICOM instance, |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7318 * into its DICOMweb JSON representation. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7319 * |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7320 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7321 * @param dicom Pointer to the DICOM instance. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7322 * @param dicomSize Size of the DICOM instance. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7323 * @param callback Callback to set the value of the binary tags. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7324 * @see OrthancPluginCreateDicom() |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7325 * @return The NULL value in case of error, or the JSON document. This string must |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7326 * be freed by OrthancPluginFreeString(). |
|
3924
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7327 * @deprecated OrthancPluginEncodeDicomWebJson2() |
|
3209
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7328 * @ingroup Toolbox |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7329 **/ |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
7330 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE char* OrthancPluginEncodeDicomWebJson( |
|
3205
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7331 OrthancPluginContext* context, |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7332 const void* dicom, |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7333 uint32_t dicomSize, |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7334 OrthancPluginDicomWebBinaryCallback callback) |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7335 { |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7336 char* target = NULL; |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7337 |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7338 _OrthancPluginEncodeDicomWeb params; |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7339 params.target = ⌖ |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7340 params.dicom = dicom; |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7341 params.dicomSize = dicomSize; |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7342 params.callback = callback; |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7343 |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7344 if (context->InvokeService(context, _OrthancPluginService_EncodeDicomWebJson, ¶ms) != OrthancPluginErrorCode_Success) |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7345 { |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7346 /* Error */ |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7347 return NULL; |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7348 } |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7349 else |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7350 { |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7351 return target; |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7352 } |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7353 } |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7354 |
|
3209
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7355 |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7356 /** |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7357 * @brief Convert a DICOM instance to DICOMweb XML. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7358 * |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7359 * This function converts a memory buffer containing a DICOM instance, |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7360 * into its DICOMweb XML representation. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7361 * |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7362 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7363 * @param dicom Pointer to the DICOM instance. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7364 * @param dicomSize Size of the DICOM instance. |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7365 * @param callback Callback to set the value of the binary tags. |
|
3937
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
7366 * @return The NULL value in case of error, or the XML document. This string must |
|
3209
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7367 * be freed by OrthancPluginFreeString(). |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7368 * @see OrthancPluginCreateDicom() |
|
3924
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7369 * @deprecated OrthancPluginEncodeDicomWebXml2() |
|
3209
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7370 * @ingroup Toolbox |
|
f6374c36a671
documentation of DICOMweb in SDK, compatibility with DCMTK 3.6.0
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3206
diff
changeset
|
7371 **/ |
|
5537
a85e49dcb63e
added ORTHANC_PLUGIN_DEPRECATED in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5499
diff
changeset
|
7372 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE char* OrthancPluginEncodeDicomWebXml( |
|
3205
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7373 OrthancPluginContext* context, |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7374 const void* dicom, |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7375 uint32_t dicomSize, |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7376 OrthancPluginDicomWebBinaryCallback callback) |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7377 { |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7378 char* target = NULL; |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7379 |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7380 _OrthancPluginEncodeDicomWeb params; |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7381 params.target = ⌖ |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7382 params.dicom = dicom; |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7383 params.dicomSize = dicomSize; |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7384 params.callback = callback; |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7385 |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7386 if (context->InvokeService(context, _OrthancPluginService_EncodeDicomWebXml, ¶ms) != OrthancPluginErrorCode_Success) |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7387 { |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7388 /* Error */ |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7389 return NULL; |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7390 } |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7391 else |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7392 { |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7393 return target; |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7394 } |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7395 } |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7396 |
|
6c86d4d407da
new in plugin sdk: OrthancPluginEncodeDicomWebJson() and OrthancPluginEncodeDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3179
diff
changeset
|
7397 |
|
3387
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7398 |
|
3924
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7399 typedef struct |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7400 { |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7401 char** target; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7402 const void* dicom; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7403 uint32_t dicomSize; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7404 OrthancPluginDicomWebBinaryCallback2 callback; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7405 void* payload; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7406 } _OrthancPluginEncodeDicomWeb2; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7407 |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7408 /** |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7409 * @brief Convert a DICOM instance to DICOMweb JSON. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7410 * |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7411 * This function converts a memory buffer containing a DICOM instance, |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7412 * into its DICOMweb JSON representation. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7413 * |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7414 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7415 * @param dicom Pointer to the DICOM instance. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7416 * @param dicomSize Size of the DICOM instance. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7417 * @param callback Callback to set the value of the binary tags. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7418 * @param payload User payload. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7419 * @return The NULL value in case of error, or the JSON document. This string must |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7420 * be freed by OrthancPluginFreeString(). |
|
3937
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
7421 * @see OrthancPluginCreateDicom() |
|
3924
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7422 * @ingroup Toolbox |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7423 **/ |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7424 ORTHANC_PLUGIN_INLINE char* OrthancPluginEncodeDicomWebJson2( |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7425 OrthancPluginContext* context, |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7426 const void* dicom, |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7427 uint32_t dicomSize, |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7428 OrthancPluginDicomWebBinaryCallback2 callback, |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7429 void* payload) |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7430 { |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7431 char* target = NULL; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7432 |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7433 _OrthancPluginEncodeDicomWeb2 params; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7434 params.target = ⌖ |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7435 params.dicom = dicom; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7436 params.dicomSize = dicomSize; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7437 params.callback = callback; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7438 params.payload = payload; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7439 |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7440 if (context->InvokeService(context, _OrthancPluginService_EncodeDicomWebJson2, ¶ms) != OrthancPluginErrorCode_Success) |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7441 { |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7442 /* Error */ |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7443 return NULL; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7444 } |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7445 else |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7446 { |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7447 return target; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7448 } |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7449 } |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7450 |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7451 |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7452 /** |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7453 * @brief Convert a DICOM instance to DICOMweb XML. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7454 * |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7455 * This function converts a memory buffer containing a DICOM instance, |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7456 * into its DICOMweb XML representation. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7457 * |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7458 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7459 * @param dicom Pointer to the DICOM instance. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7460 * @param dicomSize Size of the DICOM instance. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7461 * @param callback Callback to set the value of the binary tags. |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7462 * @param payload User payload. |
|
3937
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
7463 * @return The NULL value in case of error, or the XML document. This string must |
|
3924
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7464 * be freed by OrthancPluginFreeString(). |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7465 * @see OrthancPluginCreateDicom() |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7466 * @ingroup Toolbox |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7467 **/ |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7468 ORTHANC_PLUGIN_INLINE char* OrthancPluginEncodeDicomWebXml2( |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7469 OrthancPluginContext* context, |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7470 const void* dicom, |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7471 uint32_t dicomSize, |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7472 OrthancPluginDicomWebBinaryCallback2 callback, |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7473 void* payload) |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7474 { |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7475 char* target = NULL; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7476 |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7477 _OrthancPluginEncodeDicomWeb2 params; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7478 params.target = ⌖ |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7479 params.dicom = dicom; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7480 params.dicomSize = dicomSize; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7481 params.callback = callback; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7482 params.payload = payload; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7483 |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7484 if (context->InvokeService(context, _OrthancPluginService_EncodeDicomWebXml2, ¶ms) != OrthancPluginErrorCode_Success) |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7485 { |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7486 /* Error */ |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7487 return NULL; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7488 } |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7489 else |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7490 { |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7491 return target; |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7492 } |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7493 } |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7494 |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7495 |
|
395c59208f10
new functions in SDK: OrthancPluginEncodeDicomWebJson2() and OrthancPluginEncodeDicomWebXml2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3919
diff
changeset
|
7496 |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7497 /** |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7498 * @brief Callback executed when a HTTP header is received during a chunked transfer. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7499 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7500 * Signature of a callback function that is called by Orthanc acting |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7501 * as a HTTP client during a chunked HTTP transfer, as soon as it |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7502 * receives one HTTP header from the answer of the remote HTTP |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7503 * server. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7504 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7505 * @see OrthancPluginChunkedHttpClient() |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7506 * @param answer The user payload, as provided by the calling plugin. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7507 * @param key The key of the HTTP header. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7508 * @param value The value of the HTTP header. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7509 * @return 0 if success, or the error code if failure. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7510 * @ingroup Toolbox |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7511 **/ |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7512 typedef OrthancPluginErrorCode (*OrthancPluginChunkedClientAnswerAddHeader) ( |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7513 void* answer, |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7514 const char* key, |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7515 const char* value); |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7516 |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7517 |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7518 /** |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7519 * @brief Callback executed when an answer chunk is received during a chunked transfer. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7520 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7521 * Signature of a callback function that is called by Orthanc acting |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7522 * as a HTTP client during a chunked HTTP transfer, as soon as it |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7523 * receives one data chunk from the answer of the remote HTTP |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7524 * server. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7525 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7526 * @see OrthancPluginChunkedHttpClient() |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7527 * @param answer The user payload, as provided by the calling plugin. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7528 * @param data The content of the data chunk. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7529 * @param size The size of the data chunk. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7530 * @return 0 if success, or the error code if failure. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7531 * @ingroup Toolbox |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7532 **/ |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7533 typedef OrthancPluginErrorCode (*OrthancPluginChunkedClientAnswerAddChunk) ( |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7534 void* answer, |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7535 const void* data, |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7536 uint32_t size); |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7537 |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7538 |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7539 /** |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7540 * @brief Callback to know whether the request body is entirely read during a chunked transfer |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7541 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7542 * Signature of a callback function that is called by Orthanc acting |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7543 * as a HTTP client during a chunked HTTP transfer, while reading |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7544 * the body of a POST or PUT request. The plugin must answer "1" as |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7545 * soon as the body is entirely read: The "request" data structure |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7546 * must act as an iterator. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7547 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7548 * @see OrthancPluginChunkedHttpClient() |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7549 * @param request The user payload, as provided by the calling plugin. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7550 * @return "1" if the body is over, or "0" if there is still data to be read. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7551 * @ingroup Toolbox |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7552 **/ |
| 3414 | 7553 typedef uint8_t (*OrthancPluginChunkedClientRequestIsDone) (void* request); |
| 7554 | |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7555 |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7556 /** |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7557 * @brief Callback to advance in the request body during a chunked transfer |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7558 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7559 * Signature of a callback function that is called by Orthanc acting |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7560 * as a HTTP client during a chunked HTTP transfer, while reading |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7561 * the body of a POST or PUT request. This function asks the plugin |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7562 * to advance to the next chunk of data of the request body: The |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7563 * "request" data structure must act as an iterator. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7564 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7565 * @see OrthancPluginChunkedHttpClient() |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7566 * @param request The user payload, as provided by the calling plugin. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7567 * @return 0 if success, or the error code if failure. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7568 * @ingroup Toolbox |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7569 **/ |
| 3414 | 7570 typedef OrthancPluginErrorCode (*OrthancPluginChunkedClientRequestNext) (void* request); |
| 7571 | |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7572 |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7573 /** |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7574 * @brief Callback to read the current chunk of the request body during a chunked transfer |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7575 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7576 * Signature of a callback function that is called by Orthanc acting |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7577 * as a HTTP client during a chunked HTTP transfer, while reading |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7578 * the body of a POST or PUT request. The plugin must provide the |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7579 * content of the current chunk of data of the request body. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7580 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7581 * @see OrthancPluginChunkedHttpClient() |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7582 * @param request The user payload, as provided by the calling plugin. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7583 * @return The content of the current request chunk. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7584 * @ingroup Toolbox |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7585 **/ |
| 3414 | 7586 typedef const void* (*OrthancPluginChunkedClientRequestGetChunkData) (void* request); |
| 7587 | |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7588 |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7589 /** |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7590 * @brief Callback to read the size of the current request chunk during a chunked transfer |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7591 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7592 * Signature of a callback function that is called by Orthanc acting |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7593 * as a HTTP client during a chunked HTTP transfer, while reading |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7594 * the body of a POST or PUT request. The plugin must provide the |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7595 * size of the current chunk of data of the request body. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7596 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7597 * @see OrthancPluginChunkedHttpClient() |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7598 * @param request The user payload, as provided by the calling plugin. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7599 * @return The size of the current request chunk. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7600 * @ingroup Toolbox |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7601 **/ |
| 3414 | 7602 typedef uint32_t (*OrthancPluginChunkedClientRequestGetChunkSize) (void* request); |
|
3387
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7603 |
|
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7604 |
|
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7605 typedef struct |
|
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7606 { |
| 3414 | 7607 void* answer; |
| 7608 OrthancPluginChunkedClientAnswerAddChunk answerAddChunk; | |
| 7609 OrthancPluginChunkedClientAnswerAddHeader answerAddHeader; | |
| 7610 uint16_t* httpStatus; | |
| 7611 OrthancPluginHttpMethod method; | |
| 7612 const char* url; | |
| 7613 uint32_t headersCount; | |
| 7614 const char* const* headersKeys; | |
| 7615 const char* const* headersValues; | |
| 7616 void* request; | |
| 7617 OrthancPluginChunkedClientRequestIsDone requestIsDone; | |
| 7618 OrthancPluginChunkedClientRequestGetChunkData requestChunkData; | |
| 7619 OrthancPluginChunkedClientRequestGetChunkSize requestChunkSize; | |
| 7620 OrthancPluginChunkedClientRequestNext requestNext; | |
| 7621 const char* username; | |
| 7622 const char* password; | |
| 7623 uint32_t timeout; | |
| 7624 const char* certificateFile; | |
| 7625 const char* certificateKeyFile; | |
| 7626 const char* certificateKeyPassword; | |
| 7627 uint8_t pkcs11; | |
| 3413 | 7628 } _OrthancPluginChunkedHttpClient; |
| 7629 | |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7630 |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7631 /** |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7632 * @brief Issue a HTTP call, using chunked HTTP transfers. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7633 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7634 * Make a HTTP call to the given URL using chunked HTTP |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7635 * transfers. The request body is provided as an iterator over data |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7636 * chunks. The answer is provided as a sequence of function calls |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7637 * with the individual HTTP headers and answer chunks. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7638 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7639 * Contrarily to OrthancPluginHttpClient() that entirely stores the |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7640 * request body and the answer body in memory buffers, this function |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7641 * uses chunked HTTP transfers. This results in a lower memory |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7642 * consumption. Pay attention to the fact that Orthanc servers with |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7643 * version <= 1.5.6 do not support chunked transfers: You must use |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7644 * OrthancPluginHttpClient() if contacting such older servers. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7645 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7646 * The HTTP request will be done accordingly to the global |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7647 * configuration of Orthanc (in particular, the options "HttpProxy", |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7648 * "HttpTimeout", "HttpsVerifyPeers", "HttpsCACertificates", and |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7649 * "Pkcs11" will be taken into account). |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7650 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7651 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7652 * @param answer The user payload for the answer body. It will be provided to the callbacks for the answer. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7653 * @param answerAddChunk Callback function to report a data chunk from the answer body. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7654 * @param answerAddHeader Callback function to report an HTTP header sent by the remote server. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7655 * @param httpStatus The HTTP status after the execution of the request (out argument). |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7656 * @param method HTTP method to be used. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7657 * @param url The URL of interest. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7658 * @param headersCount The number of HTTP headers. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7659 * @param headersKeys Array containing the keys of the HTTP headers (can be <tt>NULL</tt> if no header). |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7660 * @param headersValues Array containing the values of the HTTP headers (can be <tt>NULL</tt> if no header). |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7661 * @param request The user payload containing the request body, and acting as an iterator. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7662 * It will be provided to the callbacks for the request. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7663 * @param requestIsDone Callback function to tell whether the request body is entirely read. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7664 * @param requestChunkData Callback function to get the content of the current data chunk of the request body. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7665 * @param requestChunkSize Callback function to get the size of the current data chunk of the request body. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7666 * @param requestNext Callback function to advance to the next data chunk of the request body. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7667 * @param username The username (can be <tt>NULL</tt> if no password protection). |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7668 * @param password The password (can be <tt>NULL</tt> if no password protection). |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7669 * @param timeout Timeout in seconds (0 for default timeout). |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7670 * @param certificateFile Path to the client certificate for HTTPS, in PEM format |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7671 * (can be <tt>NULL</tt> if no client certificate or if not using HTTPS). |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7672 * @param certificateKeyFile Path to the key of the client certificate for HTTPS, in PEM format |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7673 * (can be <tt>NULL</tt> if no client certificate or if not using HTTPS). |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7674 * @param certificateKeyPassword Password to unlock the key of the client certificate |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7675 * (can be <tt>NULL</tt> if no client certificate or if not using HTTPS). |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7676 * @param pkcs11 Enable PKCS#11 client authentication for hardware security modules and smart cards. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7677 * @return 0 if success, or the error code if failure. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7678 * @see OrthancPluginHttpClient() |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7679 * @ingroup Toolbox |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7680 **/ |
| 3413 | 7681 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginChunkedHttpClient( |
| 3414 | 7682 OrthancPluginContext* context, |
| 7683 void* answer, | |
| 7684 OrthancPluginChunkedClientAnswerAddChunk answerAddChunk, | |
| 7685 OrthancPluginChunkedClientAnswerAddHeader answerAddHeader, | |
| 7686 uint16_t* httpStatus, | |
| 7687 OrthancPluginHttpMethod method, | |
| 7688 const char* url, | |
| 7689 uint32_t headersCount, | |
| 7690 const char* const* headersKeys, | |
| 7691 const char* const* headersValues, | |
| 7692 void* request, | |
| 7693 OrthancPluginChunkedClientRequestIsDone requestIsDone, | |
| 7694 OrthancPluginChunkedClientRequestGetChunkData requestChunkData, | |
| 7695 OrthancPluginChunkedClientRequestGetChunkSize requestChunkSize, | |
| 7696 OrthancPluginChunkedClientRequestNext requestNext, | |
| 7697 const char* username, | |
| 7698 const char* password, | |
| 7699 uint32_t timeout, | |
| 7700 const char* certificateFile, | |
| 7701 const char* certificateKeyFile, | |
| 7702 const char* certificateKeyPassword, | |
| 7703 uint8_t pkcs11) | |
| 3413 | 7704 { |
| 7705 _OrthancPluginChunkedHttpClient params; | |
|
3387
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7706 memset(¶ms, 0, sizeof(params)); |
|
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7707 |
|
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7708 /* In common with OrthancPluginHttpClient() */ |
|
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7709 params.httpStatus = httpStatus; |
|
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7710 params.method = method; |
|
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7711 params.url = url; |
|
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7712 params.headersCount = headersCount; |
|
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7713 params.headersKeys = headersKeys; |
|
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7714 params.headersValues = headersValues; |
|
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7715 params.username = username; |
|
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7716 params.password = password; |
|
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7717 params.timeout = timeout; |
|
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7718 params.certificateFile = certificateFile; |
|
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7719 params.certificateKeyFile = certificateKeyFile; |
|
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7720 params.certificateKeyPassword = certificateKeyPassword; |
|
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7721 params.pkcs11 = pkcs11; |
|
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7722 |
| 3413 | 7723 /* For chunked body/answer */ |
|
3393
2cd0369a156f
support of chunked answers in HttpClient and in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3392
diff
changeset
|
7724 params.answer = answer; |
|
2cd0369a156f
support of chunked answers in HttpClient and in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3392
diff
changeset
|
7725 params.answerAddChunk = answerAddChunk; |
|
2cd0369a156f
support of chunked answers in HttpClient and in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3392
diff
changeset
|
7726 params.answerAddHeader = answerAddHeader; |
|
2cd0369a156f
support of chunked answers in HttpClient and in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3392
diff
changeset
|
7727 params.request = request; |
|
2cd0369a156f
support of chunked answers in HttpClient and in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3392
diff
changeset
|
7728 params.requestIsDone = requestIsDone; |
|
2cd0369a156f
support of chunked answers in HttpClient and in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3392
diff
changeset
|
7729 params.requestChunkData = requestChunkData; |
|
2cd0369a156f
support of chunked answers in HttpClient and in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3392
diff
changeset
|
7730 params.requestChunkSize = requestChunkSize; |
|
2cd0369a156f
support of chunked answers in HttpClient and in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3392
diff
changeset
|
7731 params.requestNext = requestNext; |
|
2cd0369a156f
support of chunked answers in HttpClient and in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3392
diff
changeset
|
7732 |
| 3413 | 7733 return context->InvokeService(context, _OrthancPluginService_ChunkedHttpClient, ¶ms); |
|
3387
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7734 } |
|
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7735 |
|
a48d652f1500
new function OrthancPluginHttpClientChunkedBody(), new class OrthancPlugins::HttpClient
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3376
diff
changeset
|
7736 |
|
3396
4981405e6c5c
new sdk: OrthancPluginRegisterMultipartRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3393
diff
changeset
|
7737 |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7738 /** |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7739 * @brief Opaque structure that reads the content of a HTTP request body during a chunked HTTP transfer. |
|
4943
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
7740 * @ingroup Callbacks |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7741 **/ |
| 3414 | 7742 typedef struct _OrthancPluginServerChunkedRequestReader_t OrthancPluginServerChunkedRequestReader; |
| 7743 | |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7744 |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7745 |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7746 /** |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7747 * @brief Callback to create a reader to handle incoming chunked HTTP transfers. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7748 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7749 * Signature of a callback function that is called by Orthanc acting |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7750 * as a HTTP server that supports chunked HTTP transfers. This |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7751 * callback is only invoked if the HTTP method is POST or PUT. The |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7752 * callback must create an user-specific "reader" object that will |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7753 * be fed with the body of the incoming body. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7754 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7755 * @see OrthancPluginRegisterChunkedRestCallback() |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7756 * @param reader Memory location that must be filled with the newly-created reader. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7757 * @param url The URI that is accessed. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7758 * @param request The body of the HTTP request. Note that "body" and "bodySize" are not used. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7759 * @return 0 if success, or the error code if failure. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7760 **/ |
|
3415
2a821deece64
refactoring to handle "not allowed" HTTP status 405
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3414
diff
changeset
|
7761 typedef OrthancPluginErrorCode (*OrthancPluginServerChunkedRequestReaderFactory) ( |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7762 OrthancPluginServerChunkedRequestReader** reader, |
| 3414 | 7763 const char* url, |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7764 const OrthancPluginHttpRequest* request); |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7765 |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7766 |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7767 /** |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7768 * @brief Callback invoked whenever a new data chunk is available during a chunked transfer. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7769 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7770 * Signature of a callback function that is called by Orthanc acting |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7771 * as a HTTP server that supports chunked HTTP transfers. This callback |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7772 * is invoked as soon as a new data chunk is available for the request body. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7773 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7774 * @see OrthancPluginRegisterChunkedRestCallback() |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7775 * @param reader The user payload, as created by the OrthancPluginServerChunkedRequestReaderFactory() callback. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7776 * @param data The content of the data chunk. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7777 * @param size The size of the data chunk. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7778 * @return 0 if success, or the error code if failure. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7779 **/ |
| 3414 | 7780 typedef OrthancPluginErrorCode (*OrthancPluginServerChunkedRequestReaderAddChunk) ( |
| 7781 OrthancPluginServerChunkedRequestReader* reader, | |
| 7782 const void* data, | |
| 7783 uint32_t size); | |
|
3396
4981405e6c5c
new sdk: OrthancPluginRegisterMultipartRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3393
diff
changeset
|
7784 |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7785 |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7786 /** |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7787 * @brief Callback invoked whenever the request body is entirely received. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7788 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7789 * Signature of a callback function that is called by Orthanc acting |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7790 * as a HTTP server that supports chunked HTTP transfers. This |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7791 * callback is invoked as soon as the full body of the HTTP request |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7792 * is available. The plugin can then send its answer thanks to the |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7793 * provided "output" object. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7794 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7795 * @see OrthancPluginRegisterChunkedRestCallback() |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7796 * @param reader The user payload, as created by the OrthancPluginServerChunkedRequestReaderFactory() callback. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7797 * @param output The HTTP connection to the client application. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7798 * @return 0 if success, or the error code if failure. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7799 **/ |
| 3414 | 7800 typedef OrthancPluginErrorCode (*OrthancPluginServerChunkedRequestReaderExecute) ( |
| 7801 OrthancPluginServerChunkedRequestReader* reader, | |
| 7802 OrthancPluginRestOutput* output); | |
| 7803 | |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7804 |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7805 /** |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7806 * @brief Callback invoked to release the resources associated with an incoming HTTP chunked transfer. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7807 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7808 * Signature of a callback function that is called by Orthanc acting |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7809 * as a HTTP server that supports chunked HTTP transfers. This |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7810 * callback is invoked to release all the resources allocated by the |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7811 * given reader. Note that this function might be invoked even if |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7812 * the entire body was not read, to deal with client error or |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7813 * disconnection. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7814 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7815 * @see OrthancPluginRegisterChunkedRestCallback() |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7816 * @param reader The user payload, as created by the OrthancPluginServerChunkedRequestReaderFactory() callback. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7817 **/ |
| 3414 | 7818 typedef void (*OrthancPluginServerChunkedRequestReaderFinalize) ( |
| 7819 OrthancPluginServerChunkedRequestReader* reader); | |
|
3396
4981405e6c5c
new sdk: OrthancPluginRegisterMultipartRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3393
diff
changeset
|
7820 |
|
4981405e6c5c
new sdk: OrthancPluginRegisterMultipartRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3393
diff
changeset
|
7821 typedef struct |
|
4981405e6c5c
new sdk: OrthancPluginRegisterMultipartRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3393
diff
changeset
|
7822 { |
| 3414 | 7823 const char* pathRegularExpression; |
|
3415
2a821deece64
refactoring to handle "not allowed" HTTP status 405
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3414
diff
changeset
|
7824 OrthancPluginRestCallback getHandler; |
|
2a821deece64
refactoring to handle "not allowed" HTTP status 405
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3414
diff
changeset
|
7825 OrthancPluginServerChunkedRequestReaderFactory postHandler; |
|
2a821deece64
refactoring to handle "not allowed" HTTP status 405
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3414
diff
changeset
|
7826 OrthancPluginRestCallback deleteHandler; |
|
2a821deece64
refactoring to handle "not allowed" HTTP status 405
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3414
diff
changeset
|
7827 OrthancPluginServerChunkedRequestReaderFactory putHandler; |
| 3414 | 7828 OrthancPluginServerChunkedRequestReaderAddChunk addChunk; |
| 7829 OrthancPluginServerChunkedRequestReaderExecute execute; | |
| 7830 OrthancPluginServerChunkedRequestReaderFinalize finalize; | |
| 7831 } _OrthancPluginChunkedRestCallback; | |
| 7832 | |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7833 |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7834 /** |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7835 * @brief Register a REST callback to handle chunked HTTP transfers. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7836 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7837 * This function registers a REST callback against a regular |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7838 * expression for a URI. This function must be called during the |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7839 * initialization of the plugin, i.e. inside the |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7840 * OrthancPluginInitialize() public function. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7841 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7842 * Contrarily to OrthancPluginRegisterRestCallback(), the callbacks |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7843 * will NOT be invoked in mutual exclusion, so it is up to the |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7844 * plugin to implement the required locking mechanisms. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7845 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7846 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7847 * @param pathRegularExpression Regular expression for the URI. May contain groups. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7848 * @param getHandler The callback function to handle REST calls using the GET HTTP method. |
| 4754 | 7849 * @param postHandler The callback function to handle REST calls using the POST HTTP method. |
| 7850 * @param deleteHandler The callback function to handle REST calls using the DELETE HTTP method. | |
| 7851 * @param putHandler The callback function to handle REST calls using the PUT HTTP method. | |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7852 * @param addChunk The callback invoked when a new chunk is available for the request body of a POST or PUT call. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7853 * @param execute The callback invoked once the entire body of a POST or PUT call is read. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7854 * @param finalize The callback invoked to release the resources associated with a POST or PUT call. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7855 * @see OrthancPluginRegisterRestCallbackNoLock() |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7856 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7857 * @note |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7858 * The regular expression is case sensitive and must follow the |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7859 * [Perl syntax](https://www.boost.org/doc/libs/1_67_0/libs/regex/doc/html/boost_regex/syntax/perl_syntax.html). |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7860 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7861 * @ingroup Callbacks |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7862 **/ |
| 3414 | 7863 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterChunkedRestCallback( |
| 7864 OrthancPluginContext* context, | |
| 7865 const char* pathRegularExpression, | |
|
3415
2a821deece64
refactoring to handle "not allowed" HTTP status 405
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3414
diff
changeset
|
7866 OrthancPluginRestCallback getHandler, |
|
2a821deece64
refactoring to handle "not allowed" HTTP status 405
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3414
diff
changeset
|
7867 OrthancPluginServerChunkedRequestReaderFactory postHandler, |
|
2a821deece64
refactoring to handle "not allowed" HTTP status 405
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3414
diff
changeset
|
7868 OrthancPluginRestCallback deleteHandler, |
|
2a821deece64
refactoring to handle "not allowed" HTTP status 405
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3414
diff
changeset
|
7869 OrthancPluginServerChunkedRequestReaderFactory putHandler, |
| 3414 | 7870 OrthancPluginServerChunkedRequestReaderAddChunk addChunk, |
| 7871 OrthancPluginServerChunkedRequestReaderExecute execute, | |
| 7872 OrthancPluginServerChunkedRequestReaderFinalize finalize) | |
| 7873 { | |
| 7874 _OrthancPluginChunkedRestCallback params; | |
|
3396
4981405e6c5c
new sdk: OrthancPluginRegisterMultipartRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3393
diff
changeset
|
7875 params.pathRegularExpression = pathRegularExpression; |
|
3415
2a821deece64
refactoring to handle "not allowed" HTTP status 405
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3414
diff
changeset
|
7876 params.getHandler = getHandler; |
|
2a821deece64
refactoring to handle "not allowed" HTTP status 405
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3414
diff
changeset
|
7877 params.postHandler = postHandler; |
|
2a821deece64
refactoring to handle "not allowed" HTTP status 405
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3414
diff
changeset
|
7878 params.deleteHandler = deleteHandler; |
|
2a821deece64
refactoring to handle "not allowed" HTTP status 405
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3414
diff
changeset
|
7879 params.putHandler = putHandler; |
| 3414 | 7880 params.addChunk = addChunk; |
|
3396
4981405e6c5c
new sdk: OrthancPluginRegisterMultipartRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3393
diff
changeset
|
7881 params.execute = execute; |
|
4981405e6c5c
new sdk: OrthancPluginRegisterMultipartRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3393
diff
changeset
|
7882 params.finalize = finalize; |
|
4981405e6c5c
new sdk: OrthancPluginRegisterMultipartRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3393
diff
changeset
|
7883 |
| 3414 | 7884 context->InvokeService(context, _OrthancPluginService_RegisterChunkedRestCallback, ¶ms); |
|
3396
4981405e6c5c
new sdk: OrthancPluginRegisterMultipartRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3393
diff
changeset
|
7885 } |
|
4981405e6c5c
new sdk: OrthancPluginRegisterMultipartRestCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3393
diff
changeset
|
7886 |
|
3429
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7887 |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7888 |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7889 |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7890 |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7891 typedef struct |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7892 { |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7893 char** result; |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7894 uint16_t group; |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7895 uint16_t element; |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7896 const char* privateCreator; |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7897 } _OrthancPluginGetTagName; |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7898 |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7899 /** |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7900 * @brief Returns the symbolic name of a DICOM tag. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7901 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7902 * This function makes a lookup to the dictionary of DICOM tags that |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7903 * are known to Orthanc, and returns the symbolic name of a DICOM tag. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7904 * |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7905 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7906 * @param group The group of the tag. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7907 * @param element The element of the tag. |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7908 * @param privateCreator For private tags, the name of the private creator (can be NULL). |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7909 * @return NULL in the case of an error, or a newly allocated string |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7910 * containing the path. This string must be freed by |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7911 * OrthancPluginFreeString(). |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7912 * @ingroup Toolbox |
|
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7913 **/ |
|
3429
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7914 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetTagName( |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7915 OrthancPluginContext* context, |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7916 uint16_t group, |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7917 uint16_t element, |
|
3447
d30668b1a44a
commenting new functions in SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3429
diff
changeset
|
7918 const char* privateCreator) |
|
3429
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7919 { |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7920 char* result; |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7921 |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7922 _OrthancPluginGetTagName params; |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7923 params.result = &result; |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7924 params.group = group; |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7925 params.element = element; |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7926 params.privateCreator = privateCreator; |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7927 |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7928 if (context->InvokeService(context, _OrthancPluginService_GetTagName, ¶ms) != OrthancPluginErrorCode_Success) |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7929 { |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7930 /* Error */ |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7931 return NULL; |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7932 } |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7933 else |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7934 { |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7935 return result; |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7936 } |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7937 } |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7938 |
|
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
7939 |
|
3662
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
7940 |
|
3707
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7941 /** |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7942 * @brief Callback executed by the storage commitment SCP. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7943 * |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7944 * Signature of a factory function that creates an object to handle |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7945 * one incoming storage commitment request. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7946 * |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7947 * @remark The factory receives the list of the SOP class/instance |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7948 * UIDs of interest to the remote storage commitment SCU. This gives |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7949 * the factory the possibility to start some prefetch process |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7950 * upfront in the background, before the handler object is actually |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7951 * queried about the status of these DICOM instances. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7952 * |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7953 * @param handler Output variable where the factory puts the handler object it created. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7954 * @param jobId ID of the Orthanc job that is responsible for handling |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7955 * the storage commitment request. This job will successively look for the |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7956 * status of all the individual queried DICOM instances. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7957 * @param transactionUid UID of the storage commitment transaction |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7958 * provided by the storage commitment SCU. It contains the value of the |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7959 * (0008,1195) DICOM tag. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7960 * @param sopClassUids Array of the SOP class UIDs (0008,0016) that are queried by the SCU. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7961 * @param sopInstanceUids Array of the SOP instance UIDs (0008,0018) that are queried by the SCU. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7962 * @param countInstances Number of DICOM instances that are queried. This is the size |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7963 * of the `sopClassUids` and `sopInstanceUids` arrays. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7964 * @param remoteAet The AET of the storage commitment SCU. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7965 * @param calledAet The AET used by the SCU to contact the storage commitment SCP (i.e. Orthanc). |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7966 * @return 0 if success, other value if error. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7967 * @ingroup DicomCallbacks |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7968 **/ |
|
3665
4c1d2ff7ddd0
handling of errors in storage commitment plugin factory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3664
diff
changeset
|
7969 typedef OrthancPluginErrorCode (*OrthancPluginStorageCommitmentFactory) ( |
|
4c1d2ff7ddd0
handling of errors in storage commitment plugin factory
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3664
diff
changeset
|
7970 void** handler /* out */, |
|
3662
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
7971 const char* jobId, |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
7972 const char* transactionUid, |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
7973 const char* const* sopClassUids, |
|
3664
85acfcc15829
sample storage commitment plugin, C++ wrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3662
diff
changeset
|
7974 const char* const* sopInstanceUids, |
|
3662
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
7975 uint32_t countInstances, |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
7976 const char* remoteAet, |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
7977 const char* calledAet); |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
7978 |
|
3707
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7979 |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7980 /** |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7981 * @brief Callback to free one storage commitment SCP handler. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7982 * |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7983 * Signature of a callback function that releases the resources |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7984 * allocated by the factory of the storage commitment SCP. The |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7985 * handler is the return value of a previous call to the |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7986 * OrthancPluginStorageCommitmentFactory() callback. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7987 * |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7988 * @param handler The handler object to be destructed. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7989 * @ingroup DicomCallbacks |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7990 **/ |
|
3662
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
7991 typedef void (*OrthancPluginStorageCommitmentDestructor) (void* handler); |
|
3707
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7992 |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7993 |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7994 /** |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7995 * @brief Callback to get the status of one DICOM instance in the |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7996 * storage commitment SCP. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7997 * |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7998 * Signature of a callback function that is successively invoked for |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
7999 * each DICOM instance that is queried by the remote storage |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8000 * commitment SCU. The function must be tought of as a method of |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8001 * the handler object that was created by a previous call to the |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8002 * OrthancPluginStorageCommitmentFactory() callback. After each call |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8003 * to this method, the progress of the associated Orthanc job is |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8004 * updated. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8005 * |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8006 * @param target Output variable where to put the status for the queried instance. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8007 * @param handler The handler object associated with this storage commitment request. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8008 * @param sopClassUid The SOP class UID (0008,0016) of interest. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8009 * @param sopInstanceUid The SOP instance UID (0008,0018) of interest. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8010 * @ingroup DicomCallbacks |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8011 **/ |
|
3662
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8012 typedef OrthancPluginErrorCode (*OrthancPluginStorageCommitmentLookup) ( |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8013 OrthancPluginStorageCommitmentFailureReason* target, |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8014 void* handler, |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8015 const char* sopClassUid, |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8016 const char* sopInstanceUid); |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8017 |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8018 |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8019 typedef struct |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8020 { |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8021 OrthancPluginStorageCommitmentFactory factory; |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8022 OrthancPluginStorageCommitmentDestructor destructor; |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8023 OrthancPluginStorageCommitmentLookup lookup; |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8024 } _OrthancPluginRegisterStorageCommitmentScpCallback; |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8025 |
|
3707
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8026 /** |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8027 * @brief Register a callback to handle incoming requests to the storage commitment SCP. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8028 * |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8029 * This function registers a callback to handle storage commitment SCP requests. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8030 * |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8031 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8032 * @param factory Factory function that creates the handler object |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8033 * for incoming storage commitment requests. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8034 * @param destructor Destructor function to destroy the handler object. |
|
4943
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
8035 * @param lookup Callback function to get the status of one DICOM instance. |
|
3707
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8036 * @return 0 if success, other value if error. |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8037 * @ingroup DicomCallbacks |
|
bf8f17f23c26
documentation of the storage commitment plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3665
diff
changeset
|
8038 **/ |
|
3797
d73ce7c537c3
fix signature of OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3791
diff
changeset
|
8039 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterStorageCommitmentScpCallback( |
|
3662
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8040 OrthancPluginContext* context, |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8041 OrthancPluginStorageCommitmentFactory factory, |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8042 OrthancPluginStorageCommitmentDestructor destructor, |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8043 OrthancPluginStorageCommitmentLookup lookup) |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8044 { |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8045 _OrthancPluginRegisterStorageCommitmentScpCallback params; |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8046 params.factory = factory; |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8047 params.destructor = destructor; |
|
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8048 params.lookup = lookup; |
|
3797
d73ce7c537c3
fix signature of OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3791
diff
changeset
|
8049 return context->InvokeService(context, _OrthancPluginService_RegisterStorageCommitmentScpCallback, ¶ms); |
|
3662
d8371b4302ff
OrthancPluginRegisterStorageCommitmentScpCallback()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3641
diff
changeset
|
8050 } |
|
3429
954d15f24366
new function in SDK: OrthancPluginGetTagName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3422
diff
changeset
|
8051 |
|
3846
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8052 |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8053 |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8054 /** |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8055 * @brief Callback to filter incoming DICOM instances received by Orthanc. |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8056 * |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8057 * Signature of a callback function that is triggered whenever |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8058 * Orthanc receives a new DICOM instance (e.g. through REST API or |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8059 * DICOM protocol), and that answers whether this DICOM instance |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8060 * should be accepted or discarded by Orthanc. |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8061 * |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8062 * Note that the metadata information is not available |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8063 * (i.e. GetInstanceMetadata() should not be used on "instance"). |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8064 * |
|
4921
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8065 * @warning Your callback function will be called synchronously with |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8066 * the core of Orthanc. This implies that deadlocks might emerge if |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8067 * you call other core primitives of Orthanc in your callback (such |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8068 * deadlocks are particularly visible in the presence of other plugins |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8069 * or Lua scripts). It is thus strongly advised to avoid any call to |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8070 * the REST API of Orthanc in the callback. If you have to call |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8071 * other primitives of Orthanc, you should make these calls in a |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8072 * separate thread, passing the pending events to be processed |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8073 * through a message queue. |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8074 * |
|
3846
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8075 * @param instance The received DICOM instance. |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8076 * @return 0 to discard the instance, 1 to store the instance, -1 if error. |
|
4943
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
8077 * @ingroup Callbacks |
|
3846
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8078 **/ |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8079 typedef int32_t (*OrthancPluginIncomingDicomInstanceFilter) ( |
|
3847
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
8080 const OrthancPluginDicomInstance* instance); |
|
3846
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8081 |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8082 |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8083 typedef struct |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8084 { |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8085 OrthancPluginIncomingDicomInstanceFilter callback; |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8086 } _OrthancPluginIncomingDicomInstanceFilter; |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8087 |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8088 /** |
|
4179
669f588a14b3
warn about possible deadlocks
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4131
diff
changeset
|
8089 * @brief Register a callback to filter incoming DICOM instances. |
|
3846
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8090 * |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8091 * This function registers a custom callback to filter incoming |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8092 * DICOM instances received by Orthanc (either through the REST API |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8093 * or through the DICOM protocol). |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8094 * |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8095 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8096 * @param callback The callback. |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8097 * @return 0 if success, other value if error. |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8098 * @ingroup Callbacks |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8099 **/ |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8100 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterIncomingDicomInstanceFilter( |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8101 OrthancPluginContext* context, |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8102 OrthancPluginIncomingDicomInstanceFilter callback) |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8103 { |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8104 _OrthancPluginIncomingDicomInstanceFilter params; |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8105 params.callback = callback; |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8106 |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8107 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingDicomInstanceFilter, ¶ms); |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8108 } |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8109 |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8110 |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8111 /** |
|
4796
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8112 * @brief Callback to filter incoming DICOM instances received by |
|
4913
c1b19f95e166
fix signature of OrthancPluginReceivedInstanceCallback for ABI compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4912
diff
changeset
|
8113 * Orthanc through C-STORE. |
|
4796
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8114 * |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8115 * Signature of a callback function that is triggered whenever |
|
4921
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8116 * Orthanc receives a new DICOM instance using DICOM C-STORE, and |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8117 * that answers whether this DICOM instance should be accepted or |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8118 * discarded by Orthanc. If the instance is discarded, the callback |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8119 * can specify the DIMSE error code answered by the Orthanc C-STORE |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8120 * SCP. |
|
4796
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8121 * |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8122 * Note that the metadata information is not available |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8123 * (i.e. GetInstanceMetadata() should not be used on "instance"). |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8124 * |
|
4921
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8125 * @warning Your callback function will be called synchronously with |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8126 * the core of Orthanc. This implies that deadlocks might emerge if |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8127 * you call other core primitives of Orthanc in your callback (such |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8128 * deadlocks are particularly visible in the presence of other plugins |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8129 * or Lua scripts). It is thus strongly advised to avoid any call to |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8130 * the REST API of Orthanc in the callback. If you have to call |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8131 * other primitives of Orthanc, you should make these calls in a |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8132 * separate thread, passing the pending events to be processed |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8133 * through a message queue. |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8134 * |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8135 * @param dimseStatus If the DICOM instance is discarded, |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8136 * DIMSE status to be sent by the C-STORE SCP of Orthanc |
|
4796
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8137 * @param instance The received DICOM instance. |
|
4921
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8138 * @return 0 to discard the instance, 1 to store the instance, -1 if error. |
|
4943
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
8139 * @ingroup Callbacks |
|
4796
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8140 **/ |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8141 typedef int32_t (*OrthancPluginIncomingCStoreInstanceFilter) ( |
|
4921
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8142 uint16_t* dimseStatus /* out */, |
|
4796
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8143 const OrthancPluginDicomInstance* instance); |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8144 |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8145 |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8146 typedef struct |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8147 { |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8148 OrthancPluginIncomingCStoreInstanceFilter callback; |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8149 } _OrthancPluginIncomingCStoreInstanceFilter; |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8150 |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8151 /** |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8152 * @brief Register a callback to filter incoming DICOM instances |
|
4913
c1b19f95e166
fix signature of OrthancPluginReceivedInstanceCallback for ABI compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4912
diff
changeset
|
8153 * received by Orthanc through C-STORE. |
|
4796
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8154 * |
|
4921
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8155 * This function registers a custom callback to filter incoming |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8156 * DICOM instances received by Orthanc through the DICOM protocol. |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8157 * |
|
4796
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8158 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8159 * @param callback The callback. |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8160 * @return 0 if success, other value if error. |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8161 * @ingroup Callbacks |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8162 **/ |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8163 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterIncomingCStoreInstanceFilter( |
|
4921
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8164 OrthancPluginContext* context, |
|
4796
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8165 OrthancPluginIncomingCStoreInstanceFilter callback) |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8166 { |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8167 _OrthancPluginIncomingCStoreInstanceFilter params; |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8168 params.callback = callback; |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8169 |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8170 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingCStoreInstanceFilter, ¶ms); |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8171 } |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8172 |
|
94616af363ec
added ReceivedCStoreInstanceFilter lua callback + OrthancPluginRegisterIncomingCStoreInstanceFilter in sdk
Alain Mazy <am@osimis.io>
parents:
4754
diff
changeset
|
8173 /** |
|
4919
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
8174 * @brief Callback to keep/discard/modify a DICOM instance received |
|
4913
c1b19f95e166
fix signature of OrthancPluginReceivedInstanceCallback for ABI compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4912
diff
changeset
|
8175 * by Orthanc from any source (C-STORE or REST API) |
|
4845
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8176 * |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8177 * Signature of a callback function that is triggered whenever |
|
4919
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
8178 * Orthanc receives a new DICOM instance (through DICOM protocol or |
|
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
8179 * REST API), and that specifies an action to be applied to this |
|
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
8180 * newly received instance. The instance can be kept as it is, can |
|
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
8181 * be modified by the plugin, or can be discarded. |
|
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
8182 * |
|
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
8183 * This callback is invoked immediately after reception, i.e. before |
|
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
8184 * transcoding and before filtering |
|
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
8185 * (cf. OrthancPluginRegisterIncomingDicomInstanceFilter()). |
|
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
8186 * |
|
4921
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8187 * @warning Your callback function will be called synchronously with |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8188 * the core of Orthanc. This implies that deadlocks might emerge if |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8189 * you call other core primitives of Orthanc in your callback (such |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8190 * deadlocks are particularly visible in the presence of other plugins |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8191 * or Lua scripts). It is thus strongly advised to avoid any call to |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8192 * the REST API of Orthanc in the callback. If you have to call |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8193 * other primitives of Orthanc, you should make these calls in a |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8194 * separate thread, passing the pending events to be processed |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8195 * through a message queue. |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8196 * |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8197 * @param modifiedDicomBuffer A buffer containing the modified DICOM (output). |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8198 * This buffer must be allocated using OrthancPluginCreateMemoryBuffer64() |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8199 * and will be freed by the Orthanc core. |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8200 * @param receivedDicomBuffer A buffer containing the received DICOM (input). |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8201 * @param receivedDicomBufferSize The size of the received DICOM (input). |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8202 * @param origin The origin of the DICOM instance (input). |
|
4919
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
8203 * @return `OrthancPluginReceivedInstanceAction_KeepAsIs` to accept the instance as is,<br/> |
|
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
8204 * `OrthancPluginReceivedInstanceAction_Modify` to store the modified DICOM contained in `modifiedDicomBuffer`,<br/> |
|
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
8205 * `OrthancPluginReceivedInstanceAction_Discard` to tell Orthanc to discard the instance. |
|
4943
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
8206 * @ingroup Callbacks |
|
4845
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8207 **/ |
|
4919
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
8208 typedef OrthancPluginReceivedInstanceAction (*OrthancPluginReceivedInstanceCallback) ( |
|
4915
189ae9a37e01
reorder arguments to put the target as first argument (convention)
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4913
diff
changeset
|
8209 OrthancPluginMemoryBuffer64* modifiedDicomBuffer, |
|
4845
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8210 const void* receivedDicomBuffer, |
|
4919
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
8211 uint64_t receivedDicomBufferSize, |
|
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
8212 OrthancPluginInstanceOrigin origin); |
|
4845
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8213 |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8214 |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8215 typedef struct |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8216 { |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8217 OrthancPluginReceivedInstanceCallback callback; |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8218 } _OrthancPluginReceivedInstanceCallback; |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8219 |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8220 /** |
|
4919
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
8221 * @brief Register a callback to keep/discard/modify a DICOM instance received |
|
676e03e69703
added origin in OrthancPluginReceivedInstanceCallback
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4915
diff
changeset
|
8222 * by Orthanc from any source (C-STORE or REST API) |
|
4845
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8223 * |
|
4921
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8224 * This function registers a custom callback to keep/discard/modify |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8225 * incoming DICOM instances received by Orthanc from any source |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8226 * (C-STORE or REST API). |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8227 * |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8228 * @warning Contrarily to |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8229 * OrthancPluginRegisterIncomingCStoreInstanceFilter() and |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8230 * OrthancPluginRegisterIncomingDicomInstanceFilter() that can be |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8231 * called by multiple plugins, |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8232 * OrthancPluginRegisterReceivedInstanceCallback() can only be used |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8233 * by one single plugin. |
|
309fb4f02704
fix signature of OrthancPluginIncomingCStoreInstanceFilter
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4919
diff
changeset
|
8234 * |
|
4845
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8235 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8236 * @param callback The callback. |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8237 * @return 0 if success, other value if error. |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8238 * @ingroup Callbacks |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8239 **/ |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8240 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterReceivedInstanceCallback( |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8241 OrthancPluginContext* context, |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8242 OrthancPluginReceivedInstanceCallback callback) |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8243 { |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8244 _OrthancPluginReceivedInstanceCallback params; |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8245 params.callback = callback; |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8246 |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8247 return context->InvokeService(context, _OrthancPluginService_RegisterReceivedInstanceCallback, ¶ms); |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8248 } |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8249 |
|
02d77189d8ba
added ReceivedInstanceCallback + sample C++ plugin
Alain Mazy <am@osimis.io>
parents:
4831
diff
changeset
|
8250 /** |
|
3846
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8251 * @brief Get the transfer syntax of a DICOM file. |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8252 * |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8253 * This function returns a pointer to a newly created string that |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8254 * contains the transfer syntax UID of the DICOM instance. The empty |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8255 * string might be returned if this information is unknown. |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8256 * |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8257 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8258 * @param instance The instance of interest. |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8259 * @return The NULL value in case of error, or a string containing the |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8260 * transfer syntax UID. This string must be freed by OrthancPluginFreeString(). |
| 3936 | 8261 * @ingroup DicomInstance |
|
3846
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8262 **/ |
|
3847
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
8263 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceTransferSyntaxUid( |
|
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
8264 OrthancPluginContext* context, |
|
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
8265 const OrthancPluginDicomInstance* instance) |
|
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
8266 { |
|
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
8267 char* result; |
|
3846
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8268 |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8269 _OrthancPluginAccessDicomInstance params; |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8270 memset(¶ms, 0, sizeof(params)); |
|
3847
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
8271 params.resultStringToFree = &result; |
|
3846
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8272 params.instance = instance; |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8273 |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8274 if (context->InvokeService(context, _OrthancPluginService_GetInstanceTransferSyntaxUid, ¶ms) != OrthancPluginErrorCode_Success) |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8275 { |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8276 /* Error */ |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8277 return NULL; |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8278 } |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8279 else |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8280 { |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8281 return result; |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8282 } |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8283 } |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8284 |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8285 |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8286 /** |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8287 * @brief Check whether the DICOM file has pixel data. |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8288 * |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8289 * This function returns a Boolean value indicating whether the |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8290 * DICOM instance contains the pixel data (7FE0,0010) tag. |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8291 * |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8292 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8293 * @param instance The instance of interest. |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8294 * @return "1" if the DICOM instance contains pixel data, or "0" if |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8295 * the tag is missing, or "-1" in the case of an error. |
| 3936 | 8296 * @ingroup DicomInstance |
|
3846
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8297 **/ |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8298 ORTHANC_PLUGIN_INLINE int32_t OrthancPluginHasInstancePixelData( |
|
3847
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
8299 OrthancPluginContext* context, |
|
1491d501836a
actual implementation of OrthancPluginRegisterIncomingDicomInstanceFilter()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3846
diff
changeset
|
8300 const OrthancPluginDicomInstance* instance) |
|
3846
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8301 { |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8302 int64_t hasPixelData; |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8303 |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8304 _OrthancPluginAccessDicomInstance params; |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8305 memset(¶ms, 0, sizeof(params)); |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8306 params.resultInt64 = &hasPixelData; |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8307 params.instance = instance; |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8308 |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8309 if (context->InvokeService(context, _OrthancPluginService_HasInstancePixelData, ¶ms) != OrthancPluginErrorCode_Success || |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8310 hasPixelData < 0 || |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8311 hasPixelData > 1) |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8312 { |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8313 /* Error */ |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8314 return -1; |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8315 } |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8316 else |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8317 { |
| 3963 | 8318 return (hasPixelData != 0); |
|
3846
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8319 } |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8320 } |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8321 |
|
67e765d51bdf
preparing primitives to filter incoming DICOM instances in the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3801
diff
changeset
|
8322 |
|
3916
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8323 |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8324 |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8325 |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8326 |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8327 typedef struct |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8328 { |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8329 OrthancPluginDicomInstance** target; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8330 const void* buffer; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8331 uint32_t size; |
|
3919
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8332 const char* transferSyntax; |
|
3916
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8333 } _OrthancPluginCreateDicomInstance; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8334 |
| 3936 | 8335 /** |
| 8336 * @brief Parse a DICOM instance. | |
| 8337 * | |
| 8338 * This function parses a memory buffer that contains a DICOM | |
| 8339 * file. The function returns a new pointer to a data structure that | |
| 8340 * is managed by the Orthanc core. | |
| 8341 * | |
| 8342 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 8343 * @param buffer The memory buffer containing the DICOM instance. | |
| 8344 * @param size The size of the memory buffer. | |
| 8345 * @return The newly allocated DICOM instance. It must be freed with OrthancPluginFreeDicomInstance(). | |
| 8346 * @ingroup DicomInstance | |
| 8347 **/ | |
|
3916
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8348 ORTHANC_PLUGIN_INLINE OrthancPluginDicomInstance* OrthancPluginCreateDicomInstance( |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8349 OrthancPluginContext* context, |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8350 const void* buffer, |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8351 uint32_t size) |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8352 { |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8353 OrthancPluginDicomInstance* target = NULL; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8354 |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8355 _OrthancPluginCreateDicomInstance params; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8356 params.target = ⌖ |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8357 params.buffer = buffer; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8358 params.size = size; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8359 |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8360 if (context->InvokeService(context, _OrthancPluginService_CreateDicomInstance, ¶ms) != OrthancPluginErrorCode_Success) |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8361 { |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8362 /* Error */ |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8363 return NULL; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8364 } |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8365 else |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8366 { |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8367 return target; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8368 } |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8369 } |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8370 |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8371 typedef struct |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8372 { |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8373 OrthancPluginDicomInstance* dicom; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8374 } _OrthancPluginFreeDicomInstance; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8375 |
| 3936 | 8376 /** |
| 8377 * @brief Free a DICOM instance. | |
| 8378 * | |
| 8379 * This function frees a DICOM instance that was parsed using | |
| 8380 * OrthancPluginCreateDicomInstance(). | |
| 8381 * | |
| 8382 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 8383 * @param dicom The DICOM instance. | |
| 8384 * @ingroup DicomInstance | |
| 8385 **/ | |
|
3916
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8386 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeDicomInstance( |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8387 OrthancPluginContext* context, |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8388 OrthancPluginDicomInstance* dicom) |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8389 { |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8390 _OrthancPluginFreeDicomInstance params; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8391 params.dicom = dicom; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8392 |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8393 context->InvokeService(context, _OrthancPluginService_FreeDicomInstance, ¶ms); |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8394 } |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8395 |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8396 |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8397 typedef struct |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8398 { |
|
3925
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8399 uint32_t* targetUint32; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8400 OrthancPluginMemoryBuffer* targetBuffer; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8401 OrthancPluginImage** targetImage; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8402 char** targetStringToFree; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8403 const OrthancPluginDicomInstance* instance; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8404 uint32_t frameIndex; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8405 OrthancPluginDicomToJsonFormat format; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8406 OrthancPluginDicomToJsonFlags flags; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8407 uint32_t maxStringLength; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8408 OrthancPluginDicomWebBinaryCallback2 dicomWebCallback; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8409 void* dicomWebPayload; |
|
3916
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8410 } _OrthancPluginAccessDicomInstance2; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8411 |
| 3936 | 8412 /** |
| 8413 * @brief Get the number of frames in a DICOM instance. | |
| 8414 * | |
| 8415 * This function returns the number of frames that are part of a | |
| 8416 * DICOM image managed by the Orthanc core. | |
| 8417 * | |
| 8418 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 8419 * @param instance The instance of interest. | |
| 8420 * @return The number of frames (will be zero in the case of an error). | |
| 8421 * @ingroup DicomInstance | |
| 8422 **/ | |
|
3916
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8423 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetInstanceFramesCount( |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8424 OrthancPluginContext* context, |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8425 const OrthancPluginDicomInstance* instance) |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8426 { |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8427 uint32_t count; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8428 |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8429 _OrthancPluginAccessDicomInstance2 params; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8430 memset(¶ms, 0, sizeof(params)); |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8431 params.targetUint32 = &count; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8432 params.instance = instance; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8433 |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8434 if (context->InvokeService(context, _OrthancPluginService_GetInstanceFramesCount, ¶ms) != OrthancPluginErrorCode_Success) |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8435 { |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8436 /* Error */ |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8437 return 0; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8438 } |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8439 else |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8440 { |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8441 return count; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8442 } |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8443 } |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8444 |
|
3937
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8445 |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8446 /** |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8447 * @brief Get the raw content of a frame in a DICOM instance. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8448 * |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8449 * This function returns a memory buffer containing the raw content |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8450 * of a frame in a DICOM instance that is managed by the Orthanc |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8451 * core. This is notably useful for compressed transfer syntaxes, as |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8452 * it gives access to the embedded files (such as JPEG, JPEG-LS or |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8453 * JPEG2k). The Orthanc core transparently reassembles the fragments |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8454 * to extract the raw frame. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8455 * |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8456 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8457 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8458 * @param instance The instance of interest. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8459 * @param frameIndex The index of the frame of interest. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8460 * @return 0 if success, or the error code if failure. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8461 * @ingroup DicomInstance |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8462 **/ |
|
3916
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8463 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginGetInstanceRawFrame( |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8464 OrthancPluginContext* context, |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8465 OrthancPluginMemoryBuffer* target, |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8466 const OrthancPluginDicomInstance* instance, |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8467 uint32_t frameIndex) |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8468 { |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8469 _OrthancPluginAccessDicomInstance2 params; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8470 memset(¶ms, 0, sizeof(params)); |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8471 params.targetBuffer = target; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8472 params.instance = instance; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8473 params.frameIndex = frameIndex; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8474 |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8475 return context->InvokeService(context, _OrthancPluginService_GetInstanceRawFrame, ¶ms); |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8476 } |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8477 |
|
3937
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8478 |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8479 /** |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8480 * @brief Decode one frame from a DICOM instance. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8481 * |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8482 * This function decodes one frame of a DICOM image that is managed |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8483 * by the Orthanc core. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8484 * |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8485 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8486 * @param instance The instance of interest. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8487 * @param frameIndex The index of the frame of interest. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8488 * @return The uncompressed image. It must be freed with OrthancPluginFreeImage(). |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8489 * @ingroup DicomInstance |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8490 **/ |
|
3916
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8491 ORTHANC_PLUGIN_INLINE OrthancPluginImage* OrthancPluginGetInstanceDecodedFrame( |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8492 OrthancPluginContext* context, |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8493 const OrthancPluginDicomInstance* instance, |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8494 uint32_t frameIndex) |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8495 { |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8496 OrthancPluginImage* target = NULL; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8497 |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8498 _OrthancPluginAccessDicomInstance2 params; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8499 memset(¶ms, 0, sizeof(params)); |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8500 params.targetImage = ⌖ |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8501 params.instance = instance; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8502 params.frameIndex = frameIndex; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8503 |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8504 if (context->InvokeService(context, _OrthancPluginService_GetInstanceDecodedFrame, ¶ms) != OrthancPluginErrorCode_Success) |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8505 { |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8506 return NULL; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8507 } |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8508 else |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8509 { |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8510 return target; |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8511 } |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8512 } |
|
0e3849268a55
new plugin SDK primitives related to OrthancPluginDicomInstance
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3853
diff
changeset
|
8513 |
|
3937
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8514 |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8515 /** |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8516 * @brief Parse and transcode a DICOM instance. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8517 * |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8518 * This function parses a memory buffer that contains a DICOM file, |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8519 * then transcodes it to the given transfer syntax. The function |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8520 * returns a new pointer to a data structure that is managed by the |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8521 * Orthanc core. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8522 * |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8523 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8524 * @param buffer The memory buffer containing the DICOM instance. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8525 * @param size The size of the memory buffer. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8526 * @param transferSyntax The transfer syntax UID for the transcoding. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8527 * @return The newly allocated DICOM instance. It must be freed with OrthancPluginFreeDicomInstance(). |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8528 * @ingroup DicomInstance |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8529 **/ |
|
3919
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8530 ORTHANC_PLUGIN_INLINE OrthancPluginDicomInstance* OrthancPluginTranscodeDicomInstance( |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8531 OrthancPluginContext* context, |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8532 const void* buffer, |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8533 uint32_t size, |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8534 const char* transferSyntax) |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8535 { |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8536 OrthancPluginDicomInstance* target = NULL; |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8537 |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8538 _OrthancPluginCreateDicomInstance params; |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8539 params.target = ⌖ |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8540 params.buffer = buffer; |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8541 params.size = size; |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8542 params.transferSyntax = transferSyntax; |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8543 |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8544 if (context->InvokeService(context, _OrthancPluginService_TranscodeDicomInstance, ¶ms) != OrthancPluginErrorCode_Success) |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8545 { |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8546 /* Error */ |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8547 return NULL; |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8548 } |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8549 else |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8550 { |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8551 return target; |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8552 } |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8553 } |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8554 |
|
3937
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8555 /** |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8556 * @brief Writes a DICOM instance to a memory buffer. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8557 * |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8558 * This function returns a memory buffer containing the |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8559 * serialization of a DICOM instance that is managed by the Orthanc |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8560 * core. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8561 * |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8562 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8563 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8564 * @param instance The instance of interest. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8565 * @return 0 if success, or the error code if failure. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8566 * @ingroup DicomInstance |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8567 **/ |
|
3919
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8568 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginSerializeDicomInstance( |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8569 OrthancPluginContext* context, |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8570 OrthancPluginMemoryBuffer* target, |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8571 const OrthancPluginDicomInstance* instance) |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8572 { |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8573 _OrthancPluginAccessDicomInstance2 params; |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8574 memset(¶ms, 0, sizeof(params)); |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8575 params.targetBuffer = target; |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8576 params.instance = instance; |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8577 |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8578 return context->InvokeService(context, _OrthancPluginService_SerializeDicomInstance, ¶ms); |
|
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8579 } |
|
3937
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8580 |
|
3919
6f11b3233a06
OrthancPluginTranscodeDicomInstance() and OrthancPluginSerializeDicomInstance()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3916
diff
changeset
|
8581 |
|
3925
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8582 /** |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8583 * @brief Format a DICOM memory buffer as a JSON string. |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8584 * |
|
3937
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8585 * This function takes as DICOM instance managed by the Orthanc |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8586 * core, and outputs a JSON string representing the tags of this |
|
3925
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8587 * DICOM file. |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8588 * |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8589 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8590 * @param instance The DICOM instance of interest. |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8591 * @param format The output format. |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8592 * @param flags Flags governing the output. |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8593 * @param maxStringLength The maximum length of a field. Too long fields will |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8594 * be output as "null". The 0 value means no maximum length. |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8595 * @return The NULL value if the case of an error, or the JSON |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8596 * string. This string must be freed by OrthancPluginFreeString(). |
|
3937
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8597 * @ingroup DicomInstance |
|
5327
f01c06f75d67
sanitizing @see in OrthancCPlugin.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5326
diff
changeset
|
8598 * @see OrthancPluginDicomBufferToJson() |
|
3925
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8599 **/ |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8600 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceAdvancedJson( |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8601 OrthancPluginContext* context, |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8602 const OrthancPluginDicomInstance* instance, |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8603 OrthancPluginDicomToJsonFormat format, |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8604 OrthancPluginDicomToJsonFlags flags, |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8605 uint32_t maxStringLength) |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8606 { |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8607 char* result = NULL; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8608 |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8609 _OrthancPluginAccessDicomInstance2 params; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8610 memset(¶ms, 0, sizeof(params)); |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8611 params.targetStringToFree = &result; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8612 params.instance = instance; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8613 params.format = format; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8614 params.flags = flags; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8615 params.maxStringLength = maxStringLength; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8616 |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8617 if (context->InvokeService(context, _OrthancPluginService_GetInstanceAdvancedJson, ¶ms) != OrthancPluginErrorCode_Success) |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8618 { |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8619 /* Error */ |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8620 return NULL; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8621 } |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8622 else |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8623 { |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8624 return result; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8625 } |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8626 } |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8627 |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8628 |
|
3937
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8629 /** |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8630 * @brief Convert a DICOM instance to DICOMweb JSON. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8631 * |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8632 * This function converts a DICOM instance that is managed by the |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8633 * Orthanc core, into its DICOMweb JSON representation. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8634 * |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8635 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8636 * @param instance The DICOM instance of interest. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8637 * @param callback Callback to set the value of the binary tags. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8638 * @param payload User payload. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8639 * @return The NULL value in case of error, or the JSON document. This string must |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8640 * be freed by OrthancPluginFreeString(). |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8641 * @ingroup DicomInstance |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8642 **/ |
|
3925
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8643 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceDicomWebJson( |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8644 OrthancPluginContext* context, |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8645 const OrthancPluginDicomInstance* instance, |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8646 OrthancPluginDicomWebBinaryCallback2 callback, |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8647 void* payload) |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8648 { |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8649 char* target = NULL; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8650 |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8651 _OrthancPluginAccessDicomInstance2 params; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8652 params.targetStringToFree = ⌖ |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8653 params.instance = instance; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8654 params.dicomWebCallback = callback; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8655 params.dicomWebPayload = payload; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8656 |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8657 if (context->InvokeService(context, _OrthancPluginService_GetInstanceDicomWebJson, ¶ms) != OrthancPluginErrorCode_Success) |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8658 { |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8659 /* Error */ |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8660 return NULL; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8661 } |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8662 else |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8663 { |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8664 return target; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8665 } |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8666 } |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8667 |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8668 |
|
3937
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8669 /** |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8670 * @brief Convert a DICOM instance to DICOMweb XML. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8671 * |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8672 * This function converts a DICOM instance that is managed by the |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8673 * Orthanc core, into its DICOMweb XML representation. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8674 * |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8675 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8676 * @param instance The DICOM instance of interest. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8677 * @param callback Callback to set the value of the binary tags. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8678 * @param payload User payload. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8679 * @return The NULL value in case of error, or the XML document. This string must |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8680 * be freed by OrthancPluginFreeString(). |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8681 * @ingroup DicomInstance |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8682 **/ |
|
3925
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8683 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceDicomWebXml( |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8684 OrthancPluginContext* context, |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8685 const OrthancPluginDicomInstance* instance, |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8686 OrthancPluginDicomWebBinaryCallback2 callback, |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8687 void* payload) |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8688 { |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8689 char* target = NULL; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8690 |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8691 _OrthancPluginAccessDicomInstance2 params; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8692 params.targetStringToFree = ⌖ |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8693 params.instance = instance; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8694 params.dicomWebCallback = callback; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8695 params.dicomWebPayload = payload; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8696 |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8697 if (context->InvokeService(context, _OrthancPluginService_GetInstanceDicomWebXml, ¶ms) != OrthancPluginErrorCode_Success) |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8698 { |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8699 /* Error */ |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8700 return NULL; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8701 } |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8702 else |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8703 { |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8704 return target; |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8705 } |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8706 } |
|
3930
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8707 |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8708 |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8709 |
|
3937
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8710 /** |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8711 * @brief Signature of a callback function to transcode a DICOM instance. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8712 * @param transcoded Target memory buffer. It must be allocated by the |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8713 * plugin using OrthancPluginCreateMemoryBuffer(). |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8714 * @param buffer Memory buffer containing the source DICOM instance. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8715 * @param size Size of the source memory buffer. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8716 * @param allowedSyntaxes A C array of possible transfer syntaxes UIDs for the |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8717 * result of the transcoding. The plugin must choose by itself the |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8718 * transfer syntax that will be used for the resulting DICOM image. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8719 * @param countSyntaxes The number of transfer syntaxes that are contained |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8720 * in the "allowedSyntaxes" array. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8721 * @param allowNewSopInstanceUid Whether the transcoding plugin can select |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8722 * a transfer syntax that will change the SOP instance UID (or, in other |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8723 * terms, whether the plugin can transcode using lossy compression). |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8724 * @return 0 if success (i.e. image successfully transcoded and stored into |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8725 * "transcoded"), or the error code if failure. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8726 * @ingroup Callbacks |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8727 **/ |
|
3930
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8728 typedef OrthancPluginErrorCode (*OrthancPluginTranscoderCallback) ( |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8729 OrthancPluginMemoryBuffer* transcoded /* out */, |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8730 const void* buffer, |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8731 uint64_t size, |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8732 const char* const* allowedSyntaxes, |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8733 uint32_t countSyntaxes, |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8734 uint8_t allowNewSopInstanceUid); |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8735 |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8736 |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8737 typedef struct |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8738 { |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8739 OrthancPluginTranscoderCallback callback; |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8740 } _OrthancPluginTranscoderCallback; |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8741 |
|
3937
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8742 /** |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8743 * @brief Register a callback to handle the transcoding of DICOM images. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8744 * |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8745 * This function registers a custom callback to transcode DICOM |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8746 * images, extending the built-in transcoder of Orthanc that uses |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8747 * DCMTK. The exact behavior is affected by the configuration option |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8748 * "BuiltinDecoderTranscoderOrder" of Orthanc. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8749 * |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8750 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8751 * @param callback The callback. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8752 * @return 0 if success, other value if error. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8753 * @ingroup Callbacks |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8754 **/ |
|
3930
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8755 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterTranscoderCallback( |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8756 OrthancPluginContext* context, |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8757 OrthancPluginTranscoderCallback callback) |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8758 { |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8759 _OrthancPluginTranscoderCallback params; |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8760 params.callback = callback; |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8761 |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8762 return context->InvokeService(context, _OrthancPluginService_RegisterTranscoderCallback, ¶ms); |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8763 } |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8764 |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8765 |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8766 |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8767 typedef struct |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8768 { |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8769 OrthancPluginMemoryBuffer* target; |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8770 uint32_t size; |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8771 } _OrthancPluginCreateMemoryBuffer; |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8772 |
|
3937
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8773 /** |
|
4440
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8774 * @brief Create a 32-bit memory buffer. |
|
3937
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8775 * |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8776 * This function creates a memory buffer that is managed by the |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8777 * Orthanc core. The main use case of this function is for plugins |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8778 * that act as DICOM transcoders. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8779 * |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8780 * Your plugin should never call "free()" on the resulting memory |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8781 * buffer, as the C library that is used by the plugin is in general |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8782 * not the same as the one used by the Orthanc core. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8783 * |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8784 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8785 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8786 * @param size Size of the memory buffer to be created. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8787 * @return 0 if success, or the error code if failure. |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8788 * @ingroup Toolbox |
|
41eec97c23ef
documented new primitives in plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3936
diff
changeset
|
8789 **/ |
|
3930
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8790 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCreateMemoryBuffer( |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8791 OrthancPluginContext* context, |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8792 OrthancPluginMemoryBuffer* target, |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8793 uint32_t size) |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8794 { |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8795 _OrthancPluginCreateMemoryBuffer params; |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8796 params.target = target; |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8797 params.size = size; |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8798 |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8799 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer, ¶ms); |
|
b99acc213937
transcoder plugins and GDCM transcoding are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3925
diff
changeset
|
8800 } |
|
3925
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8801 |
|
dd112d2b83f0
new SDK: OrthancPluginGetInstanceAdvancedJson(), OrthancPluginGetInstanceDicomWebJson() and OrthancPluginGetInstanceDicomWebXml()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
3924
diff
changeset
|
8802 |
|
4343
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8803 /** |
|
4943
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
8804 * @brief Generate a token to grant full access to the REST API of Orthanc. |
|
4343
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8805 * |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8806 * This function generates a token that can be set in the HTTP |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8807 * header "Authorization" so as to grant full access to the REST API |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8808 * of Orthanc using an external HTTP client. Using this function |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8809 * avoids the need of adding a separate user in the |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8810 * "RegisteredUsers" configuration of Orthanc, which eases |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8811 * deployments. |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8812 * |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8813 * This feature is notably useful in multiprocess scenarios, where a |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8814 * subprocess created by a plugin has no access to the |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8815 * "OrthancPluginContext", and thus cannot call |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8816 * "OrthancPluginRestApi[Get|Post|Put|Delete]()". |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8817 * |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8818 * This situation is frequently encountered in Python plugins, where |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8819 * the "multiprocessing" package can be used to bypass the Global |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8820 * Interpreter Lock (GIL) and thus to improve performance and |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8821 * concurrency. |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8822 * |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8823 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8824 * @return The authorization token, or NULL value in the case of an error. |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8825 * This string must be freed by OrthancPluginFreeString(). |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8826 * @ingroup Orthanc |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8827 **/ |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8828 ORTHANC_PLUGIN_INLINE char* OrthancPluginGenerateRestApiAuthorizationToken( |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8829 OrthancPluginContext* context) |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8830 { |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8831 char* result; |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8832 |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8833 _OrthancPluginRetrieveDynamicString params; |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8834 params.result = &result; |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8835 params.argument = NULL; |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8836 |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8837 if (context->InvokeService(context, _OrthancPluginService_GenerateRestApiAuthorizationToken, |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8838 ¶ms) != OrthancPluginErrorCode_Success) |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8839 { |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8840 /* Error */ |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8841 return NULL; |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8842 } |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8843 else |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8844 { |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8845 return result; |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8846 } |
|
e1e918e790e8
New function in the SDK: OrthancPluginGenerateRestApiAuthorizationToken()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4245
diff
changeset
|
8847 } |
|
4440
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8848 |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8849 |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8850 |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8851 typedef struct |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8852 { |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8853 OrthancPluginMemoryBuffer64* target; |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8854 uint64_t size; |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8855 } _OrthancPluginCreateMemoryBuffer64; |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8856 |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8857 /** |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8858 * @brief Create a 64-bit memory buffer. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8859 * |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8860 * This function creates a 64-bit memory buffer that is managed by |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8861 * the Orthanc core. The main use case of this function is for |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8862 * plugins that read files from the storage area. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8863 * |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8864 * Your plugin should never call "free()" on the resulting memory |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8865 * buffer, as the C library that is used by the plugin is in general |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8866 * not the same as the one used by the Orthanc core. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8867 * |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8868 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8869 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8870 * @param size Size of the memory buffer to be created. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8871 * @return 0 if success, or the error code if failure. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8872 * @ingroup Toolbox |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8873 **/ |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8874 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCreateMemoryBuffer64( |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8875 OrthancPluginContext* context, |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8876 OrthancPluginMemoryBuffer64* target, |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8877 uint64_t size) |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8878 { |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8879 _OrthancPluginCreateMemoryBuffer64 params; |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8880 params.target = target; |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8881 params.size = size; |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8882 |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8883 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer64, ¶ms); |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8884 } |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8885 |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8886 |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8887 typedef struct |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8888 { |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8889 OrthancPluginStorageCreate create; |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8890 OrthancPluginStorageReadWhole readWhole; |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8891 OrthancPluginStorageReadRange readRange; |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8892 OrthancPluginStorageRemove remove; |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8893 } _OrthancPluginRegisterStorageArea2; |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8894 |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8895 /** |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8896 * @brief Register a custom storage area, with support for range request. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8897 * |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8898 * This function registers a custom storage area, to replace the |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8899 * built-in way Orthanc stores its files on the filesystem. This |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8900 * function must be called during the initialization of the plugin, |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8901 * i.e. inside the OrthancPluginInitialize() public function. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8902 * |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8903 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8904 * @param create The callback function to store a file on the custom storage area. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8905 * @param readWhole The callback function to read a whole file from the custom storage area. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8906 * @param readRange The callback function to read some range of a file from the custom storage area. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8907 * If this feature is not supported by the plugin, this value can be set to NULL. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8908 * @param remove The callback function to remove a file from the custom storage area. |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8909 * @ingroup Callbacks |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8910 **/ |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8911 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterStorageArea2( |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8912 OrthancPluginContext* context, |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8913 OrthancPluginStorageCreate create, |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8914 OrthancPluginStorageReadWhole readWhole, |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8915 OrthancPluginStorageReadRange readRange, |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8916 OrthancPluginStorageRemove remove) |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8917 { |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8918 _OrthancPluginRegisterStorageArea2 params; |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8919 params.create = create; |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8920 params.readWhole = readWhole; |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8921 params.readRange = readRange; |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8922 params.remove = remove; |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8923 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea2, ¶ms); |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8924 } |
|
eddb212b2df9
New functions in the SDK: OrthancPluginCreateMemoryBuffer64() and OrthancPluginRegisterStorageArea2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4437
diff
changeset
|
8925 |
|
4477
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8926 |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8927 |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8928 typedef struct |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8929 { |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8930 _OrthancPluginCreateDicom createDicom; |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8931 const char* privateCreator; |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8932 } _OrthancPluginCreateDicom2; |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8933 |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8934 /** |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8935 * @brief Create a DICOM instance from a JSON string and an image, with a private creator. |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8936 * |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8937 * This function takes as input a string containing a JSON file |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8938 * describing the content of a DICOM instance. As an output, it |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8939 * writes the corresponding DICOM instance to a newly allocated |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8940 * memory buffer. Additionally, an image to be encoded within the |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8941 * DICOM instance can also be provided. |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8942 * |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8943 * Contrarily to the function OrthancPluginCreateDicom(), this |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8944 * function can be explicitly provided with a private creator. |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8945 * |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8946 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8947 * @param target The target memory buffer. It must be freed with OrthancPluginFreeMemoryBuffer(). |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8948 * @param json The input JSON file. |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8949 * @param pixelData The image. Can be NULL, if the pixel data is encoded inside the JSON with the data URI scheme. |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8950 * @param flags Flags governing the output. |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8951 * @param privateCreator The private creator to be used for the private DICOM tags. |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8952 * Check out the global configuration option "Dictionary" of Orthanc. |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8953 * @return 0 if success, other value if error. |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8954 * @ingroup Toolbox |
|
5327
f01c06f75d67
sanitizing @see in OrthancCPlugin.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5326
diff
changeset
|
8955 * @see OrthancPluginCreateDicom() |
|
f01c06f75d67
sanitizing @see in OrthancCPlugin.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5326
diff
changeset
|
8956 * @see OrthancPluginDicomBufferToJson() |
|
4477
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8957 **/ |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8958 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCreateDicom2( |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8959 OrthancPluginContext* context, |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8960 OrthancPluginMemoryBuffer* target, |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8961 const char* json, |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8962 const OrthancPluginImage* pixelData, |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8963 OrthancPluginCreateDicomFlags flags, |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8964 const char* privateCreator) |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8965 { |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8966 _OrthancPluginCreateDicom2 params; |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8967 params.createDicom.target = target; |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8968 params.createDicom.json = json; |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8969 params.createDicom.pixelData = pixelData; |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8970 params.createDicom.flags = flags; |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8971 params.privateCreator = privateCreator; |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8972 |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8973 return context->InvokeService(context, _OrthancPluginService_CreateDicom2, ¶ms); |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8974 } |
|
0a2c9790cb41
new primitive in plugin SDK: OrthancPluginCreateDicom2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4442
diff
changeset
|
8975 |
|
4605
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8976 |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8977 |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8978 |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8979 |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8980 |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8981 typedef struct |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8982 { |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8983 OrthancPluginMemoryBuffer* answerBody; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8984 OrthancPluginMemoryBuffer* answerHeaders; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8985 uint16_t* httpStatus; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8986 OrthancPluginHttpMethod method; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8987 const char* uri; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8988 uint32_t headersCount; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8989 const char* const* headersKeys; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8990 const char* const* headersValues; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8991 const void* body; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8992 uint32_t bodySize; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8993 uint8_t afterPlugins; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8994 } _OrthancPluginCallRestApi; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8995 |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8996 /** |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8997 * @brief Call the REST API of Orthanc with full flexibility. |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8998 * |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
8999 * Make a call to the given URI in the REST API of Orthanc. The |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9000 * result to the query is stored into a newly allocated memory |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9001 * buffer. This function is always granted full access to the REST |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9002 * API (no credentials, nor security token is needed). |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9003 * |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9004 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9005 * @param answerBody The target memory buffer (out argument). |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9006 * It must be freed with OrthancPluginFreeMemoryBuffer(). |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9007 * The value of this argument is ignored if the HTTP method is DELETE. |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9008 * @param answerHeaders The target memory buffer for the HTTP headers in the answer (out argument). |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9009 * The answer headers are formatted as a JSON object (associative array). |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9010 * The buffer must be freed with OrthancPluginFreeMemoryBuffer(). |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9011 * This argument can be set to NULL if the plugin has no interest in the answer HTTP headers. |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9012 * @param httpStatus The HTTP status after the execution of the request (out argument). |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9013 * @param method HTTP method to be used. |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9014 * @param uri The URI of interest. |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9015 * @param headersCount The number of HTTP headers. |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9016 * @param headersKeys Array containing the keys of the HTTP headers (can be <tt>NULL</tt> if no header). |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9017 * @param headersValues Array containing the values of the HTTP headers (can be <tt>NULL</tt> if no header). |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9018 * @param body The HTTP body for a POST or PUT request. |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9019 * @param bodySize The size of the body. |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9020 * @param afterPlugins If 0, the built-in API of Orthanc is used. |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9021 * If 1, the API is tainted by the plugins. |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9022 * @return 0 if success, or the error code if failure. |
|
5327
f01c06f75d67
sanitizing @see in OrthancCPlugin.h
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5326
diff
changeset
|
9023 * @see OrthancPluginRestApiGet2(), OrthancPluginRestApiPost(), OrthancPluginRestApiPut(), OrthancPluginRestApiDelete() |
|
4605
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9024 * @ingroup Orthanc |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9025 **/ |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9026 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginCallRestApi( |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9027 OrthancPluginContext* context, |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9028 OrthancPluginMemoryBuffer* answerBody, |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9029 OrthancPluginMemoryBuffer* answerHeaders, |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9030 uint16_t* httpStatus, |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9031 OrthancPluginHttpMethod method, |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9032 const char* uri, |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9033 uint32_t headersCount, |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9034 const char* const* headersKeys, |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9035 const char* const* headersValues, |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9036 const void* body, |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9037 uint32_t bodySize, |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9038 uint8_t afterPlugins) |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9039 { |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9040 _OrthancPluginCallRestApi params; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9041 memset(¶ms, 0, sizeof(params)); |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9042 |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9043 params.answerBody = answerBody; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9044 params.answerHeaders = answerHeaders; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9045 params.httpStatus = httpStatus; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9046 params.method = method; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9047 params.uri = uri; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9048 params.headersCount = headersCount; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9049 params.headersKeys = headersKeys; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9050 params.headersValues = headersValues; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9051 params.body = body; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9052 params.bodySize = bodySize; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9053 params.afterPlugins = afterPlugins; |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9054 |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9055 return context->InvokeService(context, _OrthancPluginService_CallRestApi, ¶ms); |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9056 } |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9057 |
|
c8f444e8556d
new function in the plugin SDK: OrthancPluginCallRestApi()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4596
diff
changeset
|
9058 |
|
4943
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9059 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9060 /** |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9061 * @brief Opaque structure that represents a WebDAV collection. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9062 * @ingroup Callbacks |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9063 **/ |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9064 typedef struct _OrthancPluginWebDavCollection_t OrthancPluginWebDavCollection; |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9065 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9066 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9067 /** |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9068 * @brief Declare a file while returning the content of a folder. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9069 * |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9070 * This function declares a file while returning the content of a |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9071 * WebDAV folder. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9072 * |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9073 * @param collection Context of the collection. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9074 * @param name Base name of the file. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9075 * @param dateTime The date and time of creation of the file. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9076 * Check out the documentation of OrthancPluginWebDavRetrieveFile() for more information. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9077 * @param size Size of the file. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9078 * @param mimeType The MIME type of the file. If empty or set to `NULL`, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9079 * Orthanc will do a best guess depending on the file extension. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9080 * @return 0 if success, other value if error. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9081 * @ingroup Callbacks |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9082 **/ |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9083 typedef OrthancPluginErrorCode (*OrthancPluginWebDavAddFile) ( |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9084 OrthancPluginWebDavCollection* collection, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9085 const char* name, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9086 uint64_t size, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9087 const char* mimeType, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9088 const char* dateTime); |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9089 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9090 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9091 /** |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9092 * @brief Declare a subfolder while returning the content of a folder. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9093 * |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9094 * This function declares a subfolder while returning the content of a |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9095 * WebDAV folder. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9096 * |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9097 * @param collection Context of the collection. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9098 * @param name Base name of the subfolder. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9099 * @param dateTime The date and time of creation of the subfolder. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9100 * Check out the documentation of OrthancPluginWebDavRetrieveFile() for more information. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9101 * @return 0 if success, other value if error. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9102 * @ingroup Callbacks |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9103 **/ |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9104 typedef OrthancPluginErrorCode (*OrthancPluginWebDavAddFolder) ( |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9105 OrthancPluginWebDavCollection* collection, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9106 const char* name, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9107 const char* dateTime); |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9108 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9109 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9110 /** |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9111 * @brief Retrieve the content of a file. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9112 * |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9113 * This function is used to forward the content of a file from a |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9114 * WebDAV collection, to the core of Orthanc. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9115 * |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9116 * @param collection Context of the collection. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9117 * @param data Content of the file. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9118 * @param size Size of the file. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9119 * @param mimeType The MIME type of the file. If empty or set to `NULL`, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9120 * Orthanc will do a best guess depending on the file extension. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9121 * @param dateTime The date and time of creation of the file. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9122 * It must be formatted as an ISO string of form |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9123 * `YYYYMMDDTHHMMSS,fffffffff` where T is the date-time |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9124 * separator. It must be expressed in UTC (it is the responsibility |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9125 * of the plugin to do the possible timezone |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9126 * conversions). Internally, this string will be parsed using |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9127 * `boost::posix_time::from_iso_string()`. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9128 * @return 0 if success, other value if error. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9129 * @ingroup Callbacks |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9130 **/ |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9131 typedef OrthancPluginErrorCode (*OrthancPluginWebDavRetrieveFile) ( |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9132 OrthancPluginWebDavCollection* collection, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9133 const void* data, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9134 uint64_t size, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9135 const char* mimeType, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9136 const char* dateTime); |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9137 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9138 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9139 /** |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9140 * @brief Callback for testing the existence of a folder. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9141 * |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9142 * Signature of a callback function that tests whether the given |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9143 * path in the WebDAV collection exists and corresponds to a folder. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9144 * |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9145 * @param isExisting Pointer to a Boolean that must be set to `1` if the folder exists, or `0` otherwise. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9146 * @param pathSize Number of levels in the path. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9147 * @param pathItems Items making the path. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9148 * @param payload The user payload. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9149 * @return 0 if success, other value if error. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9150 * @ingroup Callbacks |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9151 **/ |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9152 typedef OrthancPluginErrorCode (*OrthancPluginWebDavIsExistingFolderCallback) ( |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9153 uint8_t* isExisting, /* out */ |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9154 uint32_t pathSize, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9155 const char* const* pathItems, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9156 void* payload); |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9157 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9158 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9159 /** |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9160 * @brief Callback for listing the content of a folder. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9161 * |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9162 * Signature of a callback function that lists the content of a |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9163 * folder in the WebDAV collection. The callback must call the |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9164 * provided `addFile()` and `addFolder()` functions to emit the |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9165 * content of the folder. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9166 * |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9167 * @param isExisting Pointer to a Boolean that must be set to `1` if the folder exists, or `0` otherwise. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9168 * @param collection Context to be provided to `addFile()` and `addFolder()` functions. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9169 * @param addFile Function to add a file to the list. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9170 * @param addFolder Function to add a folder to the list. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9171 * @param pathSize Number of levels in the path. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9172 * @param pathItems Items making the path. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9173 * @param payload The user payload. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9174 * @return 0 if success, other value if error. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9175 * @ingroup Callbacks |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9176 **/ |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9177 typedef OrthancPluginErrorCode (*OrthancPluginWebDavListFolderCallback) ( |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9178 uint8_t* isExisting, /* out */ |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9179 OrthancPluginWebDavCollection* collection, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9180 OrthancPluginWebDavAddFile addFile, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9181 OrthancPluginWebDavAddFolder addFolder, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9182 uint32_t pathSize, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9183 const char* const* pathItems, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9184 void* payload); |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9185 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9186 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9187 /** |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9188 * @brief Callback for retrieving the content of a file. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9189 * |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9190 * Signature of a callback function that retrieves the content of a |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9191 * file in the WebDAV collection. The callback must call the |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9192 * provided `retrieveFile()` function to emit the actual content of |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9193 * the file. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9194 * |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9195 * @param collection Context to be provided to `retrieveFile()` function. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9196 * @param retrieveFile Function to return the content of the file. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9197 * @param pathSize Number of levels in the path. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9198 * @param pathItems Items making the path. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9199 * @param payload The user payload. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9200 * @return 0 if success, other value if error. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9201 * @ingroup Callbacks |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9202 **/ |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9203 typedef OrthancPluginErrorCode (*OrthancPluginWebDavRetrieveFileCallback) ( |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9204 OrthancPluginWebDavCollection* collection, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9205 OrthancPluginWebDavRetrieveFile retrieveFile, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9206 uint32_t pathSize, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9207 const char* const* pathItems, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9208 void* payload); |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9209 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9210 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9211 /** |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9212 * @brief Callback to store a file. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9213 * |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9214 * Signature of a callback function that stores a file into the |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9215 * WebDAV collection. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9216 * |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9217 * @param isReadOnly Pointer to a Boolean that must be set to `1` if the collection is read-only, or `0` otherwise. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9218 * @param pathSize Number of levels in the path. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9219 * @param pathItems Items making the path. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9220 * @param data Content of the file to be stored. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9221 * @param size Size of the file to be stored. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9222 * @param payload The user payload. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9223 * @return 0 if success, other value if error. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9224 * @ingroup Callbacks |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9225 **/ |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9226 typedef OrthancPluginErrorCode (*OrthancPluginWebDavStoreFileCallback) ( |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9227 uint8_t* isReadOnly, /* out */ |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9228 uint32_t pathSize, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9229 const char* const* pathItems, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9230 const void* data, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9231 uint64_t size, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9232 void* payload); |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9233 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9234 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9235 /** |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9236 * @brief Callback to create a folder. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9237 * |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9238 * Signature of a callback function that creates a folder in the |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9239 * WebDAV collection. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9240 * |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9241 * @param isReadOnly Pointer to a Boolean that must be set to `1` if the collection is read-only, or `0` otherwise. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9242 * @param pathSize Number of levels in the path. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9243 * @param pathItems Items making the path. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9244 * @param payload The user payload. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9245 * @return 0 if success, other value if error. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9246 * @ingroup Callbacks |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9247 **/ |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9248 typedef OrthancPluginErrorCode (*OrthancPluginWebDavCreateFolderCallback) ( |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9249 uint8_t* isReadOnly, /* out */ |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9250 uint32_t pathSize, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9251 const char* const* pathItems, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9252 void* payload); |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9253 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9254 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9255 /** |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9256 * @brief Callback to remove a file or a folder. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9257 * |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9258 * Signature of a callback function that removes a file or a folder |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9259 * from the WebDAV collection. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9260 * |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9261 * @param isReadOnly Pointer to a Boolean that must be set to `1` if the collection is read-only, or `0` otherwise. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9262 * @param pathSize Number of levels in the path. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9263 * @param pathItems Items making the path. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9264 * @param payload The user payload. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9265 * @return 0 if success, other value if error. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9266 * @ingroup Callbacks |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9267 **/ |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9268 typedef OrthancPluginErrorCode (*OrthancPluginWebDavDeleteItemCallback) ( |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9269 uint8_t* isReadOnly, /* out */ |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9270 uint32_t pathSize, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9271 const char* const* pathItems, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9272 void* payload); |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9273 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9274 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9275 typedef struct |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9276 { |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9277 const char* uri; |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9278 OrthancPluginWebDavIsExistingFolderCallback isExistingFolder; |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9279 OrthancPluginWebDavListFolderCallback listFolder; |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9280 OrthancPluginWebDavRetrieveFileCallback retrieveFile; |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9281 OrthancPluginWebDavStoreFileCallback storeFile; |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9282 OrthancPluginWebDavCreateFolderCallback createFolder; |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9283 OrthancPluginWebDavDeleteItemCallback deleteItem; |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9284 void* payload; |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9285 } _OrthancPluginRegisterWebDavCollection; |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9286 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9287 /** |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9288 * @brief Register a WebDAV virtual filesystem. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9289 * |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9290 * This function maps a WebDAV collection onto the given URI in the |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9291 * REST API of Orthanc. This function must be called during the |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9292 * initialization of the plugin, i.e. inside the |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9293 * OrthancPluginInitialize() public function. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9294 * |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9295 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9296 * @param uri URI where to map the WebDAV collection (must start with a `/` character). |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9297 * @param isExistingFolder Callback method to test for the existence of a folder. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9298 * @param listFolder Callback method to list the content of a folder. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9299 * @param retrieveFile Callback method to retrieve the content of a file. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9300 * @param storeFile Callback method to store a file into the WebDAV collection. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9301 * @param createFolder Callback method to create a folder. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9302 * @param deleteItem Callback method to delete a file or a folder. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9303 * @param payload The user payload. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9304 * @return 0 if success, other value if error. |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9305 * @ingroup Callbacks |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9306 **/ |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9307 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterWebDavCollection( |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9308 OrthancPluginContext* context, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9309 const char* uri, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9310 OrthancPluginWebDavIsExistingFolderCallback isExistingFolder, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9311 OrthancPluginWebDavListFolderCallback listFolder, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9312 OrthancPluginWebDavRetrieveFileCallback retrieveFile, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9313 OrthancPluginWebDavStoreFileCallback storeFile, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9314 OrthancPluginWebDavCreateFolderCallback createFolder, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9315 OrthancPluginWebDavDeleteItemCallback deleteItem, |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9316 void* payload) |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9317 { |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9318 _OrthancPluginRegisterWebDavCollection params; |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9319 params.uri = uri; |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9320 params.isExistingFolder = isExistingFolder; |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9321 params.listFolder = listFolder; |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9322 params.retrieveFile = retrieveFile; |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9323 params.storeFile = storeFile; |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9324 params.createFolder = createFolder; |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9325 params.deleteItem = deleteItem; |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9326 params.payload = payload; |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9327 |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9328 return context->InvokeService(context, _OrthancPluginService_RegisterWebDavCollection, ¶ms); |
|
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9329 } |
|
5030
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9330 |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9331 |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9332 /** |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9333 * @brief Gets the DatabaseServerIdentifier. |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9334 * |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9335 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9336 * @return the database server identifier. This is a statically-allocated |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9337 * string, do not free it. |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9338 * @ingroup Toolbox |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9339 **/ |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9340 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetDatabaseServerIdentifier( |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9341 OrthancPluginContext* context) |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9342 { |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9343 const char* result; |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9344 |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9345 _OrthancPluginRetrieveStaticString params; |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9346 params.result = &result; |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9347 params.argument = NULL; |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9348 |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9349 if (context->InvokeService(context, _OrthancPluginService_GetDatabaseServerIdentifier, ¶ms) != OrthancPluginErrorCode_Success) |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9350 { |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9351 /* Error */ |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9352 return NULL; |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9353 } |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9354 else |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9355 { |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9356 return result; |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9357 } |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9358 } |
|
d6ed4c73c719
SDK: Added GetDatabaseServerIdentifier
Alain Mazy <am@osimis.io>
parents:
5004
diff
changeset
|
9359 |
|
4943
47d734fa30f6
adding function OrthancPluginRegisterWebDavCollection() to the plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
4921
diff
changeset
|
9360 |
|
5194
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9361 /** |
| 5217 | 9362 * @brief Signature of a callback function that is triggered when |
| 9363 * the Orthanc core requests an operation from the database plugin. | |
| 9364 * Both request and response are encoded as protobuf buffers. | |
|
5194
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9365 * @ingroup Callbacks |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9366 **/ |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9367 typedef OrthancPluginErrorCode (*OrthancPluginCallDatabaseBackendV4) ( |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9368 OrthancPluginMemoryBuffer64* response, |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9369 void* backend, |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9370 const void* request, |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9371 uint64_t requestSize); |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9372 |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9373 /** |
| 5217 | 9374 * @brief Signature of a callback function that is triggered when |
| 9375 * the database plugin must be finalized. | |
|
5194
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9376 * @ingroup Callbacks |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9377 **/ |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9378 typedef void (*OrthancPluginFinalizeDatabaseBackendV4) (void* backend); |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9379 |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9380 typedef struct |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9381 { |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9382 void* backend; |
| 5197 | 9383 uint32_t maxDatabaseRetries; |
|
5194
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9384 OrthancPluginCallDatabaseBackendV4 operations; |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9385 OrthancPluginFinalizeDatabaseBackendV4 finalize; |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9386 } _OrthancPluginRegisterDatabaseBackendV4; |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9387 |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9388 /** |
|
5399
b7e60d081b81
fix comments in the Orthanc plugin SDK
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5389
diff
changeset
|
9389 * @brief Register a custom database back-end. |
|
5194
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9390 * |
| 5217 | 9391 * This function was added in Orthanc SDK 1.12.0. It uses Google |
| 9392 * Protocol Buffers for the communications between the Orthanc core | |
| 9393 * and database plugins. Check out "OrthancDatabasePlugin.proto" for | |
| 9394 * the definition of the protobuf messages. | |
| 9395 * | |
| 9396 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). | |
| 9397 * @param backend Pointer to the custom database backend. | |
| 9398 * @param maxDatabaseRetries Maximum number of retries if transaction doesn't succeed. | |
| 9399 * If no retry is successful, OrthancPluginErrorCode_DatabaseCannotSerialize is generated. | |
|
5194
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9400 * @param operations Access to the operations of the custom database backend. |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9401 * @param finalize Callback to deallocate the custom database backend. |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9402 * @return 0 if success, other value if error. |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9403 * @ingroup Callbacks |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9404 **/ |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9405 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterDatabaseBackendV4( |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9406 OrthancPluginContext* context, |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9407 void* backend, |
| 5217 | 9408 uint32_t maxDatabaseRetries, |
|
5194
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9409 OrthancPluginCallDatabaseBackendV4 operations, |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9410 OrthancPluginFinalizeDatabaseBackendV4 finalize) |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9411 { |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9412 _OrthancPluginRegisterDatabaseBackendV4 params; |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9413 params.backend = backend; |
| 5197 | 9414 params.maxDatabaseRetries = maxDatabaseRetries; |
|
5194
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9415 params.operations = operations; |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9416 params.finalize = finalize; |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9417 |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9418 return context->InvokeService(context, _OrthancPluginService_RegisterDatabaseBackendV4, ¶ms); |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9419 } |
|
e9f3bddd30cc
added OrthancPluginRegisterDatabaseBackendV4
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5185
diff
changeset
|
9420 |
|
5319
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9421 |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9422 typedef struct |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9423 { |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9424 OrthancPluginDicomInstance** target; |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9425 const char* instanceId; |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9426 OrthancPluginLoadDicomInstanceMode mode; |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9427 } _OrthancPluginLoadDicomInstance; |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9428 |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9429 /** |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9430 * @brief Load a DICOM instance from the Orthanc server. |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9431 * |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9432 * This function loads a DICOM instance from the content of the |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9433 * Orthanc database. The function returns a new pointer to a data |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9434 * structure that is managed by the Orthanc core. |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9435 * |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9436 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9437 * @param instanceId The Orthanc identifier of the DICOM instance of interest. |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9438 * @param mode Flag specifying how to deal with pixel data. |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9439 * @return The newly allocated DICOM instance. It must be freed with OrthancPluginFreeDicomInstance(). |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9440 * @ingroup DicomInstance |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9441 **/ |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9442 ORTHANC_PLUGIN_INLINE OrthancPluginDicomInstance* OrthancPluginLoadDicomInstance( |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9443 OrthancPluginContext* context, |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9444 const char* instanceId, |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9445 OrthancPluginLoadDicomInstanceMode mode) |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9446 { |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9447 OrthancPluginDicomInstance* target = NULL; |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9448 |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9449 _OrthancPluginLoadDicomInstance params; |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9450 params.target = ⌖ |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9451 params.instanceId = instanceId; |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9452 params.mode = mode; |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9453 |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9454 if (context->InvokeService(context, _OrthancPluginService_LoadDicomInstance, ¶ms) != OrthancPluginErrorCode_Success) |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9455 { |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9456 /* Error */ |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9457 return NULL; |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9458 } |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9459 else |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9460 { |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9461 return target; |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9462 } |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9463 } |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9464 |
|
f2e1ad71e49c
added "OrthancPluginLoadDicomInstance()" to load DICOM instances from the database
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5218
diff
changeset
|
9465 |
|
5326
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9466 typedef struct |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9467 { |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9468 const char* name; |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9469 int64_t value; |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9470 OrthancPluginMetricsType type; |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9471 } _OrthancPluginSetMetricsIntegerValue; |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9472 |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9473 /** |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9474 * @brief Set the value of an integer metrics. |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9475 * |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9476 * This function sets the value of an integer metrics to monitor the |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9477 * behavior of the plugin through tools such as Prometheus. The |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9478 * values of all the metrics are stored within the Orthanc context. |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9479 * |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9480 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9481 * @param name The name of the metrics to be set. |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9482 * @param value The value of the metrics. |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9483 * @param type The type of the metrics. This parameter is only taken into consideration |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9484 * the first time this metrics is set. |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9485 * @ingroup Toolbox |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9486 * @see OrthancPluginSetMetricsValue() |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9487 **/ |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9488 ORTHANC_PLUGIN_INLINE void OrthancPluginSetMetricsIntegerValue( |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9489 OrthancPluginContext* context, |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9490 const char* name, |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9491 int64_t value, |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9492 OrthancPluginMetricsType type) |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9493 { |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9494 _OrthancPluginSetMetricsIntegerValue params; |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9495 params.name = name; |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9496 params.value = value; |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9497 params.type = type; |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9498 context->InvokeService(context, _OrthancPluginService_SetMetricsIntegerValue, ¶ms); |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9499 } |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9500 |
|
fbe857e942cd
store metrics as integers instead of floats to avoid precision loss in increments
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5319
diff
changeset
|
9501 |
|
5471
2c23bb7d50ce
review doc of OrthancPluginSetCurrentThreadName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5452
diff
changeset
|
9502 /** |
|
2c23bb7d50ce
review doc of OrthancPluginSetCurrentThreadName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5452
diff
changeset
|
9503 * @brief Set the name of the current thread. |
|
2c23bb7d50ce
review doc of OrthancPluginSetCurrentThreadName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5452
diff
changeset
|
9504 * |
|
2c23bb7d50ce
review doc of OrthancPluginSetCurrentThreadName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5452
diff
changeset
|
9505 * This function gives a name to the thread that is calling this |
|
2c23bb7d50ce
review doc of OrthancPluginSetCurrentThreadName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5452
diff
changeset
|
9506 * function. This name is used in the Orthanc logs. This function |
|
2c23bb7d50ce
review doc of OrthancPluginSetCurrentThreadName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5452
diff
changeset
|
9507 * must only be called from threads that the plugin has created |
|
2c23bb7d50ce
review doc of OrthancPluginSetCurrentThreadName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5452
diff
changeset
|
9508 * itself. |
|
2c23bb7d50ce
review doc of OrthancPluginSetCurrentThreadName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5452
diff
changeset
|
9509 * |
|
2c23bb7d50ce
review doc of OrthancPluginSetCurrentThreadName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5452
diff
changeset
|
9510 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
2c23bb7d50ce
review doc of OrthancPluginSetCurrentThreadName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5452
diff
changeset
|
9511 * @param threadName The name of the current thread. A thread name cannot be longer than 16 characters. |
|
5452
8345267e8de5
Added OrthancPluginSetCurrentThreadName() in the plugin SDK
Alain Mazy <am@osimis.io>
parents:
5432
diff
changeset
|
9512 * @return 0 if success, other value if error. |
|
8345267e8de5
Added OrthancPluginSetCurrentThreadName() in the plugin SDK
Alain Mazy <am@osimis.io>
parents:
5432
diff
changeset
|
9513 * @ingroup Toolbox |
|
8345267e8de5
Added OrthancPluginSetCurrentThreadName() in the plugin SDK
Alain Mazy <am@osimis.io>
parents:
5432
diff
changeset
|
9514 **/ |
|
8345267e8de5
Added OrthancPluginSetCurrentThreadName() in the plugin SDK
Alain Mazy <am@osimis.io>
parents:
5432
diff
changeset
|
9515 ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginSetCurrentThreadName( |
|
5471
2c23bb7d50ce
review doc of OrthancPluginSetCurrentThreadName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5452
diff
changeset
|
9516 OrthancPluginContext* context, |
|
2c23bb7d50ce
review doc of OrthancPluginSetCurrentThreadName()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5452
diff
changeset
|
9517 const char* threadName) |
|
5452
8345267e8de5
Added OrthancPluginSetCurrentThreadName() in the plugin SDK
Alain Mazy <am@osimis.io>
parents:
5432
diff
changeset
|
9518 { |
|
8345267e8de5
Added OrthancPluginSetCurrentThreadName() in the plugin SDK
Alain Mazy <am@osimis.io>
parents:
5432
diff
changeset
|
9519 return context->InvokeService(context, _OrthancPluginService_SetCurrentThreadName, threadName); |
|
8345267e8de5
Added OrthancPluginSetCurrentThreadName() in the plugin SDK
Alain Mazy <am@osimis.io>
parents:
5432
diff
changeset
|
9520 } |
|
8345267e8de5
Added OrthancPluginSetCurrentThreadName() in the plugin SDK
Alain Mazy <am@osimis.io>
parents:
5432
diff
changeset
|
9521 |
|
5575
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
9522 |
|
5561
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9523 typedef struct |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9524 { |
|
5575
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
9525 /* Note: This structure is also defined in Logging.h and it must be binary compatible */ |
|
5561
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9526 const char* message; |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9527 const char* plugin; |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9528 const char* file; |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9529 uint32_t line; |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9530 OrthancPluginLogCategory category; |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9531 OrthancPluginLogLevel level; |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9532 } _OrthancPluginLogMessage; |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9533 |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9534 |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9535 /** |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9536 * @brief Log a message. |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9537 * |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9538 * Log a message using the Orthanc logging system. |
|
5575
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
9539 * |
|
5561
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9540 * @param context The Orthanc plugin context, as received by OrthancPluginInitialize(). |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9541 * @param message The message to be logged. |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9542 * @param plugin The plugin name. |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9543 * @param file The filename in the plugin code. |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9544 * @param line The file line in the plugin code. |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9545 * @param category The category. |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9546 * @param level The level of the message. |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9547 **/ |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9548 ORTHANC_PLUGIN_INLINE void OrthancPluginLogMessage( |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9549 OrthancPluginContext* context, |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9550 const char* message, |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9551 const char* plugin, |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9552 const char* file, |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9553 uint32_t line, |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9554 OrthancPluginLogCategory category, |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9555 OrthancPluginLogLevel level) |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9556 { |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9557 _OrthancPluginLogMessage m; |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9558 m.message = message; |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9559 m.plugin = plugin; |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9560 m.file = file; |
|
5575
d7eaa568da15
Orthanc::Logging automatically detects whether the Orthanc core supports OrthancPluginLogMessage()
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
5561
diff
changeset
|
9561 m.line = line; |
|
5561
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9562 m.category = category; |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9563 m.level = level; |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9564 context->InvokeService(context, _OrthancPluginService_LogMessage, &m); |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9565 } |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9566 |
|
0b18690c1935
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents:
5539
diff
changeset
|
9567 |
| 886 | 9568 #ifdef __cplusplus |
| 9569 } | |
| 9570 #endif | |
| 900 | 9571 |
| 9572 | |
| 9573 /** @} */ | |
| 9574 |