Orthanc Plugin SDK 1.13.1
Documentation of the plugin interface of Orthanc
OrthancCPlugin.h
1
54
55
56
79
80
81
86
87
88
110
111
112
113#pragma once
114
115
116#include <stdio.h>
117#include <string.h>
118
119#ifdef _WIN32
120# define ORTHANC_PLUGINS_API __declspec(dllexport)
121#elif __GNUC__ >= 4
122# define ORTHANC_PLUGINS_API __attribute__ ((visibility ("default")))
123#else
124# define ORTHANC_PLUGINS_API
125#endif
126
127#define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 1
128#define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 13
129#define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 1
130
131
132#if !defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE)
133#define ORTHANC_PLUGINS_VERSION_IS_ABOVE(major, minor, revision) \
134 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER > major || \
135 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER == major && \
136 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER > minor || \
137 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER == minor && \
138 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER >= revision))))
139#endif
140
141
142
143/********************************************************************
144 ** Check that function inlining is properly supported. The use of
145 ** inlining is required, to avoid the duplication of object code
146 ** between two compilation modules that would use the Orthanc Plugin
147 ** API.
148 ********************************************************************/
149
150/* If the auto-detection of the "inline" keyword below does not work
151 automatically and that your compiler is known to properly support
152 inlining, uncomment the following #define and adapt the definition
153 of "static inline". */
154
155/* #define ORTHANC_PLUGIN_INLINE static inline */
156
157#ifndef ORTHANC_PLUGIN_INLINE
158# if __STDC_VERSION__ >= 199901L
159/* This is C99 or above: http://predef.sourceforge.net/prestd.html */
160# define ORTHANC_PLUGIN_INLINE static inline
161# elif defined(__cplusplus)
162/* This is C++ */
163# define ORTHANC_PLUGIN_INLINE static inline
164# elif defined(__GNUC__)
165/* This is GCC running in C89 mode */
166# define ORTHANC_PLUGIN_INLINE static __inline
167# elif defined(_MSC_VER)
168/* This is Visual Studio running in C89 mode */
169# define ORTHANC_PLUGIN_INLINE static __inline
170# else
171# error Your compiler is not known to support the "inline" keyword
172# endif
173#endif
174
175
176#ifndef ORTHANC_PLUGIN_DEPRECATED
177# if defined(_MSC_VER)
178# define ORTHANC_PLUGIN_DEPRECATED __declspec(deprecated)
179# elif __GNUC__ >= 4
180# define ORTHANC_PLUGIN_DEPRECATED __attribute__ ((deprecated))
181# elif defined(__clang__)
182# define ORTHANC_PLUGIN_DEPRECATED __attribute__ ((deprecated))
183# else
184# pragma message("WARNING: You need to implement ORTHANC_PLUGINS_DEPRECATED for this compiler")
185# define ORTHANC_PLUGIN_DEPRECATED
186# endif
187#endif
188
189
190#ifndef ORTHANC_PLUGIN_SINCE_SDK
197# if defined(__clang__)
198# define ORTHANC_PLUGIN_SINCE_SDK(version) __attribute__ ((annotate("ORTHANC_PLUGIN_SINCE_SDK " version)))
199# else
200# define ORTHANC_PLUGIN_SINCE_SDK(version)
201# endif
202#endif
203
204
205
206/********************************************************************
207 ** Inclusion of standard libraries.
208 ********************************************************************/
209
215#include <stdint.h>
216
217#include <stdlib.h>
218
219
220
221/********************************************************************
222 ** Definition of the Orthanc Plugin API.
223 ********************************************************************/
224
225
226#define ORTHANC_PLUGINS_WEBDAV_UNKNOWN_FILE_SIZE ((uint64_t) -1) /* New in Orthanc 1.12.11 */
227
228
230
231#ifdef __cplusplus
232extern "C"
233{
234#endif
235
239 typedef enum
240 {
353
354 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
356
357
362 ORTHANC_PLUGINS_API const char* OrthancPluginGetName();
363
364
368 typedef enum
369 {
374
375 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
377
378
383 typedef struct
384 {
389
393 uint32_t groupsCount;
394
398 const char* const* groups;
399
403 uint32_t getCount;
404
408 const char* const* getKeys;
409
413 const char* const* getValues;
414
418 const void* body;
419
423 uint32_t bodySize;
424
425
426 /* --------------------------------------------------
427 New in version 0.8.1
428 -------------------------------------------------- */
429
433 uint32_t headersCount;
434
438 const char* const* headersKeys;
439
443 const char* const* headersValues;
444
445
446 /* --------------------------------------------------
447 New in version 1.12.9
448 -------------------------------------------------- */
449
455
461
463
464
465 typedef enum
466 {
467 /* Generic services */
468 _OrthancPluginService_LogInfo = 1,
469 _OrthancPluginService_LogWarning = 2,
470 _OrthancPluginService_LogError = 3,
471 _OrthancPluginService_GetOrthancPath = 4,
472 _OrthancPluginService_GetOrthancDirectory = 5,
473 _OrthancPluginService_GetConfigurationPath = 6,
474 _OrthancPluginService_SetPluginProperty = 7,
475 _OrthancPluginService_GetGlobalProperty = 8,
476 _OrthancPluginService_SetGlobalProperty = 9,
477 _OrthancPluginService_GetCommandLineArgumentsCount = 10,
478 _OrthancPluginService_GetCommandLineArgument = 11,
479 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
480 _OrthancPluginService_GetConfiguration = 13,
481 _OrthancPluginService_BufferCompression = 14,
482 _OrthancPluginService_ReadFile = 15,
483 _OrthancPluginService_WriteFile = 16,
484 _OrthancPluginService_GetErrorDescription = 17,
485 _OrthancPluginService_CallHttpClient = 18,
486 _OrthancPluginService_RegisterErrorCode = 19,
487 _OrthancPluginService_RegisterDictionaryTag = 20,
488 _OrthancPluginService_DicomBufferToJson = 21,
489 _OrthancPluginService_DicomInstanceToJson = 22,
490 _OrthancPluginService_CreateDicom = 23,
491 _OrthancPluginService_ComputeMd5 = 24,
492 _OrthancPluginService_ComputeSha1 = 25,
493 _OrthancPluginService_LookupDictionary = 26,
494 _OrthancPluginService_CallHttpClient2 = 27,
495 _OrthancPluginService_GenerateUuid = 28,
496 _OrthancPluginService_RegisterPrivateDictionaryTag = 29,
497 _OrthancPluginService_AutodetectMimeType = 30,
498 _OrthancPluginService_SetMetricsValue = 31,
499 _OrthancPluginService_EncodeDicomWebJson = 32,
500 _OrthancPluginService_EncodeDicomWebXml = 33,
501 _OrthancPluginService_ChunkedHttpClient = 34, /* New in Orthanc 1.5.7 */
502 _OrthancPluginService_GetTagName = 35, /* New in Orthanc 1.5.7 */
503 _OrthancPluginService_EncodeDicomWebJson2 = 36, /* New in Orthanc 1.7.0 */
504 _OrthancPluginService_EncodeDicomWebXml2 = 37, /* New in Orthanc 1.7.0 */
505 _OrthancPluginService_CreateMemoryBuffer = 38, /* New in Orthanc 1.7.0 */
506 _OrthancPluginService_GenerateRestApiAuthorizationToken = 39, /* New in Orthanc 1.8.1 */
507 _OrthancPluginService_CreateMemoryBuffer64 = 40, /* New in Orthanc 1.9.0 */
508 _OrthancPluginService_CreateDicom2 = 41, /* New in Orthanc 1.9.0 */
509 _OrthancPluginService_GetDatabaseServerIdentifier = 42, /* New in Orthanc 1.11.1 */
510 _OrthancPluginService_SetMetricsIntegerValue = 43, /* New in Orthanc 1.12.1 */
511 _OrthancPluginService_SetCurrentThreadName = 44, /* New in Orthanc 1.12.2 */
512 _OrthancPluginService_LogMessage = 45, /* New in Orthanc 1.12.4 */
513 _OrthancPluginService_AdoptDicomInstance = 46, /* New in Orthanc 1.12.8 */
514 _OrthancPluginService_GetAttachmentCustomData = 47, /* New in Orthanc 1.12.8 */
515 _OrthancPluginService_SetAttachmentCustomData = 48, /* New in Orthanc 1.12.8 */
516 _OrthancPluginService_StoreKeyValue = 49, /* New in Orthanc 1.12.8 */
517 _OrthancPluginService_DeleteKeyValue = 50, /* New in Orthanc 1.12.8 */
518 _OrthancPluginService_GetKeyValue = 51, /* New in Orthanc 1.12.8 */
519 _OrthancPluginService_CreateKeysValuesIterator = 52, /* New in Orthanc 1.12.8 */
520 _OrthancPluginService_FreeKeysValuesIterator = 53, /* New in Orthanc 1.12.8 */
521 _OrthancPluginService_KeysValuesIteratorNext = 54, /* New in Orthanc 1.12.8 */
522 _OrthancPluginService_KeysValuesIteratorGetKey = 55, /* New in Orthanc 1.12.8 */
523 _OrthancPluginService_KeysValuesIteratorGetValue = 56, /* New in Orthanc 1.12.8 */
524 _OrthancPluginService_EnqueueValue = 57, /* New in Orthanc 1.12.8 */
525 _OrthancPluginService_DequeueValue = 58, /* New in Orthanc 1.12.8 */
526 _OrthancPluginService_GetQueueSize = 59, /* New in Orthanc 1.12.8 */
527 _OrthancPluginService_SetStableStatus = 60, /* New in Orthanc 1.12.9 */
528 _OrthancPluginService_EmitAuditLog = 61, /* New in Orthanc 1.12.9 */
529 _OrthancPluginService_ReserveQueueValue = 62, /* New in Orthanc 1.12.10 */
530 _OrthancPluginService_AcknowledgeQueueValue = 63, /* New in Orthanc 1.12.10 */
531 _OrthancPluginService_ClearCurrentThreadName = 64, /* New in Orthanc 1.13.0 */
532
533 /* Registration of callbacks */
534 _OrthancPluginService_RegisterRestCallback = 1000,
535 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
536 _OrthancPluginService_RegisterStorageArea = 1002,
537 _OrthancPluginService_RegisterOnChangeCallback = 1003,
538 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
539 _OrthancPluginService_RegisterWorklistCallback = 1005,
540 _OrthancPluginService_RegisterDecodeImageCallback = 1006,
541 _OrthancPluginService_RegisterIncomingHttpRequestFilter = 1007,
542 _OrthancPluginService_RegisterFindCallback = 1008,
543 _OrthancPluginService_RegisterMoveCallback = 1009,
544 _OrthancPluginService_RegisterIncomingHttpRequestFilter2 = 1010,
545 _OrthancPluginService_RegisterRefreshMetricsCallback = 1011,
546 _OrthancPluginService_RegisterChunkedRestCallback = 1012, /* New in Orthanc 1.5.7 */
547 _OrthancPluginService_RegisterStorageCommitmentScpCallback = 1013, /* New in Orthanc 1.6.0 */
548 _OrthancPluginService_RegisterIncomingDicomInstanceFilter = 1014, /* New in Orthanc 1.6.1 */
549 _OrthancPluginService_RegisterTranscoderCallback = 1015, /* New in Orthanc 1.7.0 */
550 _OrthancPluginService_RegisterStorageArea2 = 1016, /* New in Orthanc 1.9.0 */
551 _OrthancPluginService_RegisterIncomingCStoreInstanceFilter = 1017, /* New in Orthanc 1.10.0 */
552 _OrthancPluginService_RegisterReceivedInstanceCallback = 1018, /* New in Orthanc 1.10.0 */
553 _OrthancPluginService_RegisterWebDavCollection = 1019, /* New in Orthanc 1.10.1 */
554 _OrthancPluginService_RegisterStorageArea3 = 1020, /* New in Orthanc 1.12.8 */
555 _OrthancPluginService_RegisterHttpAuthentication = 1021, /* New in Orthanc 1.12.9 */
556 _OrthancPluginService_RegisterAuditLogHandler = 1022, /* New in Orthanc 1.12.9 */
557 _OrthancPluginService_RegisterFindCallback2 = 1023, /* New in Orthanc 1.12.10 */
558 _OrthancPluginService_RegisterMoveCallback2 = 1024, /* New in Orthanc 1.12.10 */
559 _OrthancPluginService_RegisterWorklistCallback2 = 1025, /* New in Orthanc 1.12.10 */
560 _OrthancPluginService_RegisterStorageCommitmentScpCallback2 = 1026, /* New in Orthanc 1.12.10 */
561
562 /* Sending answers to REST calls */
563 _OrthancPluginService_AnswerBuffer = 2000,
564 _OrthancPluginService_CompressAndAnswerPngImage = 2001, /* Unused as of Orthanc 0.9.4 */
565 _OrthancPluginService_Redirect = 2002,
566 _OrthancPluginService_SendHttpStatusCode = 2003,
567 _OrthancPluginService_SendUnauthorized = 2004,
568 _OrthancPluginService_SendMethodNotAllowed = 2005,
569 _OrthancPluginService_SetCookie = 2006,
570 _OrthancPluginService_SetHttpHeader = 2007,
571 _OrthancPluginService_StartMultipartAnswer = 2008,
572 _OrthancPluginService_SendMultipartItem = 2009,
573 _OrthancPluginService_SendHttpStatus = 2010,
574 _OrthancPluginService_CompressAndAnswerImage = 2011,
575 _OrthancPluginService_SendMultipartItem2 = 2012,
576 _OrthancPluginService_SetHttpErrorDetails = 2013,
577 _OrthancPluginService_StartStreamAnswer = 2014,
578 _OrthancPluginService_SendStreamChunk = 2015,
579
580 /* Access to the Orthanc database and API */
581 _OrthancPluginService_GetDicomForInstance = 3000,
582 _OrthancPluginService_RestApiGet = 3001,
583 _OrthancPluginService_RestApiPost = 3002,
584 _OrthancPluginService_RestApiDelete = 3003,
585 _OrthancPluginService_RestApiPut = 3004,
586 _OrthancPluginService_LookupPatient = 3005,
587 _OrthancPluginService_LookupStudy = 3006,
588 _OrthancPluginService_LookupSeries = 3007,
589 _OrthancPluginService_LookupInstance = 3008,
590 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
591 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
592 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
593 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
594 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
595 _OrthancPluginService_ReconstructMainDicomTags = 3014,
596 _OrthancPluginService_RestApiGet2 = 3015,
597 _OrthancPluginService_CallRestApi = 3016, /* New in Orthanc 1.9.2 */
598
599 /* Access to DICOM instances */
600 _OrthancPluginService_GetInstanceRemoteAet = 4000,
601 _OrthancPluginService_GetInstanceSize = 4001,
602 _OrthancPluginService_GetInstanceData = 4002,
603 _OrthancPluginService_GetInstanceJson = 4003,
604 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
605 _OrthancPluginService_HasInstanceMetadata = 4005,
606 _OrthancPluginService_GetInstanceMetadata = 4006,
607 _OrthancPluginService_GetInstanceOrigin = 4007,
608 _OrthancPluginService_GetInstanceTransferSyntaxUid = 4008,
609 _OrthancPluginService_HasInstancePixelData = 4009,
610 _OrthancPluginService_CreateDicomInstance = 4010, /* New in Orthanc 1.7.0 */
611 _OrthancPluginService_FreeDicomInstance = 4011, /* New in Orthanc 1.7.0 */
612 _OrthancPluginService_GetInstanceFramesCount = 4012, /* New in Orthanc 1.7.0 */
613 _OrthancPluginService_GetInstanceRawFrame = 4013, /* New in Orthanc 1.7.0 */
614 _OrthancPluginService_GetInstanceDecodedFrame = 4014, /* New in Orthanc 1.7.0 */
615 _OrthancPluginService_TranscodeDicomInstance = 4015, /* New in Orthanc 1.7.0 */
616 _OrthancPluginService_SerializeDicomInstance = 4016, /* New in Orthanc 1.7.0 */
617 _OrthancPluginService_GetInstanceAdvancedJson = 4017, /* New in Orthanc 1.7.0 */
618 _OrthancPluginService_GetInstanceDicomWebJson = 4018, /* New in Orthanc 1.7.0 */
619 _OrthancPluginService_GetInstanceDicomWebXml = 4019, /* New in Orthanc 1.7.0 */
620 _OrthancPluginService_LoadDicomInstance = 4020, /* New in Orthanc 1.12.1 */
621 _OrthancPluginService_GetInstanceCalledAet = 4021, /* New in Orthanc 1.13.1 */
622 _OrthancPluginService_GetInstanceRemoteIp = 4022, /* New in Orthanc 1.13.1 */
623
624 /* Services for plugins implementing a database back-end */
625 _OrthancPluginService_RegisterDatabaseBackend = 5000, /* New in Orthanc 0.8.6 */
626 _OrthancPluginService_DatabaseAnswer = 5001,
627 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002, /* New in Orthanc 0.9.4 */
628 _OrthancPluginService_StorageAreaCreate = 5003,
629 _OrthancPluginService_StorageAreaRead = 5004,
630 _OrthancPluginService_StorageAreaRemove = 5005,
631 _OrthancPluginService_RegisterDatabaseBackendV3 = 5006, /* New in Orthanc 1.9.2 */
632 _OrthancPluginService_RegisterDatabaseBackendV4 = 5007, /* New in Orthanc 1.12.0 */
633
634 /* Primitives for handling images */
635 _OrthancPluginService_GetImagePixelFormat = 6000,
636 _OrthancPluginService_GetImageWidth = 6001,
637 _OrthancPluginService_GetImageHeight = 6002,
638 _OrthancPluginService_GetImagePitch = 6003,
639 _OrthancPluginService_GetImageBuffer = 6004,
640 _OrthancPluginService_UncompressImage = 6005,
641 _OrthancPluginService_FreeImage = 6006,
642 _OrthancPluginService_CompressImage = 6007,
643 _OrthancPluginService_ConvertPixelFormat = 6008,
644 _OrthancPluginService_GetFontsCount = 6009,
645 _OrthancPluginService_GetFontInfo = 6010,
646 _OrthancPluginService_DrawText = 6011,
647 _OrthancPluginService_CreateImage = 6012,
648 _OrthancPluginService_CreateImageAccessor = 6013,
649 _OrthancPluginService_DecodeDicomImage = 6014,
650
651 /* Primitives for handling C-Find, C-Move and worklists */
652 _OrthancPluginService_WorklistAddAnswer = 7000,
653 _OrthancPluginService_WorklistMarkIncomplete = 7001,
654 _OrthancPluginService_WorklistIsMatch = 7002,
655 _OrthancPluginService_WorklistGetDicomQuery = 7003,
656 _OrthancPluginService_FindAddAnswer = 7004,
657 _OrthancPluginService_FindMarkIncomplete = 7005,
658 _OrthancPluginService_GetFindQuerySize = 7006,
659 _OrthancPluginService_GetFindQueryTag = 7007,
660 _OrthancPluginService_GetFindQueryTagName = 7008,
661 _OrthancPluginService_GetFindQueryValue = 7009,
662 _OrthancPluginService_CreateFindMatcher = 7010,
663 _OrthancPluginService_FreeFindMatcher = 7011,
664 _OrthancPluginService_FindMatcherIsMatch = 7012,
665
666 /* Primitives for accessing Orthanc Peers (new in 1.4.2) */
667 _OrthancPluginService_GetPeers = 8000,
668 _OrthancPluginService_FreePeers = 8001,
669 _OrthancPluginService_GetPeersCount = 8003,
670 _OrthancPluginService_GetPeerName = 8004,
671 _OrthancPluginService_GetPeerUrl = 8005,
672 _OrthancPluginService_CallPeerApi = 8006,
673 _OrthancPluginService_GetPeerUserProperty = 8007,
674
675 /* Primitives for handling jobs (new in 1.4.2) */
676 _OrthancPluginService_CreateJob = 9000, /* Deprecated since SDK 1.11.3 */
677 _OrthancPluginService_FreeJob = 9001,
678 _OrthancPluginService_SubmitJob = 9002,
679 _OrthancPluginService_RegisterJobsUnserializer = 9003,
680 _OrthancPluginService_CreateJob2 = 9004, /* New in SDK 1.11.3 */
681
682 /* Access to DICOM connection */
683 _OrthancPluginService_GetConnectionRemoteAet = 10000, /* New in SDK 1.12.10 */
684 _OrthancPluginService_GetConnectionRemoteIp = 10001, /* New in SDK 1.12.10 */
685 _OrthancPluginService_GetConnectionCalledAet = 10002, /* New in SDK 1.12.10 */
686
687 _OrthancPluginService_INTERNAL = 0x7fffffff
688 } _OrthancPluginService;
689
690
691 typedef enum
692 {
693 _OrthancPluginProperty_Description = 1,
694 _OrthancPluginProperty_RootUri = 2,
695 _OrthancPluginProperty_OrthancExplorer = 3,
696
697 _OrthancPluginProperty_INTERNAL = 0x7fffffff
698 } _OrthancPluginProperty;
699
700
701
706 typedef enum
707 {
715
723
731
739
747
749
756 OrthancPluginPixelFormat_RGB48 ORTHANC_PLUGIN_SINCE_SDK("1.3.1") = 7,
757
764 OrthancPluginPixelFormat_Grayscale32 ORTHANC_PLUGIN_SINCE_SDK("1.3.1") = 8,
765
772 OrthancPluginPixelFormat_Float32 ORTHANC_PLUGIN_SINCE_SDK("1.3.1") = 9,
773
780 OrthancPluginPixelFormat_BGRA32 ORTHANC_PLUGIN_SINCE_SDK("1.3.1") = 10,
781
788 OrthancPluginPixelFormat_Grayscale64 ORTHANC_PLUGIN_SINCE_SDK("1.4.0") = 11,
789
790 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
792
793
794
798 typedef enum
799 {
803 OrthancPluginContentType_DicomUntilPixelData ORTHANC_PLUGIN_SINCE_SDK("1.9.2") = 3,
804
805 _OrthancPluginContentType_INTERNAL = 0x7fffffff
807
808
809
823
824
825
855
856
871
872
877 typedef enum
878 {
882
883 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
885
886
891 typedef enum
892 {
927
928 _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff
930
931
937 typedef enum
938 {
942
943 _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff
945
946
966
967
973 typedef enum
974 {
975 OrthancPluginCreateDicomFlags_None ORTHANC_PLUGIN_SINCE_SDK("1.2.0") = 0,
978
979 _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff
981
982
997
998
1013
1014
1029
1030
1040
1041
1055
1056
1060 typedef enum ORTHANC_PLUGIN_SINCE_SDK("1.5.4")
1061 {
1063
1071
1072
1085
1086
1135
1136
1140 typedef enum ORTHANC_PLUGIN_SINCE_SDK("1.10.0")
1141 {
1145
1146 _OrthancPluginReceivedInstanceAction_INTERNAL = 0x7fffffff
1148
1149
1154 typedef enum ORTHANC_PLUGIN_SINCE_SDK("1.12.1")
1155 {
1160
1166
1173
1174 _OrthancPluginLoadDicomInstanceMode_INTERNAL = 0x7fffffff
1176
1177
1184 typedef enum ORTHANC_PLUGIN_SINCE_SDK("1.12.4")
1185 {
1190
1191 _OrthancPluginLogLevel_INTERNAL = 0x7fffffff
1193
1194
1201 typedef enum ORTHANC_PLUGIN_SINCE_SDK("1.12.4")
1202 {
1210
1211 _OrthancPluginLogCategory_INTERNAL = 0x7fffffff
1213
1214
1218 typedef enum ORTHANC_PLUGIN_SINCE_SDK("1.12.8")
1219 {
1225
1226 _OrthancPluginStoreStatus_INTERNAL = 0x7fffffff
1228
1229
1233 typedef enum ORTHANC_PLUGIN_SINCE_SDK("1.12.8")
1234 {
1237
1238 _OrthancPluginQueueOrigin_INTERNAL = 0x7fffffff
1240
1241
1245 typedef enum ORTHANC_PLUGIN_SINCE_SDK("1.12.9")
1246 {
1249
1250 _OrthancPluginStableStatus_INTERNAL = 0x7fffffff
1252
1253
1266
1267
1275 typedef struct
1276 {
1280 void* data;
1281
1285 uint32_t size;
1287
1288
1289
1297 ORTHANC_PLUGIN_SINCE_SDK("1.9.0") typedef struct
1298 {
1302 void* data;
1303
1307 uint64_t size;
1309
1310
1311
1312
1317 typedef struct _OrthancPluginRestOutput_t OrthancPluginRestOutput;
1318
1319
1320
1325 typedef struct _OrthancPluginDicomInstance_t OrthancPluginDicomInstance;
1326
1327
1328
1333 typedef struct _OrthancPluginImage_t OrthancPluginImage;
1334
1335
1336
1341 typedef struct _OrthancPluginStorageArea_t OrthancPluginStorageArea;
1342
1343
1344
1349 typedef struct _OrthancPluginWorklistQuery_t OrthancPluginWorklistQuery;
1350
1351
1352
1357 typedef struct _OrthancPluginWorklistAnswers_t OrthancPluginWorklistAnswers;
1358
1359
1360
1365 typedef struct ORTHANC_PLUGIN_SINCE_SDK("1.1.0")
1366 _OrthancPluginFindQuery_t OrthancPluginFindQuery;
1367
1368
1369
1374 typedef struct ORTHANC_PLUGIN_SINCE_SDK("1.1.0")
1375 _OrthancPluginFindAnswers_t OrthancPluginFindAnswers;
1376
1377
1378
1383 typedef struct ORTHANC_PLUGIN_SINCE_SDK("1.2.0")
1384 _OrthancPluginFindMatcher_t OrthancPluginFindMatcher;
1385
1386
1387
1392 typedef struct ORTHANC_PLUGIN_SINCE_SDK("1.4.2")
1393 _OrthancPluginPeers_t OrthancPluginPeers;
1394
1395
1396
1401 typedef struct ORTHANC_PLUGIN_SINCE_SDK("1.4.2")
1402 _OrthancPluginJob_t OrthancPluginJob;
1403
1404
1405
1411 typedef struct ORTHANC_PLUGIN_SINCE_SDK("1.5.4")
1412 _OrthancPluginDicomWebNode_t OrthancPluginDicomWebNode;
1413
1414
1419 typedef struct ORTHANC_PLUGIN_SINCE_SDK("1.12.10")
1420 _OrthancPluginDicomConnection_t OrthancPluginDicomConnection;
1421
1422
1429 const char* uri,
1430 const OrthancPluginHttpRequest* request);
1431
1432
1433
1439 const OrthancPluginDicomInstance* instance,
1440 const char* instanceId);
1441
1442
1443
1449 OrthancPluginChangeType changeType,
1450 OrthancPluginResourceType resourceType,
1451 const char* resourceId);
1452
1453
1454
1460 OrthancPluginImage** target,
1461 const void* dicom,
1462 const uint32_t size,
1463 uint32_t frameIndex);
1464
1465
1466
1471 typedef void (*OrthancPluginFree) (void* buffer);
1472
1473
1474
1484 const char* bulkDataUri);
1485
1486
1487
1501 const char* uuid,
1502 const void* content,
1503 int64_t size,
1505
1506
1507
1527 void** content,
1528 int64_t* size,
1529 const char* uuid,
1531
1532
1533
1548 const char* uuid,
1550
1551
1552
1571 const char* uuid,
1573 uint64_t rangeStart);
1574
1575
1576
1588 const char* uuid,
1590
1591
1592
1612 OrthancPluginMemoryBuffer* customData,
1613 const char* uuid,
1614 const void* content,
1615 uint64_t size,
1617 OrthancPluginCompressionType compressionType,
1618 const OrthancPluginDicomInstance* dicomInstance);
1619
1620
1621
1642 const char* uuid,
1644 uint64_t rangeStart,
1645 const void* customData,
1646 uint32_t customDataSize);
1647
1648
1649
1664 const char* uuid,
1666 const void* customData,
1667 uint32_t customDataSize);
1668
1669
1685 const OrthancPluginWorklistQuery* query,
1686 const char* issuerAet,
1687 const char* calledAet);
1688
1689
1702 ORTHANC_PLUGIN_SINCE_SDK("1.12.10")
1705 const OrthancPluginWorklistQuery* query,
1706 const OrthancPluginDicomConnection* connection);
1707
1708
1734 const char* uri,
1735 const char* ip,
1736 uint32_t headersCount,
1737 const char* const* headersKeys,
1738 const char* const* headersValues);
1739
1740
1741
1773 const char* uri,
1774 const char* ip,
1775 uint32_t headersCount,
1776 const char* const* headersKeys,
1777 const char* const* headersValues,
1778 uint32_t getArgumentsCount,
1779 const char* const* getArgumentsKeys,
1780 const char* const* getArgumentsValues);
1781
1782
1783
1799 OrthancPluginFindAnswers* answers,
1800 const OrthancPluginFindQuery* query,
1801 const char* issuerAet,
1802 const char* calledAet);
1803
1804
1818 ORTHANC_PLUGIN_SINCE_SDK("1.12.10")
1820 OrthancPluginFindAnswers* answers,
1821 const OrthancPluginFindQuery* query,
1822 const OrthancPluginDicomConnection* connection);
1823
1824
1860 typedef void* (*OrthancPluginMoveCallback) (
1861 OrthancPluginResourceType resourceType,
1862 const char* patientId,
1863 const char* accessionNumber,
1864 const char* studyInstanceUid,
1865 const char* seriesInstanceUid,
1866 const char* sopInstanceUid,
1867 const char* originatorAet,
1868 const char* sourceAet,
1869 const char* targetAet,
1870 uint16_t originatorId);
1871
1872
1905 ORTHANC_PLUGIN_SINCE_SDK("1.12.10")
1907 OrthancPluginResourceType resourceType,
1908 const char* patientId,
1909 const char* accessionNumber,
1910 const char* studyInstanceUid,
1911 const char* seriesInstanceUid,
1912 const char* sopInstanceUid,
1913 const OrthancPluginDicomConnection* connection,
1914 const char* targetAet,
1915 uint16_t originatorId);
1916
1917
1930 typedef uint32_t (*OrthancPluginGetMoveSize) (void* moveDriver);
1931
1932
1945 typedef OrthancPluginErrorCode (*OrthancPluginApplyMove) (void* moveDriver);
1946
1947
1959 typedef void (*OrthancPluginFreeMove) (void* moveDriver);
1960
1961
1972 typedef void (*OrthancPluginJobFinalize) (void* job);
1973
1974
1985 typedef float (*OrthancPluginJobGetProgress) (void* job);
1986
1987
2001 typedef const char* (*OrthancPluginJobGetContent) (void* job);
2002
2003
2020 void* job);
2021
2022
2039 typedef const char* (*OrthancPluginJobGetSerialized) (void* job);
2040
2041
2060 void* job);
2061
2062
2076
2077
2101
2102
2117
2118
2132 typedef OrthancPluginJob* (*OrthancPluginJobsUnserializer) (const char* jobType,
2133 const char* serialized);
2134
2135
2136
2152
2153
2154
2182 uint32_t levelDepth,
2183 const uint16_t* levelTagGroup,
2184 const uint16_t* levelTagElement,
2185 const uint32_t* levelIndex,
2186 uint16_t tagGroup,
2187 uint16_t tagElement,
2189
2190
2191
2220 uint32_t levelDepth,
2221 const uint16_t* levelTagGroup,
2222 const uint16_t* levelTagElement,
2223 const uint32_t* levelIndex,
2224 uint16_t tagGroup,
2225 uint16_t tagElement,
2227 void* payload);
2228
2229
2230
2234 typedef struct _OrthancPluginContext_t
2235 {
2236 void* pluginsManager;
2237 const char* orthancVersion;
2238 OrthancPluginFree Free;
2239 OrthancPluginErrorCode (*InvokeService) (struct _OrthancPluginContext_t* context,
2240 _OrthancPluginService service,
2241 const void* params);
2243
2244
2245
2257
2258
2259
2268 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeString(
2269 OrthancPluginContext* context,
2270 char* str)
2271 {
2272 if (str != NULL)
2273 {
2274 context->Free(str);
2275 }
2276 }
2277
2278
2298 ORTHANC_PLUGIN_SINCE_SDK("1.4.0")
2299 ORTHANC_PLUGIN_INLINE int32_t OrthancPluginCheckVersionAdvanced(
2300 const OrthancPluginContext* context,
2301 int32_t expectedMajor,
2302 int32_t expectedMinor,
2303 int32_t expectedRevision)
2304 {
2305 int32_t major, minor, revision;
2306
2307 if (sizeof(int) != sizeof(int32_t) || /* Ensure binary compatibility with Orthanc SDK <= 1.12.1 */
2308 sizeof(int32_t) != sizeof(OrthancPluginErrorCode) ||
2309 sizeof(int32_t) != sizeof(OrthancPluginHttpMethod) ||
2310 sizeof(int32_t) != sizeof(_OrthancPluginService) ||
2311 sizeof(int32_t) != sizeof(_OrthancPluginProperty) ||
2312 sizeof(int32_t) != sizeof(OrthancPluginPixelFormat) ||
2313 sizeof(int32_t) != sizeof(OrthancPluginContentType) ||
2314 sizeof(int32_t) != sizeof(OrthancPluginResourceType) ||
2315 sizeof(int32_t) != sizeof(OrthancPluginChangeType) ||
2316 sizeof(int32_t) != sizeof(OrthancPluginCompressionType) ||
2317 sizeof(int32_t) != sizeof(OrthancPluginImageFormat) ||
2318 sizeof(int32_t) != sizeof(OrthancPluginValueRepresentation) ||
2319 sizeof(int32_t) != sizeof(OrthancPluginDicomToJsonFormat) ||
2320 sizeof(int32_t) != sizeof(OrthancPluginDicomToJsonFlags) ||
2321 sizeof(int32_t) != sizeof(OrthancPluginCreateDicomFlags) ||
2322 sizeof(int32_t) != sizeof(OrthancPluginIdentifierConstraint) ||
2323 sizeof(int32_t) != sizeof(OrthancPluginInstanceOrigin) ||
2324 sizeof(int32_t) != sizeof(OrthancPluginJobStepStatus) ||
2325 sizeof(int32_t) != sizeof(OrthancPluginJobStopReason) ||
2326 sizeof(int32_t) != sizeof(OrthancPluginConstraintType) ||
2327 sizeof(int32_t) != sizeof(OrthancPluginMetricsType) ||
2328 sizeof(int32_t) != sizeof(OrthancPluginDicomWebBinaryMode) ||
2329 sizeof(int32_t) != sizeof(OrthancPluginStorageCommitmentFailureReason) ||
2330 sizeof(int32_t) != sizeof(OrthancPluginReceivedInstanceAction) ||
2331 sizeof(int32_t) != sizeof(OrthancPluginLoadDicomInstanceMode) ||
2332 sizeof(int32_t) != sizeof(OrthancPluginLogLevel) ||
2333 sizeof(int32_t) != sizeof(OrthancPluginLogCategory) ||
2334 sizeof(int32_t) != sizeof(OrthancPluginStoreStatus) ||
2335 sizeof(int32_t) != sizeof(OrthancPluginQueueOrigin) ||
2336 sizeof(int32_t) != sizeof(OrthancPluginStableStatus) ||
2337 sizeof(int32_t) != sizeof(OrthancPluginHttpAuthenticationStatus))
2338 {
2339 /* Mismatch in the size of the enumerations */
2340 return 0;
2341 }
2342
2343 /* Assume compatibility with the mainline */
2344 if (!strcmp(context->orthancVersion, "mainline"))
2345 {
2346 return 1;
2347 }
2348
2349 /* Parse the version of the Orthanc core */
2350 if (
2351#ifdef _MSC_VER
2352 sscanf_s
2353#else
2354 sscanf
2355#endif
2356 (context->orthancVersion, "%4d.%4d.%4d", &major, &minor, &revision) != 3)
2357 {
2358 return 0;
2359 }
2360
2361 /* Check the major number of the version */
2362
2363 if (major > expectedMajor)
2364 {
2365 return 1;
2366 }
2367
2368 if (major < expectedMajor)
2369 {
2370 return 0;
2371 }
2372
2373 /* Check the minor number of the version */
2374
2375 if (minor > expectedMinor)
2376 {
2377 return 1;
2378 }
2379
2380 if (minor < expectedMinor)
2381 {
2382 return 0;
2383 }
2384
2385 /* Check the revision number of the version */
2386
2387 if (revision >= expectedRevision)
2388 {
2389 return 1;
2390 }
2391 else
2392 {
2393 return 0;
2394 }
2395 }
2396
2397
2414 ORTHANC_PLUGIN_INLINE int32_t OrthancPluginCheckVersion(
2415 const OrthancPluginContext* context)
2416 {
2418 context,
2419 ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER,
2420 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER,
2421 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER);
2422 }
2423
2424
2433 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeMemoryBuffer(
2434 OrthancPluginContext* context,
2436 {
2437 context->Free(buffer->data);
2438 }
2439
2440
2449 ORTHANC_PLUGIN_SINCE_SDK("1.9.0")
2450 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeMemoryBuffer64(
2451 OrthancPluginContext* context,
2453 {
2454 context->Free(buffer->data);
2455 }
2456
2457
2466 ORTHANC_PLUGIN_INLINE void OrthancPluginLogError(
2467 OrthancPluginContext* context,
2468 const char* message)
2469 {
2470 context->InvokeService(context, _OrthancPluginService_LogError, message);
2471 }
2472
2473
2482 ORTHANC_PLUGIN_INLINE void OrthancPluginLogWarning(
2483 OrthancPluginContext* context,
2484 const char* message)
2485 {
2486 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
2487 }
2488
2489
2498 ORTHANC_PLUGIN_INLINE void OrthancPluginLogInfo(
2499 OrthancPluginContext* context,
2500 const char* message)
2501 {
2502 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
2503 }
2504
2505
2506
2507 typedef struct
2508 {
2509 const char* pathRegularExpression;
2511 } _OrthancPluginRestCallback;
2512
2534 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterRestCallback(
2535 OrthancPluginContext* context,
2536 const char* pathRegularExpression,
2538 {
2539 _OrthancPluginRestCallback params;
2540 params.pathRegularExpression = pathRegularExpression;
2541 params.callback = callback;
2542 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, &params);
2543 }
2544
2545
2546
2575 OrthancPluginContext* context,
2576 const char* pathRegularExpression,
2578 {
2579 _OrthancPluginRestCallback params;
2580 params.pathRegularExpression = pathRegularExpression;
2581 params.callback = callback;
2582 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, &params);
2583 }
2584
2585
2586
2587 typedef struct
2588 {
2590 } _OrthancPluginOnStoredInstanceCallback;
2591
2613 OrthancPluginContext* context,
2615 {
2616 _OrthancPluginOnStoredInstanceCallback params;
2617 params.callback = callback;
2618
2619 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, &params);
2620 }
2621
2622
2623
2624 typedef struct
2625 {
2627 const void* answer;
2628 uint32_t answerSize;
2629 const char* mimeType;
2630 } _OrthancPluginAnswerBuffer;
2631
2644 ORTHANC_PLUGIN_INLINE void OrthancPluginAnswerBuffer(
2645 OrthancPluginContext* context,
2647 const void* answer,
2648 uint32_t answerSize,
2649 const char* mimeType)
2650 {
2651 _OrthancPluginAnswerBuffer params;
2652 params.output = output;
2653 params.answer = answer;
2654 params.answerSize = answerSize;
2655 params.mimeType = mimeType;
2656 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, &params);
2657 }
2658
2659
2660 typedef struct
2661 {
2664 uint32_t width;
2665 uint32_t height;
2666 uint32_t pitch;
2667 const void* buffer;
2668 } _OrthancPluginCompressAndAnswerPngImage;
2669
2670 typedef struct
2671 {
2673 OrthancPluginImageFormat imageFormat;
2674 OrthancPluginPixelFormat pixelFormat;
2675 uint32_t width;
2676 uint32_t height;
2677 uint32_t pitch;
2678 const void* buffer;
2679 uint8_t quality;
2680 } _OrthancPluginCompressAndAnswerImage;
2681
2682
2701 ORTHANC_PLUGIN_INLINE void OrthancPluginCompressAndAnswerPngImage(
2702 OrthancPluginContext* context,
2705 uint32_t width,
2706 uint32_t height,
2707 uint32_t pitch,
2708 const void* buffer)
2709 {
2710 _OrthancPluginCompressAndAnswerImage params;
2711 params.output = output;
2712 params.imageFormat = OrthancPluginImageFormat_Png;
2713 params.pixelFormat = format;
2714 params.width = width;
2715 params.height = height;
2716 params.pitch = pitch;
2717 params.buffer = buffer;
2718 params.quality = 0; /* No quality for PNG */
2719 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, &params);
2720 }
2721
2722
2723
2724 typedef struct
2725 {
2727 const char* instanceId;
2728 } _OrthancPluginGetDicomForInstance;
2729
2743 OrthancPluginContext* context,
2745 const char* instanceId)
2746 {
2747 _OrthancPluginGetDicomForInstance params;
2748 params.target = target;
2749 params.instanceId = instanceId;
2750 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, &params);
2751 }
2752
2753
2754
2755 typedef struct
2756 {
2758 const char* uri;
2759 } _OrthancPluginRestApiGet;
2760
2776 OrthancPluginContext* context,
2778 const char* uri)
2779 {
2780 _OrthancPluginRestApiGet params;
2781 params.target = target;
2782 params.uri = uri;
2783 return context->InvokeService(context, _OrthancPluginService_RestApiGet, &params);
2784 }
2785
2786
2787
2806 OrthancPluginContext* context,
2808 const char* uri)
2809 {
2810 _OrthancPluginRestApiGet params;
2811 params.target = target;
2812 params.uri = uri;
2813 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, &params);
2814 }
2815
2816
2817
2818 typedef struct
2819 {
2821 const char* uri;
2822 const void* body;
2823 uint32_t bodySize;
2824 } _OrthancPluginRestApiPostPut;
2825
2843 OrthancPluginContext* context,
2845 const char* uri,
2846 const void* body,
2847 uint32_t bodySize)
2848 {
2849 _OrthancPluginRestApiPostPut params;
2850 params.target = target;
2851 params.uri = uri;
2852 params.body = body;
2853 params.bodySize = bodySize;
2854 return context->InvokeService(context, _OrthancPluginService_RestApiPost, &params);
2855 }
2856
2857
2878 OrthancPluginContext* context,
2880 const char* uri,
2881 const void* body,
2882 uint32_t bodySize)
2883 {
2884 _OrthancPluginRestApiPostPut params;
2885 params.target = target;
2886 params.uri = uri;
2887 params.body = body;
2888 params.bodySize = bodySize;
2889 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, &params);
2890 }
2891
2892
2893
2907 OrthancPluginContext* context,
2908 const char* uri)
2909 {
2910 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
2911 }
2912
2913
2930 OrthancPluginContext* context,
2931 const char* uri)
2932 {
2933 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
2934 }
2935
2936
2937
2955 OrthancPluginContext* context,
2957 const char* uri,
2958 const void* body,
2959 uint32_t bodySize)
2960 {
2961 _OrthancPluginRestApiPostPut params;
2962 params.target = target;
2963 params.uri = uri;
2964 params.body = body;
2965 params.bodySize = bodySize;
2966 return context->InvokeService(context, _OrthancPluginService_RestApiPut, &params);
2967 }
2968
2969
2970
2991 OrthancPluginContext* context,
2993 const char* uri,
2994 const void* body,
2995 uint32_t bodySize)
2996 {
2997 _OrthancPluginRestApiPostPut params;
2998 params.target = target;
2999 params.uri = uri;
3000 params.body = body;
3001 params.bodySize = bodySize;
3002 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, &params);
3003 }
3004
3005
3006
3007 typedef struct
3008 {
3010 const char* argument;
3011 } _OrthancPluginOutputPlusArgument;
3012
3024 ORTHANC_PLUGIN_INLINE void OrthancPluginRedirect(
3025 OrthancPluginContext* context,
3027 const char* redirection)
3028 {
3029 _OrthancPluginOutputPlusArgument params;
3030 params.output = output;
3031 params.argument = redirection;
3032 context->InvokeService(context, _OrthancPluginService_Redirect, &params);
3033 }
3034
3035
3036
3037 typedef struct
3038 {
3039 char** result;
3040 const char* argument;
3041 } _OrthancPluginRetrieveDynamicString;
3042
3056 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupPatient(
3057 OrthancPluginContext* context,
3058 const char* patientID)
3059 {
3060 char* result;
3061
3062 _OrthancPluginRetrieveDynamicString params;
3063 params.result = &result;
3064 params.argument = patientID;
3065
3066 if (context->InvokeService(context, _OrthancPluginService_LookupPatient, &params) != OrthancPluginErrorCode_Success)
3067 {
3068 /* Error */
3069 return NULL;
3070 }
3071 else
3072 {
3073 return result;
3074 }
3075 }
3076
3077
3091 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupStudy(
3092 OrthancPluginContext* context,
3093 const char* studyUID)
3094 {
3095 char* result;
3096
3097 _OrthancPluginRetrieveDynamicString params;
3098 params.result = &result;
3099 params.argument = studyUID;
3100
3101 if (context->InvokeService(context, _OrthancPluginService_LookupStudy, &params) != OrthancPluginErrorCode_Success)
3102 {
3103 /* Error */
3104 return NULL;
3105 }
3106 else
3107 {
3108 return result;
3109 }
3110 }
3111
3112
3127 OrthancPluginContext* context,
3128 const char* accessionNumber)
3129 {
3130 char* result;
3131
3132 _OrthancPluginRetrieveDynamicString params;
3133 params.result = &result;
3134 params.argument = accessionNumber;
3135
3136 if (context->InvokeService(context, _OrthancPluginService_LookupStudyWithAccessionNumber, &params) != OrthancPluginErrorCode_Success)
3137 {
3138 /* Error */
3139 return NULL;
3140 }
3141 else
3142 {
3143 return result;
3144 }
3145 }
3146
3147
3161 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupSeries(
3162 OrthancPluginContext* context,
3163 const char* seriesUID)
3164 {
3165 char* result;
3166
3167 _OrthancPluginRetrieveDynamicString params;
3168 params.result = &result;
3169 params.argument = seriesUID;
3170
3171 if (context->InvokeService(context, _OrthancPluginService_LookupSeries, &params) != OrthancPluginErrorCode_Success)
3172 {
3173 /* Error */
3174 return NULL;
3175 }
3176 else
3177 {
3178 return result;
3179 }
3180 }
3181
3182
3196 ORTHANC_PLUGIN_INLINE char* OrthancPluginLookupInstance(
3197 OrthancPluginContext* context,
3198 const char* sopInstanceUID)
3199 {
3200 char* result;
3201
3202 _OrthancPluginRetrieveDynamicString params;
3203 params.result = &result;
3204 params.argument = sopInstanceUID;
3205
3206 if (context->InvokeService(context, _OrthancPluginService_LookupInstance, &params) != OrthancPluginErrorCode_Success)
3207 {
3208 /* Error */
3209 return NULL;
3210 }
3211 else
3212 {
3213 return result;
3214 }
3215 }
3216
3217
3218
3219 typedef struct
3220 {
3222 uint16_t status;
3223 } _OrthancPluginSendHttpStatusCode;
3224
3241 ORTHANC_PLUGIN_INLINE void OrthancPluginSendHttpStatusCode(
3242 OrthancPluginContext* context,
3244 uint16_t status)
3245 {
3246 _OrthancPluginSendHttpStatusCode params;
3247 params.output = output;
3248 params.status = status;
3249 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, &params);
3250 }
3251
3252
3264 ORTHANC_PLUGIN_INLINE void OrthancPluginSendUnauthorized(
3265 OrthancPluginContext* context,
3267 const char* realm)
3268 {
3269 _OrthancPluginOutputPlusArgument params;
3270 params.output = output;
3271 params.argument = realm;
3272 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, &params);
3273 }
3274
3275
3287 ORTHANC_PLUGIN_INLINE void OrthancPluginSendMethodNotAllowed(
3288 OrthancPluginContext* context,
3290 const char* allowedMethods)
3291 {
3292 _OrthancPluginOutputPlusArgument params;
3293 params.output = output;
3294 params.argument = allowedMethods;
3295 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, &params);
3296 }
3297
3298
3299 typedef struct
3300 {
3302 const char* key;
3303 const char* value;
3304 } _OrthancPluginSetHttpHeader;
3305
3317 ORTHANC_PLUGIN_INLINE void OrthancPluginSetCookie(
3318 OrthancPluginContext* context,
3320 const char* cookie,
3321 const char* value)
3322 {
3323 _OrthancPluginSetHttpHeader params;
3324 params.output = output;
3325 params.key = cookie;
3326 params.value = value;
3327 context->InvokeService(context, _OrthancPluginService_SetCookie, &params);
3328 }
3329
3330
3342 ORTHANC_PLUGIN_INLINE void OrthancPluginSetHttpHeader(
3343 OrthancPluginContext* context,
3345 const char* key,
3346 const char* value)
3347 {
3348 _OrthancPluginSetHttpHeader params;
3349 params.output = output;
3350 params.key = key;
3351 params.value = value;
3352 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, &params);
3353 }
3354
3355
3356 typedef struct
3357 {
3358 char** resultStringToFree;
3359 const char** resultString;
3360 int64_t* resultInt64;
3361 const char* key;
3362 const OrthancPluginDicomInstance* instance;
3363 OrthancPluginInstanceOrigin* resultOrigin; /* New in Orthanc 0.9.5 SDK */
3364 } _OrthancPluginAccessDicomInstance;
3365
3366
3378 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceRemoteAet(
3379 OrthancPluginContext* context,
3380 const OrthancPluginDicomInstance* instance)
3381 {
3382 const char* result;
3383
3384 _OrthancPluginAccessDicomInstance params;
3385 memset(&params, 0, sizeof(params));
3386 params.resultString = &result;
3387 params.instance = instance;
3388
3389 if (context->InvokeService(context, _OrthancPluginService_GetInstanceRemoteAet, &params) != OrthancPluginErrorCode_Success)
3390 {
3391 /* Error */
3392 return NULL;
3393 }
3394 else
3395 {
3396 return result;
3397 }
3398 }
3399
3400
3412 ORTHANC_PLUGIN_SINCE_SDK("1.13.1")
3413 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceCalledAet(
3414 OrthancPluginContext* context,
3415 const OrthancPluginDicomInstance* instance)
3416 {
3417 const char* result;
3418
3419 _OrthancPluginAccessDicomInstance params;
3420 memset(&params, 0, sizeof(params));
3421 params.resultString = &result;
3422 params.instance = instance;
3423
3424 if (context->InvokeService(context, _OrthancPluginService_GetInstanceCalledAet, &params) != OrthancPluginErrorCode_Success)
3425 {
3426 /* Error */
3427 return NULL;
3428 }
3429 else
3430 {
3431 return result;
3432 }
3433 }
3434
3435
3446 ORTHANC_PLUGIN_SINCE_SDK("1.13.1")
3447 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceRemoteIp(
3448 OrthancPluginContext* context,
3449 const OrthancPluginDicomInstance* instance)
3450 {
3451 const char* result;
3452
3453 _OrthancPluginAccessDicomInstance params;
3454 memset(&params, 0, sizeof(params));
3455 params.resultString = &result;
3456 params.instance = instance;
3457
3458 if (context->InvokeService(context, _OrthancPluginService_GetInstanceRemoteIp, &params) != OrthancPluginErrorCode_Success)
3459 {
3460 /* Error */
3461 return NULL;
3462 }
3463 else
3464 {
3465 return result;
3466 }
3467 }
3468
3469
3480 ORTHANC_PLUGIN_INLINE int64_t OrthancPluginGetInstanceSize(
3481 OrthancPluginContext* context,
3482 const OrthancPluginDicomInstance* instance)
3483 {
3484 int64_t size;
3485
3486 _OrthancPluginAccessDicomInstance params;
3487 memset(&params, 0, sizeof(params));
3488 params.resultInt64 = &size;
3489 params.instance = instance;
3490
3491 if (context->InvokeService(context, _OrthancPluginService_GetInstanceSize, &params) != OrthancPluginErrorCode_Success)
3492 {
3493 /* Error */
3494 return -1;
3495 }
3496 else
3497 {
3498 return size;
3499 }
3500 }
3501
3502
3513 ORTHANC_PLUGIN_INLINE const void* OrthancPluginGetInstanceData(
3514 OrthancPluginContext* context,
3515 const OrthancPluginDicomInstance* instance)
3516 {
3517 const char* result;
3518
3519 _OrthancPluginAccessDicomInstance params;
3520 memset(&params, 0, sizeof(params));
3521 params.resultString = &result;
3522 params.instance = instance;
3523
3524 if (context->InvokeService(context, _OrthancPluginService_GetInstanceData, &params) != OrthancPluginErrorCode_Success)
3525 {
3526 /* Error */
3527 return NULL;
3528 }
3529 else
3530 {
3531 return result;
3532 }
3533 }
3534
3535
3549 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceJson(
3550 OrthancPluginContext* context,
3551 const OrthancPluginDicomInstance* instance)
3552 {
3553 char* result;
3554
3555 _OrthancPluginAccessDicomInstance params;
3556 memset(&params, 0, sizeof(params));
3557 params.resultStringToFree = &result;
3558 params.instance = instance;
3559
3560 if (context->InvokeService(context, _OrthancPluginService_GetInstanceJson, &params) != OrthancPluginErrorCode_Success)
3561 {
3562 /* Error */
3563 return NULL;
3564 }
3565 else
3566 {
3567 return result;
3568 }
3569 }
3570
3571
3587 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceSimplifiedJson(
3588 OrthancPluginContext* context,
3589 const OrthancPluginDicomInstance* instance)
3590 {
3591 char* result;
3592
3593 _OrthancPluginAccessDicomInstance params;
3594 memset(&params, 0, sizeof(params));
3595 params.resultStringToFree = &result;
3596 params.instance = instance;
3597
3598 if (context->InvokeService(context, _OrthancPluginService_GetInstanceSimplifiedJson, &params) != OrthancPluginErrorCode_Success)
3599 {
3600 /* Error */
3601 return NULL;
3602 }
3603 else
3604 {
3605 return result;
3606 }
3607 }
3608
3609
3626 ORTHANC_PLUGIN_INLINE int32_t OrthancPluginHasInstanceMetadata(
3627 OrthancPluginContext* context,
3628 const OrthancPluginDicomInstance* instance,
3629 const char* metadata)
3630 {
3631 int64_t result;
3632
3633 _OrthancPluginAccessDicomInstance params;
3634 memset(&params, 0, sizeof(params));
3635 params.resultInt64 = &result;
3636 params.instance = instance;
3637 params.key = metadata;
3638
3639 if (context->InvokeService(context, _OrthancPluginService_HasInstanceMetadata, &params) != OrthancPluginErrorCode_Success)
3640 {
3641 /* Error */
3642 return -1;
3643 }
3644 else
3645 {
3646 return (result != 0);
3647 }
3648 }
3649
3650
3667 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetInstanceMetadata(
3668 OrthancPluginContext* context,
3669 const OrthancPluginDicomInstance* instance,
3670 const char* metadata)
3671 {
3672 const char* result;
3673
3674 _OrthancPluginAccessDicomInstance params;
3675 memset(&params, 0, sizeof(params));
3676 params.resultString = &result;
3677 params.instance = instance;
3678 params.key = metadata;
3679
3680 if (context->InvokeService(context, _OrthancPluginService_GetInstanceMetadata, &params) != OrthancPluginErrorCode_Success)
3681 {
3682 /* Error */
3683 return NULL;
3684 }
3685 else
3686 {
3687 return result;
3688 }
3689 }
3690
3691
3692
3693 typedef struct
3694 {
3698 OrthancPluginFree free;
3699 } _OrthancPluginRegisterStorageArea;
3700
3716 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterStorageArea(
3717 OrthancPluginContext* context,
3721 {
3722 _OrthancPluginRegisterStorageArea params;
3723 params.create = create;
3724 params.read = read;
3725 params.remove = remove;
3726
3727#ifdef __cplusplus
3728 params.free = ::free;
3729#else
3730 params.free = free;
3731#endif
3732
3733 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, &params);
3734 }
3735
3736
3737
3748 ORTHANC_PLUGIN_INLINE char *OrthancPluginGetOrthancPath(OrthancPluginContext* context)
3749 {
3750 char* result;
3751
3752 _OrthancPluginRetrieveDynamicString params;
3753 params.result = &result;
3754 params.argument = NULL;
3755
3756 if (context->InvokeService(context, _OrthancPluginService_GetOrthancPath, &params) != OrthancPluginErrorCode_Success)
3757 {
3758 /* Error */
3759 return NULL;
3760 }
3761 else
3762 {
3763 return result;
3764 }
3765 }
3766
3767
3778 ORTHANC_PLUGIN_INLINE char *OrthancPluginGetOrthancDirectory(OrthancPluginContext* context)
3779 {
3780 char* result;
3781
3782 _OrthancPluginRetrieveDynamicString params;
3783 params.result = &result;
3784 params.argument = NULL;
3785
3786 if (context->InvokeService(context, _OrthancPluginService_GetOrthancDirectory, &params) != OrthancPluginErrorCode_Success)
3787 {
3788 /* Error */
3789 return NULL;
3790 }
3791 else
3792 {
3793 return result;
3794 }
3795 }
3796
3797
3813 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE char *OrthancPluginGetConfigurationPath(OrthancPluginContext* context)
3814 {
3815 char* result;
3816
3817 _OrthancPluginRetrieveDynamicString params;
3818 params.result = &result;
3819 params.argument = NULL;
3820
3821 if (context->InvokeService(context, _OrthancPluginService_GetConfigurationPath, &params) != OrthancPluginErrorCode_Success)
3822 {
3823 /* Error */
3824 return NULL;
3825 }
3826 else
3827 {
3828 return result;
3829 }
3830 }
3831
3832
3833
3834 typedef struct
3835 {
3837 } _OrthancPluginOnChangeCallback;
3838
3859 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterOnChangeCallback(
3860 OrthancPluginContext* context,
3862 {
3863 _OrthancPluginOnChangeCallback params;
3864 params.callback = callback;
3865
3866 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, &params);
3867 }
3868
3869
3870
3871 typedef struct
3872 {
3873 const char* plugin;
3874 _OrthancPluginProperty property;
3875 const char* value;
3876 } _OrthancPluginSetPluginProperty;
3877
3878
3894 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE void OrthancPluginSetRootUri(
3895 OrthancPluginContext* context,
3896 const char* uri)
3897 {
3898 _OrthancPluginSetPluginProperty params;
3899 params.plugin = OrthancPluginGetName();
3900 params.property = _OrthancPluginProperty_RootUri;
3901 params.value = uri;
3902
3903 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, &params);
3904 }
3905
3906
3919 ORTHANC_PLUGIN_SINCE_SDK("1.12.4")
3920 ORTHANC_PLUGIN_INLINE void OrthancPluginSetRootUri2(
3921 OrthancPluginContext* context,
3922 const char* plugin,
3923 const char* uri)
3924 {
3925 _OrthancPluginSetPluginProperty params;
3926 params.plugin = plugin;
3927 params.property = _OrthancPluginProperty_RootUri;
3928 params.value = uri;
3929
3930 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, &params);
3931 }
3932
3933
3947 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE void OrthancPluginSetDescription(
3948 OrthancPluginContext* context,
3949 const char* description)
3950 {
3951 _OrthancPluginSetPluginProperty params;
3952 params.plugin = OrthancPluginGetName();
3953 params.property = _OrthancPluginProperty_Description;
3954 params.value = description;
3955
3956 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, &params);
3957 }
3958
3959
3970 ORTHANC_PLUGIN_SINCE_SDK("1.12.4")
3971 ORTHANC_PLUGIN_INLINE void OrthancPluginSetDescription2(
3972 OrthancPluginContext* context,
3973 const char* plugin,
3974 const char* description)
3975 {
3976 _OrthancPluginSetPluginProperty params;
3977 params.plugin = plugin;
3978 params.property = _OrthancPluginProperty_Description;
3979 params.value = description;
3980
3981 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, &params);
3982 }
3983
3984
3998 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE void OrthancPluginExtendOrthancExplorer(
3999 OrthancPluginContext* context,
4000 const char* javascript)
4001 {
4002 _OrthancPluginSetPluginProperty params;
4003 params.plugin = OrthancPluginGetName();
4004 params.property = _OrthancPluginProperty_OrthancExplorer;
4005 params.value = javascript;
4006
4007 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, &params);
4008 }
4009
4010
4021 ORTHANC_PLUGIN_SINCE_SDK("1.12.4")
4022 ORTHANC_PLUGIN_INLINE void OrthancPluginExtendOrthancExplorer2(
4023 OrthancPluginContext* context,
4024 const char* plugin,
4025 const char* javascript)
4026 {
4027 _OrthancPluginSetPluginProperty params;
4028 params.plugin = plugin;
4029 params.property = _OrthancPluginProperty_OrthancExplorer;
4030 params.value = javascript;
4031
4032 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, &params);
4033 }
4034
4035
4036 typedef struct
4037 {
4038 char** result;
4039 int32_t property;
4040 const char* value;
4041 } _OrthancPluginGlobalProperty;
4042
4043
4057 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetGlobalProperty(
4058 OrthancPluginContext* context,
4059 int32_t property,
4060 const char* defaultValue)
4061 {
4062 char* result;
4063
4064 _OrthancPluginGlobalProperty params;
4065 params.result = &result;
4066 params.property = property;
4067 params.value = defaultValue;
4068
4069 if (context->InvokeService(context, _OrthancPluginService_GetGlobalProperty, &params) != OrthancPluginErrorCode_Success)
4070 {
4071 /* Error */
4072 return NULL;
4073 }
4074 else
4075 {
4076 return result;
4077 }
4078 }
4079
4080
4097 OrthancPluginContext* context,
4098 int32_t property,
4099 const char* value)
4100 {
4101 _OrthancPluginGlobalProperty params;
4102 params.result = NULL;
4103 params.property = property;
4104 params.value = value;
4105
4106 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, &params);
4107 }
4108
4109
4110
4111 typedef struct
4112 {
4113 int32_t *resultInt32;
4114 uint32_t *resultUint32;
4115 int64_t *resultInt64;
4116 uint64_t *resultUint64;
4117 } _OrthancPluginReturnSingleValue;
4118
4127 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetCommandLineArgumentsCount(
4128 OrthancPluginContext* context)
4129 {
4130 uint32_t count = 0;
4131
4132 _OrthancPluginReturnSingleValue params;
4133 memset(&params, 0, sizeof(params));
4134 params.resultUint32 = &count;
4135
4136 if (context->InvokeService(context, _OrthancPluginService_GetCommandLineArgumentsCount, &params) != OrthancPluginErrorCode_Success)
4137 {
4138 /* Error */
4139 return 0;
4140 }
4141 else
4142 {
4143 return count;
4144 }
4145 }
4146
4147
4148
4161 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetCommandLineArgument(
4162 OrthancPluginContext* context,
4163 uint32_t argument)
4164 {
4165 char* result;
4166
4167 _OrthancPluginGlobalProperty params;
4168 params.result = &result;
4169 params.property = (int32_t) argument;
4170 params.value = NULL;
4171
4172 if (context->InvokeService(context, _OrthancPluginService_GetCommandLineArgument, &params) != OrthancPluginErrorCode_Success)
4173 {
4174 /* Error */
4175 return NULL;
4176 }
4177 else
4178 {
4179 return result;
4180 }
4181 }
4182
4183
4193 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetExpectedDatabaseVersion(
4194 OrthancPluginContext* context)
4195 {
4196 uint32_t count = 0;
4197
4198 _OrthancPluginReturnSingleValue params;
4199 memset(&params, 0, sizeof(params));
4200 params.resultUint32 = &count;
4201
4202 if (context->InvokeService(context, _OrthancPluginService_GetExpectedDatabaseVersion, &params) != OrthancPluginErrorCode_Success)
4203 {
4204 /* Error */
4205 return 0;
4206 }
4207 else
4208 {
4209 return count;
4210 }
4211 }
4212
4213
4214
4226 ORTHANC_PLUGIN_INLINE char *OrthancPluginGetConfiguration(OrthancPluginContext* context)
4227 {
4228 char* result;
4229
4230 _OrthancPluginRetrieveDynamicString params;
4231 params.result = &result;
4232 params.argument = NULL;
4233
4234 if (context->InvokeService(context, _OrthancPluginService_GetConfiguration, &params) != OrthancPluginErrorCode_Success)
4235 {
4236 /* Error */
4237 return NULL;
4238 }
4239 else
4240 {
4241 return result;
4242 }
4243 }
4244
4245
4246
4247 typedef struct
4248 {
4250 const char* subType;
4251 const char* contentType;
4252 } _OrthancPluginStartMultipartAnswer;
4253
4268 OrthancPluginContext* context,
4270 const char* subType,
4271 const char* contentType)
4272 {
4273 _OrthancPluginStartMultipartAnswer params;
4274 params.output = output;
4275 params.subType = subType;
4276 params.contentType = contentType;
4277 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, &params);
4278 }
4279
4280
4297 OrthancPluginContext* context,
4299 const void* answer,
4300 uint32_t answerSize)
4301 {
4302 _OrthancPluginAnswerBuffer params;
4303 params.output = output;
4304 params.answer = answer;
4305 params.answerSize = answerSize;
4306 params.mimeType = NULL;
4307 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, &params);
4308 }
4309
4310
4311
4312 typedef struct
4313 {
4315 const void* source;
4316 uint32_t size;
4317 OrthancPluginCompressionType compression;
4318 uint8_t uncompress;
4319 } _OrthancPluginBufferCompression;
4320
4321
4339 OrthancPluginContext* context,
4341 const void* source,
4342 uint32_t size,
4343 OrthancPluginCompressionType compression,
4344 uint8_t uncompress)
4345 {
4346 _OrthancPluginBufferCompression params;
4347 params.target = target;
4348 params.source = source;
4349 params.size = size;
4350 params.compression = compression;
4351 params.uncompress = uncompress;
4352
4353 return context->InvokeService(context, _OrthancPluginService_BufferCompression, &params);
4354 }
4355
4356
4357
4358 typedef struct
4359 {
4361 const char* path;
4362 } _OrthancPluginReadFile;
4363
4376 OrthancPluginContext* context,
4378 const char* path)
4379 {
4380 _OrthancPluginReadFile params;
4381 params.target = target;
4382 params.path = path;
4383 return context->InvokeService(context, _OrthancPluginService_ReadFile, &params);
4384 }
4385
4386
4387
4388 typedef struct
4389 {
4390 const char* path;
4391 const void* data;
4392 uint32_t size;
4393 } _OrthancPluginWriteFile;
4394
4407 OrthancPluginContext* context,
4408 const char* path,
4409 const void* data,
4410 uint32_t size)
4411 {
4412 _OrthancPluginWriteFile params;
4413 params.path = path;
4414 params.data = data;
4415 params.size = size;
4416 return context->InvokeService(context, _OrthancPluginService_WriteFile, &params);
4417 }
4418
4419
4420
4421 typedef struct
4422 {
4423 const char** target;
4425 } _OrthancPluginGetErrorDescription;
4426
4437 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetErrorDescription(
4438 OrthancPluginContext* context,
4440 {
4441 const char* result = NULL;
4442
4443 _OrthancPluginGetErrorDescription params;
4444 params.target = &result;
4445 params.error = error;
4446
4447 if (context->InvokeService(context, _OrthancPluginService_GetErrorDescription, &params) != OrthancPluginErrorCode_Success ||
4448 result == NULL)
4449 {
4450 return "Unknown error code";
4451 }
4452 else
4453 {
4454 return result;
4455 }
4456 }
4457
4458
4459
4460 typedef struct
4461 {
4463 uint16_t status;
4464 const void* body;
4465 uint32_t bodySize;
4466 } _OrthancPluginSendHttpStatus;
4467
4490 ORTHANC_PLUGIN_INLINE void OrthancPluginSendHttpStatus(
4491 OrthancPluginContext* context,
4493 uint16_t status,
4494 const void* body,
4495 uint32_t bodySize)
4496 {
4497 _OrthancPluginSendHttpStatus params;
4498 params.output = output;
4499 params.status = status;
4500 params.body = body;
4501 params.bodySize = bodySize;
4502 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, &params);
4503 }
4504
4505
4506
4507 typedef struct
4508 {
4509 const OrthancPluginImage* image;
4510 uint32_t* resultUint32;
4511 OrthancPluginPixelFormat* resultPixelFormat;
4512 void** resultBuffer;
4513 } _OrthancPluginGetImageInfo;
4514
4515
4527 OrthancPluginContext* context,
4528 const OrthancPluginImage* image)
4529 {
4531
4532 _OrthancPluginGetImageInfo params;
4533 memset(&params, 0, sizeof(params));
4534 params.image = image;
4535 params.resultPixelFormat = &target;
4536
4537 if (context->InvokeService(context, _OrthancPluginService_GetImagePixelFormat, &params) != OrthancPluginErrorCode_Success)
4538 {
4540 }
4541 else
4542 {
4543 return (OrthancPluginPixelFormat) target;
4544 }
4545 }
4546
4547
4548
4559 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetImageWidth(
4560 OrthancPluginContext* context,
4561 const OrthancPluginImage* image)
4562 {
4563 uint32_t width;
4564
4565 _OrthancPluginGetImageInfo params;
4566 memset(&params, 0, sizeof(params));
4567 params.image = image;
4568 params.resultUint32 = &width;
4569
4570 if (context->InvokeService(context, _OrthancPluginService_GetImageWidth, &params) != OrthancPluginErrorCode_Success)
4571 {
4572 return 0;
4573 }
4574 else
4575 {
4576 return width;
4577 }
4578 }
4579
4580
4581
4592 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetImageHeight(
4593 OrthancPluginContext* context,
4594 const OrthancPluginImage* image)
4595 {
4596 uint32_t height;
4597
4598 _OrthancPluginGetImageInfo params;
4599 memset(&params, 0, sizeof(params));
4600 params.image = image;
4601 params.resultUint32 = &height;
4602
4603 if (context->InvokeService(context, _OrthancPluginService_GetImageHeight, &params) != OrthancPluginErrorCode_Success)
4604 {
4605 return 0;
4606 }
4607 else
4608 {
4609 return height;
4610 }
4611 }
4612
4613
4614
4627 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetImagePitch(
4628 OrthancPluginContext* context,
4629 const OrthancPluginImage* image)
4630 {
4631 uint32_t pitch;
4632
4633 _OrthancPluginGetImageInfo params;
4634 memset(&params, 0, sizeof(params));
4635 params.image = image;
4636 params.resultUint32 = &pitch;
4637
4638 if (context->InvokeService(context, _OrthancPluginService_GetImagePitch, &params) != OrthancPluginErrorCode_Success)
4639 {
4640 return 0;
4641 }
4642 else
4643 {
4644 return pitch;
4645 }
4646 }
4647
4648
4649
4661 ORTHANC_PLUGIN_INLINE void* OrthancPluginGetImageBuffer(
4662 OrthancPluginContext* context,
4663 const OrthancPluginImage* image)
4664 {
4665 void* target = NULL;
4666
4667 _OrthancPluginGetImageInfo params;
4668 memset(&params, 0, sizeof(params));
4669 params.resultBuffer = &target;
4670 params.image = image;
4671
4672 if (context->InvokeService(context, _OrthancPluginService_GetImageBuffer, &params) != OrthancPluginErrorCode_Success)
4673 {
4674 return NULL;
4675 }
4676 else
4677 {
4678 return target;
4679 }
4680 }
4681
4682
4683 typedef struct
4684 {
4685 OrthancPluginImage** target;
4686 const void* data;
4687 uint32_t size;
4689 } _OrthancPluginUncompressImage;
4690
4691
4705 OrthancPluginContext* context,
4706 const void* data,
4707 uint32_t size,
4709 {
4710 OrthancPluginImage* target = NULL;
4711
4712 _OrthancPluginUncompressImage params;
4713 memset(&params, 0, sizeof(params));
4714 params.target = &target;
4715 params.data = data;
4716 params.size = size;
4717 params.format = format;
4718
4719 if (context->InvokeService(context, _OrthancPluginService_UncompressImage, &params) != OrthancPluginErrorCode_Success)
4720 {
4721 return NULL;
4722 }
4723 else
4724 {
4725 return target;
4726 }
4727 }
4728
4729
4730
4731
4732 typedef struct
4733 {
4734 OrthancPluginImage* image;
4735 } _OrthancPluginFreeImage;
4736
4746 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeImage(
4747 OrthancPluginContext* context,
4748 OrthancPluginImage* image)
4749 {
4750 _OrthancPluginFreeImage params;
4751 params.image = image;
4752
4753 context->InvokeService(context, _OrthancPluginService_FreeImage, &params);
4754 }
4755
4756
4757
4758
4759 typedef struct
4760 {
4762 OrthancPluginImageFormat imageFormat;
4763 OrthancPluginPixelFormat pixelFormat;
4764 uint32_t width;
4765 uint32_t height;
4766 uint32_t pitch;
4767 const void* buffer;
4768 uint8_t quality;
4769 } _OrthancPluginCompressImage;
4770
4771
4792 OrthancPluginContext* context,
4795 uint32_t width,
4796 uint32_t height,
4797 uint32_t pitch,
4798 const void* buffer)
4799 {
4800 _OrthancPluginCompressImage params;
4801 memset(&params, 0, sizeof(params));
4802 params.target = target;
4803 params.imageFormat = OrthancPluginImageFormat_Png;
4804 params.pixelFormat = format;
4805 params.width = width;
4806 params.height = height;
4807 params.pitch = pitch;
4808 params.buffer = buffer;
4809 params.quality = 0; /* Unused for PNG */
4810
4811 return context->InvokeService(context, _OrthancPluginService_CompressImage, &params);
4812 }
4813
4814
4837 OrthancPluginContext* context,
4840 uint32_t width,
4841 uint32_t height,
4842 uint32_t pitch,
4843 const void* buffer,
4844 uint8_t quality)
4845 {
4846 _OrthancPluginCompressImage params;
4847 memset(&params, 0, sizeof(params));
4848 params.target = target;
4849 params.imageFormat = OrthancPluginImageFormat_Jpeg;
4850 params.pixelFormat = format;
4851 params.width = width;
4852 params.height = height;
4853 params.pitch = pitch;
4854 params.buffer = buffer;
4855 params.quality = quality;
4856
4857 return context->InvokeService(context, _OrthancPluginService_CompressImage, &params);
4858 }
4859
4860
4861
4884 OrthancPluginContext* context,
4887 uint32_t width,
4888 uint32_t height,
4889 uint32_t pitch,
4890 const void* buffer,
4891 uint8_t quality)
4892 {
4893 _OrthancPluginCompressAndAnswerImage params;
4894 params.output = output;
4895 params.imageFormat = OrthancPluginImageFormat_Jpeg;
4896 params.pixelFormat = format;
4897 params.width = width;
4898 params.height = height;
4899 params.pitch = pitch;
4900 params.buffer = buffer;
4901 params.quality = quality;
4902 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, &params);
4903 }
4904
4905
4906
4907
4908 typedef struct
4909 {
4912 const char* url;
4913 const char* username;
4914 const char* password;
4915 const void* body;
4916 uint32_t bodySize;
4917 } _OrthancPluginCallHttpClient;
4918
4919
4937 OrthancPluginContext* context,
4939 const char* url,
4940 const char* username,
4941 const char* password)
4942 {
4943 _OrthancPluginCallHttpClient params;
4944 memset(&params, 0, sizeof(params));
4945
4946 params.target = target;
4947 params.method = OrthancPluginHttpMethod_Get;
4948 params.url = url;
4949 params.username = username;
4950 params.password = password;
4951
4952 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, &params);
4953 }
4954
4955
4975 OrthancPluginContext* context,
4977 const char* url,
4978 const void* body,
4979 uint32_t bodySize,
4980 const char* username,
4981 const char* password)
4982 {
4983 _OrthancPluginCallHttpClient params;
4984 memset(&params, 0, sizeof(params));
4985
4986 params.target = target;
4987 params.method = OrthancPluginHttpMethod_Post;
4988 params.url = url;
4989 params.body = body;
4990 params.bodySize = bodySize;
4991 params.username = username;
4992 params.password = password;
4993
4994 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, &params);
4995 }
4996
4997
5017 OrthancPluginContext* context,
5019 const char* url,
5020 const void* body,
5021 uint32_t bodySize,
5022 const char* username,
5023 const char* password)
5024 {
5025 _OrthancPluginCallHttpClient params;
5026 memset(&params, 0, sizeof(params));
5027
5028 params.target = target;
5029 params.method = OrthancPluginHttpMethod_Put;
5030 params.url = url;
5031 params.body = body;
5032 params.bodySize = bodySize;
5033 params.username = username;
5034 params.password = password;
5035
5036 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, &params);
5037 }
5038
5039
5055 OrthancPluginContext* context,
5056 const char* url,
5057 const char* username,
5058 const char* password)
5059 {
5060 _OrthancPluginCallHttpClient params;
5061 memset(&params, 0, sizeof(params));
5062
5063 params.method = OrthancPluginHttpMethod_Delete;
5064 params.url = url;
5065 params.username = username;
5066 params.password = password;
5067
5068 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, &params);
5069 }
5070
5071
5072
5073 typedef struct
5074 {
5075 OrthancPluginImage** target;
5076 const OrthancPluginImage* source;
5077 OrthancPluginPixelFormat targetFormat;
5078 } _OrthancPluginConvertPixelFormat;
5079
5080
5093 OrthancPluginContext* context,
5094 const OrthancPluginImage* source,
5095 OrthancPluginPixelFormat targetFormat)
5096 {
5097 OrthancPluginImage* target = NULL;
5098
5099 _OrthancPluginConvertPixelFormat params;
5100 params.target = &target;
5101 params.source = source;
5102 params.targetFormat = targetFormat;
5103
5104 if (context->InvokeService(context, _OrthancPluginService_ConvertPixelFormat, &params) != OrthancPluginErrorCode_Success)
5105 {
5106 return NULL;
5107 }
5108 else
5109 {
5110 return target;
5111 }
5112 }
5113
5114
5115
5127 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetFontsCount(
5128 OrthancPluginContext* context)
5129 {
5130 uint32_t count = 0;
5131
5132 _OrthancPluginReturnSingleValue params;
5133 memset(&params, 0, sizeof(params));
5134 params.resultUint32 = &count;
5135
5136 if (context->InvokeService(context, _OrthancPluginService_GetFontsCount, &params) != OrthancPluginErrorCode_Success)
5137 {
5138 /* Error */
5139 return 0;
5140 }
5141 else
5142 {
5143 return count;
5144 }
5145 }
5146
5147
5148
5149
5150 typedef struct
5151 {
5152 uint32_t fontIndex; /* in */
5153 const char** name; /* out */
5154 uint32_t* size; /* out */
5155 } _OrthancPluginGetFontInfo;
5156
5167 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetFontName(
5168 OrthancPluginContext* context,
5169 uint32_t fontIndex)
5170 {
5171 const char* result = NULL;
5172
5173 _OrthancPluginGetFontInfo params;
5174 memset(&params, 0, sizeof(params));
5175 params.name = &result;
5176 params.fontIndex = fontIndex;
5177
5178 if (context->InvokeService(context, _OrthancPluginService_GetFontInfo, &params) != OrthancPluginErrorCode_Success)
5179 {
5180 return NULL;
5181 }
5182 else
5183 {
5184 return result;
5185 }
5186 }
5187
5188
5199 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetFontSize(
5200 OrthancPluginContext* context,
5201 uint32_t fontIndex)
5202 {
5203 uint32_t result;
5204
5205 _OrthancPluginGetFontInfo params;
5206 memset(&params, 0, sizeof(params));
5207 params.size = &result;
5208 params.fontIndex = fontIndex;
5209
5210 if (context->InvokeService(context, _OrthancPluginService_GetFontInfo, &params) != OrthancPluginErrorCode_Success)
5211 {
5212 return 0;
5213 }
5214 else
5215 {
5216 return result;
5217 }
5218 }
5219
5220
5221
5222 typedef struct
5223 {
5224 OrthancPluginImage* image;
5225 uint32_t fontIndex;
5226 const char* utf8Text;
5227 int32_t x;
5228 int32_t y;
5229 uint8_t r;
5230 uint8_t g;
5231 uint8_t b;
5232 } _OrthancPluginDrawText;
5233
5234
5253 OrthancPluginContext* context,
5254 OrthancPluginImage* image,
5255 uint32_t fontIndex,
5256 const char* utf8Text,
5257 int32_t x,
5258 int32_t y,
5259 uint8_t r,
5260 uint8_t g,
5261 uint8_t b)
5262 {
5263 _OrthancPluginDrawText params;
5264 memset(&params, 0, sizeof(params));
5265 params.image = image;
5266 params.fontIndex = fontIndex;
5267 params.utf8Text = utf8Text;
5268 params.x = x;
5269 params.y = y;
5270 params.r = r;
5271 params.g = g;
5272 params.b = b;
5273
5274 return context->InvokeService(context, _OrthancPluginService_DrawText, &params);
5275 }
5276
5277
5278
5279 typedef struct
5280 {
5281 OrthancPluginStorageArea* storageArea;
5282 const char* uuid;
5283 const void* content;
5284 uint64_t size;
5286 } _OrthancPluginStorageAreaCreate;
5287
5288
5308 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStorageAreaCreate(
5309 OrthancPluginContext* context,
5310 OrthancPluginStorageArea* storageArea,
5311 const char* uuid,
5312 const void* content,
5313 uint64_t size,
5315 {
5316 _OrthancPluginStorageAreaCreate params;
5317 params.storageArea = storageArea;
5318 params.uuid = uuid;
5319 params.content = content;
5320 params.size = size;
5321 params.type = type;
5322
5323 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, &params);
5324 }
5325
5326
5327 typedef struct
5328 {
5330 OrthancPluginStorageArea* storageArea;
5331 const char* uuid;
5333 } _OrthancPluginStorageAreaRead;
5334
5335
5354 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStorageAreaRead(
5355 OrthancPluginContext* context,
5357 OrthancPluginStorageArea* storageArea,
5358 const char* uuid,
5360 {
5361 _OrthancPluginStorageAreaRead params;
5362 params.target = target;
5363 params.storageArea = storageArea;
5364 params.uuid = uuid;
5365 params.type = type;
5366
5367 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, &params);
5368 }
5369
5370
5371 typedef struct
5372 {
5373 OrthancPluginStorageArea* storageArea;
5374 const char* uuid;
5376 } _OrthancPluginStorageAreaRemove;
5377
5395 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginStorageAreaRemove(
5396 OrthancPluginContext* context,
5397 OrthancPluginStorageArea* storageArea,
5398 const char* uuid,
5400 {
5401 _OrthancPluginStorageAreaRemove params;
5402 params.storageArea = storageArea;
5403 params.uuid = uuid;
5404 params.type = type;
5405
5406 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, &params);
5407 }
5408
5409
5410
5411 typedef struct
5412 {
5413 OrthancPluginErrorCode* target;
5414 int32_t code;
5415 uint16_t httpStatus;
5416 const char* message;
5417 } _OrthancPluginRegisterErrorCode;
5418
5435 OrthancPluginContext* context,
5436 int32_t code,
5437 uint16_t httpStatus,
5438 const char* message)
5439 {
5441
5442 _OrthancPluginRegisterErrorCode params;
5443 params.target = &target;
5444 params.code = code;
5445 params.httpStatus = httpStatus;
5446 params.message = message;
5447
5448 if (context->InvokeService(context, _OrthancPluginService_RegisterErrorCode, &params) == OrthancPluginErrorCode_Success)
5449 {
5450 return target;
5451 }
5452 else
5453 {
5454 /* There was an error while assigned the error. Use a generic code. */
5456 }
5457 }
5458
5459
5460
5461 typedef struct
5462 {
5463 uint16_t group;
5464 uint16_t element;
5466 const char* name;
5467 uint32_t minMultiplicity;
5468 uint32_t maxMultiplicity;
5469 } _OrthancPluginRegisterDictionaryTag;
5470
5491 OrthancPluginContext* context,
5492 uint16_t group,
5493 uint16_t element,
5495 const char* name,
5496 uint32_t minMultiplicity,
5497 uint32_t maxMultiplicity)
5498 {
5499 _OrthancPluginRegisterDictionaryTag params;
5500 params.group = group;
5501 params.element = element;
5502 params.vr = vr;
5503 params.name = name;
5504 params.minMultiplicity = minMultiplicity;
5505 params.maxMultiplicity = maxMultiplicity;
5506
5507 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, &params);
5508 }
5509
5510
5511
5512 typedef struct
5513 {
5514 uint16_t group;
5515 uint16_t element;
5517 const char* name;
5518 uint32_t minMultiplicity;
5519 uint32_t maxMultiplicity;
5520 const char* privateCreator;
5521 } _OrthancPluginRegisterPrivateDictionaryTag;
5522
5543 ORTHANC_PLUGIN_SINCE_SDK("1.2.0")
5545 OrthancPluginContext* context,
5546 uint16_t group,
5547 uint16_t element,
5549 const char* name,
5550 uint32_t minMultiplicity,
5551 uint32_t maxMultiplicity,
5552 const char* privateCreator)
5553 {
5554 _OrthancPluginRegisterPrivateDictionaryTag params;
5555 params.group = group;
5556 params.element = element;
5557 params.vr = vr;
5558 params.name = name;
5559 params.minMultiplicity = minMultiplicity;
5560 params.maxMultiplicity = maxMultiplicity;
5561 params.privateCreator = privateCreator;
5562
5563 return context->InvokeService(context, _OrthancPluginService_RegisterPrivateDictionaryTag, &params);
5564 }
5565
5566
5567
5568 typedef struct
5569 {
5570 OrthancPluginStorageArea* storageArea;
5572 } _OrthancPluginReconstructMainDicomTags;
5573
5589 OrthancPluginContext* context,
5590 OrthancPluginStorageArea* storageArea,
5592 {
5593 _OrthancPluginReconstructMainDicomTags params;
5594 params.level = level;
5595 params.storageArea = storageArea;
5596
5597 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, &params);
5598 }
5599
5600
5601 typedef struct
5602 {
5603 char** result;
5604 const char* instanceId;
5605 const void* buffer;
5606 uint32_t size;
5609 uint32_t maxStringLength;
5610 } _OrthancPluginDicomToJson;
5611
5612
5632 ORTHANC_PLUGIN_INLINE char* OrthancPluginDicomBufferToJson(
5633 OrthancPluginContext* context,
5634 const void* buffer,
5635 uint32_t size,
5638 uint32_t maxStringLength)
5639 {
5640 char* result;
5641
5642 _OrthancPluginDicomToJson params;
5643 memset(&params, 0, sizeof(params));
5644 params.result = &result;
5645 params.buffer = buffer;
5646 params.size = size;
5647 params.format = format;
5648 params.flags = flags;
5649 params.maxStringLength = maxStringLength;
5650
5651 if (context->InvokeService(context, _OrthancPluginService_DicomBufferToJson, &params) != OrthancPluginErrorCode_Success)
5652 {
5653 /* Error */
5654 return NULL;
5655 }
5656 else
5657 {
5658 return result;
5659 }
5660 }
5661
5662
5681 ORTHANC_PLUGIN_INLINE char* OrthancPluginDicomInstanceToJson(
5682 OrthancPluginContext* context,
5683 const char* instanceId,
5686 uint32_t maxStringLength)
5687 {
5688 char* result;
5689
5690 _OrthancPluginDicomToJson params;
5691 memset(&params, 0, sizeof(params));
5692 params.result = &result;
5693 params.instanceId = instanceId;
5694 params.format = format;
5695 params.flags = flags;
5696 params.maxStringLength = maxStringLength;
5697
5698 if (context->InvokeService(context, _OrthancPluginService_DicomInstanceToJson, &params) != OrthancPluginErrorCode_Success)
5699 {
5700 /* Error */
5701 return NULL;
5702 }
5703 else
5704 {
5705 return result;
5706 }
5707 }
5708
5709
5710 typedef struct
5711 {
5713 const char* uri;
5714 uint32_t headersCount;
5715 const char* const* headersKeys;
5716 const char* const* headersValues;
5717 int32_t afterPlugins;
5718 } _OrthancPluginRestApiGet2;
5719
5740 OrthancPluginContext* context,
5742 const char* uri,
5743 uint32_t headersCount,
5744 const char* const* headersKeys,
5745 const char* const* headersValues,
5746 int32_t afterPlugins)
5747 {
5748 _OrthancPluginRestApiGet2 params;
5749 params.target = target;
5750 params.uri = uri;
5751 params.headersCount = headersCount;
5752 params.headersKeys = headersKeys;
5753 params.headersValues = headersValues;
5754 params.afterPlugins = afterPlugins;
5755
5756 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, &params);
5757 }
5758
5759
5760
5761 typedef struct
5762 {
5764 } _OrthancPluginWorklistCallback;
5765
5778 OrthancPluginContext* context,
5780 {
5781 _OrthancPluginWorklistCallback params;
5782 params.callback = callback;
5783
5784 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, &params);
5785 }
5786
5787
5788 typedef struct
5789 {
5791 const OrthancPluginWorklistQuery* query;
5792 const void* dicom;
5793 uint32_t size;
5794 } _OrthancPluginWorklistAnswersOperation;
5795
5822 OrthancPluginContext* context,
5824 const OrthancPluginWorklistQuery* query,
5825 const void* dicom,
5826 uint32_t size)
5827 {
5828 _OrthancPluginWorklistAnswersOperation params;
5829 params.answers = answers;
5830 params.query = query;
5831 params.dicom = dicom;
5832 params.size = size;
5833
5834 return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, &params);
5835 }
5836
5837
5852 OrthancPluginContext* context,
5854 {
5855 _OrthancPluginWorklistAnswersOperation params;
5856 params.answers = answers;
5857 params.query = NULL;
5858 params.dicom = NULL;
5859 params.size = 0;
5860
5861 return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, &params);
5862 }
5863
5864
5865 typedef struct
5866 {
5867 const OrthancPluginWorklistQuery* query;
5868 const void* dicom;
5869 uint32_t size;
5870 int32_t* isMatch;
5872 } _OrthancPluginWorklistQueryOperation;
5873
5889 ORTHANC_PLUGIN_INLINE int32_t OrthancPluginWorklistIsMatch(
5890 OrthancPluginContext* context,
5891 const OrthancPluginWorklistQuery* query,
5892 const void* dicom,
5893 uint32_t size)
5894 {
5895 int32_t isMatch = 0;
5896
5897 _OrthancPluginWorklistQueryOperation params;
5898 params.query = query;
5899 params.dicom = dicom;
5900 params.size = size;
5901 params.isMatch = &isMatch;
5902 params.target = NULL;
5903
5904 if (context->InvokeService(context, _OrthancPluginService_WorklistIsMatch, &params) == OrthancPluginErrorCode_Success)
5905 {
5906 return isMatch;
5907 }
5908 else
5909 {
5910 /* Error: Assume non-match */
5911 return 0;
5912 }
5913 }
5914
5915
5929 OrthancPluginContext* context,
5931 const OrthancPluginWorklistQuery* query)
5932 {
5933 _OrthancPluginWorklistQueryOperation params;
5934 params.query = query;
5935 params.dicom = NULL;
5936 params.size = 0;
5937 params.isMatch = NULL;
5938 params.target = target;
5939
5940 return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, &params);
5941 }
5942
5943
5955 OrthancPluginContext* context,
5956 const OrthancPluginDicomInstance* instance)
5957 {
5959
5960 _OrthancPluginAccessDicomInstance params;
5961 memset(&params, 0, sizeof(params));
5962 params.resultOrigin = &origin;
5963 params.instance = instance;
5964
5965 if (context->InvokeService(context, _OrthancPluginService_GetInstanceOrigin, &params) != OrthancPluginErrorCode_Success)
5966 {
5967 /* Error */
5969 }
5970 else
5971 {
5972 return origin;
5973 }
5974 }
5975
5976
5977 typedef struct
5978 {
5980 const char* json;
5981 const OrthancPluginImage* pixelData;
5983 } _OrthancPluginCreateDicom;
5984
6011 OrthancPluginContext* context,
6013 const char* json,
6014 const OrthancPluginImage* pixelData,
6016 {
6017 _OrthancPluginCreateDicom params;
6018 params.target = target;
6019 params.json = json;
6020 params.pixelData = pixelData;
6021 params.flags = flags;
6022
6023 return context->InvokeService(context, _OrthancPluginService_CreateDicom, &params);
6024 }
6025
6026
6027 typedef struct
6028 {
6030 } _OrthancPluginDecodeImageCallback;
6031
6047 OrthancPluginContext* context,
6049 {
6050 _OrthancPluginDecodeImageCallback params;
6051 params.callback = callback;
6052
6053 return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, &params);
6054 }
6055
6056
6057
6058 typedef struct
6059 {
6060 OrthancPluginImage** target;
6062 uint32_t width;
6063 uint32_t height;
6064 uint32_t pitch;
6065 void* buffer;
6066 const void* constBuffer;
6067 uint32_t bufferSize;
6068 uint32_t frameIndex;
6069 } _OrthancPluginCreateImage;
6070
6071
6085 OrthancPluginContext* context,
6087 uint32_t width,
6088 uint32_t height)
6089 {
6090 OrthancPluginImage* target = NULL;
6091
6092 _OrthancPluginCreateImage params;
6093 memset(&params, 0, sizeof(params));
6094 params.target = &target;
6095 params.format = format;
6096 params.width = width;
6097 params.height = height;
6098
6099 if (context->InvokeService(context, _OrthancPluginService_CreateImage, &params) != OrthancPluginErrorCode_Success)
6100 {
6101 return NULL;
6102 }
6103 else
6104 {
6105 return target;
6106 }
6107 }
6108
6109
6128 OrthancPluginContext* context,
6130 uint32_t width,
6131 uint32_t height,
6132 uint32_t pitch,
6133 void* buffer)
6134 {
6135 OrthancPluginImage* target = NULL;
6136
6137 _OrthancPluginCreateImage params;
6138 memset(&params, 0, sizeof(params));
6139 params.target = &target;
6140 params.format = format;
6141 params.width = width;
6142 params.height = height;
6143 params.pitch = pitch;
6144 params.buffer = buffer;
6145
6146 if (context->InvokeService(context, _OrthancPluginService_CreateImageAccessor, &params) != OrthancPluginErrorCode_Success)
6147 {
6148 return NULL;
6149 }
6150 else
6151 {
6152 return target;
6153 }
6154 }
6155
6156
6157
6174 OrthancPluginContext* context,
6175 const void* buffer,
6176 uint32_t bufferSize,
6177 uint32_t frameIndex)
6178 {
6179 OrthancPluginImage* target = NULL;
6180
6181 _OrthancPluginCreateImage params;
6182 memset(&params, 0, sizeof(params));
6183 params.target = &target;
6184 params.constBuffer = buffer;
6185 params.bufferSize = bufferSize;
6186 params.frameIndex = frameIndex;
6187
6188 if (context->InvokeService(context, _OrthancPluginService_DecodeDicomImage, &params) != OrthancPluginErrorCode_Success)
6189 {
6190 return NULL;
6191 }
6192 else
6193 {
6194 return target;
6195 }
6196 }
6197
6198
6199
6200 typedef struct
6201 {
6202 char** result;
6203 const void* buffer;
6204 uint32_t size;
6205 } _OrthancPluginComputeHash;
6206
6219 ORTHANC_PLUGIN_INLINE char* OrthancPluginComputeMd5(
6220 OrthancPluginContext* context,
6221 const void* buffer,
6222 uint32_t size)
6223 {
6224 char* result;
6225
6226 _OrthancPluginComputeHash params;
6227 params.result = &result;
6228 params.buffer = buffer;
6229 params.size = size;
6230
6231 if (context->InvokeService(context, _OrthancPluginService_ComputeMd5, &params) != OrthancPluginErrorCode_Success)
6232 {
6233 /* Error */
6234 return NULL;
6235 }
6236 else
6237 {
6238 return result;
6239 }
6240 }
6241
6242
6255 ORTHANC_PLUGIN_INLINE char* OrthancPluginComputeSha1(
6256 OrthancPluginContext* context,
6257 const void* buffer,
6258 uint32_t size)
6259 {
6260 char* result;
6261
6262 _OrthancPluginComputeHash params;
6263 params.result = &result;
6264 params.buffer = buffer;
6265 params.size = size;
6266
6267 if (context->InvokeService(context, _OrthancPluginService_ComputeSha1, &params) != OrthancPluginErrorCode_Success)
6268 {
6269 /* Error */
6270 return NULL;
6271 }
6272 else
6273 {
6274 return result;
6275 }
6276 }
6277
6278
6279
6280 typedef struct
6281 {
6283 const char* name;
6284 } _OrthancPluginLookupDictionary;
6285
6302 OrthancPluginContext* context,
6304 const char* name)
6305 {
6306 _OrthancPluginLookupDictionary params;
6307 params.target = target;
6308 params.name = name;
6309 return context->InvokeService(context, _OrthancPluginService_LookupDictionary, &params);
6310 }
6311
6312
6313
6314 typedef struct
6315 {
6317 const void* answer;
6318 uint32_t answerSize;
6319 uint32_t headersCount;
6320 const char* const* headersKeys;
6321 const char* const* headersValues;
6322 } _OrthancPluginSendMultipartItem2;
6323
6344 ORTHANC_PLUGIN_SINCE_SDK("1.0.0")
6346 OrthancPluginContext* context,
6348 const void* answer,
6349 uint32_t answerSize,
6350 uint32_t headersCount,
6351 const char* const* headersKeys,
6352 const char* const* headersValues)
6353 {
6354 _OrthancPluginSendMultipartItem2 params;
6355 params.output = output;
6356 params.answer = answer;
6357 params.answerSize = answerSize;
6358 params.headersCount = headersCount;
6359 params.headersKeys = headersKeys;
6360 params.headersValues = headersValues;
6361
6362 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem2, &params);
6363 }
6364
6365
6366 typedef struct
6367 {
6369 } _OrthancPluginIncomingHttpRequestFilter;
6370
6383 ORTHANC_PLUGIN_SINCE_SDK("1.1.0")
6384 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter(
6385 OrthancPluginContext* context,
6387 {
6388 _OrthancPluginIncomingHttpRequestFilter params;
6389 params.callback = callback;
6390
6391 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter, &params);
6392 }
6393
6394
6395
6396 typedef struct
6397 {
6398 OrthancPluginMemoryBuffer* answerBody;
6399 OrthancPluginMemoryBuffer* answerHeaders;
6400 uint16_t* httpStatus;
6402 const char* url;
6403 uint32_t headersCount;
6404 const char* const* headersKeys;
6405 const char* const* headersValues;
6406 const void* body;
6407 uint32_t bodySize;
6408 const char* username;
6409 const char* password;
6410 uint32_t timeout;
6411 const char* certificateFile;
6412 const char* certificateKeyFile;
6413 const char* certificateKeyPassword;
6414 uint8_t pkcs11;
6415 } _OrthancPluginCallHttpClient2;
6416
6417
6418
6459 ORTHANC_PLUGIN_SINCE_SDK("1.1.0")
6461 OrthancPluginContext* context,
6462 OrthancPluginMemoryBuffer* answerBody,
6463 OrthancPluginMemoryBuffer* answerHeaders,
6464 uint16_t* httpStatus,
6466 const char* url,
6467 uint32_t headersCount,
6468 const char* const* headersKeys,
6469 const char* const* headersValues,
6470 const void* body,
6471 uint32_t bodySize,
6472 const char* username,
6473 const char* password,
6474 uint32_t timeout,
6475 const char* certificateFile,
6476 const char* certificateKeyFile,
6477 const char* certificateKeyPassword,
6478 uint8_t pkcs11)
6479 {
6480 _OrthancPluginCallHttpClient2 params;
6481 memset(&params, 0, sizeof(params));
6482
6483 params.answerBody = answerBody;
6484 params.answerHeaders = answerHeaders;
6485 params.httpStatus = httpStatus;
6486 params.method = method;
6487 params.url = url;
6488 params.headersCount = headersCount;
6489 params.headersKeys = headersKeys;
6490 params.headersValues = headersValues;
6491 params.body = body;
6492 params.bodySize = bodySize;
6493 params.username = username;
6494 params.password = password;
6495 params.timeout = timeout;
6496 params.certificateFile = certificateFile;
6497 params.certificateKeyFile = certificateKeyFile;
6498 params.certificateKeyPassword = certificateKeyPassword;
6499 params.pkcs11 = pkcs11;
6500
6501 return context->InvokeService(context, _OrthancPluginService_CallHttpClient2, &params);
6502 }
6503
6504
6515 ORTHANC_PLUGIN_SINCE_SDK("1.1.0")
6516 ORTHANC_PLUGIN_INLINE char* OrthancPluginGenerateUuid(
6517 OrthancPluginContext* context)
6518 {
6519 char* result;
6520
6521 _OrthancPluginRetrieveDynamicString params;
6522 params.result = &result;
6523 params.argument = NULL;
6524
6525 if (context->InvokeService(context, _OrthancPluginService_GenerateUuid, &params) != OrthancPluginErrorCode_Success)
6526 {
6527 /* Error */
6528 return NULL;
6529 }
6530 else
6531 {
6532 return result;
6533 }
6534 }
6535
6536
6537
6538
6539 typedef struct
6540 {
6542 } _OrthancPluginFindCallback;
6543
6555 ORTHANC_PLUGIN_SINCE_SDK("1.1.0")
6557 OrthancPluginContext* context,
6559 {
6560 _OrthancPluginFindCallback params;
6561 params.callback = callback;
6562
6563 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback, &params);
6564 }
6565
6566
6567 typedef struct
6568 {
6569 OrthancPluginFindAnswers *answers;
6570 const OrthancPluginFindQuery *query;
6571 const void *dicom;
6572 uint32_t size;
6573 uint32_t index;
6574 uint32_t *resultUint32;
6575 uint16_t *resultGroup;
6576 uint16_t *resultElement;
6577 char **resultString;
6578 } _OrthancPluginFindOperation;
6579
6595 ORTHANC_PLUGIN_SINCE_SDK("1.1.0")
6597 OrthancPluginContext* context,
6598 OrthancPluginFindAnswers* answers,
6599 const void* dicom,
6600 uint32_t size)
6601 {
6602 _OrthancPluginFindOperation params;
6603 memset(&params, 0, sizeof(params));
6604 params.answers = answers;
6605 params.dicom = dicom;
6606 params.size = size;
6607
6608 return context->InvokeService(context, _OrthancPluginService_FindAddAnswer, &params);
6609 }
6610
6611
6625 ORTHANC_PLUGIN_SINCE_SDK("1.1.0")
6627 OrthancPluginContext* context,
6628 OrthancPluginFindAnswers* answers)
6629 {
6630 _OrthancPluginFindOperation params;
6631 memset(&params, 0, sizeof(params));
6632 params.answers = answers;
6633
6634 return context->InvokeService(context, _OrthancPluginService_FindMarkIncomplete, &params);
6635 }
6636
6637
6638
6650 ORTHANC_PLUGIN_SINCE_SDK("1.1.0")
6651 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetFindQuerySize(
6652 OrthancPluginContext* context,
6653 const OrthancPluginFindQuery* query)
6654 {
6655 uint32_t count = 0;
6656
6657 _OrthancPluginFindOperation params;
6658 memset(&params, 0, sizeof(params));
6659 params.query = query;
6660 params.resultUint32 = &count;
6661
6662 if (context->InvokeService(context, _OrthancPluginService_GetFindQuerySize, &params) != OrthancPluginErrorCode_Success)
6663 {
6664 /* Error */
6665 return 0;
6666 }
6667 else
6668 {
6669 return count;
6670 }
6671 }
6672
6673
6688 ORTHANC_PLUGIN_SINCE_SDK("1.1.0")
6690 OrthancPluginContext* context,
6691 uint16_t* group,
6692 uint16_t* element,
6693 const OrthancPluginFindQuery* query,
6694 uint32_t index)
6695 {
6696 _OrthancPluginFindOperation params;
6697 memset(&params, 0, sizeof(params));
6698 params.query = query;
6699 params.index = index;
6700 params.resultGroup = group;
6701 params.resultElement = element;
6702
6703 return context->InvokeService(context, _OrthancPluginService_GetFindQueryTag, &params);
6704 }
6705
6706
6720 ORTHANC_PLUGIN_SINCE_SDK("1.1.0")
6721 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetFindQueryTagName(
6722 OrthancPluginContext* context,
6723 const OrthancPluginFindQuery* query,
6724 uint32_t index)
6725 {
6726 char* result;
6727
6728 _OrthancPluginFindOperation params;
6729 memset(&params, 0, sizeof(params));
6730 params.query = query;
6731 params.index = index;
6732 params.resultString = &result;
6733
6734 if (context->InvokeService(context, _OrthancPluginService_GetFindQueryTagName, &params) != OrthancPluginErrorCode_Success)
6735 {
6736 /* Error */
6737 return NULL;
6738 }
6739 else
6740 {
6741 return result;
6742 }
6743 }
6744
6745
6759 ORTHANC_PLUGIN_SINCE_SDK("1.1.0")
6760 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetFindQueryValue(
6761 OrthancPluginContext* context,
6762 const OrthancPluginFindQuery* query,
6763 uint32_t index)
6764 {
6765 char* result;
6766
6767 _OrthancPluginFindOperation params;
6768 memset(&params, 0, sizeof(params));
6769 params.query = query;
6770 params.index = index;
6771 params.resultString = &result;
6772
6773 if (context->InvokeService(context, _OrthancPluginService_GetFindQueryValue, &params) != OrthancPluginErrorCode_Success)
6774 {
6775 /* Error */
6776 return NULL;
6777 }
6778 else
6779 {
6780 return result;
6781 }
6782 }
6783
6784
6785
6786
6787 typedef struct
6788 {
6790 OrthancPluginGetMoveSize getMoveSize;
6791 OrthancPluginApplyMove applyMove;
6792 OrthancPluginFreeMove freeMove;
6793 } _OrthancPluginMoveCallback;
6794
6808 ORTHANC_PLUGIN_SINCE_SDK("1.1.0")
6810 OrthancPluginContext* context,
6812 OrthancPluginGetMoveSize getMoveSize,
6813 OrthancPluginApplyMove applyMove,
6814 OrthancPluginFreeMove freeMove)
6815 {
6816 _OrthancPluginMoveCallback params;
6817 params.callback = callback;
6818 params.getMoveSize = getMoveSize;
6819 params.applyMove = applyMove;
6820 params.freeMove = freeMove;
6821
6822 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback, &params);
6823 }
6824
6825
6826
6827 typedef struct
6828 {
6829 OrthancPluginFindMatcher** target;
6830 const void* query;
6831 uint32_t size;
6832 } _OrthancPluginCreateFindMatcher;
6833
6834
6848 ORTHANC_PLUGIN_SINCE_SDK("1.2.0")
6850 OrthancPluginContext* context,
6851 const void* query,
6852 uint32_t size)
6853 {
6854 OrthancPluginFindMatcher* target = NULL;
6855
6856 _OrthancPluginCreateFindMatcher params;
6857 memset(&params, 0, sizeof(params));
6858 params.target = &target;
6859 params.query = query;
6860 params.size = size;
6861
6862 if (context->InvokeService(context, _OrthancPluginService_CreateFindMatcher, &params) != OrthancPluginErrorCode_Success)
6863 {
6864 return NULL;
6865 }
6866 else
6867 {
6868 return target;
6869 }
6870 }
6871
6872
6873 typedef struct
6874 {
6875 OrthancPluginFindMatcher* matcher;
6876 } _OrthancPluginFreeFindMatcher;
6877
6887 ORTHANC_PLUGIN_SINCE_SDK("1.2.0")
6888 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeFindMatcher(
6889 OrthancPluginContext* context,
6890 OrthancPluginFindMatcher* matcher)
6891 {
6892 _OrthancPluginFreeFindMatcher params;
6893 params.matcher = matcher;
6894
6895 context->InvokeService(context, _OrthancPluginService_FreeFindMatcher, &params);
6896 }
6897
6898
6899 typedef struct
6900 {
6901 const OrthancPluginFindMatcher* matcher;
6902 const void* dicom;
6903 uint32_t size;
6904 int32_t* isMatch;
6905 } _OrthancPluginFindMatcherIsMatch;
6906
6921 ORTHANC_PLUGIN_SINCE_SDK("1.2.0")
6922 ORTHANC_PLUGIN_INLINE int32_t OrthancPluginFindMatcherIsMatch(
6923 OrthancPluginContext* context,
6924 const OrthancPluginFindMatcher* matcher,
6925 const void* dicom,
6926 uint32_t size)
6927 {
6928 int32_t isMatch = 0;
6929
6930 _OrthancPluginFindMatcherIsMatch params;
6931 params.matcher = matcher;
6932 params.dicom = dicom;
6933 params.size = size;
6934 params.isMatch = &isMatch;
6935
6936 if (context->InvokeService(context, _OrthancPluginService_FindMatcherIsMatch, &params) == OrthancPluginErrorCode_Success)
6937 {
6938 return isMatch;
6939 }
6940 else
6941 {
6942 /* Error: Assume non-match */
6943 return 0;
6944 }
6945 }
6946
6947
6948 typedef struct
6949 {
6951 } _OrthancPluginIncomingHttpRequestFilter2;
6952
6964 ORTHANC_PLUGIN_SINCE_SDK("1.3.0")
6966 OrthancPluginContext* context,
6968 {
6969 _OrthancPluginIncomingHttpRequestFilter2 params;
6970 params.callback = callback;
6971
6972 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter2, &params);
6973 }
6974
6975
6976
6977 typedef struct
6978 {
6979 OrthancPluginPeers** peers;
6980 } _OrthancPluginGetPeers;
6981
6993 ORTHANC_PLUGIN_SINCE_SDK("1.4.2")
6995 OrthancPluginContext* context)
6996 {
6997 OrthancPluginPeers* peers = NULL;
6998
6999 _OrthancPluginGetPeers params;
7000 memset(&params, 0, sizeof(params));
7001 params.peers = &peers;
7002
7003 if (context->InvokeService(context, _OrthancPluginService_GetPeers, &params) != OrthancPluginErrorCode_Success)
7004 {
7005 return NULL;
7006 }
7007 else
7008 {
7009 return peers;
7010 }
7011 }
7012
7013
7014 typedef struct
7015 {
7016 OrthancPluginPeers* peers;
7017 } _OrthancPluginFreePeers;
7018
7028 ORTHANC_PLUGIN_SINCE_SDK("1.4.2")
7029 ORTHANC_PLUGIN_INLINE void OrthancPluginFreePeers(
7030 OrthancPluginContext* context,
7031 OrthancPluginPeers* peers)
7032 {
7033 _OrthancPluginFreePeers params;
7034 params.peers = peers;
7035
7036 context->InvokeService(context, _OrthancPluginService_FreePeers, &params);
7037 }
7038
7039
7040 typedef struct
7041 {
7042 uint32_t* target;
7043 const OrthancPluginPeers* peers;
7044 } _OrthancPluginGetPeersCount;
7045
7059 ORTHANC_PLUGIN_SINCE_SDK("1.4.2")
7060 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetPeersCount(
7061 OrthancPluginContext* context,
7062 const OrthancPluginPeers* peers)
7063 {
7064 uint32_t target = 0;
7065
7066 _OrthancPluginGetPeersCount params;
7067 memset(&params, 0, sizeof(params));
7068 params.target = &target;
7069 params.peers = peers;
7070
7071 if (context->InvokeService(context, _OrthancPluginService_GetPeersCount, &params) != OrthancPluginErrorCode_Success)
7072 {
7073 /* Error */
7074 return 0;
7075 }
7076 else
7077 {
7078 return target;
7079 }
7080 }
7081
7082
7083 typedef struct
7084 {
7085 const char** target;
7086 const OrthancPluginPeers* peers;
7087 uint32_t peerIndex;
7088 const char* userProperty;
7089 } _OrthancPluginGetPeerProperty;
7090
7108 ORTHANC_PLUGIN_SINCE_SDK("1.4.2")
7109 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetPeerName(
7110 OrthancPluginContext* context,
7111 const OrthancPluginPeers* peers,
7112 uint32_t peerIndex)
7113 {
7114 const char* target = NULL;
7115
7116 _OrthancPluginGetPeerProperty params;
7117 memset(&params, 0, sizeof(params));
7118 params.target = &target;
7119 params.peers = peers;
7120 params.peerIndex = peerIndex;
7121 params.userProperty = NULL;
7122
7123 if (context->InvokeService(context, _OrthancPluginService_GetPeerName, &params) != OrthancPluginErrorCode_Success)
7124 {
7125 /* Error */
7126 return NULL;
7127 }
7128 else
7129 {
7130 return target;
7131 }
7132 }
7133
7134
7150 ORTHANC_PLUGIN_SINCE_SDK("1.4.2")
7151 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetPeerUrl(
7152 OrthancPluginContext* context,
7153 const OrthancPluginPeers* peers,
7154 uint32_t peerIndex)
7155 {
7156 const char* target = NULL;
7157
7158 _OrthancPluginGetPeerProperty params;
7159 memset(&params, 0, sizeof(params));
7160 params.target = &target;
7161 params.peers = peers;
7162 params.peerIndex = peerIndex;
7163 params.userProperty = NULL;
7164
7165 if (context->InvokeService(context, _OrthancPluginService_GetPeerUrl, &params) != OrthancPluginErrorCode_Success)
7166 {
7167 /* Error */
7168 return NULL;
7169 }
7170 else
7171 {
7172 return target;
7173 }
7174 }
7175
7176
7177
7197 ORTHANC_PLUGIN_SINCE_SDK("1.4.2")
7198 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetPeerUserProperty(
7199 OrthancPluginContext* context,
7200 const OrthancPluginPeers* peers,
7201 uint32_t peerIndex,
7202 const char* userProperty)
7203 {
7204 const char* target = NULL;
7205
7206 _OrthancPluginGetPeerProperty params;
7207 memset(&params, 0, sizeof(params));
7208 params.target = &target;
7209 params.peers = peers;
7210 params.peerIndex = peerIndex;
7211 params.userProperty = userProperty;
7212
7213 if (context->InvokeService(context, _OrthancPluginService_GetPeerUserProperty, &params) != OrthancPluginErrorCode_Success)
7214 {
7215 /* No such user property */
7216 return NULL;
7217 }
7218 else
7219 {
7220 return target;
7221 }
7222 }
7223
7224
7225
7226 typedef struct
7227 {
7228 OrthancPluginMemoryBuffer* answerBody;
7229 OrthancPluginMemoryBuffer* answerHeaders;
7230 uint16_t* httpStatus;
7231 const OrthancPluginPeers* peers;
7232 uint32_t peerIndex;
7234 const char* uri;
7235 uint32_t additionalHeadersCount;
7236 const char* const* additionalHeadersKeys;
7237 const char* const* additionalHeadersValues;
7238 const void* body;
7239 uint32_t bodySize;
7240 uint32_t timeout;
7241 } _OrthancPluginCallPeerApi;
7242
7279 ORTHANC_PLUGIN_SINCE_SDK("1.4.2")
7281 OrthancPluginContext* context,
7282 OrthancPluginMemoryBuffer* answerBody,
7283 OrthancPluginMemoryBuffer* answerHeaders,
7284 uint16_t* httpStatus,
7285 const OrthancPluginPeers* peers,
7286 uint32_t peerIndex,
7288 const char* uri,
7289 uint32_t additionalHeadersCount,
7290 const char* const* additionalHeadersKeys,
7291 const char* const* additionalHeadersValues,
7292 const void* body,
7293 uint32_t bodySize,
7294 uint32_t timeout)
7295 {
7296 _OrthancPluginCallPeerApi params;
7297 memset(&params, 0, sizeof(params));
7298
7299 params.answerBody = answerBody;
7300 params.answerHeaders = answerHeaders;
7301 params.httpStatus = httpStatus;
7302 params.peers = peers;
7303 params.peerIndex = peerIndex;
7304 params.method = method;
7305 params.uri = uri;
7306 params.additionalHeadersCount = additionalHeadersCount;
7307 params.additionalHeadersKeys = additionalHeadersKeys;
7308 params.additionalHeadersValues = additionalHeadersValues;
7309 params.body = body;
7310 params.bodySize = bodySize;
7311 params.timeout = timeout;
7312
7313 return context->InvokeService(context, _OrthancPluginService_CallPeerApi, &params);
7314 }
7315
7316
7317
7318
7319
7320 typedef struct
7321 {
7322 OrthancPluginJob** target;
7323 void *job;
7324 OrthancPluginJobFinalize finalize;
7325 const char *type;
7326 OrthancPluginJobGetProgress getProgress;
7327 OrthancPluginJobGetContent getContent;
7328 OrthancPluginJobGetSerialized getSerialized;
7332 } _OrthancPluginCreateJob;
7333
7366 ORTHANC_PLUGIN_SINCE_SDK("1.4.2")
7367 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE OrthancPluginJob *OrthancPluginCreateJob(
7368 OrthancPluginContext *context,
7369 void *job,
7370 OrthancPluginJobFinalize finalize,
7371 const char *type,
7372 OrthancPluginJobGetProgress getProgress,
7373 OrthancPluginJobGetContent getContent,
7374 OrthancPluginJobGetSerialized getSerialized,
7378 {
7379 OrthancPluginJob* target = NULL;
7380
7381 _OrthancPluginCreateJob params;
7382 memset(&params, 0, sizeof(params));
7383
7384 params.target = &target;
7385 params.job = job;
7386 params.finalize = finalize;
7387 params.type = type;
7388 params.getProgress = getProgress;
7389 params.getContent = getContent;
7390 params.getSerialized = getSerialized;
7391 params.step = step;
7392 params.stop = stop;
7393 params.reset = reset;
7394
7395 if (context->InvokeService(context, _OrthancPluginService_CreateJob, &params) != OrthancPluginErrorCode_Success ||
7396 target == NULL)
7397 {
7398 /* Error */
7399 return NULL;
7400 }
7401 else
7402 {
7403 return target;
7404 }
7405 }
7406
7407
7408 typedef struct
7409 {
7410 OrthancPluginJob** target;
7411 void *job;
7412 OrthancPluginJobFinalize finalize;
7413 const char *type;
7414 OrthancPluginJobGetProgress getProgress;
7415 OrthancPluginJobGetContent2 getContent;
7416 OrthancPluginJobGetSerialized2 getSerialized;
7420 } _OrthancPluginCreateJob2;
7421
7453 ORTHANC_PLUGIN_SINCE_SDK("1.11.3")
7455 OrthancPluginContext *context,
7456 void *job,
7457 OrthancPluginJobFinalize finalize,
7458 const char *type,
7459 OrthancPluginJobGetProgress getProgress,
7460 OrthancPluginJobGetContent2 getContent,
7461 OrthancPluginJobGetSerialized2 getSerialized,
7465 {
7466 OrthancPluginJob* target = NULL;
7467
7468 _OrthancPluginCreateJob2 params;
7469 memset(&params, 0, sizeof(params));
7470
7471 params.target = &target;
7472 params.job = job;
7473 params.finalize = finalize;
7474 params.type = type;
7475 params.getProgress = getProgress;
7476 params.getContent = getContent;
7477 params.getSerialized = getSerialized;
7478 params.step = step;
7479 params.stop = stop;
7480 params.reset = reset;
7481
7482 if (context->InvokeService(context, _OrthancPluginService_CreateJob2, &params) != OrthancPluginErrorCode_Success ||
7483 target == NULL)
7484 {
7485 /* Error */
7486 return NULL;
7487 }
7488 else
7489 {
7490 return target;
7491 }
7492 }
7493
7494
7495 typedef struct
7496 {
7497 OrthancPluginJob* job;
7498 } _OrthancPluginFreeJob;
7499
7509 ORTHANC_PLUGIN_SINCE_SDK("1.4.2")
7510 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeJob(
7511 OrthancPluginContext* context,
7512 OrthancPluginJob* job)
7513 {
7514 _OrthancPluginFreeJob params;
7515 params.job = job;
7516
7517 context->InvokeService(context, _OrthancPluginService_FreeJob, &params);
7518 }
7519
7520
7521
7522 typedef struct
7523 {
7524 char** resultId;
7525 OrthancPluginJob *job;
7526 int32_t priority;
7527 } _OrthancPluginSubmitJob;
7528
7542 ORTHANC_PLUGIN_SINCE_SDK("1.4.2")
7543 ORTHANC_PLUGIN_INLINE char *OrthancPluginSubmitJob(
7544 OrthancPluginContext *context,
7545 OrthancPluginJob *job,
7546 int32_t priority)
7547 {
7548 char* resultId = NULL;
7549
7550 _OrthancPluginSubmitJob params;
7551 memset(&params, 0, sizeof(params));
7552
7553 params.resultId = &resultId;
7554 params.job = job;
7555 params.priority = priority;
7556
7557 if (context->InvokeService(context, _OrthancPluginService_SubmitJob, &params) != OrthancPluginErrorCode_Success ||
7558 resultId == NULL)
7559 {
7560 /* Error */
7561 return NULL;
7562 }
7563 else
7564 {
7565 return resultId;
7566 }
7567 }
7568
7569
7570
7571 typedef struct
7572 {
7573 OrthancPluginJobsUnserializer unserializer;
7574 } _OrthancPluginJobsUnserializer;
7575
7588 ORTHANC_PLUGIN_SINCE_SDK("1.4.2")
7589 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterJobsUnserializer(
7590 OrthancPluginContext* context,
7591 OrthancPluginJobsUnserializer unserializer)
7592 {
7593 _OrthancPluginJobsUnserializer params;
7594 params.unserializer = unserializer;
7595
7596 context->InvokeService(context, _OrthancPluginService_RegisterJobsUnserializer, &params);
7597 }
7598
7599
7600
7601 typedef struct
7602 {
7604 const char* details;
7605 uint8_t log;
7606 } _OrthancPluginSetHttpErrorDetails;
7607
7625 ORTHANC_PLUGIN_SINCE_SDK("1.5.0")
7626 ORTHANC_PLUGIN_INLINE void OrthancPluginSetHttpErrorDetails(
7627 OrthancPluginContext* context,
7629 const char* details,
7630 uint8_t log)
7631 {
7632 _OrthancPluginSetHttpErrorDetails params;
7633 params.output = output;
7634 params.details = details;
7635 params.log = log;
7636 context->InvokeService(context, _OrthancPluginService_SetHttpErrorDetails, &params);
7637 }
7638
7639
7640
7641 typedef struct
7642 {
7643 const char** result;
7644 const char* argument;
7645 } _OrthancPluginRetrieveStaticString;
7646
7658 ORTHANC_PLUGIN_SINCE_SDK("1.5.0")
7659 ORTHANC_PLUGIN_INLINE const char* OrthancPluginAutodetectMimeType(
7660 OrthancPluginContext* context,
7661 const char* path)
7662 {
7663 const char* result = NULL;
7664
7665 _OrthancPluginRetrieveStaticString params;
7666 params.result = &result;
7667 params.argument = path;
7668
7669 if (context->InvokeService(context, _OrthancPluginService_AutodetectMimeType, &params) != OrthancPluginErrorCode_Success)
7670 {
7671 /* Error */
7672 return NULL;
7673 }
7674 else
7675 {
7676 return result;
7677 }
7678 }
7679
7680
7681
7682 typedef struct
7683 {
7684 const char* name;
7685 float value;
7687 } _OrthancPluginSetMetricsValue;
7688
7705 ORTHANC_PLUGIN_SINCE_SDK("1.5.4")
7706 ORTHANC_PLUGIN_INLINE void OrthancPluginSetMetricsValue(
7707 OrthancPluginContext* context,
7708 const char* name,
7709 float value,
7711 {
7712 _OrthancPluginSetMetricsValue params;
7713 params.name = name;
7714 params.value = value;
7715 params.type = type;
7716 context->InvokeService(context, _OrthancPluginService_SetMetricsValue, &params);
7717 }
7718
7719
7720
7721 typedef struct
7722 {
7724 } _OrthancPluginRegisterRefreshMetricsCallback;
7725
7737 ORTHANC_PLUGIN_SINCE_SDK("1.5.4")
7739 OrthancPluginContext* context,
7741 {
7742 _OrthancPluginRegisterRefreshMetricsCallback params;
7743 params.callback = callback;
7744 context->InvokeService(context, _OrthancPluginService_RegisterRefreshMetricsCallback, &params);
7745 }
7746
7747
7748
7749
7750 typedef struct
7751 {
7752 char** target;
7753 const void* dicom;
7754 uint32_t dicomSize;
7756 } _OrthancPluginEncodeDicomWeb;
7757
7774 ORTHANC_PLUGIN_SINCE_SDK("1.5.4")
7775 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE char* OrthancPluginEncodeDicomWebJson(
7776 OrthancPluginContext* context,
7777 const void* dicom,
7778 uint32_t dicomSize,
7780 {
7781 char* target = NULL;
7782
7783 _OrthancPluginEncodeDicomWeb params;
7784 params.target = &target;
7785 params.dicom = dicom;
7786 params.dicomSize = dicomSize;
7787 params.callback = callback;
7788
7789 if (context->InvokeService(context, _OrthancPluginService_EncodeDicomWebJson, &params) != OrthancPluginErrorCode_Success)
7790 {
7791 /* Error */
7792 return NULL;
7793 }
7794 else
7795 {
7796 return target;
7797 }
7798 }
7799
7800
7817 ORTHANC_PLUGIN_SINCE_SDK("1.5.4")
7818 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE char* OrthancPluginEncodeDicomWebXml(
7819 OrthancPluginContext* context,
7820 const void* dicom,
7821 uint32_t dicomSize,
7823 {
7824 char* target = NULL;
7825
7826 _OrthancPluginEncodeDicomWeb params;
7827 params.target = &target;
7828 params.dicom = dicom;
7829 params.dicomSize = dicomSize;
7830 params.callback = callback;
7831
7832 if (context->InvokeService(context, _OrthancPluginService_EncodeDicomWebXml, &params) != OrthancPluginErrorCode_Success)
7833 {
7834 /* Error */
7835 return NULL;
7836 }
7837 else
7838 {
7839 return target;
7840 }
7841 }
7842
7843
7844
7845 typedef struct
7846 {
7847 char** target;
7848 const void* dicom;
7849 uint32_t dicomSize;
7851 void* payload;
7852 } _OrthancPluginEncodeDicomWeb2;
7853
7870 ORTHANC_PLUGIN_SINCE_SDK("1.7.0")
7871 ORTHANC_PLUGIN_INLINE char* OrthancPluginEncodeDicomWebJson2(
7872 OrthancPluginContext* context,
7873 const void* dicom,
7874 uint32_t dicomSize,
7876 void* payload)
7877 {
7878 char* target = NULL;
7879
7880 _OrthancPluginEncodeDicomWeb2 params;
7881 params.target = &target;
7882 params.dicom = dicom;
7883 params.dicomSize = dicomSize;
7884 params.callback = callback;
7885 params.payload = payload;
7886
7887 if (context->InvokeService(context, _OrthancPluginService_EncodeDicomWebJson2, &params) != OrthancPluginErrorCode_Success)
7888 {
7889 /* Error */
7890 return NULL;
7891 }
7892 else
7893 {
7894 return target;
7895 }
7896 }
7897
7898
7915 ORTHANC_PLUGIN_SINCE_SDK("1.7.0")
7916 ORTHANC_PLUGIN_INLINE char* OrthancPluginEncodeDicomWebXml2(
7917 OrthancPluginContext* context,
7918 const void* dicom,
7919 uint32_t dicomSize,
7921 void* payload)
7922 {
7923 char* target = NULL;
7924
7925 _OrthancPluginEncodeDicomWeb2 params;
7926 params.target = &target;
7927 params.dicom = dicom;
7928 params.dicomSize = dicomSize;
7929 params.callback = callback;
7930 params.payload = payload;
7931
7932 if (context->InvokeService(context, _OrthancPluginService_EncodeDicomWebXml2, &params) != OrthancPluginErrorCode_Success)
7933 {
7934 /* Error */
7935 return NULL;
7936 }
7937 else
7938 {
7939 return target;
7940 }
7941 }
7942
7943
7944
7961 void* answer,
7962 const char* key,
7963 const char* value);
7964
7965
7982 void* answer,
7983 const void* data,
7984 uint32_t size);
7985
7986
8001 typedef uint8_t (*OrthancPluginChunkedClientRequestIsDone) (void* request);
8002
8003
8019
8020
8034 typedef const void* (*OrthancPluginChunkedClientRequestGetChunkData) (void* request);
8035
8036
8050 typedef uint32_t (*OrthancPluginChunkedClientRequestGetChunkSize) (void* request);
8051
8052
8053 typedef struct
8054 {
8055 void* answer;
8058 uint16_t* httpStatus;
8060 const char* url;
8061 uint32_t headersCount;
8062 const char* const* headersKeys;
8063 const char* const* headersValues;
8064 void* request;
8069 const char* username;
8070 const char* password;
8071 uint32_t timeout;
8072 const char* certificateFile;
8073 const char* certificateKeyFile;
8074 const char* certificateKeyPassword;
8075 uint8_t pkcs11;
8076 } _OrthancPluginChunkedHttpClient;
8077
8078
8129 ORTHANC_PLUGIN_SINCE_SDK("1.5.7")
8131 OrthancPluginContext* context,
8132 void* answer,
8135 uint16_t* httpStatus,
8137 const char* url,
8138 uint32_t headersCount,
8139 const char* const* headersKeys,
8140 const char* const* headersValues,
8141 void* request,
8146 const char* username,
8147 const char* password,
8148 uint32_t timeout,
8149 const char* certificateFile,
8150 const char* certificateKeyFile,
8151 const char* certificateKeyPassword,
8152 uint8_t pkcs11)
8153 {
8154 _OrthancPluginChunkedHttpClient params;
8155 memset(&params, 0, sizeof(params));
8156
8157 /* In common with OrthancPluginHttpClient() */
8158 params.httpStatus = httpStatus;
8159 params.method = method;
8160 params.url = url;
8161 params.headersCount = headersCount;
8162 params.headersKeys = headersKeys;
8163 params.headersValues = headersValues;
8164 params.username = username;
8165 params.password = password;
8166 params.timeout = timeout;
8167 params.certificateFile = certificateFile;
8168 params.certificateKeyFile = certificateKeyFile;
8169 params.certificateKeyPassword = certificateKeyPassword;
8170 params.pkcs11 = pkcs11;
8171
8172 /* For chunked body/answer */
8173 params.answer = answer;
8174 params.answerAddChunk = answerAddChunk;
8175 params.answerAddHeader = answerAddHeader;
8176 params.request = request;
8177 params.requestIsDone = requestIsDone;
8178 params.requestChunkData = requestChunkData;
8179 params.requestChunkSize = requestChunkSize;
8180 params.requestNext = requestNext;
8181
8182 return context->InvokeService(context, _OrthancPluginService_ChunkedHttpClient, &params);
8183 }
8184
8185
8186
8191 typedef struct ORTHANC_PLUGIN_SINCE_SDK("1.5.7")
8192 _OrthancPluginServerChunkedRequestReader_t OrthancPluginServerChunkedRequestReader;
8193
8194
8195
8213 const char* uri,
8214 const OrthancPluginHttpRequest* request);
8215
8216
8232 const void* data,
8233 uint32_t size);
8234
8235
8252 OrthancPluginRestOutput* output);
8253
8254
8270
8271 typedef struct
8272 {
8273 const char* pathRegularExpression;
8274 OrthancPluginRestCallback getHandler;
8276 OrthancPluginRestCallback deleteHandler;
8281 } _OrthancPluginChunkedRestCallback;
8282
8283
8313 ORTHANC_PLUGIN_SINCE_SDK("1.5.7")
8315 OrthancPluginContext* context,
8316 const char* pathRegularExpression,
8317 OrthancPluginRestCallback getHandler,
8319 OrthancPluginRestCallback deleteHandler,
8324 {
8325 _OrthancPluginChunkedRestCallback params;
8326 params.pathRegularExpression = pathRegularExpression;
8327 params.getHandler = getHandler;
8328 params.postHandler = postHandler;
8329 params.deleteHandler = deleteHandler;
8330 params.putHandler = putHandler;
8331 params.addChunk = addChunk;
8332 params.execute = execute;
8333 params.finalize = finalize;
8334
8335 context->InvokeService(context, _OrthancPluginService_RegisterChunkedRestCallback, &params);
8336 }
8337
8338
8339
8340
8341
8342 typedef struct
8343 {
8344 char** result;
8345 uint16_t group;
8346 uint16_t element;
8347 const char* privateCreator;
8348 } _OrthancPluginGetTagName;
8349
8365 ORTHANC_PLUGIN_SINCE_SDK("1.5.7")
8366 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetTagName(
8367 OrthancPluginContext* context,
8368 uint16_t group,
8369 uint16_t element,
8370 const char* privateCreator)
8371 {
8372 char* result;
8373
8374 _OrthancPluginGetTagName params;
8375 params.result = &result;
8376 params.group = group;
8377 params.element = element;
8378 params.privateCreator = privateCreator;
8379
8380 if (context->InvokeService(context, _OrthancPluginService_GetTagName, &params) != OrthancPluginErrorCode_Success)
8381 {
8382 /* Error */
8383 return NULL;
8384 }
8385 else
8386 {
8387 return result;
8388 }
8389 }
8390
8391
8392
8422 void** handler /* out */,
8423 const char* jobId,
8424 const char* transactionUid,
8425 const char* const* sopClassUids,
8426 const char* const* sopInstanceUids,
8427 uint32_t countInstances,
8428 const char* remoteAet,
8429 const char* calledAet);
8430
8431
8459 ORTHANC_PLUGIN_SINCE_SDK("1.12.10")
8461 void** handler /* out */,
8462 const char* jobId,
8463 const char* transactionUid,
8464 const char* const* sopClassUids,
8465 const char* const* sopInstanceUids,
8466 uint32_t countInstances,
8467 const OrthancPluginDicomConnection* connection);
8468
8469
8481 typedef void (*OrthancPluginStorageCommitmentDestructor) (void* handler);
8482
8483
8504 void* handler,
8505 const char* sopClassUid,
8506 const char* sopInstanceUid);
8507
8508
8509 typedef struct
8510 {
8514 } _OrthancPluginRegisterStorageCommitmentScpCallback;
8515
8529 ORTHANC_PLUGIN_SINCE_SDK("1.6.0")
8531 OrthancPluginContext* context,
8535 {
8536 _OrthancPluginRegisterStorageCommitmentScpCallback params;
8537 params.factory = factory;
8538 params.destructor = destructor;
8539 params.lookup = lookup;
8540 return context->InvokeService(context, _OrthancPluginService_RegisterStorageCommitmentScpCallback, &params);
8541 }
8542
8543
8544
8571 const OrthancPluginDicomInstance* instance);
8572
8573
8574 typedef struct
8575 {
8577 } _OrthancPluginIncomingDicomInstanceFilter;
8578
8591 ORTHANC_PLUGIN_SINCE_SDK("1.6.1")
8593 OrthancPluginContext* context,
8595 {
8596 _OrthancPluginIncomingDicomInstanceFilter params;
8597 params.callback = callback;
8598
8599 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingDicomInstanceFilter, &params);
8600 }
8601
8602
8634 uint16_t* dimseStatus /* out */,
8635 const OrthancPluginDicomInstance* instance);
8636
8637
8638 typedef struct
8639 {
8641 } _OrthancPluginIncomingCStoreInstanceFilter;
8642
8655 ORTHANC_PLUGIN_SINCE_SDK("1.10.0")
8657 OrthancPluginContext* context,
8659 {
8660 _OrthancPluginIncomingCStoreInstanceFilter params;
8661 params.callback = callback;
8662
8663 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingCStoreInstanceFilter, &params);
8664 }
8665
8702 OrthancPluginMemoryBuffer64* modifiedDicomBuffer,
8703 const void* receivedDicomBuffer,
8704 uint64_t receivedDicomBufferSize,
8706
8707
8708 typedef struct
8709 {
8711 } _OrthancPluginReceivedInstanceCallback;
8712
8733 ORTHANC_PLUGIN_SINCE_SDK("1.10.0")
8735 OrthancPluginContext* context,
8737 {
8738 _OrthancPluginReceivedInstanceCallback params;
8739 params.callback = callback;
8740
8741 return context->InvokeService(context, _OrthancPluginService_RegisterReceivedInstanceCallback, &params);
8742 }
8743
8757 ORTHANC_PLUGIN_SINCE_SDK("1.6.1")
8759 OrthancPluginContext* context,
8760 const OrthancPluginDicomInstance* instance)
8761 {
8762 char* result;
8763
8764 _OrthancPluginAccessDicomInstance params;
8765 memset(&params, 0, sizeof(params));
8766 params.resultStringToFree = &result;
8767 params.instance = instance;
8768
8769 if (context->InvokeService(context, _OrthancPluginService_GetInstanceTransferSyntaxUid, &params) != OrthancPluginErrorCode_Success)
8770 {
8771 /* Error */
8772 return NULL;
8773 }
8774 else
8775 {
8776 return result;
8777 }
8778 }
8779
8780
8793 ORTHANC_PLUGIN_SINCE_SDK("1.6.1")
8794 ORTHANC_PLUGIN_INLINE int32_t OrthancPluginHasInstancePixelData(
8795 OrthancPluginContext* context,
8796 const OrthancPluginDicomInstance* instance)
8797 {
8798 int64_t hasPixelData;
8799
8800 _OrthancPluginAccessDicomInstance params;
8801 memset(&params, 0, sizeof(params));
8802 params.resultInt64 = &hasPixelData;
8803 params.instance = instance;
8804
8805 if (context->InvokeService(context, _OrthancPluginService_HasInstancePixelData, &params) != OrthancPluginErrorCode_Success ||
8806 hasPixelData < 0 ||
8807 hasPixelData > 1)
8808 {
8809 /* Error */
8810 return -1;
8811 }
8812 else
8813 {
8814 return (hasPixelData != 0);
8815 }
8816 }
8817
8818
8819
8820
8821
8822
8823 typedef struct
8824 {
8826 const void* buffer;
8827 uint32_t size;
8828 const char* transferSyntax;
8829 } _OrthancPluginCreateDicomInstance;
8830
8844 ORTHANC_PLUGIN_SINCE_SDK("1.7.0")
8846 OrthancPluginContext* context,
8847 const void* buffer,
8848 uint32_t size)
8849 {
8850 OrthancPluginDicomInstance* target = NULL;
8851
8852 _OrthancPluginCreateDicomInstance params;
8853 params.target = &target;
8854 params.buffer = buffer;
8855 params.size = size;
8856
8857 if (context->InvokeService(context, _OrthancPluginService_CreateDicomInstance, &params) != OrthancPluginErrorCode_Success)
8858 {
8859 /* Error */
8860 return NULL;
8861 }
8862 else
8863 {
8864 return target;
8865 }
8866 }
8867
8868 typedef struct
8869 {
8871 } _OrthancPluginFreeDicomInstance;
8872
8883 ORTHANC_PLUGIN_SINCE_SDK("1.7.0")
8884 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeDicomInstance(
8885 OrthancPluginContext* context,
8887 {
8888 _OrthancPluginFreeDicomInstance params;
8889 params.dicom = dicom;
8890
8891 context->InvokeService(context, _OrthancPluginService_FreeDicomInstance, &params);
8892 }
8893
8894
8895 typedef struct
8896 {
8897 uint32_t* targetUint32;
8898 OrthancPluginMemoryBuffer* targetBuffer;
8899 OrthancPluginImage** targetImage;
8900 char** targetStringToFree;
8901 const OrthancPluginDicomInstance* instance;
8902 uint32_t frameIndex;
8905 uint32_t maxStringLength;
8906 OrthancPluginDicomWebBinaryCallback2 dicomWebCallback;
8907 void* dicomWebPayload;
8908 } _OrthancPluginAccessDicomInstance2;
8909
8921 ORTHANC_PLUGIN_SINCE_SDK("1.7.0")
8922 ORTHANC_PLUGIN_INLINE uint32_t OrthancPluginGetInstanceFramesCount(
8923 OrthancPluginContext* context,
8924 const OrthancPluginDicomInstance* instance)
8925 {
8926 uint32_t count;
8927
8928 _OrthancPluginAccessDicomInstance2 params;
8929 memset(&params, 0, sizeof(params));
8930 params.targetUint32 = &count;
8931 params.instance = instance;
8932
8933 if (context->InvokeService(context, _OrthancPluginService_GetInstanceFramesCount, &params) != OrthancPluginErrorCode_Success)
8934 {
8935 /* Error */
8936 return 0;
8937 }
8938 else
8939 {
8940 return count;
8941 }
8942 }
8943
8944
8962 ORTHANC_PLUGIN_SINCE_SDK("1.7.0")
8964 OrthancPluginContext* context,
8966 const OrthancPluginDicomInstance* instance,
8967 uint32_t frameIndex)
8968 {
8969 _OrthancPluginAccessDicomInstance2 params;
8970 memset(&params, 0, sizeof(params));
8971 params.targetBuffer = target;
8972 params.instance = instance;
8973 params.frameIndex = frameIndex;
8974
8975 return context->InvokeService(context, _OrthancPluginService_GetInstanceRawFrame, &params);
8976 }
8977
8978
8991 ORTHANC_PLUGIN_SINCE_SDK("1.7.0")
8993 OrthancPluginContext* context,
8994 const OrthancPluginDicomInstance* instance,
8995 uint32_t frameIndex)
8996 {
8997 OrthancPluginImage* target = NULL;
8998
8999 _OrthancPluginAccessDicomInstance2 params;
9000 memset(&params, 0, sizeof(params));
9001 params.targetImage = &target;
9002 params.instance = instance;
9003 params.frameIndex = frameIndex;
9004
9005 if (context->InvokeService(context, _OrthancPluginService_GetInstanceDecodedFrame, &params) != OrthancPluginErrorCode_Success)
9006 {
9007 return NULL;
9008 }
9009 else
9010 {
9011 return target;
9012 }
9013 }
9014
9015
9031 ORTHANC_PLUGIN_SINCE_SDK("1.7.0")
9033 OrthancPluginContext* context,
9034 const void* buffer,
9035 uint32_t size,
9036 const char* transferSyntax)
9037 {
9038 OrthancPluginDicomInstance* target = NULL;
9039
9040 _OrthancPluginCreateDicomInstance params;
9041 params.target = &target;
9042 params.buffer = buffer;
9043 params.size = size;
9044 params.transferSyntax = transferSyntax;
9045
9046 if (context->InvokeService(context, _OrthancPluginService_TranscodeDicomInstance, &params) != OrthancPluginErrorCode_Success)
9047 {
9048 /* Error */
9049 return NULL;
9050 }
9051 else
9052 {
9053 return target;
9054 }
9055 }
9056
9070 ORTHANC_PLUGIN_SINCE_SDK("1.7.0")
9072 OrthancPluginContext* context,
9074 const OrthancPluginDicomInstance* instance)
9075 {
9076 _OrthancPluginAccessDicomInstance2 params;
9077 memset(&params, 0, sizeof(params));
9078 params.targetBuffer = target;
9079 params.instance = instance;
9080
9081 return context->InvokeService(context, _OrthancPluginService_SerializeDicomInstance, &params);
9082 }
9083
9084
9103 ORTHANC_PLUGIN_SINCE_SDK("1.7.0")
9104 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceAdvancedJson(
9105 OrthancPluginContext* context,
9106 const OrthancPluginDicomInstance* instance,
9109 uint32_t maxStringLength)
9110 {
9111 char* result = NULL;
9112
9113 _OrthancPluginAccessDicomInstance2 params;
9114 memset(&params, 0, sizeof(params));
9115 params.targetStringToFree = &result;
9116 params.instance = instance;
9117 params.format = format;
9118 params.flags = flags;
9119 params.maxStringLength = maxStringLength;
9120
9121 if (context->InvokeService(context, _OrthancPluginService_GetInstanceAdvancedJson, &params) != OrthancPluginErrorCode_Success)
9122 {
9123 /* Error */
9124 return NULL;
9125 }
9126 else
9127 {
9128 return result;
9129 }
9130 }
9131
9132
9147 ORTHANC_PLUGIN_SINCE_SDK("1.7.0")
9148 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceDicomWebJson(
9149 OrthancPluginContext* context,
9150 const OrthancPluginDicomInstance* instance,
9152 void* payload)
9153 {
9154 char* target = NULL;
9155
9156 _OrthancPluginAccessDicomInstance2 params;
9157 params.targetStringToFree = &target;
9158 params.instance = instance;
9159 params.dicomWebCallback = callback;
9160 params.dicomWebPayload = payload;
9161
9162 if (context->InvokeService(context, _OrthancPluginService_GetInstanceDicomWebJson, &params) != OrthancPluginErrorCode_Success)
9163 {
9164 /* Error */
9165 return NULL;
9166 }
9167 else
9168 {
9169 return target;
9170 }
9171 }
9172
9173
9188 ORTHANC_PLUGIN_SINCE_SDK("1.7.0")
9189 ORTHANC_PLUGIN_INLINE char* OrthancPluginGetInstanceDicomWebXml(
9190 OrthancPluginContext* context,
9191 const OrthancPluginDicomInstance* instance,
9193 void* payload)
9194 {
9195 char* target = NULL;
9196
9197 _OrthancPluginAccessDicomInstance2 params;
9198 params.targetStringToFree = &target;
9199 params.instance = instance;
9200 params.dicomWebCallback = callback;
9201 params.dicomWebPayload = payload;
9202
9203 if (context->InvokeService(context, _OrthancPluginService_GetInstanceDicomWebXml, &params) != OrthancPluginErrorCode_Success)
9204 {
9205 /* Error */
9206 return NULL;
9207 }
9208 else
9209 {
9210 return target;
9211 }
9212 }
9213
9214
9215
9235 OrthancPluginMemoryBuffer* transcoded /* out */,
9236 const void* buffer,
9237 uint64_t size,
9238 const char* const* allowedSyntaxes,
9239 uint32_t countSyntaxes,
9240 uint8_t allowNewSopInstanceUid);
9241
9242
9243 typedef struct
9244 {
9246 } _OrthancPluginTranscoderCallback;
9247
9261 ORTHANC_PLUGIN_SINCE_SDK("1.7.0")
9263 OrthancPluginContext* context,
9265 {
9266 _OrthancPluginTranscoderCallback params;
9267 params.callback = callback;
9268
9269 return context->InvokeService(context, _OrthancPluginService_RegisterTranscoderCallback, &params);
9270 }
9271
9272
9273
9274 typedef struct
9275 {
9277 uint32_t size;
9278 } _OrthancPluginCreateMemoryBuffer;
9279
9297 ORTHANC_PLUGIN_SINCE_SDK("1.7.0")
9299 OrthancPluginContext* context,
9301 uint32_t size)
9302 {
9303 _OrthancPluginCreateMemoryBuffer params;
9304 params.target = target;
9305 params.size = size;
9306
9307 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer, &params);
9308 }
9309
9310
9336 ORTHANC_PLUGIN_SINCE_SDK("1.8.1")
9338 OrthancPluginContext* context)
9339 {
9340 char* result;
9341
9342 _OrthancPluginRetrieveDynamicString params;
9343 params.result = &result;
9344 params.argument = NULL;
9345
9346 if (context->InvokeService(context, _OrthancPluginService_GenerateRestApiAuthorizationToken,
9348 {
9349 /* Error */
9350 return NULL;
9351 }
9352 else
9353 {
9354 return result;
9355 }
9356 }
9357
9358
9359
9360 typedef struct
9361 {
9363 uint64_t size;
9364 } _OrthancPluginCreateMemoryBuffer64;
9365
9383 ORTHANC_PLUGIN_SINCE_SDK("1.9.0")
9385 OrthancPluginContext* context,
9387 uint64_t size)
9388 {
9389 _OrthancPluginCreateMemoryBuffer64 params;
9390 params.target = target;
9391 params.size = size;
9392
9393 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer64, &params);
9394 }
9395
9396
9397 typedef struct
9398 {
9403 } _OrthancPluginRegisterStorageArea2;
9404
9422 ORTHANC_PLUGIN_SINCE_SDK("1.9.0")
9423 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterStorageArea2(
9424 OrthancPluginContext* context,
9429 {
9430 _OrthancPluginRegisterStorageArea2 params;
9431 params.create = create;
9432 params.readWhole = readWhole;
9433 params.readRange = readRange;
9434 params.remove = remove;
9435 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea2, &params);
9436 }
9437
9438
9439
9440 typedef struct
9441 {
9442 _OrthancPluginCreateDicom createDicom;
9443 const char* privateCreator;
9444 } _OrthancPluginCreateDicom2;
9445
9470 ORTHANC_PLUGIN_SINCE_SDK("1.9.0")
9472 OrthancPluginContext* context,
9474 const char* json,
9475 const OrthancPluginImage* pixelData,
9477 const char* privateCreator)
9478 {
9479 _OrthancPluginCreateDicom2 params;
9480 params.createDicom.target = target;
9481 params.createDicom.json = json;
9482 params.createDicom.pixelData = pixelData;
9483 params.createDicom.flags = flags;
9484 params.privateCreator = privateCreator;
9485
9486 return context->InvokeService(context, _OrthancPluginService_CreateDicom2, &params);
9487 }
9488
9489
9490
9491
9492
9493
9494 typedef struct
9495 {
9496 OrthancPluginMemoryBuffer* answerBody;
9497 OrthancPluginMemoryBuffer* answerHeaders;
9498 uint16_t* httpStatus;
9500 const char* uri;
9501 uint32_t headersCount;
9502 const char* const* headersKeys;
9503 const char* const* headersValues;
9504 const void* body;
9505 uint32_t bodySize;
9506 uint8_t afterPlugins;
9507 } _OrthancPluginCallRestApi;
9508
9539 ORTHANC_PLUGIN_SINCE_SDK("1.9.2")
9541 OrthancPluginContext* context,
9542 OrthancPluginMemoryBuffer* answerBody,
9543 OrthancPluginMemoryBuffer* answerHeaders,
9544 uint16_t* httpStatus,
9546 const char* uri,
9547 uint32_t headersCount,
9548 const char* const* headersKeys,
9549 const char* const* headersValues,
9550 const void* body,
9551 uint32_t bodySize,
9552 uint8_t afterPlugins)
9553 {
9554 _OrthancPluginCallRestApi params;
9555 memset(&params, 0, sizeof(params));
9556
9557 params.answerBody = answerBody;
9558 params.answerHeaders = answerHeaders;
9559 params.httpStatus = httpStatus;
9560 params.method = method;
9561 params.uri = uri;
9562 params.headersCount = headersCount;
9563 params.headersKeys = headersKeys;
9564 params.headersValues = headersValues;
9565 params.body = body;
9566 params.bodySize = bodySize;
9567 params.afterPlugins = afterPlugins;
9568
9569 return context->InvokeService(context, _OrthancPluginService_CallRestApi, &params);
9570 }
9571
9572
9573
9578 typedef struct ORTHANC_PLUGIN_SINCE_SDK("1.10.1")
9579 _OrthancPluginWebDavCollection_t OrthancPluginWebDavCollection;
9580
9581
9606 const char* name,
9607 uint64_t size,
9608 const char* mimeType,
9609 const char* dateTime);
9610
9611
9627 const char* name,
9628 const char* dateTime);
9629
9630
9654 const void* data,
9655 uint64_t size,
9656 const char* mimeType,
9657 const char* dateTime);
9658
9659
9674 uint8_t* isExisting, /* out */
9675 uint32_t pathSize,
9676 const char* const* pathItems,
9677 void* payload);
9678
9679
9699 uint8_t* isExisting, /* out */
9703 uint32_t pathSize,
9704 const char* const* pathItems,
9705 void* payload);
9706
9707
9727 uint32_t pathSize,
9728 const char* const* pathItems,
9729 void* payload);
9730
9731
9748 uint8_t* isReadOnly, /* out */
9749 uint32_t pathSize,
9750 const char* const* pathItems,
9751 const void* data,
9752 uint64_t size,
9753 void* payload);
9754
9755
9770 uint8_t* isReadOnly, /* out */
9771 uint32_t pathSize,
9772 const char* const* pathItems,
9773 void* payload);
9774
9775
9790 uint8_t* isReadOnly, /* out */
9791 uint32_t pathSize,
9792 const char* const* pathItems,
9793 void* payload);
9794
9795
9796 typedef struct
9797 {
9798 const char* uri;
9805 void* payload;
9806 } _OrthancPluginRegisterWebDavCollection;
9807
9828 ORTHANC_PLUGIN_SINCE_SDK("1.10.1")
9830 OrthancPluginContext* context,
9831 const char* uri,
9838 void* payload)
9839 {
9840 _OrthancPluginRegisterWebDavCollection params;
9841 params.uri = uri;
9842 params.isExistingFolder = isExistingFolder;
9843 params.listFolder = listFolder;
9844 params.retrieveFile = retrieveFile;
9845 params.storeFile = storeFile;
9846 params.createFolder = createFolder;
9847 params.deleteItem = deleteItem;
9848 params.payload = payload;
9849
9850 return context->InvokeService(context, _OrthancPluginService_RegisterWebDavCollection, &params);
9851 }
9852
9853
9862 ORTHANC_PLUGIN_SINCE_SDK("1.11.1")
9863 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetDatabaseServerIdentifier(
9864 OrthancPluginContext* context)
9865 {
9866 const char* result;
9867
9868 _OrthancPluginRetrieveStaticString params;
9869 params.result = &result;
9870 params.argument = NULL;
9871
9872 if (context->InvokeService(context, _OrthancPluginService_GetDatabaseServerIdentifier, &params) != OrthancPluginErrorCode_Success)
9873 {
9874 /* Error */
9875 return NULL;
9876 }
9877 else
9878 {
9879 return result;
9880 }
9881 }
9882
9883
9884 typedef struct
9885 {
9889 } _OrthancPluginRegisterStorageArea3;
9890
9905 ORTHANC_PLUGIN_SINCE_SDK("1.12.8")
9906 ORTHANC_PLUGIN_INLINE void OrthancPluginRegisterStorageArea3(
9907 OrthancPluginContext* context,
9911 {
9912 _OrthancPluginRegisterStorageArea3 params;
9913 params.create = create;
9914 params.readRange = readRange;
9915 params.remove = remove;
9916 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea3, &params);
9917 }
9918
9927 void* backend,
9928 const void* request,
9929 uint64_t requestSize);
9930
9936 typedef void (*OrthancPluginFinalizeDatabaseBackendV4) (void* backend);
9937
9938 typedef struct
9939 {
9940 void* backend;
9941 uint32_t maxDatabaseRetries;
9944 } _OrthancPluginRegisterDatabaseBackendV4;
9945
9963 ORTHANC_PLUGIN_SINCE_SDK("1.12.0")
9965 OrthancPluginContext* context,
9966 void* backend,
9967 uint32_t maxDatabaseRetries,
9970 {
9971 _OrthancPluginRegisterDatabaseBackendV4 params;
9972 params.backend = backend;
9973 params.maxDatabaseRetries = maxDatabaseRetries;
9974 params.operations = operations;
9975 params.finalize = finalize;
9976
9977 return context->InvokeService(context, _OrthancPluginService_RegisterDatabaseBackendV4, &params);
9978 }
9979
9980
9981 typedef struct
9982 {
9984 const char* instanceId;
9986 } _OrthancPluginLoadDicomInstance;
9987
10001 ORTHANC_PLUGIN_SINCE_SDK("1.12.1")
10003 OrthancPluginContext* context,
10004 const char* instanceId,
10006 {
10007 OrthancPluginDicomInstance* target = NULL;
10008
10009 _OrthancPluginLoadDicomInstance params;
10010 params.target = &target;
10011 params.instanceId = instanceId;
10012 params.mode = mode;
10013
10014 if (context->InvokeService(context, _OrthancPluginService_LoadDicomInstance, &params) != OrthancPluginErrorCode_Success)
10015 {
10016 /* Error */
10017 return NULL;
10018 }
10019 else
10020 {
10021 return target;
10022 }
10023 }
10024
10025
10026 typedef struct
10027 {
10028 const char* name;
10029 int64_t value;
10031 } _OrthancPluginSetMetricsIntegerValue;
10032
10048 ORTHANC_PLUGIN_SINCE_SDK("1.12.1")
10049 ORTHANC_PLUGIN_INLINE void OrthancPluginSetMetricsIntegerValue(
10050 OrthancPluginContext* context,
10051 const char* name,
10052 int64_t value,
10054 {
10055 _OrthancPluginSetMetricsIntegerValue params;
10056 params.name = name;
10057 params.value = value;
10058 params.type = type;
10059 context->InvokeService(context, _OrthancPluginService_SetMetricsIntegerValue, &params);
10060 }
10061
10062
10081 ORTHANC_PLUGIN_SINCE_SDK("1.12.2")
10083 OrthancPluginContext* context,
10084 const char* threadName)
10085 {
10086 return context->InvokeService(context, _OrthancPluginService_SetCurrentThreadName, threadName);
10087 }
10088
10089
10090 typedef struct
10091 {
10092 /* Note: This structure is also defined in Logging.h and it must be binary compatible */
10093 const char* message;
10094 const char* plugin;
10095 const char* file;
10096 uint32_t line;
10097 OrthancPluginLogCategory category;
10099 } _OrthancPluginLogMessage;
10100
10101
10115 ORTHANC_PLUGIN_SINCE_SDK("1.12.4")
10116 ORTHANC_PLUGIN_INLINE void OrthancPluginLogMessage(
10117 OrthancPluginContext* context,
10118 const char* message,
10119 const char* plugin,
10120 const char* file,
10121 uint32_t line,
10122 OrthancPluginLogCategory category,
10124 {
10125 _OrthancPluginLogMessage m;
10126 m.message = message;
10127 m.plugin = plugin;
10128 m.file = file;
10129 m.line = line;
10130 m.category = category;
10131 m.level = level;
10132 context->InvokeService(context, _OrthancPluginService_LogMessage, &m);
10133 }
10134
10135
10136 typedef struct
10137 {
10139 const char* contentType;
10140 } _OrthancPluginStartStreamAnswer;
10141
10154 ORTHANC_PLUGIN_SINCE_SDK("1.12.6")
10156 OrthancPluginContext* context,
10158 const char* contentType)
10159 {
10160 _OrthancPluginStartStreamAnswer params;
10161 params.output = output;
10162 params.contentType = contentType;
10163 return context->InvokeService(context, _OrthancPluginService_StartStreamAnswer, &params);
10164 }
10165
10166
10182 ORTHANC_PLUGIN_SINCE_SDK("1.12.6")
10184 OrthancPluginContext* context,
10186 const void* answer,
10187 uint32_t answerSize)
10188 {
10189 _OrthancPluginAnswerBuffer params;
10190 params.output = output;
10191 params.answer = answer;
10192 params.answerSize = answerSize;
10193 params.mimeType = NULL;
10194 return context->InvokeService(context, _OrthancPluginService_SendStreamChunk, &params);
10195 }
10196
10197
10198 typedef struct
10199 {
10200 OrthancPluginMemoryBuffer* instanceId;
10201 OrthancPluginMemoryBuffer* attachmentUuid;
10202 OrthancPluginStoreStatus* storeStatus;
10203 const void* dicom;
10204 uint64_t dicomSize;
10205 const void* customData;
10206 uint32_t customDataSize;
10207 } _OrthancPluginAdoptDicomInstance;
10208
10247 ORTHANC_PLUGIN_SINCE_SDK("1.12.8")
10249 OrthancPluginContext* context,
10250 OrthancPluginMemoryBuffer* instanceId, /* out */
10251 OrthancPluginMemoryBuffer* attachmentUuid, /* out */
10252 OrthancPluginStoreStatus* storeStatus, /* out */
10253 const void* dicom,
10254 uint64_t dicomSize,
10255 const void* customData,
10256 uint32_t customDataSize)
10257 {
10258 _OrthancPluginAdoptDicomInstance params;
10259 params.instanceId = instanceId;
10260 params.attachmentUuid = attachmentUuid;
10261 params.storeStatus = storeStatus;
10262 params.dicom = dicom;
10263 params.dicomSize = dicomSize;
10264 params.customData = customData;
10265 params.customDataSize = customDataSize;
10266
10267 return context->InvokeService(context, _OrthancPluginService_AdoptDicomInstance, &params);
10268 }
10269
10270
10271 typedef struct
10272 {
10273 OrthancPluginMemoryBuffer* customData;
10274 const char* attachmentUuid;
10275 } _OrthancPluginGetAttachmentCustomData;
10276
10289 ORTHANC_PLUGIN_SINCE_SDK("1.12.8")
10291 OrthancPluginContext* context,
10292 OrthancPluginMemoryBuffer* customData, /* out */
10293 const char* attachmentUuid /* in */)
10294 {
10295 _OrthancPluginGetAttachmentCustomData params;
10296 params.customData = customData;
10297 params.attachmentUuid = attachmentUuid;
10298
10299 return context->InvokeService(context, _OrthancPluginService_GetAttachmentCustomData, &params);
10300 }
10301
10302
10303 typedef struct
10304 {
10305 const char* attachmentUuid;
10306 const void* customData;
10307 uint32_t customDataSize;
10308 } _OrthancPluginSetAttachmentCustomData;
10309
10322 ORTHANC_PLUGIN_SINCE_SDK("1.12.8")
10324 OrthancPluginContext* context,
10325 const char* attachmentUuid, /* in */
10326 const void* customData, /* in */
10327 uint32_t customDataSize /* in */)
10328 {
10329 _OrthancPluginSetAttachmentCustomData params;
10330 params.attachmentUuid = attachmentUuid;
10331 params.customData = customData;
10332 params.customDataSize = customDataSize;
10333
10334 return context->InvokeService(context, _OrthancPluginService_SetAttachmentCustomData, &params);
10335 }
10336
10337
10338 typedef struct
10339 {
10340 const char* storeId;
10341 const char* key;
10342 const void* value;
10343 uint32_t valueSize;
10344 } _OrthancPluginStoreKeyValue;
10345
10356 ORTHANC_PLUGIN_SINCE_SDK("1.12.8")
10358 OrthancPluginContext* context,
10359 const char* storeId, /* in */
10360 const char* key, /* in */
10361 const void* value, /* in */
10362 uint32_t valueSize /* in */)
10363 {
10364 _OrthancPluginStoreKeyValue params;
10365 params.storeId = storeId;
10366 params.key = key;
10367 params.value = value;
10368 params.valueSize = valueSize;
10369
10370 return context->InvokeService(context, _OrthancPluginService_StoreKeyValue, &params);
10371 }
10372
10373
10374 typedef struct
10375 {
10376 const char* storeId;
10377 const char* key;
10378 } _OrthancPluginDeleteKeyValue;
10379
10388 ORTHANC_PLUGIN_SINCE_SDK("1.12.8")
10390 OrthancPluginContext* context,
10391 const char* storeId, /* in */
10392 const char* key /* in */)
10393 {
10394 _OrthancPluginDeleteKeyValue params;
10395 params.storeId = storeId;
10396 params.key = key;
10397
10398 return context->InvokeService(context, _OrthancPluginService_DeleteKeyValue, &params);
10399 }
10400
10401
10402 typedef struct
10403 {
10404 uint8_t* found;
10406 const char* storeId;
10407 const char* key;
10408 } _OrthancPluginGetKeyValue;
10409
10421 ORTHANC_PLUGIN_SINCE_SDK("1.12.8")
10423 OrthancPluginContext* context,
10424 uint8_t* found, /* out */
10425 OrthancPluginMemoryBuffer* target, /* out */
10426 const char* storeId, /* in */
10427 const char* key /* in */)
10428 {
10429 _OrthancPluginGetKeyValue params;
10430 params.found = found;
10431 params.target = target;
10432 params.storeId = storeId;
10433 params.key = key;
10434
10435 return context->InvokeService(context, _OrthancPluginService_GetKeyValue, &params);
10436 }
10437
10438
10444 typedef struct ORTHANC_PLUGIN_SINCE_SDK("1.12.8")
10445 _OrthancPluginKeysValuesIterator_t OrthancPluginKeysValuesIterator;
10446
10447
10448 typedef struct
10449 {
10451 const char* storeId;
10452 } _OrthancPluginCreateKeysValuesIterator;
10453
10454
10465 ORTHANC_PLUGIN_SINCE_SDK("1.12.8")
10467 OrthancPluginContext* context,
10468 const char* storeId)
10469 {
10470 OrthancPluginKeysValuesIterator* target = NULL;
10471
10472 _OrthancPluginCreateKeysValuesIterator params;
10473 params.target = &target;
10474 params.storeId = storeId;
10475
10476 if (context->InvokeService(context, _OrthancPluginService_CreateKeysValuesIterator, &params) != OrthancPluginErrorCode_Success)
10477 {
10478 return NULL;
10479 }
10480 else
10481 {
10482 return target;
10483 }
10484 }
10485
10486
10487 typedef struct
10488 {
10490 } _OrthancPluginFreeKeysValuesIterator;
10491
10498 ORTHANC_PLUGIN_SINCE_SDK("1.12.8")
10499 ORTHANC_PLUGIN_INLINE void OrthancPluginFreeKeysValuesIterator(
10500 OrthancPluginContext* context,
10502 {
10503 _OrthancPluginFreeKeysValuesIterator params;
10504 params.iterator = iterator;
10505
10506 context->InvokeService(context, _OrthancPluginService_FreeKeysValuesIterator, &params);
10507 }
10508
10509
10510 typedef struct
10511 {
10512 uint8_t* done;
10514 } _OrthancPluginKeysValuesIteratorNext;
10515
10526 ORTHANC_PLUGIN_SINCE_SDK("1.12.8")
10528 OrthancPluginContext* context,
10529 uint8_t* done, /* out */
10530 OrthancPluginKeysValuesIterator* iterator /* in */)
10531 {
10532 _OrthancPluginKeysValuesIteratorNext params;
10533 params.done = done;
10534 params.iterator = iterator;
10535
10536 return context->InvokeService(context, _OrthancPluginService_KeysValuesIteratorNext, &params);
10537 }
10538
10539
10540 typedef struct
10541 {
10542 const char** target;
10544 } _OrthancPluginKeysValuesIteratorGetKey;
10545
10556 ORTHANC_PLUGIN_SINCE_SDK("1.12.8")
10557 ORTHANC_PLUGIN_INLINE const char* OrthancPluginKeysValuesIteratorGetKey(
10558 OrthancPluginContext* context,
10560 {
10561 const char* target = NULL;
10562
10563 _OrthancPluginKeysValuesIteratorGetKey params;
10564 params.target = &target;
10565 params.iterator = iterator;
10566
10567 if (context->InvokeService(context, _OrthancPluginService_KeysValuesIteratorGetKey, &params) == OrthancPluginErrorCode_Success)
10568 {
10569 return target;
10570 }
10571 else
10572 {
10573 return NULL;
10574 }
10575 }
10576
10577
10578 typedef struct
10579 {
10582 } _OrthancPluginKeysValuesIteratorGetValue;
10583
10596 ORTHANC_PLUGIN_SINCE_SDK("1.12.8")
10598 OrthancPluginContext* context,
10599 OrthancPluginMemoryBuffer* target /* out */,
10600 OrthancPluginKeysValuesIterator* iterator /* in */)
10601 {
10602 _OrthancPluginKeysValuesIteratorGetValue params;
10603 params.target = target;
10604 params.iterator = iterator;
10605
10606 return context->InvokeService(context, _OrthancPluginService_KeysValuesIteratorGetValue, &params);
10607 }
10608
10609
10610 typedef struct
10611 {
10612 const char* queueId;
10613 const void* value;
10614 uint32_t valueSize;
10615 } _OrthancPluginEnqueueValue;
10616
10626 ORTHANC_PLUGIN_SINCE_SDK("1.12.8")
10628 OrthancPluginContext* context,
10629 const char* queueId, /* in */
10630 const void* value, /* in */
10631 uint32_t valueSize /* in */)
10632 {
10633 _OrthancPluginEnqueueValue params;
10634 params.queueId = queueId;
10635 params.value = value;
10636 params.valueSize = valueSize;
10637
10638 return context->InvokeService(context, _OrthancPluginService_EnqueueValue, &params);
10639 }
10640
10641
10642 typedef struct
10643 {
10644 uint8_t* found;
10646 const char* queueId;
10648 } _OrthancPluginDequeueValue;
10649
10663 ORTHANC_PLUGIN_SINCE_SDK("1.12.8")
10664 ORTHANC_PLUGIN_DEPRECATED ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginDequeueValue(
10665 OrthancPluginContext* context,
10666 uint8_t* found, /* out */
10667 OrthancPluginMemoryBuffer* target, /* out */
10668 const char* queueId, /* in */
10669 OrthancPluginQueueOrigin origin /* in */)
10670 {
10671 _OrthancPluginDequeueValue params;
10672 params.found = found;
10673 params.target = target;
10674 params.queueId = queueId;
10675 params.origin = origin;
10676
10677 return context->InvokeService(context, _OrthancPluginService_DequeueValue, &params);
10678 }
10679
10680
10681 typedef struct
10682 {
10683 const char* queueId;
10684 uint64_t* size;
10685 } _OrthancPluginGetQueueSize;
10686
10695 ORTHANC_PLUGIN_SINCE_SDK("1.12.8")
10697 OrthancPluginContext* context,
10698 const char* queueId, /* in */
10699 uint64_t* size /* out */)
10700 {
10701 _OrthancPluginGetQueueSize params;
10702 params.queueId = queueId;
10703 params.size = size;
10704
10705 return context->InvokeService(context, _OrthancPluginService_GetQueueSize, &params);
10706 }
10707
10708
10709 typedef struct
10710 {
10711 const char* resourceId;
10712 OrthancPluginStableStatus stableStatus;
10713 uint8_t* statusHasChanged;
10714 } _OrthancPluginSetStableStatus;
10715
10736 ORTHANC_PLUGIN_SINCE_SDK("1.12.9")
10738 OrthancPluginContext* context,
10739 uint8_t* statusHasChanged, /* out */
10740 const char* resourceId, /* in */
10741 OrthancPluginStableStatus stableStatus /* in */)
10742 {
10743 _OrthancPluginSetStableStatus params;
10744 params.resourceId = resourceId;
10745 params.stableStatus= stableStatus;
10746 params.statusHasChanged = statusHasChanged;
10747
10748 return context->InvokeService(context, _OrthancPluginService_SetStableStatus, &params);
10749 }
10750
10751
10775 OrthancPluginHttpAuthenticationStatus* status, /* out */
10776 OrthancPluginMemoryBuffer* customPayload, /* out */
10777 OrthancPluginMemoryBuffer* redirection, /* out */
10778 const char* uri,
10779 const char* ip,
10780 uint32_t headersCount,
10781 const char* const* headersKeys,
10782 const char* const* headersValues,
10783 uint32_t getCount,
10784 const char* const* getKeys,
10785 const char* const* getValues);
10786
10787
10788 typedef struct
10789 {
10791 } _OrthancPluginHttpAuthentication;
10792
10832 ORTHANC_PLUGIN_SINCE_SDK("1.12.9")
10834 OrthancPluginContext* context,
10836 {
10837 _OrthancPluginHttpAuthentication params;
10838 params.callback = callback;
10839
10840 return context->InvokeService(context, _OrthancPluginService_RegisterHttpAuthentication, &params);
10841 }
10842
10843
10844 typedef struct
10845 {
10846 const char* sourcePlugin;
10847 const char* userId;
10848 OrthancPluginResourceType resourceType;
10849 const char* resourceId;
10850 const char* action;
10851 const void* logData;
10852 uint32_t logDataSize;
10853 } _OrthancPluginEmitAuditLog;
10854
10855
10878 ORTHANC_PLUGIN_SINCE_SDK("1.12.9")
10879 ORTHANC_PLUGIN_INLINE void OrthancPluginEmitAuditLog(
10880 OrthancPluginContext* context,
10881 const char* sourcePlugin,
10882 const char* userId,
10883 OrthancPluginResourceType resourceType,
10884 const char* resourceId,
10885 const char* action,
10886 const void* logData,
10887 uint32_t logDataSize)
10888 {
10889 _OrthancPluginEmitAuditLog m;
10890 m.sourcePlugin = sourcePlugin;
10891 m.userId = userId;
10892 m.resourceType = resourceType;
10893 m.resourceId = resourceId;
10894 m.action = action;
10895 m.logData = logData;
10896 m.logDataSize = logDataSize;
10897 context->InvokeService(context, _OrthancPluginService_EmitAuditLog, &m);
10898 }
10899
10900
10920 const char* sourcePlugin,
10921 const char* userId,
10922 OrthancPluginResourceType resourceType,
10923 const char* resourceId,
10924 const char* action,
10925 const void* logData,
10926 uint32_t logDataSize);
10927
10928 typedef struct
10929 {
10931 } _OrthancPluginAuditLogHandler;
10932
10944 ORTHANC_PLUGIN_SINCE_SDK("1.12.9")
10946 OrthancPluginContext* context,
10948 {
10949 _OrthancPluginAuditLogHandler params;
10950 params.handler = handler;
10951
10952 return context->InvokeService(context, _OrthancPluginService_RegisterAuditLogHandler, &params);
10953 }
10954
10955
10956 typedef struct
10957 {
10958 uint8_t* found;
10960 const char* queueId;
10962 uint32_t releaseTimeout;
10963 uint64_t* valueId;
10964 } _OrthancPluginReserveQueueValue;
10965
10987 ORTHANC_PLUGIN_SINCE_SDK("1.12.10")
10989 OrthancPluginContext* context,
10990 uint8_t* found, /* out */
10991 OrthancPluginMemoryBuffer* target, /* out */
10992 uint64_t* valueId, /* out */
10993 const char* queueId, /* in */
10994 OrthancPluginQueueOrigin origin, /* in */
10995 uint32_t releaseTimeout /* in */)
10996 {
10997 _OrthancPluginReserveQueueValue params;
10998 params.found = found;
10999 params.target = target;
11000 params.queueId = queueId;
11001 params.origin = origin;
11002 params.valueId = valueId;
11003 params.releaseTimeout = releaseTimeout;
11004
11005 return context->InvokeService(context, _OrthancPluginService_ReserveQueueValue, &params);
11006 }
11007
11008 typedef struct
11009 {
11010 const char* queueId;
11011 uint64_t valueId;
11012 } _OrthancPluginAcknowledgeQueueValue;
11013
11023 ORTHANC_PLUGIN_SINCE_SDK("1.12.10")
11025 OrthancPluginContext* context,
11026 const char* queueId, /* in */
11027 uint64_t valueId /* in */)
11028 {
11029 _OrthancPluginAcknowledgeQueueValue params;
11030 params.queueId = queueId;
11031 params.valueId = valueId;
11032
11033 return context->InvokeService(context, _OrthancPluginService_AcknowledgeQueueValue, &params);
11034 }
11035
11036
11037 typedef struct
11038 {
11039 const OrthancPluginDicomConnection* connection;
11040 const char** resultString;
11041 } _OrthancPluginAccessDicomConnection;
11042
11054 ORTHANC_PLUGIN_SINCE_SDK("1.12.10")
11055 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetConnectionRemoteAet(
11056 OrthancPluginContext* context,
11057 const OrthancPluginDicomConnection* connection)
11058 {
11059 const char* result;
11060
11061 _OrthancPluginAccessDicomConnection params;
11062 memset(&params, 0, sizeof(params));
11063 params.resultString = &result;
11064 params.connection = connection;
11065
11066 if (context->InvokeService(context, _OrthancPluginService_GetConnectionRemoteAet, &params) != OrthancPluginErrorCode_Success)
11067 {
11068 /* Error */
11069 return NULL;
11070 }
11071 else
11072 {
11073 return result;
11074 }
11075 }
11076
11077
11089 ORTHANC_PLUGIN_SINCE_SDK("1.12.10")
11090 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetConnectionRemoteIp(
11091 OrthancPluginContext* context,
11092 const OrthancPluginDicomConnection* connection)
11093 {
11094 const char* result;
11095
11096 _OrthancPluginAccessDicomConnection params;
11097 memset(&params, 0, sizeof(params));
11098 params.resultString = &result;
11099 params.connection = connection;
11100
11101 if (context->InvokeService(context, _OrthancPluginService_GetConnectionRemoteIp, &params) != OrthancPluginErrorCode_Success)
11102 {
11103 /* Error */
11104 return NULL;
11105 }
11106 else
11107 {
11108 return result;
11109 }
11110 }
11111
11112
11124 ORTHANC_PLUGIN_SINCE_SDK("1.12.10")
11125 ORTHANC_PLUGIN_INLINE const char* OrthancPluginGetConnectionCalledAet(
11126 OrthancPluginContext* context,
11127 const OrthancPluginDicomConnection* connection)
11128 {
11129 const char* result;
11130
11131 _OrthancPluginAccessDicomConnection params;
11132 memset(&params, 0, sizeof(params));
11133 params.resultString = &result;
11134 params.connection = connection;
11135
11136 if (context->InvokeService(context, _OrthancPluginService_GetConnectionCalledAet, &params) != OrthancPluginErrorCode_Success)
11137 {
11138 /* Error */
11139 return NULL;
11140 }
11141 else
11142 {
11143 return result;
11144 }
11145 }
11146
11147
11148 typedef struct
11149 {
11151 } _OrthancPluginWorklistCallback2;
11152
11164 ORTHANC_PLUGIN_SINCE_SDK("1.12.10")
11166 OrthancPluginContext* context,
11168 {
11169 _OrthancPluginWorklistCallback2 params;
11170 params.callback = callback;
11171
11172 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback2, &params);
11173 }
11174
11175
11176 typedef struct
11177 {
11179 } _OrthancPluginFindCallback2;
11180
11192 ORTHANC_PLUGIN_SINCE_SDK("1.12.10")
11194 OrthancPluginContext* context,
11196 {
11197 _OrthancPluginFindCallback2 params;
11198 params.callback = callback;
11199
11200 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback2, &params);
11201 }
11202
11203
11204 typedef struct
11205 {
11207 OrthancPluginGetMoveSize getMoveSize;
11208 OrthancPluginApplyMove applyMove;
11209 OrthancPluginFreeMove freeMove;
11210 } _OrthancPluginMoveCallback2;
11211
11225 ORTHANC_PLUGIN_SINCE_SDK("1.12.10")
11227 OrthancPluginContext* context,
11229 OrthancPluginGetMoveSize getMoveSize,
11230 OrthancPluginApplyMove applyMove,
11231 OrthancPluginFreeMove freeMove)
11232 {
11233 _OrthancPluginMoveCallback2 params;
11234 params.callback = callback;
11235 params.getMoveSize = getMoveSize;
11236 params.applyMove = applyMove;
11237 params.freeMove = freeMove;
11238
11239 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback2, &params);
11240 }
11241
11242
11243 typedef struct
11244 {
11248 } _OrthancPluginRegisterStorageCommitmentScpCallback2;
11249
11263 ORTHANC_PLUGIN_SINCE_SDK("1.12.10")
11265 OrthancPluginContext* context,
11269 {
11270 _OrthancPluginRegisterStorageCommitmentScpCallback2 params;
11271 params.factory = factory;
11272 params.destructor = destructor;
11273 params.lookup = lookup;
11274 return context->InvokeService(context, _OrthancPluginService_RegisterStorageCommitmentScpCallback2, &params);
11275 }
11276
11291 ORTHANC_PLUGIN_SINCE_SDK("1.13.0")
11293 OrthancPluginContext* context)
11294 {
11295 return context->InvokeService(context, _OrthancPluginService_ClearCurrentThreadName, NULL);
11296 }
11297
11298#ifdef __cplusplus
11299}
11300#endif
11301
11302
OrthancPluginErrorCode OrthancPluginRegisterDatabaseBackendV4(OrthancPluginContext *context, void *backend, uint32_t maxDatabaseRetries, OrthancPluginCallDatabaseBackendV4 operations, OrthancPluginFinalizeDatabaseBackendV4 finalize)
Register a custom database back-end.
Definition OrthancCPlugin.h:9964
OrthancPluginErrorCode(* OrthancPluginHttpAuthentication)(OrthancPluginHttpAuthenticationStatus *status, OrthancPluginMemoryBuffer *customPayload, OrthancPluginMemoryBuffer *redirection, const char *uri, const char *ip, uint32_t headersCount, const char *const *headersKeys, const char *const *headersValues, uint32_t getCount, const char *const *getKeys, const char *const *getValues)
Callback to authenticate a HTTP request.
Definition OrthancCPlugin.h:10774
OrthancPluginErrorCode(* OrthancPluginCallDatabaseBackendV4)(OrthancPluginMemoryBuffer64 *response, void *backend, const void *request, uint64_t requestSize)
Signature of a callback function that is triggered when the Orthanc core requests an operation from t...
Definition OrthancCPlugin.h:9925
OrthancPluginReceivedInstanceAction(* OrthancPluginReceivedInstanceCallback)(OrthancPluginMemoryBuffer64 *modifiedDicomBuffer, const void *receivedDicomBuffer, uint64_t receivedDicomBufferSize, OrthancPluginInstanceOrigin origin)
Callback to keep/discard/modify a DICOM instance received by Orthanc from any source (C-STORE or REST...
Definition OrthancCPlugin.h:8701
OrthancPluginErrorCode(* OrthancPluginWebDavAddFile)(OrthancPluginWebDavCollection *collection, const char *name, uint64_t size, const char *mimeType, const char *dateTime)
Declare a file while returning the content of a folder.
Definition OrthancCPlugin.h:9604
void OrthancPluginRegisterStorageArea(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove)
Register a custom storage area.
Definition OrthancCPlugin.h:3716
void OrthancPluginRegisterOnStoredInstanceCallback(OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback)
Register a callback for received instances.
Definition OrthancCPlugin.h:2612
void(* OrthancPluginDicomWebSetBinaryNode)(OrthancPluginDicomWebNode *node, OrthancPluginDicomWebBinaryMode mode, const char *bulkDataUri)
Signature of a function to set the content of a node encoding a binary DICOM tag, into a JSON or XML ...
Definition OrthancCPlugin.h:1481
OrthancPluginErrorCode OrthancPluginRegisterDecodeImageCallback(OrthancPluginContext *context, OrthancPluginDecodeImageCallback callback)
Register a callback to handle the decoding of DICOM images.
Definition OrthancCPlugin.h:6046
OrthancPluginChangeType
Definition OrthancCPlugin.h:832
OrthancPluginErrorCode(* OrthancPluginStorageReadWhole)(OrthancPluginMemoryBuffer64 *target, const char *uuid, OrthancPluginContentType type)
Callback for reading a whole file from the storage area.
Definition OrthancCPlugin.h:1546
OrthancPluginErrorCode OrthancPluginRegisterIncomingCStoreInstanceFilter(OrthancPluginContext *context, OrthancPluginIncomingCStoreInstanceFilter callback)
Register a callback to filter incoming DICOM instances received by Orthanc through C-STORE.
Definition OrthancCPlugin.h:8656
OrthancPluginErrorCode(* OrthancPluginDecodeImageCallback)(OrthancPluginImage **target, const void *dicom, const uint32_t size, uint32_t frameIndex)
Signature of a callback function to decode a DICOM instance as an image.
Definition OrthancCPlugin.h:1459
void OrthancPluginRegisterRefreshMetricsCallback(OrthancPluginContext *context, OrthancPluginRefreshMetricsCallback callback)
Register a callback to refresh the metrics.
Definition OrthancCPlugin.h:7738
OrthancPluginErrorCode OrthancPluginRegisterHttpAuthentication(OrthancPluginContext *context, OrthancPluginHttpAuthentication callback)
Register a callback to handle HTTP authentication (and possibly HTTP authorization).
Definition OrthancCPlugin.h:10833
OrthancPluginErrorCode(* OrthancPluginWebDavCreateFolderCallback)(uint8_t *isReadOnly, uint32_t pathSize, const char *const *pathItems, void *payload)
Callback to create a folder.
Definition OrthancCPlugin.h:9769
OrthancPluginErrorCode(* OrthancPluginStorageReadRange2)(OrthancPluginMemoryBuffer64 *target, const char *uuid, OrthancPluginContentType type, uint64_t rangeStart, const void *customData, uint32_t customDataSize)
Callback for reading a range of a file from the storage area.
Definition OrthancCPlugin.h:1640
struct _OrthancPluginWebDavCollection_t OrthancPluginWebDavCollection
Opaque structure that represents a WebDAV collection.
Definition OrthancCPlugin.h:9578
void(* OrthancPluginDicomWebBinaryCallback)(OrthancPluginDicomWebNode *node, OrthancPluginDicomWebSetBinaryNode setter, uint32_t levelDepth, const uint16_t *levelTagGroup, const uint16_t *levelTagElement, const uint32_t *levelIndex, uint16_t tagGroup, uint16_t tagElement, OrthancPluginValueRepresentation vr)
Callback executed to encode a binary tag in DICOMweb.
Definition OrthancCPlugin.h:2179
OrthancPluginErrorCode(* OrthancPluginWebDavRetrieveFileCallback)(OrthancPluginWebDavCollection *collection, OrthancPluginWebDavRetrieveFile retrieveFile, uint32_t pathSize, const char *const *pathItems, void *payload)
Callback for retrieving the content of a file.
Definition OrthancCPlugin.h:9724
int32_t(* OrthancPluginIncomingDicomInstanceFilter)(const OrthancPluginDicomInstance *instance)
Callback to filter incoming DICOM instances received by Orthanc.
Definition OrthancCPlugin.h:8570
OrthancPluginErrorCode OrthancPluginStorageAreaRemove(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Remove a file from the storage area.
Definition OrthancCPlugin.h:5395
OrthancPluginErrorCode(* OrthancPluginTranscoderCallback)(OrthancPluginMemoryBuffer *transcoded, const void *buffer, uint64_t size, const char *const *allowedSyntaxes, uint32_t countSyntaxes, uint8_t allowNewSopInstanceUid)
Signature of a callback function to transcode a DICOM instance.
Definition OrthancCPlugin.h:9234
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter2(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter2 callback)
Register a callback to filter incoming HTTP requests.
Definition OrthancCPlugin.h:6965
OrthancPluginErrorCode(* OrthancPluginWebDavRetrieveFile)(OrthancPluginWebDavCollection *collection, const void *data, uint64_t size, const char *mimeType, const char *dateTime)
Retrieve the content of a file.
Definition OrthancCPlugin.h:9652
void OrthancPluginRegisterStorageArea3(OrthancPluginContext *context, OrthancPluginStorageCreate2 create, OrthancPluginStorageReadRange2 readRange, OrthancPluginStorageRemove2 remove)
Register a custom storage area, with support for custom data.
Definition OrthancCPlugin.h:9906
OrthancPluginErrorCode(* OrthancPluginStorageRead)(void **content, int64_t *size, const char *uuid, OrthancPluginContentType type)
Callback for reading from the storage area.
Definition OrthancCPlugin.h:1526
void OrthancPluginRegisterRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback.
Definition OrthancCPlugin.h:2534
uint32_t OrthancPluginGetExpectedDatabaseVersion(OrthancPluginContext *context)
Get the expected version of the database schema.
Definition OrthancCPlugin.h:4193
OrthancPluginErrorCode OrthancPluginRegisterReceivedInstanceCallback(OrthancPluginContext *context, OrthancPluginReceivedInstanceCallback callback)
Register a callback to keep/discard/modify a DICOM instance received by Orthanc from any source (C-ST...
Definition OrthancCPlugin.h:8734
OrthancPluginErrorCode(* OrthancPluginWebDavListFolderCallback)(uint8_t *isExisting, OrthancPluginWebDavCollection *collection, OrthancPluginWebDavAddFile addFile, OrthancPluginWebDavAddFolder addFolder, uint32_t pathSize, const char *const *pathItems, void *payload)
Callback for listing the content of a folder.
Definition OrthancCPlugin.h:9698
int32_t OrthancPluginCheckVersion(const OrthancPluginContext *context)
Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
Definition OrthancCPlugin.h:2414
OrthancPluginJob *(* OrthancPluginJobsUnserializer)(const char *jobType, const char *serialized)
Callback executed to unserialize a custom job.
Definition OrthancCPlugin.h:2132
struct _OrthancPluginRestOutput_t OrthancPluginRestOutput
Opaque structure that represents the HTTP connection to the client application.
Definition OrthancCPlugin.h:1317
void OrthancPluginRegisterOnChangeCallback(OrthancPluginContext *context, OrthancPluginOnChangeCallback callback)
Register a callback to monitor changes.
Definition OrthancCPlugin.h:3859
void OrthancPluginRegisterStorageArea2(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageReadWhole readWhole, OrthancPluginStorageReadRange readRange, OrthancPluginStorageRemove remove)
Register a custom storage area, with support for range request.
Definition OrthancCPlugin.h:9423
OrthancPluginErrorCode(* OrthancPluginWebDavAddFolder)(OrthancPluginWebDavCollection *collection, const char *name, const char *dateTime)
Declare a subfolder while returning the content of a folder.
Definition OrthancCPlugin.h:9625
OrthancPluginErrorCode OrthancPluginRegisterWebDavCollection(OrthancPluginContext *context, const char *uri, OrthancPluginWebDavIsExistingFolderCallback isExistingFolder, OrthancPluginWebDavListFolderCallback listFolder, OrthancPluginWebDavRetrieveFileCallback retrieveFile, OrthancPluginWebDavStoreFileCallback storeFile, OrthancPluginWebDavCreateFolderCallback createFolder, OrthancPluginWebDavDeleteItemCallback deleteItem, void *payload)
Register a WebDAV virtual filesystem.
Definition OrthancCPlugin.h:9829
int32_t(* OrthancPluginIncomingHttpRequestFilter2)(OrthancPluginHttpMethod method, const char *uri, const char *ip, uint32_t headersCount, const char *const *headersKeys, const char *const *headersValues, uint32_t getArgumentsCount, const char *const *getArgumentsKeys, const char *const *getArgumentsValues)
Callback to filter incoming HTTP requests received by Orthanc.
Definition OrthancCPlugin.h:1771
void(* OrthancPluginRefreshMetricsCallback)()
Callback executed to update the metrics of the plugin.
Definition OrthancCPlugin.h:2151
OrthancPluginErrorCode OrthancPluginRegisterTranscoderCallback(OrthancPluginContext *context, OrthancPluginTranscoderCallback callback)
Register a callback to handle the transcoding of DICOM images.
Definition OrthancCPlugin.h:9262
OrthancPluginErrorCode(* OrthancPluginOnStoredInstanceCallback)(const OrthancPluginDicomInstance *instance, const char *instanceId)
Signature of a callback function that is triggered when Orthanc stores a new DICOM instance.
Definition OrthancCPlugin.h:1438
OrthancPluginErrorCode(* OrthancPluginStorageCreate2)(OrthancPluginMemoryBuffer *customData, const char *uuid, const void *content, uint64_t size, OrthancPluginContentType type, OrthancPluginCompressionType compressionType, const OrthancPluginDicomInstance *dicomInstance)
Callback for writing to the storage area.
Definition OrthancCPlugin.h:1611
OrthancPluginErrorCode(* OrthancPluginWebDavStoreFileCallback)(uint8_t *isReadOnly, uint32_t pathSize, const char *const *pathItems, const void *data, uint64_t size, void *payload)
Callback to store a file.
Definition OrthancCPlugin.h:9747
OrthancPluginErrorCode(* OrthancPluginWebDavDeleteItemCallback)(uint8_t *isReadOnly, uint32_t pathSize, const char *const *pathItems, void *payload)
Callback to remove a file or a folder.
Definition OrthancCPlugin.h:9789
OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, OrthancPluginResourceType level)
Reconstruct the main DICOM tags.
Definition OrthancCPlugin.h:5588
OrthancPluginErrorCode(* OrthancPluginStorageRemove)(const char *uuid, OrthancPluginContentType type)
Callback for removing a file from the storage area.
Definition OrthancCPlugin.h:1587
OrthancPluginErrorCode(* OrthancPluginStorageCreate)(const char *uuid, const void *content, int64_t size, OrthancPluginContentType type)
Callback for writing to the storage area.
Definition OrthancCPlugin.h:1500
void(* OrthancPluginDicomWebBinaryCallback2)(OrthancPluginDicomWebNode *node, OrthancPluginDicomWebSetBinaryNode setter, uint32_t levelDepth, const uint16_t *levelTagGroup, const uint16_t *levelTagElement, const uint32_t *levelIndex, uint16_t tagGroup, uint16_t tagElement, OrthancPluginValueRepresentation vr, void *payload)
Callback executed to encode a binary tag in DICOMweb.
Definition OrthancCPlugin.h:2217
OrthancPluginErrorCode OrthancPluginRegisterAuditLogHandler(OrthancPluginContext *context, OrthancPluginAuditLogHandler handler)
Register a callback to handle audit logs.
Definition OrthancCPlugin.h:10945
OrthancPluginErrorCode(* OrthancPluginOnChangeCallback)(OrthancPluginChangeType changeType, OrthancPluginResourceType resourceType, const char *resourceId)
Signature of a callback function that is triggered when a change happens to some DICOM resource.
Definition OrthancCPlugin.h:1448
OrthancPluginErrorCode(* OrthancPluginRestCallback)(OrthancPluginRestOutput *output, const char *uri, const OrthancPluginHttpRequest *request)
Signature of a callback function that answers to a REST request.
Definition OrthancCPlugin.h:1427
void(* OrthancPluginFinalizeDatabaseBackendV4)(void *backend)
Signature of a callback function that is triggered when the database plugin must be finalized.
Definition OrthancCPlugin.h:9936
struct _OrthancPluginServerChunkedRequestReader_t OrthancPluginServerChunkedRequestReader
Opaque structure that reads the content of a HTTP request body during a chunked HTTP transfer.
Definition OrthancCPlugin.h:8191
OrthancPluginErrorCode(* OrthancPluginWebDavIsExistingFolderCallback)(uint8_t *isExisting, uint32_t pathSize, const char *const *pathItems, void *payload)
Callback for testing the existence of a folder.
Definition OrthancCPlugin.h:9673
struct _OrthancPluginKeysValuesIterator_t OrthancPluginKeysValuesIterator
Opaque structure that represents an iterator over the keys and values of a key-value store.
Definition OrthancCPlugin.h:10444
int32_t(* OrthancPluginIncomingHttpRequestFilter)(OrthancPluginHttpMethod method, const char *uri, const char *ip, uint32_t headersCount, const char *const *headersKeys, const char *const *headersValues)
Callback to filter incoming HTTP requests received by Orthanc.
Definition OrthancCPlugin.h:1732
int32_t OrthancPluginCheckVersionAdvanced(const OrthancPluginContext *context, int32_t expectedMajor, int32_t expectedMinor, int32_t expectedRevision)
Check that the version of the hosting Orthanc is above a given version.
Definition OrthancCPlugin.h:2299
void OrthancPluginRegisterJobsUnserializer(OrthancPluginContext *context, OrthancPluginJobsUnserializer unserializer)
Register an unserializer for custom jobs.
Definition OrthancCPlugin.h:7589
void(* OrthancPluginFree)(void *buffer)
Signature of a function to free dynamic memory.
Definition OrthancCPlugin.h:1471
OrthancPluginErrorCode(* OrthancPluginAuditLogHandler)(const char *sourcePlugin, const char *userId, OrthancPluginResourceType resourceType, const char *resourceId, const char *action, const void *logData, uint32_t logDataSize)
Callback to handle an audit log.
Definition OrthancCPlugin.h:10919
void OrthancPluginRegisterRestCallbackNoLock(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback, without locking.
Definition OrthancCPlugin.h:2574
OrthancPluginErrorCode OrthancPluginStorageAreaRead(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Read a file from the storage area.
Definition OrthancCPlugin.h:5354
OrthancPluginErrorCode(* OrthancPluginStorageRemove2)(const char *uuid, OrthancPluginContentType type, const void *customData, uint32_t customDataSize)
Callback for removing a file from the storage area.
Definition OrthancCPlugin.h:1663
OrthancPluginErrorCode(* OrthancPluginStorageReadRange)(OrthancPluginMemoryBuffer64 *target, const char *uuid, OrthancPluginContentType type, uint64_t rangeStart)
Callback for reading a range of a file from the storage area.
Definition OrthancCPlugin.h:1569
void OrthancPluginRegisterChunkedRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback getHandler, OrthancPluginServerChunkedRequestReaderFactory postHandler, OrthancPluginRestCallback deleteHandler, OrthancPluginServerChunkedRequestReaderFactory putHandler, OrthancPluginServerChunkedRequestReaderAddChunk addChunk, OrthancPluginServerChunkedRequestReaderExecute execute, OrthancPluginServerChunkedRequestReaderFinalize finalize)
Register a REST callback to handle chunked HTTP transfers.
Definition OrthancCPlugin.h:8314
int32_t(* OrthancPluginIncomingCStoreInstanceFilter)(uint16_t *dimseStatus, const OrthancPluginDicomInstance *instance)
Callback to filter incoming DICOM instances received by Orthanc through C-STORE.
Definition OrthancCPlugin.h:8633
OrthancPluginErrorCode OrthancPluginRegisterIncomingDicomInstanceFilter(OrthancPluginContext *context, OrthancPluginIncomingDicomInstanceFilter callback)
Register a callback to filter incoming DICOM instances.
Definition OrthancCPlugin.h:8592
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter callback)
Register a callback to filter incoming HTTP requests.
Definition OrthancCPlugin.h:6384
OrthancPluginErrorCode OrthancPluginStorageAreaCreate(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, const void *content, uint64_t size, OrthancPluginContentType type)
Create a file inside the storage area.
Definition OrthancCPlugin.h:5308
@ OrthancPluginChangeType_OrthancStopped
Definition OrthancCPlugin.h:844
@ OrthancPluginChangeType_OrthancStarted
Definition OrthancCPlugin.h:843
@ OrthancPluginChangeType_Deleted
Definition OrthancCPlugin.h:834
@ OrthancPluginChangeType_JobFailure
Definition OrthancCPlugin.h:851
@ OrthancPluginChangeType_NewInstance
Definition OrthancCPlugin.h:836
@ OrthancPluginChangeType_NewPatient
Definition OrthancCPlugin.h:837
@ OrthancPluginChangeType_JobSubmitted
Definition OrthancCPlugin.h:849
@ OrthancPluginChangeType_NewSeries
Definition OrthancCPlugin.h:838
@ OrthancPluginChangeType_StablePatient
Definition OrthancCPlugin.h:840
@ OrthancPluginChangeType_UpdatedPeers
Definition OrthancCPlugin.h:847
@ OrthancPluginChangeType_StableStudy
Definition OrthancCPlugin.h:842
@ OrthancPluginChangeType_CompletedSeries
Definition OrthancCPlugin.h:833
@ OrthancPluginChangeType_NewChildInstance
Definition OrthancCPlugin.h:835
@ OrthancPluginChangeType_UpdatedAttachment
Definition OrthancCPlugin.h:845
@ OrthancPluginChangeType_UpdatedMetadata
Definition OrthancCPlugin.h:846
@ OrthancPluginChangeType_StableSeries
Definition OrthancCPlugin.h:841
@ OrthancPluginChangeType_UpdatedModalities
Definition OrthancCPlugin.h:848
@ OrthancPluginChangeType_JobSuccess
Definition OrthancCPlugin.h:850
@ OrthancPluginChangeType_NewStudy
Definition OrthancCPlugin.h:839
uint32_t OrthancPluginGetFindQuerySize(OrthancPluginContext *context, const OrthancPluginFindQuery *query)
Get the number of tags in a C-Find query.
Definition OrthancCPlugin.h:6651
struct _OrthancPluginFindQuery_t OrthancPluginFindQuery
Opaque structure to an object that represents a C-Find query.
Definition OrthancCPlugin.h:1365
OrthancPluginErrorCode(* OrthancPluginApplyMove)(void *moveDriver)
Callback to apply one C-Move suboperation.
Definition OrthancCPlugin.h:1945
OrthancPluginErrorCode OrthancPluginFindMarkIncomplete(OrthancPluginContext *context, OrthancPluginFindAnswers *answers)
Mark the set of C-Find answers as incomplete.
Definition OrthancCPlugin.h:6626
void(* OrthancPluginStorageCommitmentDestructor)(void *handler)
Callback to free one storage commitment SCP handler.
Definition OrthancCPlugin.h:8481
OrthancPluginErrorCode(* OrthancPluginWorklistCallback)(OrthancPluginWorklistAnswers *answers, const OrthancPluginWorklistQuery *query, const char *issuerAet, const char *calledAet)
Callback to handle the C-Find SCP requests for worklists.
Definition OrthancCPlugin.h:1683
OrthancPluginErrorCode OrthancPluginRegisterMoveCallback2(OrthancPluginContext *context, OrthancPluginMoveCallback2 callback, OrthancPluginGetMoveSize getMoveSize, OrthancPluginApplyMove applyMove, OrthancPluginFreeMove freeMove)
Register a callback to handle C-Move requests (v2).
Definition OrthancCPlugin.h:11226
OrthancPluginErrorCode OrthancPluginRegisterMoveCallback(OrthancPluginContext *context, OrthancPluginMoveCallback callback, OrthancPluginGetMoveSize getMoveSize, OrthancPluginApplyMove applyMove, OrthancPluginFreeMove freeMove)
Register a callback to handle C-Move requests.
Definition OrthancCPlugin.h:6809
char * OrthancPluginGetFindQueryValue(OrthancPluginContext *context, const OrthancPluginFindQuery *query, uint32_t index)
Get the value associated with one tag in a C-Find query.
Definition OrthancCPlugin.h:6760
OrthancPluginErrorCode(* OrthancPluginStorageCommitmentFactory)(void **handler, const char *jobId, const char *transactionUid, const char *const *sopClassUids, const char *const *sopInstanceUids, uint32_t countInstances, const char *remoteAet, const char *calledAet)
Callback executed by the storage commitment SCP.
Definition OrthancCPlugin.h:8421
OrthancPluginErrorCode OrthancPluginRegisterStorageCommitmentScpCallback2(OrthancPluginContext *context, OrthancPluginStorageCommitmentFactory2 factory, OrthancPluginStorageCommitmentDestructor destructor, OrthancPluginStorageCommitmentLookup lookup)
Register a callback to handle incoming requests to the storage commitment SCP (v2).
Definition OrthancCPlugin.h:11264
OrthancPluginErrorCode OrthancPluginRegisterWorklistCallback2(OrthancPluginContext *context, OrthancPluginWorklistCallback2 callback)
Register a callback to handle modality worklists requests (v2).
Definition OrthancCPlugin.h:11165
OrthancPluginErrorCode OrthancPluginRegisterFindCallback(OrthancPluginContext *context, OrthancPluginFindCallback callback)
Register a callback to handle C-Find requests.
Definition OrthancCPlugin.h:6556
OrthancPluginErrorCode(* OrthancPluginFindCallback2)(OrthancPluginFindAnswers *answers, const OrthancPluginFindQuery *query, const OrthancPluginDicomConnection *connection)
Callback to handle incoming C-Find SCP requests (v2).
Definition OrthancCPlugin.h:1819
OrthancPluginErrorCode OrthancPluginWorklistGetDicomQuery(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginWorklistQuery *query)
Retrieve the worklist query as a DICOM file.
Definition OrthancCPlugin.h:5928
OrthancPluginErrorCode(* OrthancPluginStorageCommitmentLookup)(OrthancPluginStorageCommitmentFailureReason *target, void *handler, const char *sopClassUid, const char *sopInstanceUid)
Callback to get the status of one DICOM instance in the storage commitment SCP.
Definition OrthancCPlugin.h:8502
int32_t OrthancPluginWorklistIsMatch(OrthancPluginContext *context, const OrthancPluginWorklistQuery *query, const void *dicom, uint32_t size)
Test whether a worklist matches the query.
Definition OrthancCPlugin.h:5889
OrthancPluginErrorCode OrthancPluginFindAddAnswer(OrthancPluginContext *context, OrthancPluginFindAnswers *answers, const void *dicom, uint32_t size)
Add one answer to some C-Find request.
Definition OrthancCPlugin.h:6596
OrthancPluginErrorCode OrthancPluginRegisterStorageCommitmentScpCallback(OrthancPluginContext *context, OrthancPluginStorageCommitmentFactory factory, OrthancPluginStorageCommitmentDestructor destructor, OrthancPluginStorageCommitmentLookup lookup)
Register a callback to handle incoming requests to the storage commitment SCP.
Definition OrthancCPlugin.h:8530
struct _OrthancPluginFindAnswers_t OrthancPluginFindAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition OrthancCPlugin.h:1374
struct _OrthancPluginWorklistAnswers_t OrthancPluginWorklistAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition OrthancCPlugin.h:1357
OrthancPluginErrorCode(* OrthancPluginFindCallback)(OrthancPluginFindAnswers *answers, const OrthancPluginFindQuery *query, const char *issuerAet, const char *calledAet)
Callback to handle incoming C-Find SCP requests.
Definition OrthancCPlugin.h:1798
uint32_t(* OrthancPluginGetMoveSize)(void *moveDriver)
Callback to read the size of a C-Move driver.
Definition OrthancCPlugin.h:1930
OrthancPluginErrorCode OrthancPluginRegisterWorklistCallback(OrthancPluginContext *context, OrthancPluginWorklistCallback callback)
Register a callback to handle modality worklists requests.
Definition OrthancCPlugin.h:5777
void *(* OrthancPluginMoveCallback2)(OrthancPluginResourceType resourceType, const char *patientId, const char *accessionNumber, const char *studyInstanceUid, const char *seriesInstanceUid, const char *sopInstanceUid, const OrthancPluginDicomConnection *connection, const char *targetAet, uint16_t originatorId)
Callback to handle incoming C-Move SCP requests (v2).
Definition OrthancCPlugin.h:1906
OrthancPluginErrorCode OrthancPluginRegisterFindCallback2(OrthancPluginContext *context, OrthancPluginFindCallback2 callback)
Register a callback to handle C-Find requests (v2).
Definition OrthancCPlugin.h:11193
char * OrthancPluginGetFindQueryTagName(OrthancPluginContext *context, const OrthancPluginFindQuery *query, uint32_t index)
Get the symbolic name of one tag in a C-Find query.
Definition OrthancCPlugin.h:6721
OrthancPluginErrorCode OrthancPluginWorklistMarkIncomplete(OrthancPluginContext *context, OrthancPluginWorklistAnswers *answers)
Mark the set of worklist answers as incomplete.
Definition OrthancCPlugin.h:5851
OrthancPluginErrorCode OrthancPluginGetFindQueryTag(OrthancPluginContext *context, uint16_t *group, uint16_t *element, const OrthancPluginFindQuery *query, uint32_t index)
Get one tag in a C-Find query.
Definition OrthancCPlugin.h:6689
OrthancPluginErrorCode(* OrthancPluginStorageCommitmentFactory2)(void **handler, const char *jobId, const char *transactionUid, const char *const *sopClassUids, const char *const *sopInstanceUids, uint32_t countInstances, const OrthancPluginDicomConnection *connection)
Callback executed by the storage commitment SCP (v2).
Definition OrthancCPlugin.h:8460
void(* OrthancPluginFreeMove)(void *moveDriver)
Callback to free one C-Move driver.
Definition OrthancCPlugin.h:1959
struct _OrthancPluginWorklistQuery_t OrthancPluginWorklistQuery
Opaque structure to an object that represents a C-Find query for worklists.
Definition OrthancCPlugin.h:1349
void *(* OrthancPluginMoveCallback)(OrthancPluginResourceType resourceType, const char *patientId, const char *accessionNumber, const char *studyInstanceUid, const char *seriesInstanceUid, const char *sopInstanceUid, const char *originatorAet, const char *sourceAet, const char *targetAet, uint16_t originatorId)
Callback to handle incoming C-Move SCP requests.
Definition OrthancCPlugin.h:1860
OrthancPluginErrorCode OrthancPluginWorklistAddAnswer(OrthancPluginContext *context, OrthancPluginWorklistAnswers *answers, const OrthancPluginWorklistQuery *query, const void *dicom, uint32_t size)
Add one answer to some modality worklist request.
Definition OrthancCPlugin.h:5821
OrthancPluginErrorCode(* OrthancPluginWorklistCallback2)(OrthancPluginWorklistAnswers *answers, const OrthancPluginWorklistQuery *query, const OrthancPluginDicomConnection *connection)
Callback to handle the C-Find SCP requests for worklists (v2).
Definition OrthancCPlugin.h:1703
const char * OrthancPluginGetConnectionRemoteAet(OrthancPluginContext *context, const OrthancPluginDicomConnection *connection)
Get the remote AET of a DICOM connection.
Definition OrthancCPlugin.h:11055
struct _OrthancPluginDicomConnection_t OrthancPluginDicomConnection
Opaque structure that represents the parameters of a DICOM connection.
Definition OrthancCPlugin.h:1419
const char * OrthancPluginGetConnectionRemoteIp(OrthancPluginContext *context, const OrthancPluginDicomConnection *connection)
Get the remote IP of a DICOM connection.
Definition OrthancCPlugin.h:11090
const char * OrthancPluginGetConnectionCalledAet(OrthancPluginContext *context, const OrthancPluginDicomConnection *connection)
Get the called AET of a DICOM connection.
Definition OrthancCPlugin.h:11125
int32_t OrthancPluginHasInstancePixelData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Check whether the DICOM file has pixel data.
Definition OrthancCPlugin.h:8794
char * OrthancPluginGetInstanceDicomWebXml(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb XML.
Definition OrthancCPlugin.h:9189
struct _OrthancPluginDicomInstance_t OrthancPluginDicomInstance
Opaque structure that represents a DICOM instance that is managed by the Orthanc core.
Definition OrthancCPlugin.h:1325
OrthancPluginErrorCode OrthancPluginGetInstanceRawFrame(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginDicomInstance *instance, uint32_t frameIndex)
Get the raw content of a frame in a DICOM instance.
Definition OrthancCPlugin.h:8963
const char * OrthancPluginGetInstanceRemoteIp(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the Remote IP of a DICOM instance.
Definition OrthancCPlugin.h:3447
const char * OrthancPluginGetInstanceRemoteAet(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the AET of a DICOM instance.
Definition OrthancCPlugin.h:3378
OrthancPluginDicomInstance * OrthancPluginLoadDicomInstance(OrthancPluginContext *context, const char *instanceId, OrthancPluginLoadDicomInstanceMode mode)
Load a DICOM instance from the Orthanc server.
Definition OrthancCPlugin.h:10002
char * OrthancPluginGetInstanceJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file.
Definition OrthancCPlugin.h:3549
OrthancPluginDicomInstance * OrthancPluginTranscodeDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size, const char *transferSyntax)
Parse and transcode a DICOM instance.
Definition OrthancCPlugin.h:9032
int32_t OrthancPluginHasInstanceMetadata(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, const char *metadata)
Check whether a DICOM instance is associated with some metadata.
Definition OrthancCPlugin.h:3626
OrthancPluginDicomInstance * OrthancPluginCreateDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size)
Parse a DICOM instance.
Definition OrthancCPlugin.h:8845
uint32_t OrthancPluginGetInstanceFramesCount(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the number of frames in a DICOM instance.
Definition OrthancCPlugin.h:8922
OrthancPluginInstanceOrigin OrthancPluginGetInstanceOrigin(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the origin of a DICOM file.
Definition OrthancCPlugin.h:5954
int64_t OrthancPluginGetInstanceSize(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the size of a DICOM file.
Definition OrthancCPlugin.h:3480
char * OrthancPluginGetInstanceDicomWebJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb JSON.
Definition OrthancCPlugin.h:9148
char * OrthancPluginGetInstanceTransferSyntaxUid(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the transfer syntax of a DICOM file.
Definition OrthancCPlugin.h:8758
void OrthancPluginFreeDicomInstance(OrthancPluginContext *context, OrthancPluginDicomInstance *dicom)
Free a DICOM instance.
Definition OrthancCPlugin.h:8884
const char * OrthancPluginGetInstanceCalledAet(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the Called AET of a DICOM instance.
Definition OrthancCPlugin.h:3413
OrthancPluginErrorCode OrthancPluginSerializeDicomInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginDicomInstance *instance)
Writes a DICOM instance to a memory buffer.
Definition OrthancCPlugin.h:9071
const char * OrthancPluginGetInstanceMetadata(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, const char *metadata)
Get the value of some metadata associated with a given DICOM instance.
Definition OrthancCPlugin.h:3667
char * OrthancPluginGetInstanceSimplifiedJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file (with simplification).
Definition OrthancCPlugin.h:3587
const void * OrthancPluginGetInstanceData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the data of a DICOM file.
Definition OrthancCPlugin.h:3513
OrthancPluginImage * OrthancPluginGetInstanceDecodedFrame(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition OrthancCPlugin.h:8992
char * OrthancPluginGetInstanceAdvancedJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomToJsonFormat format, OrthancPluginDicomToJsonFlags flags, uint32_t maxStringLength)
Format a DICOM memory buffer as a JSON string.
Definition OrthancCPlugin.h:9104
OrthancPluginImage * OrthancPluginConvertPixelFormat(OrthancPluginContext *context, const OrthancPluginImage *source, OrthancPluginPixelFormat targetFormat)
Change the pixel format of an image.
Definition OrthancCPlugin.h:5092
OrthancPluginPixelFormat
Definition OrthancCPlugin.h:707
OrthancPluginErrorCode OrthancPluginDrawText(OrthancPluginContext *context, OrthancPluginImage *image, uint32_t fontIndex, const char *utf8Text, int32_t x, int32_t y, uint8_t r, uint8_t g, uint8_t b)
Draw text on an image.
Definition OrthancCPlugin.h:5252
OrthancPluginErrorCode OrthancPluginCompressJpegImage(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginPixelFormat format, uint32_t width, uint32_t height, uint32_t pitch, const void *buffer, uint8_t quality)
Encode a JPEG image.
Definition OrthancCPlugin.h:4836
uint32_t OrthancPluginGetImagePitch(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pitch of an image.
Definition OrthancCPlugin.h:4627
OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pixel format of an image.
Definition OrthancCPlugin.h:4526
OrthancPluginImage * OrthancPluginCreateImage(OrthancPluginContext *context, OrthancPluginPixelFormat format, uint32_t width, uint32_t height)
Create an image.
Definition OrthancCPlugin.h:6084
uint32_t OrthancPluginGetFontsCount(OrthancPluginContext *context)
Return the number of available fonts.
Definition OrthancCPlugin.h:5127
uint32_t OrthancPluginGetImageHeight(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the height of an image.
Definition OrthancCPlugin.h:4592
void * OrthancPluginGetImageBuffer(OrthancPluginContext *context, const OrthancPluginImage *image)
Return a pointer to the content of an image.
Definition OrthancCPlugin.h:4661
void OrthancPluginFreeImage(OrthancPluginContext *context, OrthancPluginImage *image)
Free an image.
Definition OrthancCPlugin.h:4746
OrthancPluginErrorCode OrthancPluginCompressPngImage(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginPixelFormat format, uint32_t width, uint32_t height, uint32_t pitch, const void *buffer)
Encode a PNG image.
Definition OrthancCPlugin.h:4791
OrthancPluginImage * OrthancPluginDecodeDicomImage(OrthancPluginContext *context, const void *buffer, uint32_t bufferSize, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition OrthancCPlugin.h:6173
OrthancPluginImage * OrthancPluginUncompressImage(OrthancPluginContext *context, const void *data, uint32_t size, OrthancPluginImageFormat format)
Decode a compressed image.
Definition OrthancCPlugin.h:4704
const char * OrthancPluginGetFontName(OrthancPluginContext *context, uint32_t fontIndex)
Return the name of a font.
Definition OrthancCPlugin.h:5167
OrthancPluginImageFormat
Definition OrthancCPlugin.h:878
struct _OrthancPluginStorageArea_t OrthancPluginStorageArea
Opaque structure that represents the storage area that is actually used by Orthanc.
Definition OrthancCPlugin.h:1341
OrthancPluginCompressionType
Definition OrthancCPlugin.h:862
uint32_t OrthancPluginGetImageWidth(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the width of an image.
Definition OrthancCPlugin.h:4559
OrthancPluginErrorCode OrthancPluginBufferCompression(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const void *source, uint32_t size, OrthancPluginCompressionType compression, uint8_t uncompress)
Compress or decompress a buffer.
Definition OrthancCPlugin.h:4338
uint32_t OrthancPluginGetFontSize(OrthancPluginContext *context, uint32_t fontIndex)
Return the size of a font.
Definition OrthancCPlugin.h:5199
OrthancPluginImage * OrthancPluginCreateImageAccessor(OrthancPluginContext *context, OrthancPluginPixelFormat format, uint32_t width, uint32_t height, uint32_t pitch, void *buffer)
Create an image pointing to a memory buffer.
Definition OrthancCPlugin.h:6127
struct _OrthancPluginImage_t OrthancPluginImage
Opaque structure that represents an image that is uncompressed in memory.
Definition OrthancCPlugin.h:1333
@ OrthancPluginPixelFormat_RGBA32
Color image in RGBA32 format.
Definition OrthancCPlugin.h:746
@ OrthancPluginPixelFormat_RGB48
Color image in RGB48 format.
Definition OrthancCPlugin.h:756
@ OrthancPluginPixelFormat_Grayscale8
Graylevel 8bpp image.
Definition OrthancCPlugin.h:714
@ OrthancPluginPixelFormat_SignedGrayscale16
Graylevel, signed 16bpp image.
Definition OrthancCPlugin.h:730
@ OrthancPluginPixelFormat_Float32
Graylevel, floating-point 32bpp image.
Definition OrthancCPlugin.h:772
@ OrthancPluginPixelFormat_RGB24
Color image in RGB24 format.
Definition OrthancCPlugin.h:738
@ OrthancPluginPixelFormat_BGRA32
Color image in BGRA32 format.
Definition OrthancCPlugin.h:780
@ OrthancPluginPixelFormat_Unknown
Definition OrthancCPlugin.h:748
@ OrthancPluginPixelFormat_Grayscale64
Graylevel, unsigned 64bpp image.
Definition OrthancCPlugin.h:788
@ OrthancPluginPixelFormat_Grayscale32
Graylevel, unsigned 32bpp image.
Definition OrthancCPlugin.h:764
@ OrthancPluginPixelFormat_Grayscale16
Graylevel, unsigned 16bpp image.
Definition OrthancCPlugin.h:722
@ OrthancPluginImageFormat_Png
Definition OrthancCPlugin.h:879
@ OrthancPluginImageFormat_Jpeg
Definition OrthancCPlugin.h:880
@ OrthancPluginImageFormat_Dicom
Definition OrthancCPlugin.h:881
@ OrthancPluginCompressionType_Gzip
Definition OrthancCPlugin.h:865
@ OrthancPluginCompressionType_ZlibWithSize
Definition OrthancCPlugin.h:864
@ OrthancPluginCompressionType_None
Definition OrthancCPlugin.h:867
@ OrthancPluginCompressionType_Zlib
Definition OrthancCPlugin.h:863
@ OrthancPluginCompressionType_GzipWithSize
Definition OrthancCPlugin.h:866
OrthancPluginErrorCode OrthancPluginRestApiPost(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, const void *body, uint32_t bodySize)
Make a POST call to the built-in Orthanc REST API.
Definition OrthancCPlugin.h:2842
OrthancPluginErrorCode OrthancPluginRestApiPostAfterPlugins(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, const void *body, uint32_t bodySize)
Make a POST call to the REST API, as tainted by the plugins.
Definition OrthancCPlugin.h:2877
OrthancPluginErrorCode OrthancPluginRestApiPutAfterPlugins(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, const void *body, uint32_t bodySize)
Make a PUT call to the REST API, as tainted by the plugins.
Definition OrthancCPlugin.h:2990
char * OrthancPluginLookupStudyWithAccessionNumber(OrthancPluginContext *context, const char *accessionNumber)
Look for a study, using the accession number.
Definition OrthancCPlugin.h:3126
char * OrthancPluginLookupSeries(OrthancPluginContext *context, const char *seriesUID)
Look for a series.
Definition OrthancCPlugin.h:3161
OrthancPluginErrorCode OrthancPluginSetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *value)
Set the value of a global property.
Definition OrthancCPlugin.h:4096
OrthancPluginErrorCode OrthancPluginRestApiPut(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, const void *body, uint32_t bodySize)
Make a PUT call to the built-in Orthanc REST API.
Definition OrthancCPlugin.h:2954
char * OrthancPluginGetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *defaultValue)
Get the value of a global property.
Definition OrthancCPlugin.h:4057
char * OrthancPluginLookupStudy(OrthancPluginContext *context, const char *studyUID)
Look for a study.
Definition OrthancCPlugin.h:3091
OrthancPluginErrorCode OrthancPluginRestApiGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the built-in Orthanc REST API.
Definition OrthancCPlugin.h:2775
char * OrthancPluginLookupInstance(OrthancPluginContext *context, const char *sopInstanceUID)
Look for an instance.
Definition OrthancCPlugin.h:3196
OrthancPluginErrorCode OrthancPluginRestApiGetAfterPlugins(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the REST API, as tainted by the plugins.
Definition OrthancCPlugin.h:2805
char * OrthancPluginLookupPatient(OrthancPluginContext *context, const char *patientID)
Look for a patient.
Definition OrthancCPlugin.h:3056
OrthancPluginErrorCode OrthancPluginRestApiDelete(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the built-in Orthanc REST API.
Definition OrthancCPlugin.h:2906
OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the REST API, as tainted by the plugins.
Definition OrthancCPlugin.h:2929
OrthancPluginErrorCode OrthancPluginCallRestApi(OrthancPluginContext *context, OrthancPluginMemoryBuffer *answerBody, OrthancPluginMemoryBuffer *answerHeaders, uint16_t *httpStatus, OrthancPluginHttpMethod method, const char *uri, uint32_t headersCount, const char *const *headersKeys, const char *const *headersValues, const void *body, uint32_t bodySize, uint8_t afterPlugins)
Call the REST API of Orthanc with full flexibility.
Definition OrthancCPlugin.h:9540
char * OrthancPluginGenerateRestApiAuthorizationToken(OrthancPluginContext *context)
Generate a token to grant full access to the REST API of Orthanc.
Definition OrthancCPlugin.h:9337
OrthancPluginErrorCode OrthancPluginRestApiGet2(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, uint32_t headersCount, const char *const *headersKeys, const char *const *headersValues, int32_t afterPlugins)
Make a GET call to the Orthanc REST API, with custom HTTP headers.
Definition OrthancCPlugin.h:5739
OrthancPluginErrorCode OrthancPluginGetDicomForInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *instanceId)
Retrieve a DICOM instance using its Orthanc identifier.
Definition OrthancCPlugin.h:2742
void OrthancPluginCompressAndAnswerPngImage(OrthancPluginContext *context, OrthancPluginRestOutput *output, OrthancPluginPixelFormat format, uint32_t width, uint32_t height, uint32_t pitch, const void *buffer)
Answer to a REST request with a PNG image.
Definition OrthancCPlugin.h:2701
void OrthancPluginSendUnauthorized(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *realm)
Signal that a REST request is not authorized.
Definition OrthancCPlugin.h:3264
void OrthancPluginSetHttpErrorDetails(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *details, uint8_t log)
Provide a detailed description for an HTTP error.
Definition OrthancCPlugin.h:7626
void OrthancPluginSendMethodNotAllowed(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *allowedMethods)
Signal that this URI does not support this HTTP method.
Definition OrthancCPlugin.h:3287
OrthancPluginErrorCode OrthancPluginSendStreamChunk(OrthancPluginContext *context, OrthancPluginRestOutput *output, const void *answer, uint32_t answerSize)
Send a chunk as a part of an HTTP stream answer.
Definition OrthancCPlugin.h:10183
void OrthancPluginAnswerBuffer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const void *answer, uint32_t answerSize, const char *mimeType)
Answer to a REST request.
Definition OrthancCPlugin.h:2644
void OrthancPluginSendHttpStatusCode(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status)
Send a HTTP status code.
Definition OrthancCPlugin.h:3241
void OrthancPluginSetHttpHeader(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *key, const char *value)
Set some HTTP header.
Definition OrthancCPlugin.h:3342
OrthancPluginErrorCode OrthancPluginStartStreamAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *contentType)
Start an HTTP stream answer.
Definition OrthancCPlugin.h:10155
void OrthancPluginSetCookie(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *cookie, const char *value)
Set a cookie.
Definition OrthancCPlugin.h:3317
void OrthancPluginRedirect(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *redirection)
Redirect a REST request.
Definition OrthancCPlugin.h:3024
void OrthancPluginCompressAndAnswerJpegImage(OrthancPluginContext *context, OrthancPluginRestOutput *output, OrthancPluginPixelFormat format, uint32_t width, uint32_t height, uint32_t pitch, const void *buffer, uint8_t quality)
Answer to a REST request with a JPEG image.
Definition OrthancCPlugin.h:4883
OrthancPluginErrorCode OrthancPluginSendMultipartItem(OrthancPluginContext *context, OrthancPluginRestOutput *output, const void *answer, uint32_t answerSize)
Send an item as a part of some HTTP multipart answer.
Definition OrthancCPlugin.h:4296
OrthancPluginErrorCode OrthancPluginSendMultipartItem2(OrthancPluginContext *context, OrthancPluginRestOutput *output, const void *answer, uint32_t answerSize, uint32_t headersCount, const char *const *headersKeys, const char *const *headersValues)
Send an item as a part of some HTTP multipart answer, with custom headers.
Definition OrthancCPlugin.h:6345
void OrthancPluginSendHttpStatus(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status, const void *body, uint32_t bodySize)
Send a HTTP status, with a custom body.
Definition OrthancCPlugin.h:4490
OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *subType, const char *contentType)
Start an HTTP multipart answer.
Definition OrthancCPlugin.h:4267
OrthancPluginErrorCode(* OrthancPluginJobStop)(void *job, OrthancPluginJobStopReason reason)
Callback executed once one custom job leaves the "running" state.
Definition OrthancCPlugin.h:2099
OrthancPluginErrorCode(* OrthancPluginServerChunkedRequestReaderExecute)(OrthancPluginServerChunkedRequestReader *reader, OrthancPluginRestOutput *output)
Callback invoked whenever the request body is entirely received.
Definition OrthancCPlugin.h:8250
OrthancPluginErrorCode OrthancPluginHttpClient(OrthancPluginContext *context, OrthancPluginMemoryBuffer *answerBody, OrthancPluginMemoryBuffer *answerHeaders, uint16_t *httpStatus, OrthancPluginHttpMethod method, const char *url, uint32_t headersCount, const char *const *headersKeys, const char *const *headersValues, const void *body, uint32_t bodySize, const char *username, const char *password, uint32_t timeout, const char *certificateFile, const char *certificateKeyFile, const char *certificateKeyPassword, uint8_t pkcs11)
Issue a HTTP call with full flexibility.
Definition OrthancCPlugin.h:6460
struct _OrthancPluginJob_t OrthancPluginJob
Opaque structure to a job to be executed by Orthanc.
Definition OrthancCPlugin.h:1401
OrthancPluginErrorCode OrthancPluginCreateDicom2(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *json, const OrthancPluginImage *pixelData, OrthancPluginCreateDicomFlags flags, const char *privateCreator)
Create a DICOM instance from a JSON string and an image, with a private creator.
Definition OrthancCPlugin.h:9471
void OrthancPluginLogMessage(OrthancPluginContext *context, const char *message, const char *plugin, const char *file, uint32_t line, OrthancPluginLogCategory category, OrthancPluginLogLevel level)
Log a message.
Definition OrthancCPlugin.h:10116
void OrthancPluginLogInfo(OrthancPluginContext *context, const char *message)
Log an information.
Definition OrthancCPlugin.h:2498
void OrthancPluginFreeFindMatcher(OrthancPluginContext *context, OrthancPluginFindMatcher *matcher)
Free a C-Find matcher.
Definition OrthancCPlugin.h:6888
void OrthancPluginFreePeers(OrthancPluginContext *context, OrthancPluginPeers *peers)
Free the list of available Orthanc peers.
Definition OrthancCPlugin.h:7029
OrthancPluginLogLevel
Definition OrthancCPlugin.h:1185
OrthancPluginErrorCode OrthancPluginRegisterPrivateDictionaryTag(OrthancPluginContext *context, uint16_t group, uint16_t element, OrthancPluginValueRepresentation vr, const char *name, uint32_t minMultiplicity, uint32_t maxMultiplicity, const char *privateCreator)
Register a new private tag into the DICOM dictionary.
Definition OrthancCPlugin.h:5544
OrthancPluginIdentifierConstraint
Definition OrthancCPlugin.h:989
void OrthancPluginExtendOrthancExplorer2(OrthancPluginContext *context, const char *plugin, const char *javascript)
Extend the JavaScript code of Orthanc Explorer.
Definition OrthancCPlugin.h:4022
OrthancPluginErrorCode OrthancPluginRegisterDictionaryTag(OrthancPluginContext *context, uint16_t group, uint16_t element, OrthancPluginValueRepresentation vr, const char *name, uint32_t minMultiplicity, uint32_t maxMultiplicity)
Register a new tag into the DICOM dictionary.
Definition OrthancCPlugin.h:5490
OrthancPluginResourceType
Definition OrthancCPlugin.h:814
void OrthancPluginSetRootUri2(OrthancPluginContext *context, const char *plugin, const char *uri)
Set the URI where the plugin provides its Web interface.
Definition OrthancCPlugin.h:3920
void OrthancPluginSetMetricsIntegerValue(OrthancPluginContext *context, const char *name, int64_t value, OrthancPluginMetricsType type)
Set the value of an integer metrics.
Definition OrthancCPlugin.h:10049
OrthancPluginLogCategory
Definition OrthancCPlugin.h:1202
OrthancPluginErrorCode OrthancPluginAcknowledgeQueueValue(OrthancPluginContext *context, const char *queueId, uint64_t valueId)
Acknowledge that a queue value has been properly consumed by the plugin and can be permanently remove...
Definition OrthancCPlugin.h:11024
OrthancPluginErrorCode OrthancPluginWriteFile(OrthancPluginContext *context, const char *path, const void *data, uint32_t size)
Write a file.
Definition OrthancCPlugin.h:4406
const char * OrthancPluginKeysValuesIteratorGetKey(OrthancPluginContext *context, OrthancPluginKeysValuesIterator *iterator)
Get the current key of an iterator over a key-value store.
Definition OrthancCPlugin.h:10557
uint32_t OrthancPluginGetCommandLineArgumentsCount(OrthancPluginContext *context)
Get the number of command-line arguments.
Definition OrthancCPlugin.h:4127
OrthancPluginErrorCode OrthancPluginKeysValuesIteratorNext(OrthancPluginContext *context, uint8_t *done, OrthancPluginKeysValuesIterator *iterator)
Read the next element of an iterator over a key-value store.
Definition OrthancCPlugin.h:10527
char * OrthancPluginComputeMd5(OrthancPluginContext *context, const void *buffer, uint32_t size)
Compute an MD5 hash.
Definition OrthancCPlugin.h:6219
OrthancPluginErrorCode
Definition OrthancCPlugin.h:240
struct _OrthancPluginPeers_t OrthancPluginPeers
Opaque structure to the set of remote Orthanc Peers that are known to the local Orthanc server.
Definition OrthancCPlugin.h:1392
OrthancPluginErrorCode OrthancPluginHttpPost(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *url, const void *body, uint32_t bodySize, const char *username, const char *password)
Issue a HTTP POST call.
Definition OrthancCPlugin.h:4974
uint32_t(* OrthancPluginChunkedClientRequestGetChunkSize)(void *request)
Callback to read the size of the current request chunk during a chunked transfer.
Definition OrthancCPlugin.h:8050
OrthancPluginErrorCode OrthancPluginRegisterErrorCode(OrthancPluginContext *context, int32_t code, uint16_t httpStatus, const char *message)
Declare a custom error code for this plugin.
Definition OrthancCPlugin.h:5434
OrthancPluginErrorCode OrthancPluginCreateMemoryBuffer(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, uint32_t size)
Create a 32-bit memory buffer.
Definition OrthancCPlugin.h:9298
OrthancPluginJob * OrthancPluginCreateJob2(OrthancPluginContext *context, void *job, OrthancPluginJobFinalize finalize, const char *type, OrthancPluginJobGetProgress getProgress, OrthancPluginJobGetContent2 getContent, OrthancPluginJobGetSerialized2 getSerialized, OrthancPluginJobStep step, OrthancPluginJobStop stop, OrthancPluginJobReset reset)
Create a custom job.
Definition OrthancCPlugin.h:7454
OrthancPluginErrorCode(* OrthancPluginServerChunkedRequestReaderFactory)(OrthancPluginServerChunkedRequestReader **reader, const char *uri, const OrthancPluginHttpRequest *request)
Callback to create a reader to handle incoming chunked HTTP transfers.
Definition OrthancCPlugin.h:8211
OrthancPluginDicomWebBinaryMode
Definition OrthancCPlugin.h:1079
OrthancPluginErrorCode OrthancPluginClearCurrentThreadName(OrthancPluginContext *context)
Clear the name of the current thread.
Definition OrthancCPlugin.h:11292
OrthancPluginErrorCode(* OrthancPluginJobGetContent2)(OrthancPluginMemoryBuffer *target, void *job)
Callback to retrieve the content of one custom job.
Definition OrthancCPlugin.h:2019
OrthancPluginErrorCode(* OrthancPluginChunkedClientRequestNext)(void *request)
Callback to advance in the request body during a chunked transfer.
Definition OrthancCPlugin.h:8018
OrthancPluginHttpAuthenticationStatus
Definition OrthancCPlugin.h:1258
struct _OrthancPluginDicomWebNode_t OrthancPluginDicomWebNode
Opaque structure that represents a node in a JSON or XML document used in DICOMweb.
Definition OrthancCPlugin.h:1411
OrthancPluginErrorCode OrthancPluginGetKeyValue(OrthancPluginContext *context, uint8_t *found, OrthancPluginMemoryBuffer *target, const char *storeId, const char *key)
Get the value associated with a key in the Orthanc key-value store.
Definition OrthancCPlugin.h:10422
float(* OrthancPluginJobGetProgress)(void *job)
Callback to check the progress of one custom job.
Definition OrthancCPlugin.h:1985
char * OrthancPluginEncodeDicomWebJson(OrthancPluginContext *context, const void *dicom, uint32_t dicomSize, OrthancPluginDicomWebBinaryCallback callback)
Convert a DICOM instance to DICOMweb JSON.
Definition OrthancCPlugin.h:7775
OrthancPluginFindMatcher * OrthancPluginCreateFindMatcher(OrthancPluginContext *context, const void *query, uint32_t size)
Create a C-Find matcher.
Definition OrthancCPlugin.h:6849
OrthancPluginDicomToJsonFlags
Definition OrthancCPlugin.h:953
OrthancPluginJobStepStatus
Definition OrthancCPlugin.h:1035
OrthancPluginCreateDicomFlags
Definition OrthancCPlugin.h:974
void(* OrthancPluginServerChunkedRequestReaderFinalize)(OrthancPluginServerChunkedRequestReader *reader)
Callback invoked to release the resources associated with an incoming HTTP chunked transfer.
Definition OrthancCPlugin.h:8268
int32_t OrthancPluginFindMatcherIsMatch(OrthancPluginContext *context, const OrthancPluginFindMatcher *matcher, const void *dicom, uint32_t size)
Test whether a DICOM instance matches a C-Find query.
Definition OrthancCPlugin.h:6922
void OrthancPluginExtendOrthancExplorer(OrthancPluginContext *context, const char *javascript)
Extend the JavaScript code of Orthanc Explorer.
Definition OrthancCPlugin.h:3998
void OrthancPluginLogWarning(OrthancPluginContext *context, const char *message)
Log a warning.
Definition OrthancCPlugin.h:2482
OrthancPluginQueueOrigin
Definition OrthancCPlugin.h:1234
OrthancPluginErrorCode OrthancPluginDequeueValue(OrthancPluginContext *context, uint8_t *found, OrthancPluginMemoryBuffer *target, const char *queueId, OrthancPluginQueueOrigin origin)
Dequeue a value from a queue.
Definition OrthancCPlugin.h:10664
const char * OrthancPluginGetPeerName(OrthancPluginContext *context, const OrthancPluginPeers *peers, uint32_t peerIndex)
Get the symbolic name of an Orthanc peer.
Definition OrthancCPlugin.h:7109
OrthancPluginPeers * OrthancPluginGetPeers(OrthancPluginContext *context)
Return the list of available Orthanc peers.
Definition OrthancCPlugin.h:6994
OrthancPluginConstraintType
Definition OrthancCPlugin.h:1004
char * OrthancPluginGetOrthancDirectory(OrthancPluginContext *context)
Return the directory containing the Orthanc.
Definition OrthancCPlugin.h:3778
OrthancPluginErrorCode OrthancPluginReadFile(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *path)
Read a file.
Definition OrthancCPlugin.h:4375
OrthancPluginJobStepStatus(* OrthancPluginJobStep)(void *job)
Callback to execute one step of a custom job.
Definition OrthancCPlugin.h:2075
char * OrthancPluginComputeSha1(OrthancPluginContext *context, const void *buffer, uint32_t size)
Compute a SHA-1 hash.
Definition OrthancCPlugin.h:6255
char * OrthancPluginGetCommandLineArgument(OrthancPluginContext *context, uint32_t argument)
Get the value of a command-line argument.
Definition OrthancCPlugin.h:4161
void OrthancPluginSetMetricsValue(OrthancPluginContext *context, const char *name, float value, OrthancPluginMetricsType type)
Set the value of a floating-point metrics.
Definition OrthancCPlugin.h:7706
OrthancPluginErrorCode(* OrthancPluginServerChunkedRequestReaderAddChunk)(OrthancPluginServerChunkedRequestReader *reader, const void *data, uint32_t size)
Callback invoked whenever a new data chunk is available during a chunked transfer.
Definition OrthancCPlugin.h:8230
OrthancPluginReceivedInstanceAction
Definition OrthancCPlugin.h:1141
OrthancPluginErrorCode OrthancPluginChunkedHttpClient(OrthancPluginContext *context, void *answer, OrthancPluginChunkedClientAnswerAddChunk answerAddChunk, OrthancPluginChunkedClientAnswerAddHeader answerAddHeader, uint16_t *httpStatus, OrthancPluginHttpMethod method, const char *url, uint32_t headersCount, const char *const *headersKeys, const char *const *headersValues, void *request, OrthancPluginChunkedClientRequestIsDone requestIsDone, OrthancPluginChunkedClientRequestGetChunkData requestChunkData, OrthancPluginChunkedClientRequestGetChunkSize requestChunkSize, OrthancPluginChunkedClientRequestNext requestNext, const char *username, const char *password, uint32_t timeout, const char *certificateFile, const char *certificateKeyFile, const char *certificateKeyPassword, uint8_t pkcs11)
Issue a HTTP call, using chunked HTTP transfers.
Definition OrthancCPlugin.h:8130
int32_t(* OrthancPluginJobGetSerialized2)(OrthancPluginMemoryBuffer *target, void *job)
Callback to serialize one custom job.
Definition OrthancCPlugin.h:2059
void OrthancPluginFreeMemoryBuffer64(OrthancPluginContext *context, OrthancPluginMemoryBuffer64 *buffer)
Free a memory buffer.
Definition OrthancCPlugin.h:2450
OrthancPluginErrorCode OrthancPluginHttpPut(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *url, const void *body, uint32_t bodySize, const char *username, const char *password)
Issue a HTTP PUT call.
Definition OrthancCPlugin.h:5016
OrthancPluginErrorCode OrthancPluginStoreKeyValue(OrthancPluginContext *context, const char *storeId, const char *key, const void *value, uint32_t valueSize)
Store a key-value pair in the Orthanc database.
Definition OrthancCPlugin.h:10357
char * OrthancPluginDicomBufferToJson(OrthancPluginContext *context, const void *buffer, uint32_t size, OrthancPluginDicomToJsonFormat format, OrthancPluginDicomToJsonFlags flags, uint32_t maxStringLength)
Format a DICOM memory buffer as a JSON string.
Definition OrthancCPlugin.h:5632
OrthancPluginErrorCode OrthancPluginSetStableStatus(OrthancPluginContext *context, uint8_t *statusHasChanged, const char *resourceId, OrthancPluginStableStatus stableStatus)
Change the "Stable" status of a resource.
Definition OrthancCPlugin.h:10737
OrthancPluginErrorCode OrthancPluginCreateDicom(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *json, const OrthancPluginImage *pixelData, OrthancPluginCreateDicomFlags flags)
Create a DICOM instance from a JSON string and an image.
Definition OrthancCPlugin.h:6010
char * OrthancPluginDicomInstanceToJson(OrthancPluginContext *context, const char *instanceId, OrthancPluginDicomToJsonFormat format, OrthancPluginDicomToJsonFlags flags, uint32_t maxStringLength)
Format a DICOM instance as a JSON string.
Definition OrthancCPlugin.h:5681
void OrthancPluginFreeKeysValuesIterator(OrthancPluginContext *context, OrthancPluginKeysValuesIterator *iterator)
Free an iterator over a key-value store.
Definition OrthancCPlugin.h:10499
void OrthancPluginFreeJob(OrthancPluginContext *context, OrthancPluginJob *job)
Free a custom job.
Definition OrthancCPlugin.h:7510
const char * OrthancPluginGetDatabaseServerIdentifier(OrthancPluginContext *context)
Gets the DatabaseServerIdentifier.
Definition OrthancCPlugin.h:9863
char * OrthancPluginGenerateUuid(OrthancPluginContext *context)
Generate an UUID.
Definition OrthancCPlugin.h:6516
OrthancPluginStorageCommitmentFailureReason
Definition OrthancCPlugin.h:1093
OrthancPluginErrorCode(* OrthancPluginChunkedClientAnswerAddChunk)(void *answer, const void *data, uint32_t size)
Callback executed when an answer chunk is received during a chunked transfer.
Definition OrthancCPlugin.h:7981
const char * OrthancPluginGetPeerUserProperty(OrthancPluginContext *context, const OrthancPluginPeers *peers, uint32_t peerIndex, const char *userProperty)
Get some user-defined property of an Orthanc peer.
Definition OrthancCPlugin.h:7198
OrthancPluginMetricsType
Definition OrthancCPlugin.h:1061
OrthancPluginErrorCode OrthancPluginReserveQueueValue(OrthancPluginContext *context, uint8_t *found, OrthancPluginMemoryBuffer *target, uint64_t *valueId, const char *queueId, OrthancPluginQueueOrigin origin, uint32_t releaseTimeout)
Reserve a value from a queue, which means that the message is not available to other consumers....
Definition OrthancCPlugin.h:10988
const char * OrthancPluginAutodetectMimeType(OrthancPluginContext *context, const char *path)
Detect the MIME type of a file.
Definition OrthancCPlugin.h:7659
OrthancPluginErrorCode OrthancPluginSetAttachmentCustomData(OrthancPluginContext *context, const char *attachmentUuid, const void *customData, uint32_t customDataSize)
Update the custom data associated with an attachment in the Orthanc database.
Definition OrthancCPlugin.h:10323
OrthancPluginErrorCode OrthancPluginHttpDelete(OrthancPluginContext *context, const char *url, const char *username, const char *password)
Issue a HTTP DELETE call.
Definition OrthancCPlugin.h:5054
uint8_t(* OrthancPluginChunkedClientRequestIsDone)(void *request)
Callback to know whether the request body is entirely read during a chunked transfer.
Definition OrthancCPlugin.h:8001
const void *(* OrthancPluginChunkedClientRequestGetChunkData)(void *request)
Callback to read the current chunk of the request body during a chunked transfer.
Definition OrthancCPlugin.h:8034
OrthancPluginErrorCode OrthancPluginAdoptDicomInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *instanceId, OrthancPluginMemoryBuffer *attachmentUuid, OrthancPluginStoreStatus *storeStatus, const void *dicom, uint64_t dicomSize, const void *customData, uint32_t customDataSize)
Adopt a DICOM instance read from the filesystem.
Definition OrthancCPlugin.h:10248
OrthancPluginJob * OrthancPluginCreateJob(OrthancPluginContext *context, void *job, OrthancPluginJobFinalize finalize, const char *type, OrthancPluginJobGetProgress getProgress, OrthancPluginJobGetContent getContent, OrthancPluginJobGetSerialized getSerialized, OrthancPluginJobStep step, OrthancPluginJobStop stop, OrthancPluginJobReset reset)
Create a custom job.
Definition OrthancCPlugin.h:7367
void OrthancPluginFreeMemoryBuffer(OrthancPluginContext *context, OrthancPluginMemoryBuffer *buffer)
Free a memory buffer.
Definition OrthancCPlugin.h:2433
OrthancPluginErrorCode OrthancPluginEnqueueValue(OrthancPluginContext *context, const char *queueId, const void *value, uint32_t valueSize)
Append a value to the back of a queue.
Definition OrthancCPlugin.h:10627
char * OrthancPluginEncodeDicomWebXml(OrthancPluginContext *context, const void *dicom, uint32_t dicomSize, OrthancPluginDicomWebBinaryCallback callback)
Convert a DICOM instance to DICOMweb XML.
Definition OrthancCPlugin.h:7818
const char *(* OrthancPluginJobGetSerialized)(void *job)
Callback to serialize one custom job.
Definition OrthancCPlugin.h:2039
char * OrthancPluginGetConfiguration(OrthancPluginContext *context)
Return the content of the configuration file(s).
Definition OrthancCPlugin.h:4226
OrthancPluginKeysValuesIterator * OrthancPluginCreateKeysValuesIterator(OrthancPluginContext *context, const char *storeId)
Create an iterator over the key-value pairs of a key-value store in the Orthanc database.
Definition OrthancCPlugin.h:10466
OrthancPluginErrorCode OrthancPluginCreateMemoryBuffer64(OrthancPluginContext *context, OrthancPluginMemoryBuffer64 *target, uint64_t size)
Create a 64-bit memory buffer.
Definition OrthancCPlugin.h:9384
OrthancPluginLoadDicomInstanceMode
Definition OrthancCPlugin.h:1155
OrthancPluginStoreStatus
Definition OrthancCPlugin.h:1219
OrthancPluginErrorCode(* OrthancPluginChunkedClientAnswerAddHeader)(void *answer, const char *key, const char *value)
Callback executed when a HTTP header is received during a chunked transfer.
Definition OrthancCPlugin.h:7960
uint32_t OrthancPluginGetPeersCount(OrthancPluginContext *context, const OrthancPluginPeers *peers)
Get the number of Orthanc peers.
Definition OrthancCPlugin.h:7060
const char *(* OrthancPluginJobGetContent)(void *job)
Callback to retrieve the content of one custom job.
Definition OrthancCPlugin.h:2001
OrthancPluginValueRepresentation
Definition OrthancCPlugin.h:892
void OrthancPluginEmitAuditLog(OrthancPluginContext *context, const char *sourcePlugin, const char *userId, OrthancPluginResourceType resourceType, const char *resourceId, const char *action, const void *logData, uint32_t logDataSize)
Generate an audit log to signal security-related events.
Definition OrthancCPlugin.h:10879
char * OrthancPluginSubmitJob(OrthancPluginContext *context, OrthancPluginJob *job, int32_t priority)
Submit a new job to the jobs engine of Orthanc.
Definition OrthancCPlugin.h:7543
OrthancPluginErrorCode OrthancPluginKeysValuesIteratorGetValue(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginKeysValuesIterator *iterator)
Get the current value of an iterator over a key-value store.
Definition OrthancCPlugin.h:10597
OrthancPluginErrorCode OrthancPluginHttpGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *url, const char *username, const char *password)
Issue a HTTP GET call.
Definition OrthancCPlugin.h:4936
OrthancPluginJobStopReason
Definition OrthancCPlugin.h:1049
OrthancPluginErrorCode OrthancPluginDeleteKeyValue(OrthancPluginContext *context, const char *storeId, const char *key)
Delete a key-value pair from the Orthanc database.
Definition OrthancCPlugin.h:10389
char * OrthancPluginGetOrthancPath(OrthancPluginContext *context)
Return the path to the Orthanc executable.
Definition OrthancCPlugin.h:3748
OrthancPluginDicomToJsonFormat
Definition OrthancCPlugin.h:938
void OrthancPluginSetDescription2(OrthancPluginContext *context, const char *plugin, const char *description)
Set a description for this plugin.
Definition OrthancCPlugin.h:3971
OrthancPluginErrorCode OrthancPluginGetAttachmentCustomData(OrthancPluginContext *context, OrthancPluginMemoryBuffer *customData, const char *attachmentUuid)
Retrieve the custom data associated with an attachment in the Orthanc database.
Definition OrthancCPlugin.h:10290
void OrthancPluginLogError(OrthancPluginContext *context, const char *message)
Log an error.
Definition OrthancCPlugin.h:2466
char * OrthancPluginGetConfigurationPath(OrthancPluginContext *context)
Return the path to the configuration file(s).
Definition OrthancCPlugin.h:3813
OrthancPluginHttpMethod
Definition OrthancCPlugin.h:369
void OrthancPluginSetRootUri(OrthancPluginContext *context, const char *uri)
Set the URI where the plugin provides its Web interface.
Definition OrthancCPlugin.h:3894
char * OrthancPluginEncodeDicomWebXml2(OrthancPluginContext *context, const void *dicom, uint32_t dicomSize, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb XML.
Definition OrthancCPlugin.h:7916
OrthancPluginErrorCode OrthancPluginCallPeerApi(OrthancPluginContext *context, OrthancPluginMemoryBuffer *answerBody, OrthancPluginMemoryBuffer *answerHeaders, uint16_t *httpStatus, const OrthancPluginPeers *peers, uint32_t peerIndex, OrthancPluginHttpMethod method, const char *uri, uint32_t additionalHeadersCount, const char *const *additionalHeadersKeys, const char *const *additionalHeadersValues, const void *body, uint32_t bodySize, uint32_t timeout)
Call the REST API of an Orthanc peer.
Definition OrthancCPlugin.h:7280
struct _OrthancPluginFindMatcher_t OrthancPluginFindMatcher
Opaque structure to an object that can be used to check whether a DICOM instance matches a C-Find que...
Definition OrthancCPlugin.h:1383
char * OrthancPluginEncodeDicomWebJson2(OrthancPluginContext *context, const void *dicom, uint32_t dicomSize, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb JSON.
Definition OrthancCPlugin.h:7871
OrthancPluginErrorCode OrthancPluginLookupDictionary(OrthancPluginContext *context, OrthancPluginDictionaryEntry *target, const char *name)
Get information about the given DICOM tag.
Definition OrthancCPlugin.h:6301
OrthancPluginErrorCode OrthancPluginGetQueueSize(OrthancPluginContext *context, const char *queueId, uint64_t *size)
Get the number of elements that are currently stored in a queue.
Definition OrthancCPlugin.h:10696
OrthancPluginInstanceOrigin
Definition OrthancCPlugin.h:1019
void(* OrthancPluginJobFinalize)(void *job)
Callback to finalize one custom job.
Definition OrthancCPlugin.h:1972
void OrthancPluginFreeString(OrthancPluginContext *context, char *str)
Free a string.
Definition OrthancCPlugin.h:2268
OrthancPluginErrorCode OrthancPluginSetCurrentThreadName(OrthancPluginContext *context, const char *threadName)
Set the name of the current thread.
Definition OrthancCPlugin.h:10082
OrthancPluginErrorCode(* OrthancPluginJobReset)(void *job)
Callback executed once one stopped custom job is started again.
Definition OrthancCPlugin.h:2116
const char * OrthancPluginGetErrorDescription(OrthancPluginContext *context, OrthancPluginErrorCode error)
Get the description of a given error code.
Definition OrthancCPlugin.h:4437
struct _OrthancPluginContext_t OrthancPluginContext
Data structure that contains information about the Orthanc core.
OrthancPluginContentType
Definition OrthancCPlugin.h:799
const char * OrthancPluginGetPeerUrl(OrthancPluginContext *context, const OrthancPluginPeers *peers, uint32_t peerIndex)
Get the base URL of an Orthanc peer.
Definition OrthancCPlugin.h:7151
void OrthancPluginSetDescription(OrthancPluginContext *context, const char *description)
Set a description for this plugin.
Definition OrthancCPlugin.h:3947
OrthancPluginStableStatus
Definition OrthancCPlugin.h:1246
char * OrthancPluginGetTagName(OrthancPluginContext *context, uint16_t group, uint16_t element, const char *privateCreator)
Returns the symbolic name of a DICOM tag.
Definition OrthancCPlugin.h:8366
@ OrthancPluginLogLevel_Warning
Definition OrthancCPlugin.h:1187
@ OrthancPluginLogLevel_Trace
Definition OrthancCPlugin.h:1189
@ OrthancPluginLogLevel_Error
Definition OrthancCPlugin.h:1186
@ OrthancPluginLogLevel_Info
Definition OrthancCPlugin.h:1188
@ OrthancPluginIdentifierConstraint_Wildcard
Definition OrthancCPlugin.h:993
@ OrthancPluginIdentifierConstraint_Equal
Definition OrthancCPlugin.h:990
@ OrthancPluginIdentifierConstraint_SmallerOrEqual
Definition OrthancCPlugin.h:991
@ OrthancPluginIdentifierConstraint_GreaterOrEqual
Definition OrthancCPlugin.h:992
@ OrthancPluginResourceType_Instance
Definition OrthancCPlugin.h:818
@ OrthancPluginResourceType_None
Definition OrthancCPlugin.h:819
@ OrthancPluginResourceType_Series
Definition OrthancCPlugin.h:817
@ OrthancPluginResourceType_Study
Definition OrthancCPlugin.h:816
@ OrthancPluginResourceType_Patient
Definition OrthancCPlugin.h:815
@ OrthancPluginLogCategory_Dicom
Definition OrthancCPlugin.h:1207
@ OrthancPluginLogCategory_Jobs
Definition OrthancCPlugin.h:1208
@ OrthancPluginLogCategory_Sqlite
Definition OrthancCPlugin.h:1206
@ OrthancPluginLogCategory_Plugins
Definition OrthancCPlugin.h:1204
@ OrthancPluginLogCategory_Generic
Definition OrthancCPlugin.h:1203
@ OrthancPluginLogCategory_Lua
Definition OrthancCPlugin.h:1209
@ OrthancPluginLogCategory_Http
Definition OrthancCPlugin.h:1205
@ OrthancPluginErrorCode_CreateDicomBadParent
Definition OrthancCPlugin.h:330
@ OrthancPluginErrorCode_MainDicomTagsMultiplyDefined
Definition OrthancCPlugin.h:286
@ OrthancPluginErrorCode_SQLiteFlush
Definition OrthancCPlugin.h:298
@ OrthancPluginErrorCode_IncompatibleDatabaseVersion
Definition OrthancCPlugin.h:260
@ OrthancPluginErrorCode_BadSequenceOfCalls
Definition OrthancCPlugin.h:248
@ OrthancPluginErrorCode_SharedLibrary
Definition OrthancCPlugin.h:267
@ OrthancPluginErrorCode_NullPointer
Definition OrthancCPlugin.h:277
@ OrthancPluginErrorCode_NotLuaPredicate
Definition OrthancCPlugin.h:340
@ OrthancPluginErrorCode_LuaAlreadyExecuted
Definition OrthancCPlugin.h:338
@ OrthancPluginErrorCode_NotAcceptable
Definition OrthancCPlugin.h:276
@ OrthancPluginErrorCode_FullStorage
Definition OrthancCPlugin.h:261
@ OrthancPluginErrorCode_DatabaseBackendAlreadyRegistered
Definition OrthancCPlugin.h:343
@ OrthancPluginErrorCode_InexistentFile
Definition OrthancCPlugin.h:255
@ OrthancPluginErrorCode_CreateDicomParentEncoding
Definition OrthancCPlugin.h:332
@ OrthancPluginErrorCode_CannotOrderSlices
Definition OrthancCPlugin.h:346
@ OrthancPluginErrorCode_InternalError
Definition OrthancCPlugin.h:241
@ OrthancPluginErrorCode_DiscontinuedAbi
Definition OrthancCPlugin.h:282
@ OrthancPluginErrorCode_NoCFindHandler
Definition OrthancCPlugin.h:316
@ OrthancPluginErrorCode_SQLiteCommitWithoutTransaction
Definition OrthancCPlugin.h:296
@ OrthancPluginErrorCode_DatabasePlugin
Definition OrthancCPlugin.h:273
@ OrthancPluginErrorCode_SQLiteStatementAlreadyUsed
Definition OrthancCPlugin.h:293
@ OrthancPluginErrorCode_SQLiteCannotRun
Definition OrthancCPlugin.h:299
@ OrthancPluginErrorCode_UnknownPluginService
Definition OrthancCPlugin.h:268
@ OrthancPluginErrorCode_JsonToLuaTable
Definition OrthancCPlugin.h:335
@ OrthancPluginErrorCode_CreateDicomOverrideTag
Definition OrthancCPlugin.h:326
@ OrthancPluginErrorCode_SQLiteBindOutOfRange
Definition OrthancCPlugin.h:301
@ OrthancPluginErrorCode_ParameterOutOfRange
Definition OrthancCPlugin.h:245
@ OrthancPluginErrorCode_SQLiteRegisterFunction
Definition OrthancCPlugin.h:297
@ OrthancPluginErrorCode_SQLiteTransactionBegin
Definition OrthancCPlugin.h:305
@ OrthancPluginErrorCode_CreateDicomNoPayload
Definition OrthancCPlugin.h:328
@ OrthancPluginErrorCode_Unauthorized
Definition OrthancCPlugin.h:271
@ OrthancPluginErrorCode_RegularFileExpected
Definition OrthancCPlugin.h:312
@ OrthancPluginErrorCode_DicomPortInUse
Definition OrthancCPlugin.h:310
@ OrthancPluginErrorCode_BadApplicationEntityTitle
Definition OrthancCPlugin.h:315
@ OrthancPluginErrorCode_NoCStoreHandler
Definition OrthancCPlugin.h:318
@ OrthancPluginErrorCode_PathToExecutable
Definition OrthancCPlugin.h:313
@ OrthancPluginErrorCode_NoSopClassOrInstance
Definition OrthancCPlugin.h:320
@ OrthancPluginErrorCode_BadFont
Definition OrthancCPlugin.h:272
@ OrthancPluginErrorCode_DicomGetUnavailable
Definition OrthancCPlugin.h:351
@ OrthancPluginErrorCode_DatabaseUnavailable
Definition OrthancCPlugin.h:278
@ OrthancPluginErrorCode_CannotCreateLua
Definition OrthancCPlugin.h:336
@ OrthancPluginErrorCode_SQLiteExecute
Definition OrthancCPlugin.h:294
@ OrthancPluginErrorCode_UriSyntax
Definition OrthancCPlugin.h:254
@ OrthancPluginErrorCode_DirectoryOverFile
Definition OrthancCPlugin.h:306
@ OrthancPluginErrorCode_Revision
Definition OrthancCPlugin.h:285
@ OrthancPluginErrorCode_InexistentTag
Definition OrthancCPlugin.h:263
@ OrthancPluginErrorCode_IncompatibleImageFormat
Definition OrthancCPlugin.h:265
@ OrthancPluginErrorCode_UnsupportedMediaType
Definition OrthancCPlugin.h:352
@ OrthancPluginErrorCode_DicomFindUnavailable
Definition OrthancCPlugin.h:322
@ OrthancPluginErrorCode_SQLiteCannotStep
Definition OrthancCPlugin.h:300
@ OrthancPluginErrorCode_CreateDicomParentIsInstance
Definition OrthancCPlugin.h:331
@ OrthancPluginErrorCode_DuplicateResource
Definition OrthancCPlugin.h:288
@ OrthancPluginErrorCode_StorageAreaAlreadyRegistered
Definition OrthancCPlugin.h:342
@ OrthancPluginErrorCode_LuaReturnsNoString
Definition OrthancCPlugin.h:341
@ OrthancPluginErrorCode_UnknownResource
Definition OrthancCPlugin.h:259
@ OrthancPluginErrorCode_CreateDicomNotString
Definition OrthancCPlugin.h:325
@ OrthancPluginErrorCode_HttpPortInUse
Definition OrthancCPlugin.h:309
@ OrthancPluginErrorCode_SslDisabled
Definition OrthancCPlugin.h:345
@ OrthancPluginErrorCode_UnknownModality
Definition OrthancCPlugin.h:333
@ OrthancPluginErrorCode_BadHttpStatusInRest
Definition OrthancCPlugin.h:311
@ OrthancPluginErrorCode_BadGeometry
Definition OrthancCPlugin.h:280
@ OrthancPluginErrorCode_AlreadyExistingTag
Definition OrthancCPlugin.h:348
@ OrthancPluginErrorCode_FileStorageCannotWrite
Definition OrthancCPlugin.h:307
@ OrthancPluginErrorCode_CreateDicomUseDataUriScheme
Definition OrthancCPlugin.h:329
@ OrthancPluginErrorCode_DirectoryExpected
Definition OrthancCPlugin.h:308
@ OrthancPluginErrorCode_NoCMoveHandler
Definition OrthancCPlugin.h:317
@ OrthancPluginErrorCode_SQLitePrepareStatement
Definition OrthancCPlugin.h:302
@ OrthancPluginErrorCode_CorruptedFile
Definition OrthancCPlugin.h:262
@ OrthancPluginErrorCode_StorageAreaPlugin
Definition OrthancCPlugin.h:274
@ OrthancPluginErrorCode_BadJobOrdering
Definition OrthancCPlugin.h:334
@ OrthancPluginErrorCode_IncompatibleConfigurations
Definition OrthancCPlugin.h:289
@ OrthancPluginErrorCode_DatabaseCannotSerialize
Definition OrthancCPlugin.h:284
@ OrthancPluginErrorCode_CanceledJob
Definition OrthancCPlugin.h:279
@ OrthancPluginErrorCode_BadRange
Definition OrthancCPlugin.h:283
@ OrthancPluginErrorCode_NotImplemented
Definition OrthancCPlugin.h:244
@ OrthancPluginErrorCode_SslInitialization
Definition OrthancCPlugin.h:281
@ OrthancPluginErrorCode_IncompatibleImageSize
Definition OrthancCPlugin.h:266
@ OrthancPluginErrorCode_BadFileFormat
Definition OrthancCPlugin.h:257
@ OrthancPluginErrorCode_BadRequest
Definition OrthancCPlugin.h:250
@ OrthancPluginErrorCode_SystemCommand
Definition OrthancCPlugin.h:252
@ OrthancPluginErrorCode_NoStorageCommitmentHandler
Definition OrthancCPlugin.h:349
@ OrthancPluginErrorCode_SQLiteAlreadyOpened
Definition OrthancCPlugin.h:291
@ OrthancPluginErrorCode_Plugin
Definition OrthancCPlugin.h:243
@ OrthancPluginErrorCode_CannotExecuteLua
Definition OrthancCPlugin.h:337
@ OrthancPluginErrorCode_SQLiteRollbackWithoutTransaction
Definition OrthancCPlugin.h:295
@ OrthancPluginErrorCode_UnknownDicomTag
Definition OrthancCPlugin.h:269
@ OrthancPluginErrorCode_ForbiddenAccess
Definition OrthancCPlugin.h:287
@ OrthancPluginErrorCode_NoPresentationContext
Definition OrthancCPlugin.h:321
@ OrthancPluginErrorCode_EmptyRequest
Definition OrthancCPlugin.h:275
@ OrthancPluginErrorCode_DatabaseNotInitialized
Definition OrthancCPlugin.h:344
@ OrthancPluginErrorCode_DicomMoveUnavailable
Definition OrthancCPlugin.h:323
@ OrthancPluginErrorCode_SQLiteTransactionCommit
Definition OrthancCPlugin.h:304
@ OrthancPluginErrorCode_BadJson
Definition OrthancCPlugin.h:270
@ OrthancPluginErrorCode_Success
Definition OrthancCPlugin.h:242
@ OrthancPluginErrorCode_NetworkProtocol
Definition OrthancCPlugin.h:251
@ OrthancPluginErrorCode_NoApplicationEntityFilter
Definition OrthancCPlugin.h:319
@ OrthancPluginErrorCode_InexistentItem
Definition OrthancCPlugin.h:249
@ OrthancPluginErrorCode_Timeout
Definition OrthancCPlugin.h:258
@ OrthancPluginErrorCode_LuaBadOutput
Definition OrthancCPlugin.h:339
@ OrthancPluginErrorCode_SQLiteTransactionAlreadyStarted
Definition OrthancCPlugin.h:303
@ OrthancPluginErrorCode_NoCGetHandler
Definition OrthancCPlugin.h:350
@ OrthancPluginErrorCode_SQLiteNotOpened
Definition OrthancCPlugin.h:290
@ OrthancPluginErrorCode_ReadOnly
Definition OrthancCPlugin.h:264
@ OrthancPluginErrorCode_CannotStoreInstance
Definition OrthancCPlugin.h:324
@ OrthancPluginErrorCode_CannotWriteFile
Definition OrthancCPlugin.h:256
@ OrthancPluginErrorCode_BadParameterType
Definition OrthancCPlugin.h:247
@ OrthancPluginErrorCode_NotEnoughMemory
Definition OrthancCPlugin.h:246
@ OrthancPluginErrorCode_CreateDicomUseContent
Definition OrthancCPlugin.h:327
@ OrthancPluginErrorCode_Database
Definition OrthancCPlugin.h:253
@ OrthancPluginErrorCode_SQLiteCannotOpen
Definition OrthancCPlugin.h:292
@ OrthancPluginErrorCode_MakeDirectory
Definition OrthancCPlugin.h:314
@ OrthancPluginErrorCode_NoWorklistHandler
Definition OrthancCPlugin.h:347
@ OrthancPluginDicomWebBinaryMode_InlineBinary
Definition OrthancCPlugin.h:1081
@ OrthancPluginDicomWebBinaryMode_BulkDataUri
Definition OrthancCPlugin.h:1082
@ OrthancPluginDicomWebBinaryMode_ArrayOfValues
Definition OrthancCPlugin.h:1083
@ OrthancPluginDicomWebBinaryMode_Ignore
Definition OrthancCPlugin.h:1080
@ OrthancPluginHttpAuthenticationStatus_Forbidden
Definition OrthancCPlugin.h:1261
@ OrthancPluginHttpAuthenticationStatus_Redirect
Definition OrthancCPlugin.h:1262
@ OrthancPluginHttpAuthenticationStatus_Unauthorized
Definition OrthancCPlugin.h:1260
@ OrthancPluginHttpAuthenticationStatus_Granted
Definition OrthancCPlugin.h:1259
@ OrthancPluginDicomToJsonFlags_ConvertBinaryToAscii
Definition OrthancCPlugin.h:959
@ OrthancPluginDicomToJsonFlags_IncludeBinary
Definition OrthancCPlugin.h:955
@ OrthancPluginDicomToJsonFlags_IncludePixelData
Definition OrthancCPlugin.h:958
@ OrthancPluginDicomToJsonFlags_IncludeUnknownTags
Definition OrthancCPlugin.h:957
@ OrthancPluginDicomToJsonFlags_SkipGroupLengths
Definition OrthancCPlugin.h:962
@ OrthancPluginDicomToJsonFlags_None
Definition OrthancCPlugin.h:954
@ OrthancPluginDicomToJsonFlags_ConvertBinaryToNull
Definition OrthancCPlugin.h:960
@ OrthancPluginDicomToJsonFlags_StopAfterPixelData
Definition OrthancCPlugin.h:961
@ OrthancPluginDicomToJsonFlags_IncludePrivateTags
Definition OrthancCPlugin.h:956
@ OrthancPluginJobStepStatus_Continue
Definition OrthancCPlugin.h:1038
@ OrthancPluginJobStepStatus_Success
Definition OrthancCPlugin.h:1036
@ OrthancPluginJobStepStatus_Failure
Definition OrthancCPlugin.h:1037
@ OrthancPluginCreateDicomFlags_DecodeDataUriScheme
Definition OrthancCPlugin.h:976
@ OrthancPluginCreateDicomFlags_None
Definition OrthancCPlugin.h:975
@ OrthancPluginCreateDicomFlags_GenerateIdentifiers
Definition OrthancCPlugin.h:977
@ OrthancPluginQueueOrigin_Front
Definition OrthancCPlugin.h:1235
@ OrthancPluginQueueOrigin_Back
Definition OrthancCPlugin.h:1236
@ OrthancPluginConstraintType_SmallerOrEqual
Definition OrthancCPlugin.h:1006
@ OrthancPluginConstraintType_List
Definition OrthancCPlugin.h:1009
@ OrthancPluginConstraintType_GreaterOrEqual
Definition OrthancCPlugin.h:1007
@ OrthancPluginConstraintType_Equal
Definition OrthancCPlugin.h:1005
@ OrthancPluginConstraintType_Wildcard
Definition OrthancCPlugin.h:1008
@ OrthancPluginReceivedInstanceAction_KeepAsIs
Definition OrthancCPlugin.h:1142
@ OrthancPluginReceivedInstanceAction_Discard
Definition OrthancCPlugin.h:1144
@ OrthancPluginReceivedInstanceAction_Modify
Definition OrthancCPlugin.h:1143
@ OrthancPluginStorageCommitmentFailureReason_ReferencedSOPClassNotSupported
Definition OrthancCPlugin.h:1120
@ OrthancPluginStorageCommitmentFailureReason_Success
Definition OrthancCPlugin.h:1097
@ OrthancPluginStorageCommitmentFailureReason_DuplicateTransactionUID
Definition OrthancCPlugin.h:1133
@ OrthancPluginStorageCommitmentFailureReason_ClassInstanceConflict
Definition OrthancCPlugin.h:1127
@ OrthancPluginStorageCommitmentFailureReason_ResourceLimitation
Definition OrthancCPlugin.h:1114
@ OrthancPluginStorageCommitmentFailureReason_NoSuchObjectInstance
Definition OrthancCPlugin.h:1108
@ OrthancPluginStorageCommitmentFailureReason_ProcessingFailure
Definition OrthancCPlugin.h:1102
@ OrthancPluginMetricsType_Default
Definition OrthancCPlugin.h:1062
@ OrthancPluginMetricsType_Timer
Definition OrthancCPlugin.h:1069
@ OrthancPluginLoadDicomInstanceMode_UntilPixelData
Definition OrthancCPlugin.h:1165
@ OrthancPluginLoadDicomInstanceMode_WholeDicom
Definition OrthancCPlugin.h:1159
@ OrthancPluginLoadDicomInstanceMode_EmptyPixelData
Definition OrthancCPlugin.h:1172
@ OrthancPluginStoreStatus_Success
Definition OrthancCPlugin.h:1220
@ OrthancPluginStoreStatus_FilteredOut
Definition OrthancCPlugin.h:1223
@ OrthancPluginStoreStatus_StorageFull
Definition OrthancCPlugin.h:1224
@ OrthancPluginStoreStatus_Failure
Definition OrthancCPlugin.h:1222
@ OrthancPluginStoreStatus_AlreadyStored
Definition OrthancCPlugin.h:1221
@ OrthancPluginValueRepresentation_PN
Definition OrthancCPlugin.h:908
@ OrthancPluginValueRepresentation_UV
Definition OrthancCPlugin.h:926
@ OrthancPluginValueRepresentation_UL
Definition OrthancCPlugin.h:916
@ OrthancPluginValueRepresentation_UN
Definition OrthancCPlugin.h:917
@ OrthancPluginValueRepresentation_UR
Definition OrthancCPlugin.h:923
@ OrthancPluginValueRepresentation_DA
Definition OrthancCPlugin.h:897
@ OrthancPluginValueRepresentation_OF
Definition OrthancCPlugin.h:906
@ OrthancPluginValueRepresentation_OW
Definition OrthancCPlugin.h:907
@ OrthancPluginValueRepresentation_CS
Definition OrthancCPlugin.h:896
@ OrthancPluginValueRepresentation_OV
Definition OrthancCPlugin.h:924
@ OrthancPluginValueRepresentation_US
Definition OrthancCPlugin.h:918
@ OrthancPluginValueRepresentation_SH
Definition OrthancCPlugin.h:909
@ OrthancPluginValueRepresentation_OL
Definition OrthancCPlugin.h:921
@ OrthancPluginValueRepresentation_OD
Definition OrthancCPlugin.h:920
@ OrthancPluginValueRepresentation_FL
Definition OrthancCPlugin.h:901
@ OrthancPluginValueRepresentation_DT
Definition OrthancCPlugin.h:899
@ OrthancPluginValueRepresentation_UC
Definition OrthancCPlugin.h:922
@ OrthancPluginValueRepresentation_TM
Definition OrthancCPlugin.h:914
@ OrthancPluginValueRepresentation_SQ
Definition OrthancCPlugin.h:911
@ OrthancPluginValueRepresentation_DS
Definition OrthancCPlugin.h:898
@ OrthancPluginValueRepresentation_OB
Definition OrthancCPlugin.h:905
@ OrthancPluginValueRepresentation_SV
Definition OrthancCPlugin.h:925
@ OrthancPluginValueRepresentation_SL
Definition OrthancCPlugin.h:910
@ OrthancPluginValueRepresentation_ST
Definition OrthancCPlugin.h:913
@ OrthancPluginValueRepresentation_IS
Definition OrthancCPlugin.h:902
@ OrthancPluginValueRepresentation_LT
Definition OrthancCPlugin.h:904
@ OrthancPluginValueRepresentation_SS
Definition OrthancCPlugin.h:912
@ OrthancPluginValueRepresentation_UT
Definition OrthancCPlugin.h:919
@ OrthancPluginValueRepresentation_LO
Definition OrthancCPlugin.h:903
@ OrthancPluginValueRepresentation_AE
Definition OrthancCPlugin.h:893
@ OrthancPluginValueRepresentation_FD
Definition OrthancCPlugin.h:900
@ OrthancPluginValueRepresentation_UI
Definition OrthancCPlugin.h:915
@ OrthancPluginValueRepresentation_AS
Definition OrthancCPlugin.h:894
@ OrthancPluginValueRepresentation_AT
Definition OrthancCPlugin.h:895
@ OrthancPluginJobStopReason_Failure
Definition OrthancCPlugin.h:1052
@ OrthancPluginJobStopReason_Success
Definition OrthancCPlugin.h:1050
@ OrthancPluginJobStopReason_Canceled
Definition OrthancCPlugin.h:1053
@ OrthancPluginJobStopReason_Paused
Definition OrthancCPlugin.h:1051
@ OrthancPluginDicomToJsonFormat_Full
Definition OrthancCPlugin.h:939
@ OrthancPluginDicomToJsonFormat_Human
Definition OrthancCPlugin.h:941
@ OrthancPluginDicomToJsonFormat_Short
Definition OrthancCPlugin.h:940
@ OrthancPluginHttpMethod_Delete
Definition OrthancCPlugin.h:373
@ OrthancPluginHttpMethod_Post
Definition OrthancCPlugin.h:371
@ OrthancPluginHttpMethod_Put
Definition OrthancCPlugin.h:372
@ OrthancPluginHttpMethod_Get
Definition OrthancCPlugin.h:370
@ OrthancPluginInstanceOrigin_Unknown
Definition OrthancCPlugin.h:1020
@ OrthancPluginInstanceOrigin_RestApi
Definition OrthancCPlugin.h:1022
@ OrthancPluginInstanceOrigin_Lua
Definition OrthancCPlugin.h:1024
@ OrthancPluginInstanceOrigin_WebDav
Definition OrthancCPlugin.h:1025
@ OrthancPluginInstanceOrigin_DicomProtocol
Definition OrthancCPlugin.h:1021
@ OrthancPluginInstanceOrigin_Plugin
Definition OrthancCPlugin.h:1023
@ OrthancPluginContentType_Dicom
Definition OrthancCPlugin.h:801
@ OrthancPluginContentType_DicomAsJson
Definition OrthancCPlugin.h:802
@ OrthancPluginContentType_Unknown
Definition OrthancCPlugin.h:800
@ OrthancPluginContentType_DicomUntilPixelData
Definition OrthancCPlugin.h:803
@ OrthancPluginStableStatus_Unstable
Definition OrthancCPlugin.h:1248
@ OrthancPluginStableStatus_Stable
Definition OrthancCPlugin.h:1247
An entry in the dictionary of DICOM tags.
Definition OrthancCPlugin.h:2250
uint32_t minMultiplicity
Definition OrthancCPlugin.h:2254
uint32_t maxMultiplicity
Definition OrthancCPlugin.h:2255
OrthancPluginValueRepresentation vr
Definition OrthancCPlugin.h:2253
uint16_t element
Definition OrthancCPlugin.h:2252
uint16_t group
Definition OrthancCPlugin.h:2251
The parameters of a REST request.
Definition OrthancCPlugin.h:384
uint32_t authenticationPayloadSize
The size of the custom authentication payload (0 if no authentication callback is registered).
Definition OrthancCPlugin.h:460
const char *const * getValues
For a GET request, the values of the GET parameters.
Definition OrthancCPlugin.h:413
const char *const * groups
The matched values for the groups of the regular expression.
Definition OrthancCPlugin.h:398
const void * authenticationPayload
If a HTTP authentication callback is registered, the content of the custom payload generated by the c...
Definition OrthancCPlugin.h:454
uint32_t bodySize
For a PUT or POST request, the number of bytes of the body.
Definition OrthancCPlugin.h:423
uint32_t groupsCount
The number of groups of the regular expression.
Definition OrthancCPlugin.h:393
const char *const * headersKeys
The keys of the HTTP headers (always converted to low-case).
Definition OrthancCPlugin.h:438
const void * body
For a PUT or POST request, the content of the body.
Definition OrthancCPlugin.h:418
const char *const * getKeys
For a GET request, the keys of the GET parameters.
Definition OrthancCPlugin.h:408
uint32_t headersCount
The number of HTTP headers.
Definition OrthancCPlugin.h:433
OrthancPluginHttpMethod method
The HTTP method.
Definition OrthancCPlugin.h:388
uint32_t getCount
For a GET request, the number of GET parameters.
Definition OrthancCPlugin.h:403
const char *const * headersValues
The values of the HTTP headers.
Definition OrthancCPlugin.h:443
A 64-bit memory buffer allocated by the core system of Orthanc.
Definition OrthancCPlugin.h:1298
uint64_t size
The number of bytes in the buffer.
Definition OrthancCPlugin.h:1307
void * data
The content of the buffer.
Definition OrthancCPlugin.h:1302
A 32-bit memory buffer allocated by the core system of Orthanc.
Definition OrthancCPlugin.h:1276
uint32_t size
The number of bytes in the buffer.
Definition OrthancCPlugin.h:1285
void * data
The content of the buffer.
Definition OrthancCPlugin.h:1280