120# define ORTHANC_PLUGINS_API __declspec(dllexport)
122# define ORTHANC_PLUGINS_API __attribute__ ((visibility ("default")))
124# define ORTHANC_PLUGINS_API
127#define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 1
128#define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 13
129#define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 1
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))))
157#ifndef ORTHANC_PLUGIN_INLINE
158# if __STDC_VERSION__ >= 199901L
160# define ORTHANC_PLUGIN_INLINE static inline
161# elif defined(__cplusplus)
163# define ORTHANC_PLUGIN_INLINE static inline
164# elif defined(__GNUC__)
166# define ORTHANC_PLUGIN_INLINE static __inline
167# elif defined(_MSC_VER)
169# define ORTHANC_PLUGIN_INLINE static __inline
171# error Your compiler is not known to support the "inline" keyword
176#ifndef ORTHANC_PLUGIN_DEPRECATED
177# if defined(_MSC_VER)
178# define ORTHANC_PLUGIN_DEPRECATED __declspec(deprecated)
180# define ORTHANC_PLUGIN_DEPRECATED __attribute__ ((deprecated))
181# elif defined(__clang__)
182# define ORTHANC_PLUGIN_DEPRECATED __attribute__ ((deprecated))
184# pragma message("WARNING: You need to implement ORTHANC_PLUGINS_DEPRECATED for this compiler")
185# define ORTHANC_PLUGIN_DEPRECATED
190#ifndef ORTHANC_PLUGIN_SINCE_SDK
197# if defined(__clang__)
198# define ORTHANC_PLUGIN_SINCE_SDK(version) __attribute__ ((annotate("ORTHANC_PLUGIN_SINCE_SDK " version)))
200# define ORTHANC_PLUGIN_SINCE_SDK(version)
226#define ORTHANC_PLUGINS_WEBDAV_UNKNOWN_FILE_SIZE ((uint64_t) -1)
354 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
362 ORTHANC_PLUGINS_API
const char* OrthancPluginGetName();
375 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
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,
502 _OrthancPluginService_GetTagName = 35,
503 _OrthancPluginService_EncodeDicomWebJson2 = 36,
504 _OrthancPluginService_EncodeDicomWebXml2 = 37,
505 _OrthancPluginService_CreateMemoryBuffer = 38,
506 _OrthancPluginService_GenerateRestApiAuthorizationToken = 39,
507 _OrthancPluginService_CreateMemoryBuffer64 = 40,
508 _OrthancPluginService_CreateDicom2 = 41,
509 _OrthancPluginService_GetDatabaseServerIdentifier = 42,
510 _OrthancPluginService_SetMetricsIntegerValue = 43,
511 _OrthancPluginService_SetCurrentThreadName = 44,
512 _OrthancPluginService_LogMessage = 45,
513 _OrthancPluginService_AdoptDicomInstance = 46,
514 _OrthancPluginService_GetAttachmentCustomData = 47,
515 _OrthancPluginService_SetAttachmentCustomData = 48,
516 _OrthancPluginService_StoreKeyValue = 49,
517 _OrthancPluginService_DeleteKeyValue = 50,
518 _OrthancPluginService_GetKeyValue = 51,
519 _OrthancPluginService_CreateKeysValuesIterator = 52,
520 _OrthancPluginService_FreeKeysValuesIterator = 53,
521 _OrthancPluginService_KeysValuesIteratorNext = 54,
522 _OrthancPluginService_KeysValuesIteratorGetKey = 55,
523 _OrthancPluginService_KeysValuesIteratorGetValue = 56,
524 _OrthancPluginService_EnqueueValue = 57,
525 _OrthancPluginService_DequeueValue = 58,
526 _OrthancPluginService_GetQueueSize = 59,
527 _OrthancPluginService_SetStableStatus = 60,
528 _OrthancPluginService_EmitAuditLog = 61,
529 _OrthancPluginService_ReserveQueueValue = 62,
530 _OrthancPluginService_AcknowledgeQueueValue = 63,
531 _OrthancPluginService_ClearCurrentThreadName = 64,
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,
547 _OrthancPluginService_RegisterStorageCommitmentScpCallback = 1013,
548 _OrthancPluginService_RegisterIncomingDicomInstanceFilter = 1014,
549 _OrthancPluginService_RegisterTranscoderCallback = 1015,
550 _OrthancPluginService_RegisterStorageArea2 = 1016,
551 _OrthancPluginService_RegisterIncomingCStoreInstanceFilter = 1017,
552 _OrthancPluginService_RegisterReceivedInstanceCallback = 1018,
553 _OrthancPluginService_RegisterWebDavCollection = 1019,
554 _OrthancPluginService_RegisterStorageArea3 = 1020,
555 _OrthancPluginService_RegisterHttpAuthentication = 1021,
556 _OrthancPluginService_RegisterAuditLogHandler = 1022,
557 _OrthancPluginService_RegisterFindCallback2 = 1023,
558 _OrthancPluginService_RegisterMoveCallback2 = 1024,
559 _OrthancPluginService_RegisterWorklistCallback2 = 1025,
560 _OrthancPluginService_RegisterStorageCommitmentScpCallback2 = 1026,
563 _OrthancPluginService_AnswerBuffer = 2000,
564 _OrthancPluginService_CompressAndAnswerPngImage = 2001,
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,
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,
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,
611 _OrthancPluginService_FreeDicomInstance = 4011,
612 _OrthancPluginService_GetInstanceFramesCount = 4012,
613 _OrthancPluginService_GetInstanceRawFrame = 4013,
614 _OrthancPluginService_GetInstanceDecodedFrame = 4014,
615 _OrthancPluginService_TranscodeDicomInstance = 4015,
616 _OrthancPluginService_SerializeDicomInstance = 4016,
617 _OrthancPluginService_GetInstanceAdvancedJson = 4017,
618 _OrthancPluginService_GetInstanceDicomWebJson = 4018,
619 _OrthancPluginService_GetInstanceDicomWebXml = 4019,
620 _OrthancPluginService_LoadDicomInstance = 4020,
621 _OrthancPluginService_GetInstanceCalledAet = 4021,
622 _OrthancPluginService_GetInstanceRemoteIp = 4022,
625 _OrthancPluginService_RegisterDatabaseBackend = 5000,
626 _OrthancPluginService_DatabaseAnswer = 5001,
627 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002,
628 _OrthancPluginService_StorageAreaCreate = 5003,
629 _OrthancPluginService_StorageAreaRead = 5004,
630 _OrthancPluginService_StorageAreaRemove = 5005,
631 _OrthancPluginService_RegisterDatabaseBackendV3 = 5006,
632 _OrthancPluginService_RegisterDatabaseBackendV4 = 5007,
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,
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,
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,
676 _OrthancPluginService_CreateJob = 9000,
677 _OrthancPluginService_FreeJob = 9001,
678 _OrthancPluginService_SubmitJob = 9002,
679 _OrthancPluginService_RegisterJobsUnserializer = 9003,
680 _OrthancPluginService_CreateJob2 = 9004,
683 _OrthancPluginService_GetConnectionRemoteAet = 10000,
684 _OrthancPluginService_GetConnectionRemoteIp = 10001,
685 _OrthancPluginService_GetConnectionCalledAet = 10002,
687 _OrthancPluginService_INTERNAL = 0x7fffffff
688 } _OrthancPluginService;
693 _OrthancPluginProperty_Description = 1,
694 _OrthancPluginProperty_RootUri = 2,
695 _OrthancPluginProperty_OrthancExplorer = 3,
697 _OrthancPluginProperty_INTERNAL = 0x7fffffff
698 } _OrthancPluginProperty;
790 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
805 _OrthancPluginContentType_INTERNAL = 0x7fffffff
821 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
853 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
869 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
883 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
928 _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff
943 _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff
964 _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff
979 _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff
995 _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff
1011 _OrthancPluginConstraintType_INTERNAL = 0x7fffffff
1027 _OrthancPluginInstanceOrigin_INTERNAL = 0x7fffffff
1034 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
1048 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
1060 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.5.4")
1078 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.5.4")
1092 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.6.0")
1140 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.10.0")
1146 _OrthancPluginReceivedInstanceAction_INTERNAL = 0x7fffffff
1154 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.12.1")
1174 _OrthancPluginLoadDicomInstanceMode_INTERNAL = 0x7fffffff
1184 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.12.4")
1191 _OrthancPluginLogLevel_INTERNAL = 0x7fffffff
1201 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.12.4")
1211 _OrthancPluginLogCategory_INTERNAL = 0x7fffffff
1218 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
1226 _OrthancPluginStoreStatus_INTERNAL = 0x7fffffff
1233 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
1238 _OrthancPluginQueueOrigin_INTERNAL = 0x7fffffff
1245 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.12.9")
1250 _OrthancPluginStableStatus_INTERNAL = 0x7fffffff
1257 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.12.9")
1264 _OrthancPluginHttpAuthenticationStatus_INTERNAL = 0x7fffffff
1297 ORTHANC_PLUGIN_SINCE_SDK(
"1.9.0") typedef struct
1365 typedef struct ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
1374 typedef struct ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
1383 typedef struct ORTHANC_PLUGIN_SINCE_SDK(
"1.2.0")
1392 typedef struct ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
1401 typedef struct ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
1411 typedef struct ORTHANC_PLUGIN_SINCE_SDK(
"1.5.4")
1419 typedef struct ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
1440 const char* instanceId);
1451 const char* resourceId);
1462 const uint32_t size,
1463 uint32_t frameIndex);
1484 const char* bulkDataUri);
1502 const void* content,
1573 uint64_t rangeStart);
1614 const void* content,
1644 uint64_t rangeStart,
1645 const void* customData,
1646 uint32_t customDataSize);
1666 const void* customData,
1667 uint32_t customDataSize);
1686 const char* issuerAet,
1687 const char* calledAet);
1702 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
1736 uint32_t headersCount,
1737 const
char* const* headersKeys,
1738 const
char* const* headersValues);
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);
1801 const
char* issuerAet,
1802 const
char* calledAet);
1818 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
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);
1905 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
1908 const
char* patientId,
1909 const
char* accessionNumber,
1910 const
char* studyInstanceUid,
1911 const
char* seriesInstanceUid,
1912 const
char* sopInstanceUid,
1914 const
char* targetAet,
1915 uint16_t originatorId);
2133 const
char* serialized);
2182 uint32_t levelDepth,
2183 const uint16_t* levelTagGroup,
2184 const uint16_t* levelTagElement,
2185 const uint32_t* levelIndex,
2187 uint16_t tagElement,
2220 uint32_t levelDepth,
2221 const uint16_t* levelTagGroup,
2222 const uint16_t* levelTagElement,
2223 const uint32_t* levelIndex,
2225 uint16_t tagElement,
2234 typedef struct _OrthancPluginContext_t
2236 void* pluginsManager;
2237 const char* orthancVersion;
2240 _OrthancPluginService service,
2241 const void* params);
2298 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.0")
2301 int32_t expectedMajor,
2302 int32_t expectedMinor,
2303 int32_t expectedRevision)
2305 int32_t major, minor, revision;
2307 if (
sizeof(
int) !=
sizeof(int32_t) ||
2310 sizeof(int32_t) !=
sizeof(_OrthancPluginService) ||
2311 sizeof(int32_t) !=
sizeof(_OrthancPluginProperty) ||
2344 if (!strcmp(context->orthancVersion,
"mainline"))
2356 (context->orthancVersion,
"%4d.%4d.%4d", &major, &minor, &revision) != 3)
2363 if (major > expectedMajor)
2368 if (major < expectedMajor)
2375 if (minor > expectedMinor)
2380 if (minor < expectedMinor)
2387 if (revision >= expectedRevision)
2419 ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER,
2420 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER,
2421 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER);
2437 context->Free(buffer->
data);
2449 ORTHANC_PLUGIN_SINCE_SDK(
"1.9.0")
2454 context->Free(buffer->data);
2468 const char* message)
2470 context->InvokeService(context, _OrthancPluginService_LogError, message);
2484 const char* message)
2486 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
2500 const char* message)
2502 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
2509 const char* pathRegularExpression;
2511 } _OrthancPluginRestCallback;
2536 const char* pathRegularExpression,
2539 _OrthancPluginRestCallback params;
2540 params.pathRegularExpression = pathRegularExpression;
2541 params.callback = callback;
2542 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
2576 const char* pathRegularExpression,
2579 _OrthancPluginRestCallback params;
2580 params.pathRegularExpression = pathRegularExpression;
2581 params.callback = callback;
2582 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms);
2590 } _OrthancPluginOnStoredInstanceCallback;
2616 _OrthancPluginOnStoredInstanceCallback params;
2617 params.callback = callback;
2619 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
2628 uint32_t answerSize;
2629 const char* mimeType;
2630 } _OrthancPluginAnswerBuffer;
2648 uint32_t answerSize,
2649 const char* mimeType)
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, ¶ms);
2668 } _OrthancPluginCompressAndAnswerPngImage;
2680 } _OrthancPluginCompressAndAnswerImage;
2710 _OrthancPluginCompressAndAnswerImage params;
2711 params.output = output;
2713 params.pixelFormat = format;
2714 params.width = width;
2715 params.height = height;
2716 params.pitch = pitch;
2717 params.buffer = buffer;
2719 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
2727 const char* instanceId;
2728 } _OrthancPluginGetDicomForInstance;
2745 const char* instanceId)
2747 _OrthancPluginGetDicomForInstance params;
2748 params.target = target;
2749 params.instanceId = instanceId;
2750 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
2759 } _OrthancPluginRestApiGet;
2780 _OrthancPluginRestApiGet params;
2781 params.target = target;
2783 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
2810 _OrthancPluginRestApiGet params;
2811 params.target = target;
2813 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms);
2824 } _OrthancPluginRestApiPostPut;
2849 _OrthancPluginRestApiPostPut params;
2850 params.target = target;
2853 params.bodySize = bodySize;
2854 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
2884 _OrthancPluginRestApiPostPut params;
2885 params.target = target;
2888 params.bodySize = bodySize;
2889 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms);
2910 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
2933 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
2961 _OrthancPluginRestApiPostPut params;
2962 params.target = target;
2965 params.bodySize = bodySize;
2966 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
2997 _OrthancPluginRestApiPostPut params;
2998 params.target = target;
3001 params.bodySize = bodySize;
3002 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms);
3010 const char* argument;
3011 } _OrthancPluginOutputPlusArgument;
3027 const char* redirection)
3029 _OrthancPluginOutputPlusArgument params;
3030 params.output = output;
3031 params.argument = redirection;
3032 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
3040 const char* argument;
3041 } _OrthancPluginRetrieveDynamicString;
3058 const char* patientID)
3062 _OrthancPluginRetrieveDynamicString params;
3063 params.result = &result;
3064 params.argument = patientID;
3093 const char* studyUID)
3097 _OrthancPluginRetrieveDynamicString params;
3098 params.result = &result;
3099 params.argument = studyUID;
3128 const char* accessionNumber)
3132 _OrthancPluginRetrieveDynamicString params;
3133 params.result = &result;
3134 params.argument = accessionNumber;
3163 const char* seriesUID)
3167 _OrthancPluginRetrieveDynamicString params;
3168 params.result = &result;
3169 params.argument = seriesUID;
3198 const char* sopInstanceUID)
3202 _OrthancPluginRetrieveDynamicString params;
3203 params.result = &result;
3204 params.argument = sopInstanceUID;
3223 } _OrthancPluginSendHttpStatusCode;
3246 _OrthancPluginSendHttpStatusCode params;
3247 params.output = output;
3248 params.status = status;
3249 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
3269 _OrthancPluginOutputPlusArgument params;
3270 params.output = output;
3271 params.argument = realm;
3272 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
3290 const char* allowedMethods)
3292 _OrthancPluginOutputPlusArgument params;
3293 params.output = output;
3294 params.argument = allowedMethods;
3295 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
3304 } _OrthancPluginSetHttpHeader;
3323 _OrthancPluginSetHttpHeader params;
3324 params.output = output;
3325 params.key = cookie;
3326 params.value = value;
3327 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
3348 _OrthancPluginSetHttpHeader params;
3349 params.output = output;
3351 params.value = value;
3352 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
3358 char** resultStringToFree;
3359 const char** resultString;
3360 int64_t* resultInt64;
3364 } _OrthancPluginAccessDicomInstance;
3384 _OrthancPluginAccessDicomInstance params;
3385 memset(¶ms, 0,
sizeof(params));
3386 params.resultString = &result;
3387 params.instance = instance;
3412 ORTHANC_PLUGIN_SINCE_SDK(
"1.13.1")
3419 _OrthancPluginAccessDicomInstance params;
3420 memset(¶ms, 0,
sizeof(params));
3421 params.resultString = &result;
3422 params.instance = instance;
3446 ORTHANC_PLUGIN_SINCE_SDK(
"1.13.1")
3453 _OrthancPluginAccessDicomInstance params;
3454 memset(¶ms, 0,
sizeof(params));
3455 params.resultString = &result;
3456 params.instance = instance;
3486 _OrthancPluginAccessDicomInstance params;
3487 memset(¶ms, 0,
sizeof(params));
3488 params.resultInt64 = &size;
3489 params.instance = instance;
3519 _OrthancPluginAccessDicomInstance params;
3520 memset(¶ms, 0,
sizeof(params));
3521 params.resultString = &result;
3522 params.instance = instance;
3555 _OrthancPluginAccessDicomInstance params;
3556 memset(¶ms, 0,
sizeof(params));
3557 params.resultStringToFree = &result;
3558 params.instance = instance;
3593 _OrthancPluginAccessDicomInstance params;
3594 memset(¶ms, 0,
sizeof(params));
3595 params.resultStringToFree = &result;
3596 params.instance = instance;
3629 const char* metadata)
3633 _OrthancPluginAccessDicomInstance params;
3634 memset(¶ms, 0,
sizeof(params));
3635 params.resultInt64 = &result;
3636 params.instance = instance;
3637 params.key = metadata;
3646 return (result != 0);
3670 const char* metadata)
3674 _OrthancPluginAccessDicomInstance params;
3675 memset(¶ms, 0,
sizeof(params));
3676 params.resultString = &result;
3677 params.instance = instance;
3678 params.key = metadata;
3699 } _OrthancPluginRegisterStorageArea;
3722 _OrthancPluginRegisterStorageArea params;
3723 params.create = create;
3725 params.remove = remove;
3728 params.free = ::free;
3733 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
3752 _OrthancPluginRetrieveDynamicString params;
3753 params.result = &result;
3754 params.argument = NULL;
3782 _OrthancPluginRetrieveDynamicString params;
3783 params.result = &result;
3784 params.argument = NULL;
3817 _OrthancPluginRetrieveDynamicString params;
3818 params.result = &result;
3819 params.argument = NULL;
3837 } _OrthancPluginOnChangeCallback;
3863 _OrthancPluginOnChangeCallback params;
3864 params.callback = callback;
3866 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms);
3874 _OrthancPluginProperty property;
3876 } _OrthancPluginSetPluginProperty;
3898 _OrthancPluginSetPluginProperty params;
3899 params.plugin = OrthancPluginGetName();
3900 params.property = _OrthancPluginProperty_RootUri;
3903 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3919 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.4")
3925 _OrthancPluginSetPluginProperty params;
3926 params.plugin = plugin;
3927 params.property = _OrthancPluginProperty_RootUri;
3930 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3949 const char* description)
3951 _OrthancPluginSetPluginProperty params;
3952 params.plugin = OrthancPluginGetName();
3953 params.property = _OrthancPluginProperty_Description;
3954 params.value = description;
3956 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3970 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.4")
3974 const
char* description)
3976 _OrthancPluginSetPluginProperty params;
3977 params.plugin = plugin;
3978 params.property = _OrthancPluginProperty_Description;
3979 params.value = description;
3981 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
4000 const char* javascript)
4002 _OrthancPluginSetPluginProperty params;
4003 params.plugin = OrthancPluginGetName();
4004 params.property = _OrthancPluginProperty_OrthancExplorer;
4005 params.value = javascript;
4007 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
4021 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.4")
4025 const
char* javascript)
4027 _OrthancPluginSetPluginProperty params;
4028 params.plugin = plugin;
4029 params.property = _OrthancPluginProperty_OrthancExplorer;
4030 params.value = javascript;
4032 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
4041 } _OrthancPluginGlobalProperty;
4060 const char* defaultValue)
4064 _OrthancPluginGlobalProperty params;
4065 params.result = &result;
4066 params.property = property;
4067 params.value = defaultValue;
4101 _OrthancPluginGlobalProperty params;
4102 params.result = NULL;
4103 params.property = property;
4104 params.value = value;
4106 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms);
4113 int32_t *resultInt32;
4114 uint32_t *resultUint32;
4115 int64_t *resultInt64;
4116 uint64_t *resultUint64;
4117 } _OrthancPluginReturnSingleValue;
4132 _OrthancPluginReturnSingleValue params;
4133 memset(¶ms, 0,
sizeof(params));
4134 params.resultUint32 = &count;
4167 _OrthancPluginGlobalProperty params;
4168 params.result = &result;
4169 params.property = (int32_t) argument;
4170 params.value = NULL;
4198 _OrthancPluginReturnSingleValue params;
4199 memset(¶ms, 0,
sizeof(params));
4200 params.resultUint32 = &count;
4230 _OrthancPluginRetrieveDynamicString params;
4231 params.result = &result;
4232 params.argument = NULL;
4250 const char* subType;
4251 const char* contentType;
4252 } _OrthancPluginStartMultipartAnswer;
4270 const char* subType,
4271 const char* contentType)
4273 _OrthancPluginStartMultipartAnswer params;
4274 params.output = output;
4275 params.subType = subType;
4276 params.contentType = contentType;
4277 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms);
4300 uint32_t answerSize)
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, ¶ms);
4319 } _OrthancPluginBufferCompression;
4346 _OrthancPluginBufferCompression params;
4347 params.target = target;
4348 params.source = source;
4350 params.compression = compression;
4351 params.uncompress = uncompress;
4353 return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms);
4362 } _OrthancPluginReadFile;
4380 _OrthancPluginReadFile params;
4381 params.target = target;
4383 return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms);
4393 } _OrthancPluginWriteFile;
4412 _OrthancPluginWriteFile params;
4416 return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms);
4423 const char** target;
4425 } _OrthancPluginGetErrorDescription;
4441 const char* result = NULL;
4443 _OrthancPluginGetErrorDescription params;
4444 params.target = &result;
4445 params.error = error;
4450 return "Unknown error code";
4466 } _OrthancPluginSendHttpStatus;
4497 _OrthancPluginSendHttpStatus params;
4498 params.output = output;
4499 params.status = status;
4501 params.bodySize = bodySize;
4502 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms);
4510 uint32_t* resultUint32;
4512 void** resultBuffer;
4513 } _OrthancPluginGetImageInfo;
4532 _OrthancPluginGetImageInfo params;
4533 memset(¶ms, 0,
sizeof(params));
4534 params.image = image;
4535 params.resultPixelFormat = ⌖
4565 _OrthancPluginGetImageInfo params;
4566 memset(¶ms, 0,
sizeof(params));
4567 params.image = image;
4568 params.resultUint32 = &width;
4598 _OrthancPluginGetImageInfo params;
4599 memset(¶ms, 0,
sizeof(params));
4600 params.image = image;
4601 params.resultUint32 = &height;
4633 _OrthancPluginGetImageInfo params;
4634 memset(¶ms, 0,
sizeof(params));
4635 params.image = image;
4636 params.resultUint32 = &pitch;
4665 void* target = NULL;
4667 _OrthancPluginGetImageInfo params;
4668 memset(¶ms, 0,
sizeof(params));
4669 params.resultBuffer = ⌖
4670 params.image = image;
4689 } _OrthancPluginUncompressImage;
4712 _OrthancPluginUncompressImage params;
4713 memset(¶ms, 0,
sizeof(params));
4714 params.target = ⌖
4717 params.format = format;
4735 } _OrthancPluginFreeImage;
4750 _OrthancPluginFreeImage params;
4751 params.image = image;
4753 context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms);
4769 } _OrthancPluginCompressImage;
4800 _OrthancPluginCompressImage params;
4801 memset(¶ms, 0,
sizeof(params));
4802 params.target = target;
4804 params.pixelFormat = format;
4805 params.width = width;
4806 params.height = height;
4807 params.pitch = pitch;
4808 params.buffer = buffer;
4811 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4846 _OrthancPluginCompressImage params;
4847 memset(¶ms, 0,
sizeof(params));
4848 params.target = target;
4850 params.pixelFormat = format;
4851 params.width = width;
4852 params.height = height;
4853 params.pitch = pitch;
4854 params.buffer = buffer;
4855 params.quality = quality;
4857 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4893 _OrthancPluginCompressAndAnswerImage params;
4894 params.output = output;
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, ¶ms);
4913 const char* username;
4914 const char* password;
4917 } _OrthancPluginCallHttpClient;
4940 const char* username,
4941 const char* password)
4943 _OrthancPluginCallHttpClient params;
4944 memset(¶ms, 0,
sizeof(params));
4946 params.target = target;
4949 params.username = username;
4950 params.password = password;
4952 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4980 const char* username,
4981 const char* password)
4983 _OrthancPluginCallHttpClient params;
4984 memset(¶ms, 0,
sizeof(params));
4986 params.target = target;
4990 params.bodySize = bodySize;
4991 params.username = username;
4992 params.password = password;
4994 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
5022 const char* username,
5023 const char* password)
5025 _OrthancPluginCallHttpClient params;
5026 memset(¶ms, 0,
sizeof(params));
5028 params.target = target;
5032 params.bodySize = bodySize;
5033 params.username = username;
5034 params.password = password;
5036 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
5057 const char* username,
5058 const char* password)
5060 _OrthancPluginCallHttpClient params;
5061 memset(¶ms, 0,
sizeof(params));
5065 params.username = username;
5066 params.password = password;
5068 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
5078 } _OrthancPluginConvertPixelFormat;
5099 _OrthancPluginConvertPixelFormat params;
5100 params.target = ⌖
5101 params.source = source;
5102 params.targetFormat = targetFormat;
5132 _OrthancPluginReturnSingleValue params;
5133 memset(¶ms, 0,
sizeof(params));
5134 params.resultUint32 = &count;
5155 } _OrthancPluginGetFontInfo;
5171 const char* result = NULL;
5173 _OrthancPluginGetFontInfo params;
5174 memset(¶ms, 0,
sizeof(params));
5175 params.name = &result;
5176 params.fontIndex = fontIndex;
5205 _OrthancPluginGetFontInfo params;
5206 memset(¶ms, 0,
sizeof(params));
5207 params.size = &result;
5208 params.fontIndex = fontIndex;
5226 const char* utf8Text;
5232 } _OrthancPluginDrawText;
5256 const char* utf8Text,
5263 _OrthancPluginDrawText params;
5264 memset(¶ms, 0,
sizeof(params));
5265 params.image = image;
5266 params.fontIndex = fontIndex;
5267 params.utf8Text = utf8Text;
5274 return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms);
5283 const void* content;
5286 } _OrthancPluginStorageAreaCreate;
5312 const void* content,
5316 _OrthancPluginStorageAreaCreate params;
5317 params.storageArea = storageArea;
5319 params.content = content;
5323 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms);
5333 } _OrthancPluginStorageAreaRead;
5361 _OrthancPluginStorageAreaRead params;
5362 params.target = target;
5363 params.storageArea = storageArea;
5367 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms);
5376 } _OrthancPluginStorageAreaRemove;
5401 _OrthancPluginStorageAreaRemove params;
5402 params.storageArea = storageArea;
5406 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms);
5415 uint16_t httpStatus;
5416 const char* message;
5417 } _OrthancPluginRegisterErrorCode;
5437 uint16_t httpStatus,
5438 const char* message)
5442 _OrthancPluginRegisterErrorCode params;
5443 params.target = ⌖
5445 params.httpStatus = httpStatus;
5446 params.message = message;
5467 uint32_t minMultiplicity;
5468 uint32_t maxMultiplicity;
5469 } _OrthancPluginRegisterDictionaryTag;
5496 uint32_t minMultiplicity,
5497 uint32_t maxMultiplicity)
5499 _OrthancPluginRegisterDictionaryTag params;
5500 params.group = group;
5501 params.element = element;
5504 params.minMultiplicity = minMultiplicity;
5505 params.maxMultiplicity = maxMultiplicity;
5507 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, ¶ms);
5518 uint32_t minMultiplicity;
5519 uint32_t maxMultiplicity;
5520 const char* privateCreator;
5521 } _OrthancPluginRegisterPrivateDictionaryTag;
5543 ORTHANC_PLUGIN_SINCE_SDK(
"1.2.0")
5550 uint32_t minMultiplicity,
5551 uint32_t maxMultiplicity,
5552 const
char* privateCreator)
5554 _OrthancPluginRegisterPrivateDictionaryTag params;
5555 params.group = group;
5556 params.element = element;
5559 params.minMultiplicity = minMultiplicity;
5560 params.maxMultiplicity = maxMultiplicity;
5561 params.privateCreator = privateCreator;
5563 return context->InvokeService(context, _OrthancPluginService_RegisterPrivateDictionaryTag, ¶ms);
5572 } _OrthancPluginReconstructMainDicomTags;
5593 _OrthancPluginReconstructMainDicomTags params;
5594 params.level = level;
5595 params.storageArea = storageArea;
5597 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, ¶ms);
5604 const char* instanceId;
5609 uint32_t maxStringLength;
5610 } _OrthancPluginDicomToJson;
5638 uint32_t maxStringLength)
5642 _OrthancPluginDicomToJson params;
5643 memset(¶ms, 0,
sizeof(params));
5644 params.result = &result;
5645 params.buffer = buffer;
5647 params.format = format;
5648 params.flags = flags;
5649 params.maxStringLength = maxStringLength;
5683 const char* instanceId,
5686 uint32_t maxStringLength)
5690 _OrthancPluginDicomToJson params;
5691 memset(¶ms, 0,
sizeof(params));
5692 params.result = &result;
5693 params.instanceId = instanceId;
5694 params.format = format;
5695 params.flags = flags;
5696 params.maxStringLength = maxStringLength;
5714 uint32_t headersCount;
5715 const char*
const* headersKeys;
5716 const char*
const* headersValues;
5717 int32_t afterPlugins;
5718 } _OrthancPluginRestApiGet2;
5743 uint32_t headersCount,
5744 const char*
const* headersKeys,
5745 const char*
const* headersValues,
5746 int32_t afterPlugins)
5748 _OrthancPluginRestApiGet2 params;
5749 params.target = target;
5751 params.headersCount = headersCount;
5752 params.headersKeys = headersKeys;
5753 params.headersValues = headersValues;
5754 params.afterPlugins = afterPlugins;
5756 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, ¶ms);
5764 } _OrthancPluginWorklistCallback;
5781 _OrthancPluginWorklistCallback params;
5782 params.callback = callback;
5784 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, ¶ms);
5794 } _OrthancPluginWorklistAnswersOperation;
5828 _OrthancPluginWorklistAnswersOperation params;
5829 params.answers = answers;
5830 params.query = query;
5831 params.dicom = dicom;
5834 return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, ¶ms);
5855 _OrthancPluginWorklistAnswersOperation params;
5856 params.answers = answers;
5857 params.query = NULL;
5858 params.dicom = NULL;
5861 return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, ¶ms);
5872 } _OrthancPluginWorklistQueryOperation;
5895 int32_t isMatch = 0;
5897 _OrthancPluginWorklistQueryOperation params;
5898 params.query = query;
5899 params.dicom = dicom;
5901 params.isMatch = &isMatch;
5902 params.target = NULL;
5933 _OrthancPluginWorklistQueryOperation params;
5934 params.query = query;
5935 params.dicom = NULL;
5937 params.isMatch = NULL;
5938 params.target = target;
5940 return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, ¶ms);
5960 _OrthancPluginAccessDicomInstance params;
5961 memset(¶ms, 0,
sizeof(params));
5962 params.resultOrigin = &origin;
5963 params.instance = instance;
5983 } _OrthancPluginCreateDicom;
6017 _OrthancPluginCreateDicom params;
6018 params.target = target;
6020 params.pixelData = pixelData;
6021 params.flags = flags;
6023 return context->InvokeService(context, _OrthancPluginService_CreateDicom, ¶ms);
6030 } _OrthancPluginDecodeImageCallback;
6050 _OrthancPluginDecodeImageCallback params;
6051 params.callback = callback;
6053 return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, ¶ms);
6066 const void* constBuffer;
6067 uint32_t bufferSize;
6068 uint32_t frameIndex;
6069 } _OrthancPluginCreateImage;
6092 _OrthancPluginCreateImage params;
6093 memset(¶ms, 0,
sizeof(params));
6094 params.target = ⌖
6095 params.format = format;
6096 params.width = width;
6097 params.height = height;
6137 _OrthancPluginCreateImage params;
6138 memset(¶ms, 0,
sizeof(params));
6139 params.target = ⌖
6140 params.format = format;
6141 params.width = width;
6142 params.height = height;
6143 params.pitch = pitch;
6144 params.buffer = buffer;
6176 uint32_t bufferSize,
6177 uint32_t frameIndex)
6181 _OrthancPluginCreateImage params;
6182 memset(¶ms, 0,
sizeof(params));
6183 params.target = ⌖
6184 params.constBuffer = buffer;
6185 params.bufferSize = bufferSize;
6186 params.frameIndex = frameIndex;
6205 } _OrthancPluginComputeHash;
6226 _OrthancPluginComputeHash params;
6227 params.result = &result;
6228 params.buffer = buffer;
6262 _OrthancPluginComputeHash params;
6263 params.result = &result;
6264 params.buffer = buffer;
6284 } _OrthancPluginLookupDictionary;
6306 _OrthancPluginLookupDictionary params;
6307 params.target = target;
6309 return context->InvokeService(context, _OrthancPluginService_LookupDictionary, ¶ms);
6318 uint32_t answerSize;
6319 uint32_t headersCount;
6320 const char*
const* headersKeys;
6321 const char*
const* headersValues;
6322 } _OrthancPluginSendMultipartItem2;
6344 ORTHANC_PLUGIN_SINCE_SDK(
"1.0.0")
6349 uint32_t answerSize,
6350 uint32_t headersCount,
6351 const
char* const* headersKeys,
6352 const
char* const* headersValues)
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;
6362 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem2, ¶ms);
6369 } _OrthancPluginIncomingHttpRequestFilter;
6383 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6388 _OrthancPluginIncomingHttpRequestFilter params;
6389 params.callback = callback;
6391 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter, ¶ms);
6400 uint16_t* httpStatus;
6403 uint32_t headersCount;
6404 const char*
const* headersKeys;
6405 const char*
const* headersValues;
6408 const char* username;
6409 const char* password;
6411 const char* certificateFile;
6412 const char* certificateKeyFile;
6413 const char* certificateKeyPassword;
6415 } _OrthancPluginCallHttpClient2;
6459 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6464 uint16_t* httpStatus,
6467 uint32_t headersCount,
6468 const
char* const* headersKeys,
6469 const
char* const* headersValues,
6472 const
char* username,
6473 const
char* password,
6475 const
char* certificateFile,
6476 const
char* certificateKeyFile,
6477 const
char* certificateKeyPassword,
6480 _OrthancPluginCallHttpClient2 params;
6481 memset(¶ms, 0,
sizeof(params));
6483 params.answerBody = answerBody;
6484 params.answerHeaders = answerHeaders;
6485 params.httpStatus = httpStatus;
6486 params.method = method;
6488 params.headersCount = headersCount;
6489 params.headersKeys = headersKeys;
6490 params.headersValues = headersValues;
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;
6501 return context->InvokeService(context, _OrthancPluginService_CallHttpClient2, ¶ms);
6515 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6521 _OrthancPluginRetrieveDynamicString params;
6522 params.result = &result;
6523 params.argument = NULL;
6542 } _OrthancPluginFindCallback;
6555 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6560 _OrthancPluginFindCallback params;
6561 params.callback = callback;
6563 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback, ¶ms);
6574 uint32_t *resultUint32;
6575 uint16_t *resultGroup;
6576 uint16_t *resultElement;
6577 char **resultString;
6578 } _OrthancPluginFindOperation;
6595 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6602 _OrthancPluginFindOperation params;
6603 memset(¶ms, 0,
sizeof(params));
6604 params.answers = answers;
6605 params.dicom = dicom;
6608 return context->InvokeService(context, _OrthancPluginService_FindAddAnswer, ¶ms);
6625 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6630 _OrthancPluginFindOperation params;
6631 memset(¶ms, 0,
sizeof(params));
6632 params.answers = answers;
6634 return context->InvokeService(context, _OrthancPluginService_FindMarkIncomplete, ¶ms);
6650 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6657 _OrthancPluginFindOperation params;
6658 memset(¶ms, 0,
sizeof(params));
6659 params.query = query;
6660 params.resultUint32 = &count;
6688 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6696 _OrthancPluginFindOperation params;
6697 memset(¶ms, 0,
sizeof(params));
6698 params.query = query;
6699 params.index = index;
6700 params.resultGroup = group;
6701 params.resultElement = element;
6703 return context->InvokeService(context, _OrthancPluginService_GetFindQueryTag, ¶ms);
6720 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6728 _OrthancPluginFindOperation params;
6729 memset(¶ms, 0,
sizeof(params));
6730 params.query = query;
6731 params.index = index;
6732 params.resultString = &result;
6759 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6767 _OrthancPluginFindOperation params;
6768 memset(¶ms, 0,
sizeof(params));
6769 params.query = query;
6770 params.index = index;
6771 params.resultString = &result;
6793 } _OrthancPluginMoveCallback;
6808 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6816 _OrthancPluginMoveCallback params;
6817 params.callback = callback;
6818 params.getMoveSize = getMoveSize;
6819 params.applyMove = applyMove;
6820 params.freeMove = freeMove;
6822 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback, ¶ms);
6832 } _OrthancPluginCreateFindMatcher;
6848 ORTHANC_PLUGIN_SINCE_SDK(
"1.2.0")
6856 _OrthancPluginCreateFindMatcher params;
6857 memset(¶ms, 0,
sizeof(params));
6858 params.target = ⌖
6859 params.query = query;
6876 } _OrthancPluginFreeFindMatcher;
6887 ORTHANC_PLUGIN_SINCE_SDK(
"1.2.0")
6892 _OrthancPluginFreeFindMatcher params;
6893 params.matcher = matcher;
6895 context->InvokeService(context, _OrthancPluginService_FreeFindMatcher, ¶ms);
6905 } _OrthancPluginFindMatcherIsMatch;
6921 ORTHANC_PLUGIN_SINCE_SDK(
"1.2.0")
6928 int32_t isMatch = 0;
6930 _OrthancPluginFindMatcherIsMatch params;
6931 params.matcher = matcher;
6932 params.dicom = dicom;
6934 params.isMatch = &isMatch;
6951 } _OrthancPluginIncomingHttpRequestFilter2;
6964 ORTHANC_PLUGIN_SINCE_SDK(
"1.3.0")
6969 _OrthancPluginIncomingHttpRequestFilter2 params;
6970 params.callback = callback;
6972 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter2, ¶ms);
6980 } _OrthancPluginGetPeers;
6993 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
6999 _OrthancPluginGetPeers params;
7000 memset(¶ms, 0,
sizeof(params));
7001 params.peers = &peers;
7017 } _OrthancPluginFreePeers;
7028 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
7033 _OrthancPluginFreePeers params;
7034 params.peers = peers;
7036 context->InvokeService(context, _OrthancPluginService_FreePeers, ¶ms);
7044 } _OrthancPluginGetPeersCount;
7059 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
7064 uint32_t target = 0;
7066 _OrthancPluginGetPeersCount params;
7067 memset(¶ms, 0,
sizeof(params));
7068 params.target = ⌖
7069 params.peers = peers;
7085 const char** target;
7088 const char* userProperty;
7089 } _OrthancPluginGetPeerProperty;
7108 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
7114 const char* target = NULL;
7116 _OrthancPluginGetPeerProperty params;
7117 memset(¶ms, 0,
sizeof(params));
7118 params.target = ⌖
7119 params.peers = peers;
7120 params.peerIndex = peerIndex;
7121 params.userProperty = NULL;
7150 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
7156 const char* target = NULL;
7158 _OrthancPluginGetPeerProperty params;
7159 memset(¶ms, 0,
sizeof(params));
7160 params.target = ⌖
7161 params.peers = peers;
7162 params.peerIndex = peerIndex;
7163 params.userProperty = NULL;
7197 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
7202 const
char* userProperty)
7204 const char* target = NULL;
7206 _OrthancPluginGetPeerProperty params;
7207 memset(¶ms, 0,
sizeof(params));
7208 params.target = ⌖
7209 params.peers = peers;
7210 params.peerIndex = peerIndex;
7211 params.userProperty = userProperty;
7230 uint16_t* httpStatus;
7235 uint32_t additionalHeadersCount;
7236 const char*
const* additionalHeadersKeys;
7237 const char*
const* additionalHeadersValues;
7241 } _OrthancPluginCallPeerApi;
7279 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
7284 uint16_t* httpStatus,
7289 uint32_t additionalHeadersCount,
7290 const
char* const* additionalHeadersKeys,
7291 const
char* const* additionalHeadersValues,
7296 _OrthancPluginCallPeerApi params;
7297 memset(¶ms, 0,
sizeof(params));
7299 params.answerBody = answerBody;
7300 params.answerHeaders = answerHeaders;
7301 params.httpStatus = httpStatus;
7302 params.peers = peers;
7303 params.peerIndex = peerIndex;
7304 params.method = method;
7306 params.additionalHeadersCount = additionalHeadersCount;
7307 params.additionalHeadersKeys = additionalHeadersKeys;
7308 params.additionalHeadersValues = additionalHeadersValues;
7310 params.bodySize = bodySize;
7311 params.timeout = timeout;
7313 return context->InvokeService(context, _OrthancPluginService_CallPeerApi, ¶ms);
7332 } _OrthancPluginCreateJob;
7366 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
7381 _OrthancPluginCreateJob params;
7382 memset(¶ms, 0,
sizeof(params));
7384 params.target = ⌖
7386 params.finalize = finalize;
7388 params.getProgress = getProgress;
7389 params.getContent = getContent;
7390 params.getSerialized = getSerialized;
7393 params.reset = reset;
7420 } _OrthancPluginCreateJob2;
7453 ORTHANC_PLUGIN_SINCE_SDK(
"1.11.3")
7468 _OrthancPluginCreateJob2 params;
7469 memset(¶ms, 0,
sizeof(params));
7471 params.target = ⌖
7473 params.finalize = finalize;
7475 params.getProgress = getProgress;
7476 params.getContent = getContent;
7477 params.getSerialized = getSerialized;
7480 params.reset = reset;
7498 } _OrthancPluginFreeJob;
7509 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
7514 _OrthancPluginFreeJob params;
7517 context->InvokeService(context, _OrthancPluginService_FreeJob, ¶ms);
7527 } _OrthancPluginSubmitJob;
7542 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
7548 char* resultId = NULL;
7550 _OrthancPluginSubmitJob params;
7551 memset(¶ms, 0,
sizeof(params));
7553 params.resultId = &resultId;
7555 params.priority = priority;
7574 } _OrthancPluginJobsUnserializer;
7588 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
7593 _OrthancPluginJobsUnserializer params;
7594 params.unserializer = unserializer;
7596 context->InvokeService(context, _OrthancPluginService_RegisterJobsUnserializer, ¶ms);
7604 const char* details;
7606 } _OrthancPluginSetHttpErrorDetails;
7625 ORTHANC_PLUGIN_SINCE_SDK(
"1.5.0")
7629 const
char* details,
7632 _OrthancPluginSetHttpErrorDetails params;
7633 params.output = output;
7634 params.details = details;
7636 context->InvokeService(context, _OrthancPluginService_SetHttpErrorDetails, ¶ms);
7643 const char** result;
7644 const char* argument;
7645 } _OrthancPluginRetrieveStaticString;
7658 ORTHANC_PLUGIN_SINCE_SDK(
"1.5.0")
7663 const char* result = NULL;
7665 _OrthancPluginRetrieveStaticString params;
7666 params.result = &result;
7667 params.argument = path;
7687 } _OrthancPluginSetMetricsValue;
7705 ORTHANC_PLUGIN_SINCE_SDK(
"1.5.4")
7712 _OrthancPluginSetMetricsValue params;
7714 params.value = value;
7716 context->InvokeService(context, _OrthancPluginService_SetMetricsValue, ¶ms);
7724 } _OrthancPluginRegisterRefreshMetricsCallback;
7737 ORTHANC_PLUGIN_SINCE_SDK(
"1.5.4")
7742 _OrthancPluginRegisterRefreshMetricsCallback params;
7743 params.callback = callback;
7744 context->InvokeService(context, _OrthancPluginService_RegisterRefreshMetricsCallback, ¶ms);
7756 } _OrthancPluginEncodeDicomWeb;
7774 ORTHANC_PLUGIN_SINCE_SDK(
"1.5.4")
7781 char* target = NULL;
7783 _OrthancPluginEncodeDicomWeb params;
7784 params.target = ⌖
7785 params.dicom = dicom;
7786 params.dicomSize = dicomSize;
7787 params.callback = callback;
7817 ORTHANC_PLUGIN_SINCE_SDK(
"1.5.4")
7824 char* target = NULL;
7826 _OrthancPluginEncodeDicomWeb params;
7827 params.target = ⌖
7828 params.dicom = dicom;
7829 params.dicomSize = dicomSize;
7830 params.callback = callback;
7852 } _OrthancPluginEncodeDicomWeb2;
7870 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
7878 char* target = NULL;
7880 _OrthancPluginEncodeDicomWeb2 params;
7881 params.target = ⌖
7882 params.dicom = dicom;
7883 params.dicomSize = dicomSize;
7884 params.callback = callback;
7885 params.payload = payload;
7915 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
7923 char* target = NULL;
7925 _OrthancPluginEncodeDicomWeb2 params;
7926 params.target = ⌖
7927 params.dicom = dicom;
7928 params.dicomSize = dicomSize;
7929 params.callback = callback;
7930 params.payload = payload;
8034 typedef const void* (*OrthancPluginChunkedClientRequestGetChunkData) (
void* request);
8058 uint16_t* httpStatus;
8061 uint32_t headersCount;
8062 const char*
const* headersKeys;
8063 const char*
const* headersValues;
8069 const char* username;
8070 const char* password;
8072 const char* certificateFile;
8073 const char* certificateKeyFile;
8074 const char* certificateKeyPassword;
8076 } _OrthancPluginChunkedHttpClient;
8129 ORTHANC_PLUGIN_SINCE_SDK(
"1.5.7")
8135 uint16_t* httpStatus,
8138 uint32_t headersCount,
8139 const
char* const* headersKeys,
8140 const
char* const* headersValues,
8146 const
char* username,
8147 const
char* password,
8149 const
char* certificateFile,
8150 const
char* certificateKeyFile,
8151 const
char* certificateKeyPassword,
8154 _OrthancPluginChunkedHttpClient params;
8155 memset(¶ms, 0,
sizeof(params));
8158 params.httpStatus = httpStatus;
8159 params.method = method;
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;
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;
8182 return context->InvokeService(context, _OrthancPluginService_ChunkedHttpClient, ¶ms);
8191 typedef struct ORTHANC_PLUGIN_SINCE_SDK(
"1.5.7")
8273 const char* pathRegularExpression;
8281 } _OrthancPluginChunkedRestCallback;
8313 ORTHANC_PLUGIN_SINCE_SDK(
"1.5.7")
8316 const
char* pathRegularExpression,
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;
8335 context->InvokeService(context, _OrthancPluginService_RegisterChunkedRestCallback, ¶ms);
8347 const char* privateCreator;
8348 } _OrthancPluginGetTagName;
8365 ORTHANC_PLUGIN_SINCE_SDK(
"1.5.7")
8370 const
char* privateCreator)
8374 _OrthancPluginGetTagName params;
8375 params.result = &result;
8376 params.group = group;
8377 params.element = element;
8378 params.privateCreator = privateCreator;
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);
8459 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
8463 const
char* transactionUid,
8464 const
char* const* sopClassUids,
8465 const
char* const* sopInstanceUids,
8466 uint32_t countInstances,
8505 const
char* sopClassUid,
8506 const
char* sopInstanceUid);
8514 } _OrthancPluginRegisterStorageCommitmentScpCallback;
8529 ORTHANC_PLUGIN_SINCE_SDK(
"1.6.0")
8536 _OrthancPluginRegisterStorageCommitmentScpCallback params;
8537 params.factory = factory;
8538 params.destructor = destructor;
8539 params.lookup = lookup;
8540 return context->InvokeService(context, _OrthancPluginService_RegisterStorageCommitmentScpCallback, ¶ms);
8577 } _OrthancPluginIncomingDicomInstanceFilter;
8591 ORTHANC_PLUGIN_SINCE_SDK(
"1.6.1")
8596 _OrthancPluginIncomingDicomInstanceFilter params;
8597 params.callback = callback;
8599 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingDicomInstanceFilter, ¶ms);
8634 uint16_t* dimseStatus ,
8641 } _OrthancPluginIncomingCStoreInstanceFilter;
8655 ORTHANC_PLUGIN_SINCE_SDK(
"1.10.0")
8660 _OrthancPluginIncomingCStoreInstanceFilter params;
8661 params.callback = callback;
8663 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingCStoreInstanceFilter, ¶ms);
8703 const void* receivedDicomBuffer,
8704 uint64_t receivedDicomBufferSize,
8711 } _OrthancPluginReceivedInstanceCallback;
8733 ORTHANC_PLUGIN_SINCE_SDK(
"1.10.0")
8738 _OrthancPluginReceivedInstanceCallback params;
8739 params.callback = callback;
8741 return context->InvokeService(context, _OrthancPluginService_RegisterReceivedInstanceCallback, ¶ms);
8757 ORTHANC_PLUGIN_SINCE_SDK(
"1.6.1")
8764 _OrthancPluginAccessDicomInstance params;
8765 memset(¶ms, 0,
sizeof(params));
8766 params.resultStringToFree = &result;
8767 params.instance = instance;
8793 ORTHANC_PLUGIN_SINCE_SDK(
"1.6.1")
8798 int64_t hasPixelData;
8800 _OrthancPluginAccessDicomInstance params;
8801 memset(¶ms, 0,
sizeof(params));
8802 params.resultInt64 = &hasPixelData;
8803 params.instance = instance;
8814 return (hasPixelData != 0);
8828 const char* transferSyntax;
8829 } _OrthancPluginCreateDicomInstance;
8844 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
8852 _OrthancPluginCreateDicomInstance params;
8853 params.target = ⌖
8854 params.buffer = buffer;
8871 } _OrthancPluginFreeDicomInstance;
8883 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
8888 _OrthancPluginFreeDicomInstance params;
8889 params.dicom = dicom;
8891 context->InvokeService(context, _OrthancPluginService_FreeDicomInstance, ¶ms);
8897 uint32_t* targetUint32;
8900 char** targetStringToFree;
8902 uint32_t frameIndex;
8905 uint32_t maxStringLength;
8907 void* dicomWebPayload;
8908 } _OrthancPluginAccessDicomInstance2;
8921 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
8928 _OrthancPluginAccessDicomInstance2 params;
8929 memset(¶ms, 0,
sizeof(params));
8930 params.targetUint32 = &count;
8931 params.instance = instance;
8962 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
8967 uint32_t frameIndex)
8969 _OrthancPluginAccessDicomInstance2 params;
8970 memset(¶ms, 0,
sizeof(params));
8971 params.targetBuffer = target;
8972 params.instance = instance;
8973 params.frameIndex = frameIndex;
8975 return context->InvokeService(context, _OrthancPluginService_GetInstanceRawFrame, ¶ms);
8991 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
8995 uint32_t frameIndex)
8999 _OrthancPluginAccessDicomInstance2 params;
9000 memset(¶ms, 0,
sizeof(params));
9001 params.targetImage = ⌖
9002 params.instance = instance;
9003 params.frameIndex = frameIndex;
9031 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
9036 const
char* transferSyntax)
9040 _OrthancPluginCreateDicomInstance params;
9041 params.target = ⌖
9042 params.buffer = buffer;
9044 params.transferSyntax = transferSyntax;
9070 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
9076 _OrthancPluginAccessDicomInstance2 params;
9077 memset(¶ms, 0,
sizeof(params));
9078 params.targetBuffer = target;
9079 params.instance = instance;
9081 return context->InvokeService(context, _OrthancPluginService_SerializeDicomInstance, ¶ms);
9103 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
9109 uint32_t maxStringLength)
9111 char* result = NULL;
9113 _OrthancPluginAccessDicomInstance2 params;
9114 memset(¶ms, 0,
sizeof(params));
9115 params.targetStringToFree = &result;
9116 params.instance = instance;
9117 params.format = format;
9118 params.flags = flags;
9119 params.maxStringLength = maxStringLength;
9147 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
9154 char* target = NULL;
9156 _OrthancPluginAccessDicomInstance2 params;
9157 params.targetStringToFree = ⌖
9158 params.instance = instance;
9159 params.dicomWebCallback = callback;
9160 params.dicomWebPayload = payload;
9188 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
9195 char* target = NULL;
9197 _OrthancPluginAccessDicomInstance2 params;
9198 params.targetStringToFree = ⌖
9199 params.instance = instance;
9200 params.dicomWebCallback = callback;
9201 params.dicomWebPayload = payload;
9238 const char*
const* allowedSyntaxes,
9239 uint32_t countSyntaxes,
9240 uint8_t allowNewSopInstanceUid);
9246 } _OrthancPluginTranscoderCallback;
9261 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
9266 _OrthancPluginTranscoderCallback params;
9267 params.callback = callback;
9269 return context->InvokeService(context, _OrthancPluginService_RegisterTranscoderCallback, ¶ms);
9278 } _OrthancPluginCreateMemoryBuffer;
9297 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
9303 _OrthancPluginCreateMemoryBuffer params;
9304 params.target = target;
9307 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer, ¶ms);
9336 ORTHANC_PLUGIN_SINCE_SDK(
"1.8.1")
9342 _OrthancPluginRetrieveDynamicString params;
9343 params.result = &result;
9344 params.argument = NULL;
9346 if (context->InvokeService(context, _OrthancPluginService_GenerateRestApiAuthorizationToken,
9364 } _OrthancPluginCreateMemoryBuffer64;
9383 ORTHANC_PLUGIN_SINCE_SDK(
"1.9.0")
9389 _OrthancPluginCreateMemoryBuffer64 params;
9390 params.target = target;
9393 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer64, ¶ms);
9403 } _OrthancPluginRegisterStorageArea2;
9422 ORTHANC_PLUGIN_SINCE_SDK(
"1.9.0")
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, ¶ms);
9442 _OrthancPluginCreateDicom createDicom;
9443 const char* privateCreator;
9444 } _OrthancPluginCreateDicom2;
9470 ORTHANC_PLUGIN_SINCE_SDK(
"1.9.0")
9477 const
char* privateCreator)
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;
9486 return context->InvokeService(context, _OrthancPluginService_CreateDicom2, ¶ms);
9498 uint16_t* httpStatus;
9501 uint32_t headersCount;
9502 const char*
const* headersKeys;
9503 const char*
const* headersValues;
9506 uint8_t afterPlugins;
9507 } _OrthancPluginCallRestApi;
9539 ORTHANC_PLUGIN_SINCE_SDK(
"1.9.2")
9544 uint16_t* httpStatus,
9547 uint32_t headersCount,
9548 const
char* const* headersKeys,
9549 const
char* const* headersValues,
9552 uint8_t afterPlugins)
9554 _OrthancPluginCallRestApi params;
9555 memset(¶ms, 0,
sizeof(params));
9557 params.answerBody = answerBody;
9558 params.answerHeaders = answerHeaders;
9559 params.httpStatus = httpStatus;
9560 params.method = method;
9562 params.headersCount = headersCount;
9563 params.headersKeys = headersKeys;
9564 params.headersValues = headersValues;
9566 params.bodySize = bodySize;
9567 params.afterPlugins = afterPlugins;
9569 return context->InvokeService(context, _OrthancPluginService_CallRestApi, ¶ms);
9578 typedef struct ORTHANC_PLUGIN_SINCE_SDK(
"1.10.1")
9608 const char* mimeType,
9609 const char* dateTime);
9628 const char* dateTime);
9656 const char* mimeType,
9657 const char* dateTime);
9674 uint8_t* isExisting,
9676 const char*
const* pathItems,
9699 uint8_t* isExisting,
9704 const char*
const* pathItems,
9728 const char*
const* pathItems,
9748 uint8_t* isReadOnly,
9750 const char*
const* pathItems,
9770 uint8_t* isReadOnly,
9772 const char*
const* pathItems,
9790 uint8_t* isReadOnly,
9792 const char*
const* pathItems,
9806 } _OrthancPluginRegisterWebDavCollection;
9828 ORTHANC_PLUGIN_SINCE_SDK(
"1.10.1")
9840 _OrthancPluginRegisterWebDavCollection params;
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;
9850 return context->InvokeService(context, _OrthancPluginService_RegisterWebDavCollection, ¶ms);
9862 ORTHANC_PLUGIN_SINCE_SDK(
"1.11.1")
9868 _OrthancPluginRetrieveStaticString params;
9869 params.result = &result;
9870 params.argument = NULL;
9889 } _OrthancPluginRegisterStorageArea3;
9905 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
9912 _OrthancPluginRegisterStorageArea3 params;
9913 params.create = create;
9914 params.readRange = readRange;
9915 params.remove = remove;
9916 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea3, ¶ms);
9928 const void* request,
9929 uint64_t requestSize);
9941 uint32_t maxDatabaseRetries;
9944 } _OrthancPluginRegisterDatabaseBackendV4;
9963 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.0")
9967 uint32_t maxDatabaseRetries,
9971 _OrthancPluginRegisterDatabaseBackendV4 params;
9972 params.backend = backend;
9973 params.maxDatabaseRetries = maxDatabaseRetries;
9974 params.operations = operations;
9975 params.finalize = finalize;
9977 return context->InvokeService(context, _OrthancPluginService_RegisterDatabaseBackendV4, ¶ms);
9984 const char* instanceId;
9986 } _OrthancPluginLoadDicomInstance;
10001 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.1")
10004 const
char* instanceId,
10009 _OrthancPluginLoadDicomInstance params;
10010 params.target = ⌖
10011 params.instanceId = instanceId;
10012 params.mode = mode;
10031 } _OrthancPluginSetMetricsIntegerValue;
10048 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.1")
10055 _OrthancPluginSetMetricsIntegerValue params;
10056 params.name = name;
10057 params.value = value;
10058 params.type = type;
10059 context->InvokeService(context, _OrthancPluginService_SetMetricsIntegerValue, ¶ms);
10081 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.2")
10084 const
char* threadName)
10086 return context->InvokeService(context, _OrthancPluginService_SetCurrentThreadName, threadName);
10093 const char* message;
10094 const char* plugin;
10099 } _OrthancPluginLogMessage;
10115 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.4")
10118 const
char* message,
10119 const
char* plugin,
10125 _OrthancPluginLogMessage m;
10126 m.message = message;
10130 m.category = category;
10132 context->InvokeService(context, _OrthancPluginService_LogMessage, &m);
10139 const char* contentType;
10140 } _OrthancPluginStartStreamAnswer;
10154 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.6")
10158 const
char* contentType)
10160 _OrthancPluginStartStreamAnswer params;
10161 params.output = output;
10162 params.contentType = contentType;
10163 return context->InvokeService(context, _OrthancPluginService_StartStreamAnswer, ¶ms);
10182 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.6")
10186 const
void* answer,
10187 uint32_t answerSize)
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, ¶ms);
10204 uint64_t dicomSize;
10205 const void* customData;
10206 uint32_t customDataSize;
10207 } _OrthancPluginAdoptDicomInstance;
10247 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10254 uint64_t dicomSize,
10255 const
void* customData,
10256 uint32_t customDataSize)
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;
10267 return context->InvokeService(context, _OrthancPluginService_AdoptDicomInstance, ¶ms);
10274 const char* attachmentUuid;
10275 } _OrthancPluginGetAttachmentCustomData;
10289 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10293 const
char* attachmentUuid )
10295 _OrthancPluginGetAttachmentCustomData params;
10296 params.customData = customData;
10297 params.attachmentUuid = attachmentUuid;
10299 return context->InvokeService(context, _OrthancPluginService_GetAttachmentCustomData, ¶ms);
10305 const char* attachmentUuid;
10306 const void* customData;
10307 uint32_t customDataSize;
10308 } _OrthancPluginSetAttachmentCustomData;
10322 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10325 const
char* attachmentUuid,
10326 const
void* customData,
10327 uint32_t customDataSize )
10329 _OrthancPluginSetAttachmentCustomData params;
10330 params.attachmentUuid = attachmentUuid;
10331 params.customData = customData;
10332 params.customDataSize = customDataSize;
10334 return context->InvokeService(context, _OrthancPluginService_SetAttachmentCustomData, ¶ms);
10340 const char* storeId;
10343 uint32_t valueSize;
10344 } _OrthancPluginStoreKeyValue;
10356 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10359 const
char* storeId,
10362 uint32_t valueSize )
10364 _OrthancPluginStoreKeyValue params;
10365 params.storeId = storeId;
10367 params.value = value;
10368 params.valueSize = valueSize;
10370 return context->InvokeService(context, _OrthancPluginService_StoreKeyValue, ¶ms);
10376 const char* storeId;
10378 } _OrthancPluginDeleteKeyValue;
10388 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10391 const
char* storeId,
10394 _OrthancPluginDeleteKeyValue params;
10395 params.storeId = storeId;
10398 return context->InvokeService(context, _OrthancPluginService_DeleteKeyValue, ¶ms);
10406 const char* storeId;
10408 } _OrthancPluginGetKeyValue;
10421 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10426 const
char* storeId,
10429 _OrthancPluginGetKeyValue params;
10430 params.found = found;
10431 params.target = target;
10432 params.storeId = storeId;
10435 return context->InvokeService(context, _OrthancPluginService_GetKeyValue, ¶ms);
10444 typedef struct ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10451 const char* storeId;
10452 } _OrthancPluginCreateKeysValuesIterator;
10465 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10468 const
char* storeId)
10472 _OrthancPluginCreateKeysValuesIterator params;
10473 params.target = ⌖
10474 params.storeId = storeId;
10490 } _OrthancPluginFreeKeysValuesIterator;
10498 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10503 _OrthancPluginFreeKeysValuesIterator params;
10504 params.iterator = iterator;
10506 context->InvokeService(context, _OrthancPluginService_FreeKeysValuesIterator, ¶ms);
10514 } _OrthancPluginKeysValuesIteratorNext;
10526 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10532 _OrthancPluginKeysValuesIteratorNext params;
10533 params.done = done;
10534 params.iterator = iterator;
10536 return context->InvokeService(context, _OrthancPluginService_KeysValuesIteratorNext, ¶ms);
10542 const char** target;
10544 } _OrthancPluginKeysValuesIteratorGetKey;
10556 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10561 const char* target = NULL;
10563 _OrthancPluginKeysValuesIteratorGetKey params;
10564 params.target = ⌖
10565 params.iterator = iterator;
10582 } _OrthancPluginKeysValuesIteratorGetValue;
10596 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10602 _OrthancPluginKeysValuesIteratorGetValue params;
10603 params.target = target;
10604 params.iterator = iterator;
10606 return context->InvokeService(context, _OrthancPluginService_KeysValuesIteratorGetValue, ¶ms);
10612 const char* queueId;
10614 uint32_t valueSize;
10615 } _OrthancPluginEnqueueValue;
10626 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10629 const
char* queueId,
10631 uint32_t valueSize )
10633 _OrthancPluginEnqueueValue params;
10634 params.queueId = queueId;
10635 params.value = value;
10636 params.valueSize = valueSize;
10638 return context->InvokeService(context, _OrthancPluginService_EnqueueValue, ¶ms);
10646 const char* queueId;
10648 } _OrthancPluginDequeueValue;
10663 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10668 const
char* queueId,
10671 _OrthancPluginDequeueValue params;
10672 params.found = found;
10673 params.target = target;
10674 params.queueId = queueId;
10675 params.origin = origin;
10677 return context->InvokeService(context, _OrthancPluginService_DequeueValue, ¶ms);
10683 const char* queueId;
10685 } _OrthancPluginGetQueueSize;
10695 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10698 const
char* queueId,
10701 _OrthancPluginGetQueueSize params;
10702 params.queueId = queueId;
10703 params.size = size;
10705 return context->InvokeService(context, _OrthancPluginService_GetQueueSize, ¶ms);
10711 const char* resourceId;
10713 uint8_t* statusHasChanged;
10714 } _OrthancPluginSetStableStatus;
10736 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.9")
10739 uint8_t* statusHasChanged,
10740 const
char* resourceId,
10743 _OrthancPluginSetStableStatus params;
10744 params.resourceId = resourceId;
10745 params.stableStatus= stableStatus;
10746 params.statusHasChanged = statusHasChanged;
10748 return context->InvokeService(context, _OrthancPluginService_SetStableStatus, ¶ms);
10780 uint32_t headersCount,
10781 const char*
const* headersKeys,
10782 const char*
const* headersValues,
10784 const char*
const* getKeys,
10785 const char*
const* getValues);
10791 } _OrthancPluginHttpAuthentication;
10832 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.9")
10837 _OrthancPluginHttpAuthentication params;
10838 params.callback = callback;
10840 return context->InvokeService(context, _OrthancPluginService_RegisterHttpAuthentication, ¶ms);
10846 const char* sourcePlugin;
10847 const char* userId;
10849 const char* resourceId;
10850 const char* action;
10851 const void* logData;
10852 uint32_t logDataSize;
10853 } _OrthancPluginEmitAuditLog;
10878 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.9")
10881 const
char* sourcePlugin,
10882 const
char* userId,
10884 const
char* resourceId,
10885 const
char* action,
10886 const
void* logData,
10887 uint32_t logDataSize)
10889 _OrthancPluginEmitAuditLog m;
10890 m.sourcePlugin = sourcePlugin;
10892 m.resourceType = resourceType;
10893 m.resourceId = resourceId;
10895 m.logData = logData;
10896 m.logDataSize = logDataSize;
10897 context->InvokeService(context, _OrthancPluginService_EmitAuditLog, &m);
10920 const char* sourcePlugin,
10921 const char* userId,
10923 const char* resourceId,
10924 const char* action,
10925 const void* logData,
10926 uint32_t logDataSize);
10931 } _OrthancPluginAuditLogHandler;
10944 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.9")
10949 _OrthancPluginAuditLogHandler params;
10950 params.handler = handler;
10952 return context->InvokeService(context, _OrthancPluginService_RegisterAuditLogHandler, ¶ms);
10960 const char* queueId;
10962 uint32_t releaseTimeout;
10964 } _OrthancPluginReserveQueueValue;
10987 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
10993 const
char* queueId,
10995 uint32_t releaseTimeout )
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;
11005 return context->InvokeService(context, _OrthancPluginService_ReserveQueueValue, ¶ms);
11010 const char* queueId;
11012 } _OrthancPluginAcknowledgeQueueValue;
11023 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
11026 const
char* queueId,
11029 _OrthancPluginAcknowledgeQueueValue params;
11030 params.queueId = queueId;
11031 params.valueId = valueId;
11033 return context->InvokeService(context, _OrthancPluginService_AcknowledgeQueueValue, ¶ms);
11040 const char** resultString;
11041 } _OrthancPluginAccessDicomConnection;
11054 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
11059 const char* result;
11061 _OrthancPluginAccessDicomConnection params;
11062 memset(¶ms, 0,
sizeof(params));
11063 params.resultString = &result;
11064 params.connection = connection;
11089 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
11094 const char* result;
11096 _OrthancPluginAccessDicomConnection params;
11097 memset(¶ms, 0,
sizeof(params));
11098 params.resultString = &result;
11099 params.connection = connection;
11124 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
11129 const char* result;
11131 _OrthancPluginAccessDicomConnection params;
11132 memset(¶ms, 0,
sizeof(params));
11133 params.resultString = &result;
11134 params.connection = connection;
11151 } _OrthancPluginWorklistCallback2;
11164 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
11169 _OrthancPluginWorklistCallback2 params;
11170 params.callback = callback;
11172 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback2, ¶ms);
11179 } _OrthancPluginFindCallback2;
11192 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
11197 _OrthancPluginFindCallback2 params;
11198 params.callback = callback;
11200 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback2, ¶ms);
11210 } _OrthancPluginMoveCallback2;
11225 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
11233 _OrthancPluginMoveCallback2 params;
11234 params.callback = callback;
11235 params.getMoveSize = getMoveSize;
11236 params.applyMove = applyMove;
11237 params.freeMove = freeMove;
11239 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback2, ¶ms);
11248 } _OrthancPluginRegisterStorageCommitmentScpCallback2;
11263 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
11270 _OrthancPluginRegisterStorageCommitmentScpCallback2 params;
11271 params.factory = factory;
11272 params.destructor = destructor;
11273 params.lookup = lookup;
11274 return context->InvokeService(context, _OrthancPluginService_RegisterStorageCommitmentScpCallback2, ¶ms);
11291 ORTHANC_PLUGIN_SINCE_SDK(
"1.13.0")
11295 return context->InvokeService(context, _OrthancPluginService_ClearCurrentThreadName, NULL);
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
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