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 12
129 #define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 10
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)
350 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
358 ORTHANC_PLUGINS_API
const char* OrthancPluginGetName();
371 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
464 _OrthancPluginService_LogInfo = 1,
465 _OrthancPluginService_LogWarning = 2,
466 _OrthancPluginService_LogError = 3,
467 _OrthancPluginService_GetOrthancPath = 4,
468 _OrthancPluginService_GetOrthancDirectory = 5,
469 _OrthancPluginService_GetConfigurationPath = 6,
470 _OrthancPluginService_SetPluginProperty = 7,
471 _OrthancPluginService_GetGlobalProperty = 8,
472 _OrthancPluginService_SetGlobalProperty = 9,
473 _OrthancPluginService_GetCommandLineArgumentsCount = 10,
474 _OrthancPluginService_GetCommandLineArgument = 11,
475 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
476 _OrthancPluginService_GetConfiguration = 13,
477 _OrthancPluginService_BufferCompression = 14,
478 _OrthancPluginService_ReadFile = 15,
479 _OrthancPluginService_WriteFile = 16,
480 _OrthancPluginService_GetErrorDescription = 17,
481 _OrthancPluginService_CallHttpClient = 18,
482 _OrthancPluginService_RegisterErrorCode = 19,
483 _OrthancPluginService_RegisterDictionaryTag = 20,
484 _OrthancPluginService_DicomBufferToJson = 21,
485 _OrthancPluginService_DicomInstanceToJson = 22,
486 _OrthancPluginService_CreateDicom = 23,
487 _OrthancPluginService_ComputeMd5 = 24,
488 _OrthancPluginService_ComputeSha1 = 25,
489 _OrthancPluginService_LookupDictionary = 26,
490 _OrthancPluginService_CallHttpClient2 = 27,
491 _OrthancPluginService_GenerateUuid = 28,
492 _OrthancPluginService_RegisterPrivateDictionaryTag = 29,
493 _OrthancPluginService_AutodetectMimeType = 30,
494 _OrthancPluginService_SetMetricsValue = 31,
495 _OrthancPluginService_EncodeDicomWebJson = 32,
496 _OrthancPluginService_EncodeDicomWebXml = 33,
497 _OrthancPluginService_ChunkedHttpClient = 34,
498 _OrthancPluginService_GetTagName = 35,
499 _OrthancPluginService_EncodeDicomWebJson2 = 36,
500 _OrthancPluginService_EncodeDicomWebXml2 = 37,
501 _OrthancPluginService_CreateMemoryBuffer = 38,
502 _OrthancPluginService_GenerateRestApiAuthorizationToken = 39,
503 _OrthancPluginService_CreateMemoryBuffer64 = 40,
504 _OrthancPluginService_CreateDicom2 = 41,
505 _OrthancPluginService_GetDatabaseServerIdentifier = 42,
506 _OrthancPluginService_SetMetricsIntegerValue = 43,
507 _OrthancPluginService_SetCurrentThreadName = 44,
508 _OrthancPluginService_LogMessage = 45,
509 _OrthancPluginService_AdoptDicomInstance = 46,
510 _OrthancPluginService_GetAttachmentCustomData = 47,
511 _OrthancPluginService_SetAttachmentCustomData = 48,
512 _OrthancPluginService_StoreKeyValue = 49,
513 _OrthancPluginService_DeleteKeyValue = 50,
514 _OrthancPluginService_GetKeyValue = 51,
515 _OrthancPluginService_CreateKeysValuesIterator = 52,
516 _OrthancPluginService_FreeKeysValuesIterator = 53,
517 _OrthancPluginService_KeysValuesIteratorNext = 54,
518 _OrthancPluginService_KeysValuesIteratorGetKey = 55,
519 _OrthancPluginService_KeysValuesIteratorGetValue = 56,
520 _OrthancPluginService_EnqueueValue = 57,
521 _OrthancPluginService_DequeueValue = 58,
522 _OrthancPluginService_GetQueueSize = 59,
523 _OrthancPluginService_SetStableStatus = 60,
524 _OrthancPluginService_EmitAuditLog = 61,
525 _OrthancPluginService_ReserveQueueValue = 62,
526 _OrthancPluginService_AcknowledgeQueueValue = 63,
529 _OrthancPluginService_RegisterRestCallback = 1000,
530 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
531 _OrthancPluginService_RegisterStorageArea = 1002,
532 _OrthancPluginService_RegisterOnChangeCallback = 1003,
533 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
534 _OrthancPluginService_RegisterWorklistCallback = 1005,
535 _OrthancPluginService_RegisterDecodeImageCallback = 1006,
536 _OrthancPluginService_RegisterIncomingHttpRequestFilter = 1007,
537 _OrthancPluginService_RegisterFindCallback = 1008,
538 _OrthancPluginService_RegisterMoveCallback = 1009,
539 _OrthancPluginService_RegisterIncomingHttpRequestFilter2 = 1010,
540 _OrthancPluginService_RegisterRefreshMetricsCallback = 1011,
541 _OrthancPluginService_RegisterChunkedRestCallback = 1012,
542 _OrthancPluginService_RegisterStorageCommitmentScpCallback = 1013,
543 _OrthancPluginService_RegisterIncomingDicomInstanceFilter = 1014,
544 _OrthancPluginService_RegisterTranscoderCallback = 1015,
545 _OrthancPluginService_RegisterStorageArea2 = 1016,
546 _OrthancPluginService_RegisterIncomingCStoreInstanceFilter = 1017,
547 _OrthancPluginService_RegisterReceivedInstanceCallback = 1018,
548 _OrthancPluginService_RegisterWebDavCollection = 1019,
549 _OrthancPluginService_RegisterStorageArea3 = 1020,
550 _OrthancPluginService_RegisterHttpAuthentication = 1021,
551 _OrthancPluginService_RegisterAuditLogHandler = 1022,
552 _OrthancPluginService_RegisterFindCallback2 = 1023,
553 _OrthancPluginService_RegisterMoveCallback2 = 1024,
554 _OrthancPluginService_RegisterWorklistCallback2 = 1025,
555 _OrthancPluginService_RegisterStorageCommitmentScpCallback2 = 1026,
558 _OrthancPluginService_AnswerBuffer = 2000,
559 _OrthancPluginService_CompressAndAnswerPngImage = 2001,
560 _OrthancPluginService_Redirect = 2002,
561 _OrthancPluginService_SendHttpStatusCode = 2003,
562 _OrthancPluginService_SendUnauthorized = 2004,
563 _OrthancPluginService_SendMethodNotAllowed = 2005,
564 _OrthancPluginService_SetCookie = 2006,
565 _OrthancPluginService_SetHttpHeader = 2007,
566 _OrthancPluginService_StartMultipartAnswer = 2008,
567 _OrthancPluginService_SendMultipartItem = 2009,
568 _OrthancPluginService_SendHttpStatus = 2010,
569 _OrthancPluginService_CompressAndAnswerImage = 2011,
570 _OrthancPluginService_SendMultipartItem2 = 2012,
571 _OrthancPluginService_SetHttpErrorDetails = 2013,
572 _OrthancPluginService_StartStreamAnswer = 2014,
573 _OrthancPluginService_SendStreamChunk = 2015,
576 _OrthancPluginService_GetDicomForInstance = 3000,
577 _OrthancPluginService_RestApiGet = 3001,
578 _OrthancPluginService_RestApiPost = 3002,
579 _OrthancPluginService_RestApiDelete = 3003,
580 _OrthancPluginService_RestApiPut = 3004,
581 _OrthancPluginService_LookupPatient = 3005,
582 _OrthancPluginService_LookupStudy = 3006,
583 _OrthancPluginService_LookupSeries = 3007,
584 _OrthancPluginService_LookupInstance = 3008,
585 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
586 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
587 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
588 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
589 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
590 _OrthancPluginService_ReconstructMainDicomTags = 3014,
591 _OrthancPluginService_RestApiGet2 = 3015,
592 _OrthancPluginService_CallRestApi = 3016,
595 _OrthancPluginService_GetInstanceRemoteAet = 4000,
596 _OrthancPluginService_GetInstanceSize = 4001,
597 _OrthancPluginService_GetInstanceData = 4002,
598 _OrthancPluginService_GetInstanceJson = 4003,
599 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
600 _OrthancPluginService_HasInstanceMetadata = 4005,
601 _OrthancPluginService_GetInstanceMetadata = 4006,
602 _OrthancPluginService_GetInstanceOrigin = 4007,
603 _OrthancPluginService_GetInstanceTransferSyntaxUid = 4008,
604 _OrthancPluginService_HasInstancePixelData = 4009,
605 _OrthancPluginService_CreateDicomInstance = 4010,
606 _OrthancPluginService_FreeDicomInstance = 4011,
607 _OrthancPluginService_GetInstanceFramesCount = 4012,
608 _OrthancPluginService_GetInstanceRawFrame = 4013,
609 _OrthancPluginService_GetInstanceDecodedFrame = 4014,
610 _OrthancPluginService_TranscodeDicomInstance = 4015,
611 _OrthancPluginService_SerializeDicomInstance = 4016,
612 _OrthancPluginService_GetInstanceAdvancedJson = 4017,
613 _OrthancPluginService_GetInstanceDicomWebJson = 4018,
614 _OrthancPluginService_GetInstanceDicomWebXml = 4019,
615 _OrthancPluginService_LoadDicomInstance = 4020,
618 _OrthancPluginService_RegisterDatabaseBackend = 5000,
619 _OrthancPluginService_DatabaseAnswer = 5001,
620 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002,
621 _OrthancPluginService_StorageAreaCreate = 5003,
622 _OrthancPluginService_StorageAreaRead = 5004,
623 _OrthancPluginService_StorageAreaRemove = 5005,
624 _OrthancPluginService_RegisterDatabaseBackendV3 = 5006,
625 _OrthancPluginService_RegisterDatabaseBackendV4 = 5007,
628 _OrthancPluginService_GetImagePixelFormat = 6000,
629 _OrthancPluginService_GetImageWidth = 6001,
630 _OrthancPluginService_GetImageHeight = 6002,
631 _OrthancPluginService_GetImagePitch = 6003,
632 _OrthancPluginService_GetImageBuffer = 6004,
633 _OrthancPluginService_UncompressImage = 6005,
634 _OrthancPluginService_FreeImage = 6006,
635 _OrthancPluginService_CompressImage = 6007,
636 _OrthancPluginService_ConvertPixelFormat = 6008,
637 _OrthancPluginService_GetFontsCount = 6009,
638 _OrthancPluginService_GetFontInfo = 6010,
639 _OrthancPluginService_DrawText = 6011,
640 _OrthancPluginService_CreateImage = 6012,
641 _OrthancPluginService_CreateImageAccessor = 6013,
642 _OrthancPluginService_DecodeDicomImage = 6014,
645 _OrthancPluginService_WorklistAddAnswer = 7000,
646 _OrthancPluginService_WorklistMarkIncomplete = 7001,
647 _OrthancPluginService_WorklistIsMatch = 7002,
648 _OrthancPluginService_WorklistGetDicomQuery = 7003,
649 _OrthancPluginService_FindAddAnswer = 7004,
650 _OrthancPluginService_FindMarkIncomplete = 7005,
651 _OrthancPluginService_GetFindQuerySize = 7006,
652 _OrthancPluginService_GetFindQueryTag = 7007,
653 _OrthancPluginService_GetFindQueryTagName = 7008,
654 _OrthancPluginService_GetFindQueryValue = 7009,
655 _OrthancPluginService_CreateFindMatcher = 7010,
656 _OrthancPluginService_FreeFindMatcher = 7011,
657 _OrthancPluginService_FindMatcherIsMatch = 7012,
660 _OrthancPluginService_GetPeers = 8000,
661 _OrthancPluginService_FreePeers = 8001,
662 _OrthancPluginService_GetPeersCount = 8003,
663 _OrthancPluginService_GetPeerName = 8004,
664 _OrthancPluginService_GetPeerUrl = 8005,
665 _OrthancPluginService_CallPeerApi = 8006,
666 _OrthancPluginService_GetPeerUserProperty = 8007,
669 _OrthancPluginService_CreateJob = 9000,
670 _OrthancPluginService_FreeJob = 9001,
671 _OrthancPluginService_SubmitJob = 9002,
672 _OrthancPluginService_RegisterJobsUnserializer = 9003,
673 _OrthancPluginService_CreateJob2 = 9004,
676 _OrthancPluginService_GetConnectionRemoteAet = 10000,
677 _OrthancPluginService_GetConnectionRemoteIp = 10001,
678 _OrthancPluginService_GetConnectionCalledAet = 10002,
680 _OrthancPluginService_INTERNAL = 0x7fffffff
681 } _OrthancPluginService;
686 _OrthancPluginProperty_Description = 1,
687 _OrthancPluginProperty_RootUri = 2,
688 _OrthancPluginProperty_OrthancExplorer = 3,
690 _OrthancPluginProperty_INTERNAL = 0x7fffffff
691 } _OrthancPluginProperty;
783 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
798 _OrthancPluginContentType_INTERNAL = 0x7fffffff
814 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
846 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
862 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
876 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
914 _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff
929 _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff
950 _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff
965 _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff
981 _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff
997 _OrthancPluginConstraintType_INTERNAL = 0x7fffffff
1013 _OrthancPluginInstanceOrigin_INTERNAL = 0x7fffffff
1020 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
1034 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
1046 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.5.4")
1063 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.5.4")
1076 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.6.0")
1124 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.10.0")
1130 _OrthancPluginReceivedInstanceAction_INTERNAL = 0x7fffffff
1138 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.12.1")
1158 _OrthancPluginLoadDicomInstanceMode_INTERNAL = 0x7fffffff
1168 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.12.4")
1175 _OrthancPluginLogLevel_INTERNAL = 0x7fffffff
1185 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.12.4")
1195 _OrthancPluginLogCategory_INTERNAL = 0x7fffffff
1202 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
1210 _OrthancPluginStoreStatus_INTERNAL = 0x7fffffff
1217 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
1222 _OrthancPluginQueueOrigin_INTERNAL = 0x7fffffff
1229 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.12.9")
1234 _OrthancPluginStableStatus_INTERNAL = 0x7fffffff
1241 typedef enum ORTHANC_PLUGIN_SINCE_SDK(
"1.12.9")
1248 _OrthancPluginHttpAuthenticationStatus_INTERNAL = 0x7fffffff
1281 ORTHANC_PLUGIN_SINCE_SDK(
"1.9.0") typedef struct
1349 typedef struct ORTHANC_PLUGIN_SINCE_SDK("1.1.0")
1358 typedef struct ORTHANC_PLUGIN_SINCE_SDK("1.1.0")
1367 typedef struct ORTHANC_PLUGIN_SINCE_SDK("1.2.0")
1376 typedef struct ORTHANC_PLUGIN_SINCE_SDK("1.4.2")
1385 typedef struct ORTHANC_PLUGIN_SINCE_SDK("1.4.2")
1395 typedef struct ORTHANC_PLUGIN_SINCE_SDK("1.5.4")
1403 typedef struct ORTHANC_PLUGIN_SINCE_SDK("1.12.10")
1424 const char* instanceId);
1435 const char* resourceId);
1446 const uint32_t size,
1447 uint32_t frameIndex);
1468 const char* bulkDataUri);
1486 const void* content,
1557 uint64_t rangeStart);
1598 const void* content,
1628 uint64_t rangeStart,
1629 const void* customData,
1630 uint32_t customDataSize);
1650 const void* customData,
1651 uint32_t customDataSize);
1670 const char* issuerAet,
1671 const char* calledAet);
1686 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
1720 uint32_t headersCount,
1721 const
char* const* headersKeys,
1722 const
char* const* headersValues);
1759 uint32_t headersCount,
1760 const
char* const* headersKeys,
1761 const
char* const* headersValues,
1762 uint32_t getArgumentsCount,
1763 const
char* const* getArgumentsKeys,
1764 const
char* const* getArgumentsValues);
1785 const
char* issuerAet,
1786 const
char* calledAet);
1802 ORTHANC_PLUGIN_SINCE_SDK("1.12.10")
1846 const
char* patientId,
1847 const
char* accessionNumber,
1848 const
char* studyInstanceUid,
1849 const
char* seriesInstanceUid,
1850 const
char* sopInstanceUid,
1851 const
char* originatorAet,
1852 const
char* sourceAet,
1853 const
char* targetAet,
1854 uint16_t originatorId);
1889 ORTHANC_PLUGIN_SINCE_SDK("1.12.10")
1892 const
char* patientId,
1893 const
char* accessionNumber,
1894 const
char* studyInstanceUid,
1895 const
char* seriesInstanceUid,
1896 const
char* sopInstanceUid,
1898 const
char* targetAet,
1899 uint16_t originatorId);
2117 const
char* serialized);
2166 uint32_t levelDepth,
2167 const uint16_t* levelTagGroup,
2168 const uint16_t* levelTagElement,
2169 const uint32_t* levelIndex,
2171 uint16_t tagElement,
2204 uint32_t levelDepth,
2205 const uint16_t* levelTagGroup,
2206 const uint16_t* levelTagElement,
2207 const uint32_t* levelIndex,
2209 uint16_t tagElement,
2218 typedef struct _OrthancPluginContext_t
2220 void* pluginsManager;
2221 const char* orthancVersion;
2224 _OrthancPluginService service,
2225 const void* params);
2282 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.0")
2285 int32_t expectedMajor,
2286 int32_t expectedMinor,
2287 int32_t expectedRevision)
2289 int32_t major, minor, revision;
2291 if (
sizeof(
int) !=
sizeof(int32_t) ||
2294 sizeof(int32_t) !=
sizeof(_OrthancPluginService) ||
2295 sizeof(int32_t) !=
sizeof(_OrthancPluginProperty) ||
2328 if (!strcmp(context->orthancVersion,
"mainline"))
2340 (context->orthancVersion,
"%4d.%4d.%4d", &major, &minor, &revision) != 3)
2347 if (major > expectedMajor)
2352 if (major < expectedMajor)
2359 if (minor > expectedMinor)
2364 if (minor < expectedMinor)
2371 if (revision >= expectedRevision)
2403 ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER,
2404 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER,
2405 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER);
2421 context->Free(buffer->
data);
2433 ORTHANC_PLUGIN_SINCE_SDK(
"1.9.0")
2438 context->Free(buffer->data);
2452 const char* message)
2454 context->InvokeService(context, _OrthancPluginService_LogError, message);
2468 const char* message)
2470 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
2484 const char* message)
2486 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
2493 const char* pathRegularExpression;
2495 } _OrthancPluginRestCallback;
2520 const char* pathRegularExpression,
2523 _OrthancPluginRestCallback params;
2524 params.pathRegularExpression = pathRegularExpression;
2525 params.callback = callback;
2526 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
2560 const char* pathRegularExpression,
2563 _OrthancPluginRestCallback params;
2564 params.pathRegularExpression = pathRegularExpression;
2565 params.callback = callback;
2566 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms);
2574 } _OrthancPluginOnStoredInstanceCallback;
2600 _OrthancPluginOnStoredInstanceCallback params;
2601 params.callback = callback;
2603 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
2612 uint32_t answerSize;
2613 const char* mimeType;
2614 } _OrthancPluginAnswerBuffer;
2632 uint32_t answerSize,
2633 const char* mimeType)
2635 _OrthancPluginAnswerBuffer params;
2636 params.output = output;
2637 params.answer = answer;
2638 params.answerSize = answerSize;
2639 params.mimeType = mimeType;
2640 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms);
2652 } _OrthancPluginCompressAndAnswerPngImage;
2664 } _OrthancPluginCompressAndAnswerImage;
2694 _OrthancPluginCompressAndAnswerImage params;
2695 params.output = output;
2697 params.pixelFormat = format;
2698 params.width = width;
2699 params.height = height;
2700 params.pitch = pitch;
2701 params.buffer = buffer;
2703 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
2711 const char* instanceId;
2712 } _OrthancPluginGetDicomForInstance;
2729 const char* instanceId)
2731 _OrthancPluginGetDicomForInstance params;
2732 params.target = target;
2733 params.instanceId = instanceId;
2734 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
2743 } _OrthancPluginRestApiGet;
2764 _OrthancPluginRestApiGet params;
2765 params.target = target;
2767 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
2794 _OrthancPluginRestApiGet params;
2795 params.target = target;
2797 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms);
2808 } _OrthancPluginRestApiPostPut;
2833 _OrthancPluginRestApiPostPut params;
2834 params.target = target;
2837 params.bodySize = bodySize;
2838 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
2868 _OrthancPluginRestApiPostPut params;
2869 params.target = target;
2872 params.bodySize = bodySize;
2873 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms);
2894 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
2917 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
2945 _OrthancPluginRestApiPostPut params;
2946 params.target = target;
2949 params.bodySize = bodySize;
2950 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
2981 _OrthancPluginRestApiPostPut params;
2982 params.target = target;
2985 params.bodySize = bodySize;
2986 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms);
2994 const char* argument;
2995 } _OrthancPluginOutputPlusArgument;
3011 const char* redirection)
3013 _OrthancPluginOutputPlusArgument params;
3014 params.output = output;
3015 params.argument = redirection;
3016 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
3024 const char* argument;
3025 } _OrthancPluginRetrieveDynamicString;
3042 const char* patientID)
3046 _OrthancPluginRetrieveDynamicString params;
3047 params.result = &result;
3048 params.argument = patientID;
3077 const char* studyUID)
3081 _OrthancPluginRetrieveDynamicString params;
3082 params.result = &result;
3083 params.argument = studyUID;
3112 const char* accessionNumber)
3116 _OrthancPluginRetrieveDynamicString params;
3117 params.result = &result;
3118 params.argument = accessionNumber;
3147 const char* seriesUID)
3151 _OrthancPluginRetrieveDynamicString params;
3152 params.result = &result;
3153 params.argument = seriesUID;
3182 const char* sopInstanceUID)
3186 _OrthancPluginRetrieveDynamicString params;
3187 params.result = &result;
3188 params.argument = sopInstanceUID;
3207 } _OrthancPluginSendHttpStatusCode;
3230 _OrthancPluginSendHttpStatusCode params;
3231 params.output = output;
3232 params.status = status;
3233 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
3253 _OrthancPluginOutputPlusArgument params;
3254 params.output = output;
3255 params.argument = realm;
3256 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
3274 const char* allowedMethods)
3276 _OrthancPluginOutputPlusArgument params;
3277 params.output = output;
3278 params.argument = allowedMethods;
3279 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
3288 } _OrthancPluginSetHttpHeader;
3307 _OrthancPluginSetHttpHeader params;
3308 params.output = output;
3309 params.key = cookie;
3310 params.value = value;
3311 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
3332 _OrthancPluginSetHttpHeader params;
3333 params.output = output;
3335 params.value = value;
3336 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
3342 char** resultStringToFree;
3343 const char** resultString;
3344 int64_t* resultInt64;
3348 } _OrthancPluginAccessDicomInstance;
3368 _OrthancPluginAccessDicomInstance params;
3369 memset(¶ms, 0,
sizeof(params));
3370 params.resultString = &result;
3371 params.instance = instance;
3401 _OrthancPluginAccessDicomInstance params;
3402 memset(¶ms, 0,
sizeof(params));
3403 params.resultInt64 = &size;
3404 params.instance = instance;
3434 _OrthancPluginAccessDicomInstance params;
3435 memset(¶ms, 0,
sizeof(params));
3436 params.resultString = &result;
3437 params.instance = instance;
3470 _OrthancPluginAccessDicomInstance params;
3471 memset(¶ms, 0,
sizeof(params));
3472 params.resultStringToFree = &result;
3473 params.instance = instance;
3508 _OrthancPluginAccessDicomInstance params;
3509 memset(¶ms, 0,
sizeof(params));
3510 params.resultStringToFree = &result;
3511 params.instance = instance;
3544 const char* metadata)
3548 _OrthancPluginAccessDicomInstance params;
3549 memset(¶ms, 0,
sizeof(params));
3550 params.resultInt64 = &result;
3551 params.instance = instance;
3552 params.key = metadata;
3561 return (result != 0);
3585 const char* metadata)
3589 _OrthancPluginAccessDicomInstance params;
3590 memset(¶ms, 0,
sizeof(params));
3591 params.resultString = &result;
3592 params.instance = instance;
3593 params.key = metadata;
3614 } _OrthancPluginRegisterStorageArea;
3637 _OrthancPluginRegisterStorageArea params;
3638 params.create = create;
3640 params.remove = remove;
3643 params.free = ::free;
3648 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
3667 _OrthancPluginRetrieveDynamicString params;
3668 params.result = &result;
3669 params.argument = NULL;
3697 _OrthancPluginRetrieveDynamicString params;
3698 params.result = &result;
3699 params.argument = NULL;
3732 _OrthancPluginRetrieveDynamicString params;
3733 params.result = &result;
3734 params.argument = NULL;
3752 } _OrthancPluginOnChangeCallback;
3778 _OrthancPluginOnChangeCallback params;
3779 params.callback = callback;
3781 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms);
3789 _OrthancPluginProperty property;
3791 } _OrthancPluginSetPluginProperty;
3813 _OrthancPluginSetPluginProperty params;
3814 params.plugin = OrthancPluginGetName();
3815 params.property = _OrthancPluginProperty_RootUri;
3818 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3834 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.4")
3840 _OrthancPluginSetPluginProperty params;
3841 params.plugin = plugin;
3842 params.property = _OrthancPluginProperty_RootUri;
3845 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3864 const char* description)
3866 _OrthancPluginSetPluginProperty params;
3867 params.plugin = OrthancPluginGetName();
3868 params.property = _OrthancPluginProperty_Description;
3869 params.value = description;
3871 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3885 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.4")
3889 const
char* description)
3891 _OrthancPluginSetPluginProperty params;
3892 params.plugin = plugin;
3893 params.property = _OrthancPluginProperty_Description;
3894 params.value = description;
3896 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3915 const char* javascript)
3917 _OrthancPluginSetPluginProperty params;
3918 params.plugin = OrthancPluginGetName();
3919 params.property = _OrthancPluginProperty_OrthancExplorer;
3920 params.value = javascript;
3922 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3936 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.4")
3940 const
char* javascript)
3942 _OrthancPluginSetPluginProperty params;
3943 params.plugin = plugin;
3944 params.property = _OrthancPluginProperty_OrthancExplorer;
3945 params.value = javascript;
3947 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3956 } _OrthancPluginGlobalProperty;
3975 const char* defaultValue)
3979 _OrthancPluginGlobalProperty params;
3980 params.result = &result;
3981 params.property = property;
3982 params.value = defaultValue;
4016 _OrthancPluginGlobalProperty params;
4017 params.result = NULL;
4018 params.property = property;
4019 params.value = value;
4021 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms);
4028 int32_t *resultInt32;
4029 uint32_t *resultUint32;
4030 int64_t *resultInt64;
4031 uint64_t *resultUint64;
4032 } _OrthancPluginReturnSingleValue;
4047 _OrthancPluginReturnSingleValue params;
4048 memset(¶ms, 0,
sizeof(params));
4049 params.resultUint32 = &count;
4082 _OrthancPluginGlobalProperty params;
4083 params.result = &result;
4084 params.property = (int32_t) argument;
4085 params.value = NULL;
4113 _OrthancPluginReturnSingleValue params;
4114 memset(¶ms, 0,
sizeof(params));
4115 params.resultUint32 = &count;
4145 _OrthancPluginRetrieveDynamicString params;
4146 params.result = &result;
4147 params.argument = NULL;
4165 const char* subType;
4166 const char* contentType;
4167 } _OrthancPluginStartMultipartAnswer;
4185 const char* subType,
4186 const char* contentType)
4188 _OrthancPluginStartMultipartAnswer params;
4189 params.output = output;
4190 params.subType = subType;
4191 params.contentType = contentType;
4192 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms);
4215 uint32_t answerSize)
4217 _OrthancPluginAnswerBuffer params;
4218 params.output = output;
4219 params.answer = answer;
4220 params.answerSize = answerSize;
4221 params.mimeType = NULL;
4222 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms);
4234 } _OrthancPluginBufferCompression;
4261 _OrthancPluginBufferCompression params;
4262 params.target = target;
4263 params.source = source;
4265 params.compression = compression;
4266 params.uncompress = uncompress;
4268 return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms);
4277 } _OrthancPluginReadFile;
4295 _OrthancPluginReadFile params;
4296 params.target = target;
4298 return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms);
4308 } _OrthancPluginWriteFile;
4327 _OrthancPluginWriteFile params;
4331 return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms);
4338 const char** target;
4340 } _OrthancPluginGetErrorDescription;
4356 const char* result = NULL;
4358 _OrthancPluginGetErrorDescription params;
4359 params.target = &result;
4360 params.error = error;
4365 return "Unknown error code";
4381 } _OrthancPluginSendHttpStatus;
4412 _OrthancPluginSendHttpStatus params;
4413 params.output = output;
4414 params.status = status;
4416 params.bodySize = bodySize;
4417 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms);
4425 uint32_t* resultUint32;
4427 void** resultBuffer;
4428 } _OrthancPluginGetImageInfo;
4447 _OrthancPluginGetImageInfo params;
4448 memset(¶ms, 0,
sizeof(params));
4449 params.image = image;
4450 params.resultPixelFormat = ⌖
4480 _OrthancPluginGetImageInfo params;
4481 memset(¶ms, 0,
sizeof(params));
4482 params.image = image;
4483 params.resultUint32 = &width;
4513 _OrthancPluginGetImageInfo params;
4514 memset(¶ms, 0,
sizeof(params));
4515 params.image = image;
4516 params.resultUint32 = &height;
4548 _OrthancPluginGetImageInfo params;
4549 memset(¶ms, 0,
sizeof(params));
4550 params.image = image;
4551 params.resultUint32 = &pitch;
4580 void* target = NULL;
4582 _OrthancPluginGetImageInfo params;
4583 memset(¶ms, 0,
sizeof(params));
4584 params.resultBuffer = ⌖
4585 params.image = image;
4604 } _OrthancPluginUncompressImage;
4627 _OrthancPluginUncompressImage params;
4628 memset(¶ms, 0,
sizeof(params));
4629 params.target = ⌖
4632 params.format = format;
4650 } _OrthancPluginFreeImage;
4665 _OrthancPluginFreeImage params;
4666 params.image = image;
4668 context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms);
4684 } _OrthancPluginCompressImage;
4715 _OrthancPluginCompressImage params;
4716 memset(¶ms, 0,
sizeof(params));
4717 params.target = target;
4719 params.pixelFormat = format;
4720 params.width = width;
4721 params.height = height;
4722 params.pitch = pitch;
4723 params.buffer = buffer;
4726 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4761 _OrthancPluginCompressImage params;
4762 memset(¶ms, 0,
sizeof(params));
4763 params.target = target;
4765 params.pixelFormat = format;
4766 params.width = width;
4767 params.height = height;
4768 params.pitch = pitch;
4769 params.buffer = buffer;
4770 params.quality = quality;
4772 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4808 _OrthancPluginCompressAndAnswerImage params;
4809 params.output = output;
4811 params.pixelFormat = format;
4812 params.width = width;
4813 params.height = height;
4814 params.pitch = pitch;
4815 params.buffer = buffer;
4816 params.quality = quality;
4817 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
4828 const char* username;
4829 const char* password;
4832 } _OrthancPluginCallHttpClient;
4855 const char* username,
4856 const char* password)
4858 _OrthancPluginCallHttpClient params;
4859 memset(¶ms, 0,
sizeof(params));
4861 params.target = target;
4864 params.username = username;
4865 params.password = password;
4867 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4895 const char* username,
4896 const char* password)
4898 _OrthancPluginCallHttpClient params;
4899 memset(¶ms, 0,
sizeof(params));
4901 params.target = target;
4905 params.bodySize = bodySize;
4906 params.username = username;
4907 params.password = password;
4909 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4937 const char* username,
4938 const char* password)
4940 _OrthancPluginCallHttpClient params;
4941 memset(¶ms, 0,
sizeof(params));
4943 params.target = target;
4947 params.bodySize = bodySize;
4948 params.username = username;
4949 params.password = password;
4951 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4972 const char* username,
4973 const char* password)
4975 _OrthancPluginCallHttpClient params;
4976 memset(¶ms, 0,
sizeof(params));
4980 params.username = username;
4981 params.password = password;
4983 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4993 } _OrthancPluginConvertPixelFormat;
5014 _OrthancPluginConvertPixelFormat params;
5015 params.target = ⌖
5016 params.source = source;
5017 params.targetFormat = targetFormat;
5047 _OrthancPluginReturnSingleValue params;
5048 memset(¶ms, 0,
sizeof(params));
5049 params.resultUint32 = &count;
5070 } _OrthancPluginGetFontInfo;
5086 const char* result = NULL;
5088 _OrthancPluginGetFontInfo params;
5089 memset(¶ms, 0,
sizeof(params));
5090 params.name = &result;
5091 params.fontIndex = fontIndex;
5120 _OrthancPluginGetFontInfo params;
5121 memset(¶ms, 0,
sizeof(params));
5122 params.size = &result;
5123 params.fontIndex = fontIndex;
5141 const char* utf8Text;
5147 } _OrthancPluginDrawText;
5171 const char* utf8Text,
5178 _OrthancPluginDrawText params;
5179 memset(¶ms, 0,
sizeof(params));
5180 params.image = image;
5181 params.fontIndex = fontIndex;
5182 params.utf8Text = utf8Text;
5189 return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms);
5198 const void* content;
5201 } _OrthancPluginStorageAreaCreate;
5227 const void* content,
5231 _OrthancPluginStorageAreaCreate params;
5232 params.storageArea = storageArea;
5234 params.content = content;
5238 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms);
5248 } _OrthancPluginStorageAreaRead;
5276 _OrthancPluginStorageAreaRead params;
5277 params.target = target;
5278 params.storageArea = storageArea;
5282 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms);
5291 } _OrthancPluginStorageAreaRemove;
5316 _OrthancPluginStorageAreaRemove params;
5317 params.storageArea = storageArea;
5321 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms);
5330 uint16_t httpStatus;
5331 const char* message;
5332 } _OrthancPluginRegisterErrorCode;
5352 uint16_t httpStatus,
5353 const char* message)
5357 _OrthancPluginRegisterErrorCode params;
5358 params.target = ⌖
5360 params.httpStatus = httpStatus;
5361 params.message = message;
5382 uint32_t minMultiplicity;
5383 uint32_t maxMultiplicity;
5384 } _OrthancPluginRegisterDictionaryTag;
5411 uint32_t minMultiplicity,
5412 uint32_t maxMultiplicity)
5414 _OrthancPluginRegisterDictionaryTag params;
5415 params.group = group;
5416 params.element = element;
5419 params.minMultiplicity = minMultiplicity;
5420 params.maxMultiplicity = maxMultiplicity;
5422 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, ¶ms);
5433 uint32_t minMultiplicity;
5434 uint32_t maxMultiplicity;
5435 const char* privateCreator;
5436 } _OrthancPluginRegisterPrivateDictionaryTag;
5458 ORTHANC_PLUGIN_SINCE_SDK(
"1.2.0")
5465 uint32_t minMultiplicity,
5466 uint32_t maxMultiplicity,
5467 const
char* privateCreator)
5469 _OrthancPluginRegisterPrivateDictionaryTag params;
5470 params.group = group;
5471 params.element = element;
5474 params.minMultiplicity = minMultiplicity;
5475 params.maxMultiplicity = maxMultiplicity;
5476 params.privateCreator = privateCreator;
5478 return context->InvokeService(context, _OrthancPluginService_RegisterPrivateDictionaryTag, ¶ms);
5487 } _OrthancPluginReconstructMainDicomTags;
5508 _OrthancPluginReconstructMainDicomTags params;
5509 params.level = level;
5510 params.storageArea = storageArea;
5512 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, ¶ms);
5519 const char* instanceId;
5524 uint32_t maxStringLength;
5525 } _OrthancPluginDicomToJson;
5553 uint32_t maxStringLength)
5557 _OrthancPluginDicomToJson params;
5558 memset(¶ms, 0,
sizeof(params));
5559 params.result = &result;
5560 params.buffer = buffer;
5562 params.format = format;
5563 params.flags = flags;
5564 params.maxStringLength = maxStringLength;
5598 const char* instanceId,
5601 uint32_t maxStringLength)
5605 _OrthancPluginDicomToJson params;
5606 memset(¶ms, 0,
sizeof(params));
5607 params.result = &result;
5608 params.instanceId = instanceId;
5609 params.format = format;
5610 params.flags = flags;
5611 params.maxStringLength = maxStringLength;
5629 uint32_t headersCount;
5630 const char*
const* headersKeys;
5631 const char*
const* headersValues;
5632 int32_t afterPlugins;
5633 } _OrthancPluginRestApiGet2;
5658 uint32_t headersCount,
5659 const char*
const* headersKeys,
5660 const char*
const* headersValues,
5661 int32_t afterPlugins)
5663 _OrthancPluginRestApiGet2 params;
5664 params.target = target;
5666 params.headersCount = headersCount;
5667 params.headersKeys = headersKeys;
5668 params.headersValues = headersValues;
5669 params.afterPlugins = afterPlugins;
5671 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, ¶ms);
5679 } _OrthancPluginWorklistCallback;
5696 _OrthancPluginWorklistCallback params;
5697 params.callback = callback;
5699 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, ¶ms);
5709 } _OrthancPluginWorklistAnswersOperation;
5734 _OrthancPluginWorklistAnswersOperation params;
5735 params.answers = answers;
5736 params.query = query;
5737 params.dicom = dicom;
5740 return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, ¶ms);
5761 _OrthancPluginWorklistAnswersOperation params;
5762 params.answers = answers;
5763 params.query = NULL;
5764 params.dicom = NULL;
5767 return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, ¶ms);
5778 } _OrthancPluginWorklistQueryOperation;
5801 int32_t isMatch = 0;
5803 _OrthancPluginWorklistQueryOperation params;
5804 params.query = query;
5805 params.dicom = dicom;
5807 params.isMatch = &isMatch;
5808 params.target = NULL;
5839 _OrthancPluginWorklistQueryOperation params;
5840 params.query = query;
5841 params.dicom = NULL;
5843 params.isMatch = NULL;
5844 params.target = target;
5846 return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, ¶ms);
5866 _OrthancPluginAccessDicomInstance params;
5867 memset(¶ms, 0,
sizeof(params));
5868 params.resultOrigin = &origin;
5869 params.instance = instance;
5889 } _OrthancPluginCreateDicom;
5923 _OrthancPluginCreateDicom params;
5924 params.target = target;
5926 params.pixelData = pixelData;
5927 params.flags = flags;
5929 return context->InvokeService(context, _OrthancPluginService_CreateDicom, ¶ms);
5936 } _OrthancPluginDecodeImageCallback;
5956 _OrthancPluginDecodeImageCallback params;
5957 params.callback = callback;
5959 return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, ¶ms);
5972 const void* constBuffer;
5973 uint32_t bufferSize;
5974 uint32_t frameIndex;
5975 } _OrthancPluginCreateImage;
5998 _OrthancPluginCreateImage params;
5999 memset(¶ms, 0,
sizeof(params));
6000 params.target = ⌖
6001 params.format = format;
6002 params.width = width;
6003 params.height = height;
6043 _OrthancPluginCreateImage params;
6044 memset(¶ms, 0,
sizeof(params));
6045 params.target = ⌖
6046 params.format = format;
6047 params.width = width;
6048 params.height = height;
6049 params.pitch = pitch;
6050 params.buffer = buffer;
6082 uint32_t bufferSize,
6083 uint32_t frameIndex)
6087 _OrthancPluginCreateImage params;
6088 memset(¶ms, 0,
sizeof(params));
6089 params.target = ⌖
6090 params.constBuffer = buffer;
6091 params.bufferSize = bufferSize;
6092 params.frameIndex = frameIndex;
6111 } _OrthancPluginComputeHash;
6132 _OrthancPluginComputeHash params;
6133 params.result = &result;
6134 params.buffer = buffer;
6168 _OrthancPluginComputeHash params;
6169 params.result = &result;
6170 params.buffer = buffer;
6190 } _OrthancPluginLookupDictionary;
6212 _OrthancPluginLookupDictionary params;
6213 params.target = target;
6215 return context->InvokeService(context, _OrthancPluginService_LookupDictionary, ¶ms);
6224 uint32_t answerSize;
6225 uint32_t headersCount;
6226 const char*
const* headersKeys;
6227 const char*
const* headersValues;
6228 } _OrthancPluginSendMultipartItem2;
6250 ORTHANC_PLUGIN_SINCE_SDK(
"1.0.0")
6255 uint32_t answerSize,
6256 uint32_t headersCount,
6257 const
char* const* headersKeys,
6258 const
char* const* headersValues)
6260 _OrthancPluginSendMultipartItem2 params;
6261 params.output = output;
6262 params.answer = answer;
6263 params.answerSize = answerSize;
6264 params.headersCount = headersCount;
6265 params.headersKeys = headersKeys;
6266 params.headersValues = headersValues;
6268 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem2, ¶ms);
6275 } _OrthancPluginIncomingHttpRequestFilter;
6289 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6294 _OrthancPluginIncomingHttpRequestFilter params;
6295 params.callback = callback;
6297 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter, ¶ms);
6306 uint16_t* httpStatus;
6309 uint32_t headersCount;
6310 const char*
const* headersKeys;
6311 const char*
const* headersValues;
6314 const char* username;
6315 const char* password;
6317 const char* certificateFile;
6318 const char* certificateKeyFile;
6319 const char* certificateKeyPassword;
6321 } _OrthancPluginCallHttpClient2;
6365 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6370 uint16_t* httpStatus,
6373 uint32_t headersCount,
6374 const
char* const* headersKeys,
6375 const
char* const* headersValues,
6378 const
char* username,
6379 const
char* password,
6381 const
char* certificateFile,
6382 const
char* certificateKeyFile,
6383 const
char* certificateKeyPassword,
6386 _OrthancPluginCallHttpClient2 params;
6387 memset(¶ms, 0,
sizeof(params));
6389 params.answerBody = answerBody;
6390 params.answerHeaders = answerHeaders;
6391 params.httpStatus = httpStatus;
6392 params.method = method;
6394 params.headersCount = headersCount;
6395 params.headersKeys = headersKeys;
6396 params.headersValues = headersValues;
6398 params.bodySize = bodySize;
6399 params.username = username;
6400 params.password = password;
6401 params.timeout = timeout;
6402 params.certificateFile = certificateFile;
6403 params.certificateKeyFile = certificateKeyFile;
6404 params.certificateKeyPassword = certificateKeyPassword;
6405 params.pkcs11 = pkcs11;
6407 return context->InvokeService(context, _OrthancPluginService_CallHttpClient2, ¶ms);
6421 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6427 _OrthancPluginRetrieveDynamicString params;
6428 params.result = &result;
6429 params.argument = NULL;
6448 } _OrthancPluginFindCallback;
6461 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6466 _OrthancPluginFindCallback params;
6467 params.callback = callback;
6469 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback, ¶ms);
6480 uint32_t *resultUint32;
6481 uint16_t *resultGroup;
6482 uint16_t *resultElement;
6483 char **resultString;
6484 } _OrthancPluginFindOperation;
6501 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6508 _OrthancPluginFindOperation params;
6509 memset(¶ms, 0,
sizeof(params));
6510 params.answers = answers;
6511 params.dicom = dicom;
6514 return context->InvokeService(context, _OrthancPluginService_FindAddAnswer, ¶ms);
6531 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6536 _OrthancPluginFindOperation params;
6537 memset(¶ms, 0,
sizeof(params));
6538 params.answers = answers;
6540 return context->InvokeService(context, _OrthancPluginService_FindMarkIncomplete, ¶ms);
6556 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6563 _OrthancPluginFindOperation params;
6564 memset(¶ms, 0,
sizeof(params));
6565 params.query = query;
6566 params.resultUint32 = &count;
6594 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6602 _OrthancPluginFindOperation params;
6603 memset(¶ms, 0,
sizeof(params));
6604 params.query = query;
6605 params.index = index;
6606 params.resultGroup = group;
6607 params.resultElement = element;
6609 return context->InvokeService(context, _OrthancPluginService_GetFindQueryTag, ¶ms);
6626 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6634 _OrthancPluginFindOperation params;
6635 memset(¶ms, 0,
sizeof(params));
6636 params.query = query;
6637 params.index = index;
6638 params.resultString = &result;
6665 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6673 _OrthancPluginFindOperation params;
6674 memset(¶ms, 0,
sizeof(params));
6675 params.query = query;
6676 params.index = index;
6677 params.resultString = &result;
6699 } _OrthancPluginMoveCallback;
6714 ORTHANC_PLUGIN_SINCE_SDK(
"1.1.0")
6722 _OrthancPluginMoveCallback params;
6723 params.callback = callback;
6724 params.getMoveSize = getMoveSize;
6725 params.applyMove = applyMove;
6726 params.freeMove = freeMove;
6728 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback, ¶ms);
6738 } _OrthancPluginCreateFindMatcher;
6754 ORTHANC_PLUGIN_SINCE_SDK(
"1.2.0")
6762 _OrthancPluginCreateFindMatcher params;
6763 memset(¶ms, 0,
sizeof(params));
6764 params.target = ⌖
6765 params.query = query;
6782 } _OrthancPluginFreeFindMatcher;
6793 ORTHANC_PLUGIN_SINCE_SDK(
"1.2.0")
6798 _OrthancPluginFreeFindMatcher params;
6799 params.matcher = matcher;
6801 context->InvokeService(context, _OrthancPluginService_FreeFindMatcher, ¶ms);
6811 } _OrthancPluginFindMatcherIsMatch;
6827 ORTHANC_PLUGIN_SINCE_SDK(
"1.2.0")
6834 int32_t isMatch = 0;
6836 _OrthancPluginFindMatcherIsMatch params;
6837 params.matcher = matcher;
6838 params.dicom = dicom;
6840 params.isMatch = &isMatch;
6857 } _OrthancPluginIncomingHttpRequestFilter2;
6870 ORTHANC_PLUGIN_SINCE_SDK(
"1.3.0")
6875 _OrthancPluginIncomingHttpRequestFilter2 params;
6876 params.callback = callback;
6878 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter2, ¶ms);
6886 } _OrthancPluginGetPeers;
6899 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
6905 _OrthancPluginGetPeers params;
6906 memset(¶ms, 0,
sizeof(params));
6907 params.peers = &peers;
6923 } _OrthancPluginFreePeers;
6934 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
6939 _OrthancPluginFreePeers params;
6940 params.peers = peers;
6942 context->InvokeService(context, _OrthancPluginService_FreePeers, ¶ms);
6950 } _OrthancPluginGetPeersCount;
6965 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
6970 uint32_t target = 0;
6972 _OrthancPluginGetPeersCount params;
6973 memset(¶ms, 0,
sizeof(params));
6974 params.target = ⌖
6975 params.peers = peers;
6991 const char** target;
6994 const char* userProperty;
6995 } _OrthancPluginGetPeerProperty;
7014 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
7020 const char* target = NULL;
7022 _OrthancPluginGetPeerProperty params;
7023 memset(¶ms, 0,
sizeof(params));
7024 params.target = ⌖
7025 params.peers = peers;
7026 params.peerIndex = peerIndex;
7027 params.userProperty = NULL;
7056 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
7062 const char* target = NULL;
7064 _OrthancPluginGetPeerProperty params;
7065 memset(¶ms, 0,
sizeof(params));
7066 params.target = ⌖
7067 params.peers = peers;
7068 params.peerIndex = peerIndex;
7069 params.userProperty = NULL;
7103 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
7108 const
char* userProperty)
7110 const char* target = NULL;
7112 _OrthancPluginGetPeerProperty params;
7113 memset(¶ms, 0,
sizeof(params));
7114 params.target = ⌖
7115 params.peers = peers;
7116 params.peerIndex = peerIndex;
7117 params.userProperty = userProperty;
7136 uint16_t* httpStatus;
7141 uint32_t additionalHeadersCount;
7142 const char*
const* additionalHeadersKeys;
7143 const char*
const* additionalHeadersValues;
7147 } _OrthancPluginCallPeerApi;
7185 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
7190 uint16_t* httpStatus,
7195 uint32_t additionalHeadersCount,
7196 const
char* const* additionalHeadersKeys,
7197 const
char* const* additionalHeadersValues,
7202 _OrthancPluginCallPeerApi params;
7203 memset(¶ms, 0,
sizeof(params));
7205 params.answerBody = answerBody;
7206 params.answerHeaders = answerHeaders;
7207 params.httpStatus = httpStatus;
7208 params.peers = peers;
7209 params.peerIndex = peerIndex;
7210 params.method = method;
7212 params.additionalHeadersCount = additionalHeadersCount;
7213 params.additionalHeadersKeys = additionalHeadersKeys;
7214 params.additionalHeadersValues = additionalHeadersValues;
7216 params.bodySize = bodySize;
7217 params.timeout = timeout;
7219 return context->InvokeService(context, _OrthancPluginService_CallPeerApi, ¶ms);
7238 } _OrthancPluginCreateJob;
7272 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
7287 _OrthancPluginCreateJob params;
7288 memset(¶ms, 0,
sizeof(params));
7290 params.target = ⌖
7292 params.finalize = finalize;
7294 params.getProgress = getProgress;
7295 params.getContent = getContent;
7296 params.getSerialized = getSerialized;
7299 params.reset = reset;
7326 } _OrthancPluginCreateJob2;
7359 ORTHANC_PLUGIN_SINCE_SDK(
"1.11.3")
7374 _OrthancPluginCreateJob2 params;
7375 memset(¶ms, 0,
sizeof(params));
7377 params.target = ⌖
7379 params.finalize = finalize;
7381 params.getProgress = getProgress;
7382 params.getContent = getContent;
7383 params.getSerialized = getSerialized;
7386 params.reset = reset;
7404 } _OrthancPluginFreeJob;
7415 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
7420 _OrthancPluginFreeJob params;
7423 context->InvokeService(context, _OrthancPluginService_FreeJob, ¶ms);
7433 } _OrthancPluginSubmitJob;
7448 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
7454 char* resultId = NULL;
7456 _OrthancPluginSubmitJob params;
7457 memset(¶ms, 0,
sizeof(params));
7459 params.resultId = &resultId;
7461 params.priority = priority;
7480 } _OrthancPluginJobsUnserializer;
7494 ORTHANC_PLUGIN_SINCE_SDK(
"1.4.2")
7499 _OrthancPluginJobsUnserializer params;
7500 params.unserializer = unserializer;
7502 context->InvokeService(context, _OrthancPluginService_RegisterJobsUnserializer, ¶ms);
7510 const char* details;
7512 } _OrthancPluginSetHttpErrorDetails;
7531 ORTHANC_PLUGIN_SINCE_SDK(
"1.5.0")
7535 const
char* details,
7538 _OrthancPluginSetHttpErrorDetails params;
7539 params.output = output;
7540 params.details = details;
7542 context->InvokeService(context, _OrthancPluginService_SetHttpErrorDetails, ¶ms);
7549 const char** result;
7550 const char* argument;
7551 } _OrthancPluginRetrieveStaticString;
7564 ORTHANC_PLUGIN_SINCE_SDK(
"1.5.0")
7569 const char* result = NULL;
7571 _OrthancPluginRetrieveStaticString params;
7572 params.result = &result;
7573 params.argument = path;
7593 } _OrthancPluginSetMetricsValue;
7611 ORTHANC_PLUGIN_SINCE_SDK(
"1.5.4")
7618 _OrthancPluginSetMetricsValue params;
7620 params.value = value;
7622 context->InvokeService(context, _OrthancPluginService_SetMetricsValue, ¶ms);
7630 } _OrthancPluginRegisterRefreshMetricsCallback;
7643 ORTHANC_PLUGIN_SINCE_SDK(
"1.5.4")
7648 _OrthancPluginRegisterRefreshMetricsCallback params;
7649 params.callback = callback;
7650 context->InvokeService(context, _OrthancPluginService_RegisterRefreshMetricsCallback, ¶ms);
7662 } _OrthancPluginEncodeDicomWeb;
7680 ORTHANC_PLUGIN_SINCE_SDK(
"1.5.4")
7687 char* target = NULL;
7689 _OrthancPluginEncodeDicomWeb params;
7690 params.target = ⌖
7691 params.dicom = dicom;
7692 params.dicomSize = dicomSize;
7693 params.callback = callback;
7723 ORTHANC_PLUGIN_SINCE_SDK(
"1.5.4")
7730 char* target = NULL;
7732 _OrthancPluginEncodeDicomWeb params;
7733 params.target = ⌖
7734 params.dicom = dicom;
7735 params.dicomSize = dicomSize;
7736 params.callback = callback;
7758 } _OrthancPluginEncodeDicomWeb2;
7776 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
7784 char* target = NULL;
7786 _OrthancPluginEncodeDicomWeb2 params;
7787 params.target = ⌖
7788 params.dicom = dicom;
7789 params.dicomSize = dicomSize;
7790 params.callback = callback;
7791 params.payload = payload;
7821 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
7829 char* target = NULL;
7831 _OrthancPluginEncodeDicomWeb2 params;
7832 params.target = ⌖
7833 params.dicom = dicom;
7834 params.dicomSize = dicomSize;
7835 params.callback = callback;
7836 params.payload = payload;
7940 typedef const void* (*OrthancPluginChunkedClientRequestGetChunkData) (
void* request);
7964 uint16_t* httpStatus;
7967 uint32_t headersCount;
7968 const char*
const* headersKeys;
7969 const char*
const* headersValues;
7975 const char* username;
7976 const char* password;
7978 const char* certificateFile;
7979 const char* certificateKeyFile;
7980 const char* certificateKeyPassword;
7982 } _OrthancPluginChunkedHttpClient;
8035 ORTHANC_PLUGIN_SINCE_SDK(
"1.5.7")
8041 uint16_t* httpStatus,
8044 uint32_t headersCount,
8045 const
char* const* headersKeys,
8046 const
char* const* headersValues,
8052 const
char* username,
8053 const
char* password,
8055 const
char* certificateFile,
8056 const
char* certificateKeyFile,
8057 const
char* certificateKeyPassword,
8060 _OrthancPluginChunkedHttpClient params;
8061 memset(¶ms, 0,
sizeof(params));
8064 params.httpStatus = httpStatus;
8065 params.method = method;
8067 params.headersCount = headersCount;
8068 params.headersKeys = headersKeys;
8069 params.headersValues = headersValues;
8070 params.username = username;
8071 params.password = password;
8072 params.timeout = timeout;
8073 params.certificateFile = certificateFile;
8074 params.certificateKeyFile = certificateKeyFile;
8075 params.certificateKeyPassword = certificateKeyPassword;
8076 params.pkcs11 = pkcs11;
8079 params.answer = answer;
8080 params.answerAddChunk = answerAddChunk;
8081 params.answerAddHeader = answerAddHeader;
8082 params.request = request;
8083 params.requestIsDone = requestIsDone;
8084 params.requestChunkData = requestChunkData;
8085 params.requestChunkSize = requestChunkSize;
8086 params.requestNext = requestNext;
8088 return context->InvokeService(context, _OrthancPluginService_ChunkedHttpClient, ¶ms);
8097 typedef struct ORTHANC_PLUGIN_SINCE_SDK("1.5.7")
8179 const char* pathRegularExpression;
8187 } _OrthancPluginChunkedRestCallback;
8219 ORTHANC_PLUGIN_SINCE_SDK(
"1.5.7")
8222 const
char* pathRegularExpression,
8231 _OrthancPluginChunkedRestCallback params;
8232 params.pathRegularExpression = pathRegularExpression;
8233 params.getHandler = getHandler;
8234 params.postHandler = postHandler;
8235 params.deleteHandler = deleteHandler;
8236 params.putHandler = putHandler;
8237 params.addChunk = addChunk;
8238 params.execute = execute;
8239 params.finalize = finalize;
8241 context->InvokeService(context, _OrthancPluginService_RegisterChunkedRestCallback, ¶ms);
8253 const char* privateCreator;
8254 } _OrthancPluginGetTagName;
8271 ORTHANC_PLUGIN_SINCE_SDK(
"1.5.7")
8276 const
char* privateCreator)
8280 _OrthancPluginGetTagName params;
8281 params.result = &result;
8282 params.group = group;
8283 params.element = element;
8284 params.privateCreator = privateCreator;
8330 const char* transactionUid,
8331 const char*
const* sopClassUids,
8332 const char*
const* sopInstanceUids,
8333 uint32_t countInstances,
8334 const char* remoteAet,
8335 const char* calledAet);
8365 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
8369 const
char* transactionUid,
8370 const
char* const* sopClassUids,
8371 const
char* const* sopInstanceUids,
8372 uint32_t countInstances,
8411 const
char* sopClassUid,
8412 const
char* sopInstanceUid);
8420 } _OrthancPluginRegisterStorageCommitmentScpCallback;
8435 ORTHANC_PLUGIN_SINCE_SDK(
"1.6.0")
8442 _OrthancPluginRegisterStorageCommitmentScpCallback params;
8443 params.factory = factory;
8444 params.destructor = destructor;
8445 params.lookup = lookup;
8446 return context->InvokeService(context, _OrthancPluginService_RegisterStorageCommitmentScpCallback, ¶ms);
8483 } _OrthancPluginIncomingDicomInstanceFilter;
8497 ORTHANC_PLUGIN_SINCE_SDK(
"1.6.1")
8502 _OrthancPluginIncomingDicomInstanceFilter params;
8503 params.callback = callback;
8505 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingDicomInstanceFilter, ¶ms);
8540 uint16_t* dimseStatus ,
8547 } _OrthancPluginIncomingCStoreInstanceFilter;
8561 ORTHANC_PLUGIN_SINCE_SDK(
"1.10.0")
8566 _OrthancPluginIncomingCStoreInstanceFilter params;
8567 params.callback = callback;
8569 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingCStoreInstanceFilter, ¶ms);
8609 const void* receivedDicomBuffer,
8610 uint64_t receivedDicomBufferSize,
8617 } _OrthancPluginReceivedInstanceCallback;
8639 ORTHANC_PLUGIN_SINCE_SDK(
"1.10.0")
8644 _OrthancPluginReceivedInstanceCallback params;
8645 params.callback = callback;
8647 return context->InvokeService(context, _OrthancPluginService_RegisterReceivedInstanceCallback, ¶ms);
8663 ORTHANC_PLUGIN_SINCE_SDK(
"1.6.1")
8670 _OrthancPluginAccessDicomInstance params;
8671 memset(¶ms, 0,
sizeof(params));
8672 params.resultStringToFree = &result;
8673 params.instance = instance;
8699 ORTHANC_PLUGIN_SINCE_SDK(
"1.6.1")
8704 int64_t hasPixelData;
8706 _OrthancPluginAccessDicomInstance params;
8707 memset(¶ms, 0,
sizeof(params));
8708 params.resultInt64 = &hasPixelData;
8709 params.instance = instance;
8720 return (hasPixelData != 0);
8734 const char* transferSyntax;
8735 } _OrthancPluginCreateDicomInstance;
8750 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
8758 _OrthancPluginCreateDicomInstance params;
8759 params.target = ⌖
8760 params.buffer = buffer;
8777 } _OrthancPluginFreeDicomInstance;
8789 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
8794 _OrthancPluginFreeDicomInstance params;
8795 params.dicom = dicom;
8797 context->InvokeService(context, _OrthancPluginService_FreeDicomInstance, ¶ms);
8803 uint32_t* targetUint32;
8806 char** targetStringToFree;
8808 uint32_t frameIndex;
8811 uint32_t maxStringLength;
8813 void* dicomWebPayload;
8814 } _OrthancPluginAccessDicomInstance2;
8827 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
8834 _OrthancPluginAccessDicomInstance2 params;
8835 memset(¶ms, 0,
sizeof(params));
8836 params.targetUint32 = &count;
8837 params.instance = instance;
8868 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
8873 uint32_t frameIndex)
8875 _OrthancPluginAccessDicomInstance2 params;
8876 memset(¶ms, 0,
sizeof(params));
8877 params.targetBuffer = target;
8878 params.instance = instance;
8879 params.frameIndex = frameIndex;
8881 return context->InvokeService(context, _OrthancPluginService_GetInstanceRawFrame, ¶ms);
8897 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
8901 uint32_t frameIndex)
8905 _OrthancPluginAccessDicomInstance2 params;
8906 memset(¶ms, 0,
sizeof(params));
8907 params.targetImage = ⌖
8908 params.instance = instance;
8909 params.frameIndex = frameIndex;
8937 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
8942 const
char* transferSyntax)
8946 _OrthancPluginCreateDicomInstance params;
8947 params.target = ⌖
8948 params.buffer = buffer;
8950 params.transferSyntax = transferSyntax;
8976 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
8982 _OrthancPluginAccessDicomInstance2 params;
8983 memset(¶ms, 0,
sizeof(params));
8984 params.targetBuffer = target;
8985 params.instance = instance;
8987 return context->InvokeService(context, _OrthancPluginService_SerializeDicomInstance, ¶ms);
9009 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
9015 uint32_t maxStringLength)
9017 char* result = NULL;
9019 _OrthancPluginAccessDicomInstance2 params;
9020 memset(¶ms, 0,
sizeof(params));
9021 params.targetStringToFree = &result;
9022 params.instance = instance;
9023 params.format = format;
9024 params.flags = flags;
9025 params.maxStringLength = maxStringLength;
9053 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
9060 char* target = NULL;
9062 _OrthancPluginAccessDicomInstance2 params;
9063 params.targetStringToFree = ⌖
9064 params.instance = instance;
9065 params.dicomWebCallback = callback;
9066 params.dicomWebPayload = payload;
9094 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
9101 char* target = NULL;
9103 _OrthancPluginAccessDicomInstance2 params;
9104 params.targetStringToFree = ⌖
9105 params.instance = instance;
9106 params.dicomWebCallback = callback;
9107 params.dicomWebPayload = payload;
9144 const char*
const* allowedSyntaxes,
9145 uint32_t countSyntaxes,
9146 uint8_t allowNewSopInstanceUid);
9152 } _OrthancPluginTranscoderCallback;
9167 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
9172 _OrthancPluginTranscoderCallback params;
9173 params.callback = callback;
9175 return context->InvokeService(context, _OrthancPluginService_RegisterTranscoderCallback, ¶ms);
9184 } _OrthancPluginCreateMemoryBuffer;
9203 ORTHANC_PLUGIN_SINCE_SDK(
"1.7.0")
9209 _OrthancPluginCreateMemoryBuffer params;
9210 params.target = target;
9213 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer, ¶ms);
9242 ORTHANC_PLUGIN_SINCE_SDK(
"1.8.1")
9248 _OrthancPluginRetrieveDynamicString params;
9249 params.result = &result;
9250 params.argument = NULL;
9252 if (context->InvokeService(context, _OrthancPluginService_GenerateRestApiAuthorizationToken,
9270 } _OrthancPluginCreateMemoryBuffer64;
9289 ORTHANC_PLUGIN_SINCE_SDK(
"1.9.0")
9295 _OrthancPluginCreateMemoryBuffer64 params;
9296 params.target = target;
9299 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer64, ¶ms);
9309 } _OrthancPluginRegisterStorageArea2;
9328 ORTHANC_PLUGIN_SINCE_SDK(
"1.9.0")
9336 _OrthancPluginRegisterStorageArea2 params;
9337 params.create = create;
9338 params.readWhole = readWhole;
9339 params.readRange = readRange;
9340 params.remove = remove;
9341 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea2, ¶ms);
9348 _OrthancPluginCreateDicom createDicom;
9349 const char* privateCreator;
9350 } _OrthancPluginCreateDicom2;
9376 ORTHANC_PLUGIN_SINCE_SDK(
"1.9.0")
9383 const
char* privateCreator)
9385 _OrthancPluginCreateDicom2 params;
9386 params.createDicom.target = target;
9387 params.createDicom.json = json;
9388 params.createDicom.pixelData = pixelData;
9389 params.createDicom.flags = flags;
9390 params.privateCreator = privateCreator;
9392 return context->InvokeService(context, _OrthancPluginService_CreateDicom2, ¶ms);
9404 uint16_t* httpStatus;
9407 uint32_t headersCount;
9408 const char*
const* headersKeys;
9409 const char*
const* headersValues;
9412 uint8_t afterPlugins;
9413 } _OrthancPluginCallRestApi;
9445 ORTHANC_PLUGIN_SINCE_SDK(
"1.9.2")
9450 uint16_t* httpStatus,
9453 uint32_t headersCount,
9454 const
char* const* headersKeys,
9455 const
char* const* headersValues,
9458 uint8_t afterPlugins)
9460 _OrthancPluginCallRestApi params;
9461 memset(¶ms, 0,
sizeof(params));
9463 params.answerBody = answerBody;
9464 params.answerHeaders = answerHeaders;
9465 params.httpStatus = httpStatus;
9466 params.method = method;
9468 params.headersCount = headersCount;
9469 params.headersKeys = headersKeys;
9470 params.headersValues = headersValues;
9472 params.bodySize = bodySize;
9473 params.afterPlugins = afterPlugins;
9475 return context->InvokeService(context, _OrthancPluginService_CallRestApi, ¶ms);
9484 typedef struct ORTHANC_PLUGIN_SINCE_SDK("1.10.1")
9508 const char* mimeType,
9509 const char* dateTime);
9528 const char* dateTime);
9556 const char* mimeType,
9557 const char* dateTime);
9574 uint8_t* isExisting,
9576 const char*
const* pathItems,
9599 uint8_t* isExisting,
9604 const char*
const* pathItems,
9628 const char*
const* pathItems,
9648 uint8_t* isReadOnly,
9650 const char*
const* pathItems,
9670 uint8_t* isReadOnly,
9672 const char*
const* pathItems,
9690 uint8_t* isReadOnly,
9692 const char*
const* pathItems,
9706 } _OrthancPluginRegisterWebDavCollection;
9728 ORTHANC_PLUGIN_SINCE_SDK(
"1.10.1")
9740 _OrthancPluginRegisterWebDavCollection params;
9742 params.isExistingFolder = isExistingFolder;
9743 params.listFolder = listFolder;
9744 params.retrieveFile = retrieveFile;
9745 params.storeFile = storeFile;
9746 params.createFolder = createFolder;
9747 params.deleteItem = deleteItem;
9748 params.payload = payload;
9750 return context->InvokeService(context, _OrthancPluginService_RegisterWebDavCollection, ¶ms);
9762 ORTHANC_PLUGIN_SINCE_SDK(
"1.11.1")
9768 _OrthancPluginRetrieveStaticString params;
9769 params.result = &result;
9770 params.argument = NULL;
9789 } _OrthancPluginRegisterStorageArea3;
9805 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
9812 _OrthancPluginRegisterStorageArea3 params;
9813 params.create = create;
9814 params.readRange = readRange;
9815 params.remove = remove;
9816 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea3, ¶ms);
9828 const void* request,
9829 uint64_t requestSize);
9841 uint32_t maxDatabaseRetries;
9844 } _OrthancPluginRegisterDatabaseBackendV4;
9863 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.0")
9867 uint32_t maxDatabaseRetries,
9871 _OrthancPluginRegisterDatabaseBackendV4 params;
9872 params.backend = backend;
9873 params.maxDatabaseRetries = maxDatabaseRetries;
9874 params.operations = operations;
9875 params.finalize = finalize;
9877 return context->InvokeService(context, _OrthancPluginService_RegisterDatabaseBackendV4, ¶ms);
9884 const char* instanceId;
9886 } _OrthancPluginLoadDicomInstance;
9901 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.1")
9904 const
char* instanceId,
9909 _OrthancPluginLoadDicomInstance params;
9910 params.target = ⌖
9911 params.instanceId = instanceId;
9931 } _OrthancPluginSetMetricsIntegerValue;
9948 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.1")
9955 _OrthancPluginSetMetricsIntegerValue params;
9957 params.value = value;
9959 context->InvokeService(context, _OrthancPluginService_SetMetricsIntegerValue, ¶ms);
9976 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.2")
9979 const
char* threadName)
9981 return context->InvokeService(context, _OrthancPluginService_SetCurrentThreadName, threadName);
9988 const char* message;
9994 } _OrthancPluginLogMessage;
10010 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.4")
10013 const
char* message,
10014 const
char* plugin,
10020 _OrthancPluginLogMessage m;
10021 m.message = message;
10025 m.category = category;
10027 context->InvokeService(context, _OrthancPluginService_LogMessage, &m);
10034 const char* contentType;
10035 } _OrthancPluginStartStreamAnswer;
10049 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.6")
10053 const
char* contentType)
10055 _OrthancPluginStartStreamAnswer params;
10056 params.output = output;
10057 params.contentType = contentType;
10058 return context->InvokeService(context, _OrthancPluginService_StartStreamAnswer, ¶ms);
10077 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.6")
10081 const
void* answer,
10082 uint32_t answerSize)
10084 _OrthancPluginAnswerBuffer params;
10085 params.output = output;
10086 params.answer = answer;
10087 params.answerSize = answerSize;
10088 params.mimeType = NULL;
10089 return context->InvokeService(context, _OrthancPluginService_SendStreamChunk, ¶ms);
10099 uint64_t dicomSize;
10100 const void* customData;
10101 uint32_t customDataSize;
10102 } _OrthancPluginAdoptDicomInstance;
10142 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10149 uint64_t dicomSize,
10150 const
void* customData,
10151 uint32_t customDataSize)
10153 _OrthancPluginAdoptDicomInstance params;
10154 params.instanceId = instanceId;
10155 params.attachmentUuid = attachmentUuid;
10156 params.storeStatus = storeStatus;
10157 params.dicom = dicom;
10158 params.dicomSize = dicomSize;
10159 params.customData = customData;
10160 params.customDataSize = customDataSize;
10162 return context->InvokeService(context, _OrthancPluginService_AdoptDicomInstance, ¶ms);
10169 const char* attachmentUuid;
10170 } _OrthancPluginGetAttachmentCustomData;
10184 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10188 const
char* attachmentUuid )
10190 _OrthancPluginGetAttachmentCustomData params;
10191 params.customData = customData;
10192 params.attachmentUuid = attachmentUuid;
10194 return context->InvokeService(context, _OrthancPluginService_GetAttachmentCustomData, ¶ms);
10200 const char* attachmentUuid;
10201 const void* customData;
10202 uint32_t customDataSize;
10203 } _OrthancPluginSetAttachmentCustomData;
10217 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10220 const
char* attachmentUuid,
10221 const
void* customData,
10222 uint32_t customDataSize )
10224 _OrthancPluginSetAttachmentCustomData params;
10225 params.attachmentUuid = attachmentUuid;
10226 params.customData = customData;
10227 params.customDataSize = customDataSize;
10229 return context->InvokeService(context, _OrthancPluginService_SetAttachmentCustomData, ¶ms);
10235 const char* storeId;
10238 uint32_t valueSize;
10239 } _OrthancPluginStoreKeyValue;
10251 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10254 const
char* storeId,
10257 uint32_t valueSize )
10259 _OrthancPluginStoreKeyValue params;
10260 params.storeId = storeId;
10262 params.value = value;
10263 params.valueSize = valueSize;
10265 return context->InvokeService(context, _OrthancPluginService_StoreKeyValue, ¶ms);
10271 const char* storeId;
10273 } _OrthancPluginDeleteKeyValue;
10283 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10286 const
char* storeId,
10289 _OrthancPluginDeleteKeyValue params;
10290 params.storeId = storeId;
10293 return context->InvokeService(context, _OrthancPluginService_DeleteKeyValue, ¶ms);
10301 const char* storeId;
10303 } _OrthancPluginGetKeyValue;
10316 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10321 const
char* storeId,
10324 _OrthancPluginGetKeyValue params;
10325 params.found = found;
10326 params.target = target;
10327 params.storeId = storeId;
10330 return context->InvokeService(context, _OrthancPluginService_GetKeyValue, ¶ms);
10339 typedef struct ORTHANC_PLUGIN_SINCE_SDK("1.12.8")
10346 const char* storeId;
10347 } _OrthancPluginCreateKeysValuesIterator;
10360 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10363 const
char* storeId)
10367 _OrthancPluginCreateKeysValuesIterator params;
10368 params.target = ⌖
10369 params.storeId = storeId;
10385 } _OrthancPluginFreeKeysValuesIterator;
10393 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10398 _OrthancPluginFreeKeysValuesIterator params;
10399 params.iterator = iterator;
10401 context->InvokeService(context, _OrthancPluginService_FreeKeysValuesIterator, ¶ms);
10409 } _OrthancPluginKeysValuesIteratorNext;
10421 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10427 _OrthancPluginKeysValuesIteratorNext params;
10428 params.done = done;
10429 params.iterator = iterator;
10431 return context->InvokeService(context, _OrthancPluginService_KeysValuesIteratorNext, ¶ms);
10437 const char** target;
10439 } _OrthancPluginKeysValuesIteratorGetKey;
10451 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10456 const char* target = NULL;
10458 _OrthancPluginKeysValuesIteratorGetKey params;
10459 params.target = ⌖
10460 params.iterator = iterator;
10477 } _OrthancPluginKeysValuesIteratorGetValue;
10491 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10497 _OrthancPluginKeysValuesIteratorGetValue params;
10498 params.target = target;
10499 params.iterator = iterator;
10501 return context->InvokeService(context, _OrthancPluginService_KeysValuesIteratorGetValue, ¶ms);
10507 const char* queueId;
10509 uint32_t valueSize;
10510 } _OrthancPluginEnqueueValue;
10521 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10524 const
char* queueId,
10526 uint32_t valueSize )
10528 _OrthancPluginEnqueueValue params;
10529 params.queueId = queueId;
10530 params.value = value;
10531 params.valueSize = valueSize;
10533 return context->InvokeService(context, _OrthancPluginService_EnqueueValue, ¶ms);
10541 const char* queueId;
10543 } _OrthancPluginDequeueValue;
10558 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10563 const
char* queueId,
10566 _OrthancPluginDequeueValue params;
10567 params.found = found;
10568 params.target = target;
10569 params.queueId = queueId;
10570 params.origin = origin;
10572 return context->InvokeService(context, _OrthancPluginService_DequeueValue, ¶ms);
10578 const char* queueId;
10580 } _OrthancPluginGetQueueSize;
10590 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.8")
10593 const
char* queueId,
10596 _OrthancPluginGetQueueSize params;
10597 params.queueId = queueId;
10598 params.size = size;
10600 return context->InvokeService(context, _OrthancPluginService_GetQueueSize, ¶ms);
10606 const char* resourceId;
10608 uint8_t* statusHasChanged;
10609 } _OrthancPluginSetStableStatus;
10631 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.9")
10634 uint8_t* statusHasChanged,
10635 const
char* resourceId,
10638 _OrthancPluginSetStableStatus params;
10639 params.resourceId = resourceId;
10640 params.stableStatus= stableStatus;
10641 params.statusHasChanged = statusHasChanged;
10643 return context->InvokeService(context, _OrthancPluginService_SetStableStatus, ¶ms);
10675 uint32_t headersCount,
10676 const char*
const* headersKeys,
10677 const char*
const* headersValues,
10679 const char*
const* getKeys,
10680 const char*
const* getValues);
10686 } _OrthancPluginHttpAuthentication;
10727 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.9")
10732 _OrthancPluginHttpAuthentication params;
10733 params.callback = callback;
10735 return context->InvokeService(context, _OrthancPluginService_RegisterHttpAuthentication, ¶ms);
10741 const char* sourcePlugin;
10742 const char* userId;
10744 const char* resourceId;
10745 const char* action;
10746 const void* logData;
10747 uint32_t logDataSize;
10748 } _OrthancPluginEmitAuditLog;
10773 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.9")
10776 const
char* sourcePlugin,
10777 const
char* userId,
10779 const
char* resourceId,
10780 const
char* action,
10781 const
void* logData,
10782 uint32_t logDataSize)
10784 _OrthancPluginEmitAuditLog m;
10785 m.sourcePlugin = sourcePlugin;
10787 m.resourceType = resourceType;
10788 m.resourceId = resourceId;
10790 m.logData = logData;
10791 m.logDataSize = logDataSize;
10792 context->InvokeService(context, _OrthancPluginService_EmitAuditLog, &m);
10815 const char* sourcePlugin,
10816 const char* userId,
10818 const char* resourceId,
10819 const char* action,
10820 const void* logData,
10821 uint32_t logDataSize);
10826 } _OrthancPluginAuditLogHandler;
10839 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.9")
10844 _OrthancPluginAuditLogHandler params;
10845 params.handler = handler;
10847 return context->InvokeService(context, _OrthancPluginService_RegisterAuditLogHandler, ¶ms);
10855 const char* queueId;
10857 uint32_t releaseTimeout;
10859 } _OrthancPluginReserveQueueValue;
10882 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
10888 const
char* queueId,
10890 uint32_t releaseTimeout )
10892 _OrthancPluginReserveQueueValue params;
10893 params.found = found;
10894 params.target = target;
10895 params.queueId = queueId;
10896 params.origin = origin;
10897 params.valueId = valueId;
10898 params.releaseTimeout = releaseTimeout;
10900 return context->InvokeService(context, _OrthancPluginService_ReserveQueueValue, ¶ms);
10905 const char* queueId;
10907 } _OrthancPluginAcknowledgeQueueValue;
10918 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
10921 const
char* queueId,
10924 _OrthancPluginAcknowledgeQueueValue params;
10925 params.queueId = queueId;
10926 params.valueId = valueId;
10928 return context->InvokeService(context, _OrthancPluginService_AcknowledgeQueueValue, ¶ms);
10935 const char** resultString;
10936 } _OrthancPluginAccessDicomConnection;
10949 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
10954 const char* result;
10956 _OrthancPluginAccessDicomConnection params;
10957 memset(¶ms, 0,
sizeof(params));
10958 params.resultString = &result;
10959 params.connection = connection;
10984 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
10989 const char* result;
10991 _OrthancPluginAccessDicomConnection params;
10992 memset(¶ms, 0,
sizeof(params));
10993 params.resultString = &result;
10994 params.connection = connection;
11019 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
11024 const char* result;
11026 _OrthancPluginAccessDicomConnection params;
11027 memset(¶ms, 0,
sizeof(params));
11028 params.resultString = &result;
11029 params.connection = connection;
11046 } _OrthancPluginWorklistCallback2;
11059 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
11064 _OrthancPluginWorklistCallback2 params;
11065 params.callback = callback;
11067 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback2, ¶ms);
11074 } _OrthancPluginFindCallback2;
11087 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
11092 _OrthancPluginFindCallback2 params;
11093 params.callback = callback;
11095 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback2, ¶ms);
11105 } _OrthancPluginMoveCallback2;
11120 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
11128 _OrthancPluginMoveCallback2 params;
11129 params.callback = callback;
11130 params.getMoveSize = getMoveSize;
11131 params.applyMove = applyMove;
11132 params.freeMove = freeMove;
11134 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback2, ¶ms);
11143 } _OrthancPluginRegisterStorageCommitmentScpCallback2;
11158 ORTHANC_PLUGIN_SINCE_SDK(
"1.12.10")
11165 _OrthancPluginRegisterStorageCommitmentScpCallback2 params;
11166 params.factory = factory;
11167 params.destructor = destructor;
11168 params.lookup = lookup;
11169 return context->InvokeService(context, _OrthancPluginService_RegisterStorageCommitmentScpCallback2, ¶ms);
OrthancPluginErrorCode OrthancPluginRegisterDatabaseBackendV4(OrthancPluginContext *context, void *backend, uint32_t maxDatabaseRetries, OrthancPluginCallDatabaseBackendV4 operations, OrthancPluginFinalizeDatabaseBackendV4 finalize)
Register a custom database back-end.
Definition: OrthancCPlugin.h:9864
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:10669
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:9825
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:8607
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:9504
void OrthancPluginRegisterStorageArea(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove)
Register a custom storage area.
Definition: OrthancCPlugin.h:3631
void OrthancPluginRegisterOnStoredInstanceCallback(OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback)
Register a callback for received instances.
Definition: OrthancCPlugin.h:2596
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:1465
OrthancPluginErrorCode OrthancPluginRegisterDecodeImageCallback(OrthancPluginContext *context, OrthancPluginDecodeImageCallback callback)
Register a callback to handle the decoding of DICOM images.
Definition: OrthancCPlugin.h:5952
OrthancPluginChangeType
Definition: OrthancCPlugin.h:825
OrthancPluginErrorCode(* OrthancPluginStorageReadWhole)(OrthancPluginMemoryBuffer64 *target, const char *uuid, OrthancPluginContentType type)
Callback for reading a whole file from the storage area.
Definition: OrthancCPlugin.h:1530
OrthancPluginErrorCode OrthancPluginRegisterIncomingCStoreInstanceFilter(OrthancPluginContext *context, OrthancPluginIncomingCStoreInstanceFilter callback)
Register a callback to filter incoming DICOM instances received by Orthanc through C-STORE.
Definition: OrthancCPlugin.h:8562
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:1443
void OrthancPluginRegisterRefreshMetricsCallback(OrthancPluginContext *context, OrthancPluginRefreshMetricsCallback callback)
Register a callback to refresh the metrics.
Definition: OrthancCPlugin.h:7644
OrthancPluginErrorCode OrthancPluginRegisterHttpAuthentication(OrthancPluginContext *context, OrthancPluginHttpAuthentication callback)
Register a callback to handle HTTP authentication (and possibly HTTP authorization).
Definition: OrthancCPlugin.h:10728
OrthancPluginErrorCode(* OrthancPluginWebDavCreateFolderCallback)(uint8_t *isReadOnly, uint32_t pathSize, const char *const *pathItems, void *payload)
Callback to create a folder.
Definition: OrthancCPlugin.h:9669
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:1624
struct _OrthancPluginWebDavCollection_t OrthancPluginWebDavCollection
Opaque structure that represents a WebDAV collection.
Definition: OrthancCPlugin.h:9484
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:2163
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:9624
int32_t(* OrthancPluginIncomingDicomInstanceFilter)(const OrthancPluginDicomInstance *instance)
Callback to filter incoming DICOM instances received by Orthanc.
Definition: OrthancCPlugin.h:8476
OrthancPluginErrorCode OrthancPluginStorageAreaRemove(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Remove a file from the storage area.
Definition: OrthancCPlugin.h:5310
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:9140
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter2(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter2 callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:6871
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:9552
void OrthancPluginRegisterStorageArea3(OrthancPluginContext *context, OrthancPluginStorageCreate2 create, OrthancPluginStorageReadRange2 readRange, OrthancPluginStorageRemove2 remove)
Register a custom storage area, with support for custom data.
Definition: OrthancCPlugin.h:9806
OrthancPluginErrorCode(* OrthancPluginStorageRead)(void **content, int64_t *size, const char *uuid, OrthancPluginContentType type)
Callback for reading from the storage area.
Definition: OrthancCPlugin.h:1510
void OrthancPluginRegisterRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback.
Definition: OrthancCPlugin.h:2518
uint32_t OrthancPluginGetExpectedDatabaseVersion(OrthancPluginContext *context)
Get the expected version of the database schema.
Definition: OrthancCPlugin.h:4108
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:8640
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:9598
int32_t OrthancPluginCheckVersion(const OrthancPluginContext *context)
Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
Definition: OrthancCPlugin.h:2398
struct _OrthancPluginRestOutput_t OrthancPluginRestOutput
Opaque structure that represents the HTTP connection to the client application.
Definition: OrthancCPlugin.h:1301
void OrthancPluginRegisterOnChangeCallback(OrthancPluginContext *context, OrthancPluginOnChangeCallback callback)
Register a callback to monitor changes.
Definition: OrthancCPlugin.h:3774
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:9329
OrthancPluginErrorCode(* OrthancPluginWebDavAddFolder)(OrthancPluginWebDavCollection *collection, const char *name, const char *dateTime)
Declare a subfolder while returning the content of a folder.
Definition: OrthancCPlugin.h:9525
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:9729
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:1755
void(* OrthancPluginRefreshMetricsCallback)()
Callback executed to update the metrics of the plugin.
Definition: OrthancCPlugin.h:2135
OrthancPluginErrorCode OrthancPluginRegisterTranscoderCallback(OrthancPluginContext *context, OrthancPluginTranscoderCallback callback)
Register a callback to handle the transcoding of DICOM images.
Definition: OrthancCPlugin.h:9168
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:1422
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:1595
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:9647
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:9689
OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, OrthancPluginResourceType level)
Reconstruct the main DICOM tags.
Definition: OrthancCPlugin.h:5503
OrthancPluginErrorCode(* OrthancPluginStorageRemove)(const char *uuid, OrthancPluginContentType type)
Callback for removing a file from the storage area.
Definition: OrthancCPlugin.h:1571
OrthancPluginErrorCode(* OrthancPluginStorageCreate)(const char *uuid, const void *content, int64_t size, OrthancPluginContentType type)
Callback for writing to the storage area.
Definition: OrthancCPlugin.h:1484
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:2201
OrthancPluginErrorCode OrthancPluginRegisterAuditLogHandler(OrthancPluginContext *context, OrthancPluginAuditLogHandler handler)
Register a callback to handle audit logs.
Definition: OrthancCPlugin.h:10840
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:1432
OrthancPluginErrorCode(* OrthancPluginRestCallback)(OrthancPluginRestOutput *output, const char *uri, const OrthancPluginHttpRequest *request)
Signature of a callback function that answers to a REST request.
Definition: OrthancCPlugin.h:1411
void(* OrthancPluginFinalizeDatabaseBackendV4)(void *backend)
Signature of a callback function that is triggered when the database plugin must be finalized.
Definition: OrthancCPlugin.h:9836
struct _OrthancPluginServerChunkedRequestReader_t OrthancPluginServerChunkedRequestReader
Opaque structure that reads the content of a HTTP request body during a chunked HTTP transfer.
Definition: OrthancCPlugin.h:8097
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:9573
struct _OrthancPluginKeysValuesIterator_t OrthancPluginKeysValuesIterator
Opaque structure that represents an iterator over the keys and values of a key-value store.
Definition: OrthancCPlugin.h:10339
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:1716
OrthancPluginJob *(* OrthancPluginJobsUnserializer)(const char *jobType, const char *serialized)
Callback executed to unserialize a custom job.
Definition: OrthancCPlugin.h:2116
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:2283
void OrthancPluginRegisterJobsUnserializer(OrthancPluginContext *context, OrthancPluginJobsUnserializer unserializer)
Register an unserializer for custom jobs.
Definition: OrthancCPlugin.h:7495
void(* OrthancPluginFree)(void *buffer)
Signature of a function to free dynamic memory.
Definition: OrthancCPlugin.h:1455
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:10814
void OrthancPluginRegisterRestCallbackNoLock(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback, without locking.
Definition: OrthancCPlugin.h:2558
OrthancPluginErrorCode OrthancPluginStorageAreaRead(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Read a file from the storage area.
Definition: OrthancCPlugin.h:5269
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:1647
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:1553
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:8220
int32_t(* OrthancPluginIncomingCStoreInstanceFilter)(uint16_t *dimseStatus, const OrthancPluginDicomInstance *instance)
Callback to filter incoming DICOM instances received by Orthanc through C-STORE.
Definition: OrthancCPlugin.h:8539
OrthancPluginErrorCode OrthancPluginRegisterIncomingDicomInstanceFilter(OrthancPluginContext *context, OrthancPluginIncomingDicomInstanceFilter callback)
Register a callback to filter incoming DICOM instances.
Definition: OrthancCPlugin.h:8498
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:6290
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:5223
@ OrthancPluginChangeType_OrthancStopped
Definition: OrthancCPlugin.h:837
@ OrthancPluginChangeType_OrthancStarted
Definition: OrthancCPlugin.h:836
@ OrthancPluginChangeType_Deleted
Definition: OrthancCPlugin.h:827
@ OrthancPluginChangeType_JobFailure
Definition: OrthancCPlugin.h:844
@ OrthancPluginChangeType_NewInstance
Definition: OrthancCPlugin.h:829
@ OrthancPluginChangeType_NewPatient
Definition: OrthancCPlugin.h:830
@ OrthancPluginChangeType_JobSubmitted
Definition: OrthancCPlugin.h:842
@ OrthancPluginChangeType_NewSeries
Definition: OrthancCPlugin.h:831
@ OrthancPluginChangeType_StablePatient
Definition: OrthancCPlugin.h:833
@ OrthancPluginChangeType_UpdatedPeers
Definition: OrthancCPlugin.h:840
@ OrthancPluginChangeType_StableStudy
Definition: OrthancCPlugin.h:835
@ OrthancPluginChangeType_CompletedSeries
Definition: OrthancCPlugin.h:826
@ OrthancPluginChangeType_NewChildInstance
Definition: OrthancCPlugin.h:828
@ OrthancPluginChangeType_UpdatedAttachment
Definition: OrthancCPlugin.h:838
@ OrthancPluginChangeType_UpdatedMetadata
Definition: OrthancCPlugin.h:839
@ OrthancPluginChangeType_StableSeries
Definition: OrthancCPlugin.h:834
@ OrthancPluginChangeType_UpdatedModalities
Definition: OrthancCPlugin.h:841
@ OrthancPluginChangeType_JobSuccess
Definition: OrthancCPlugin.h:843
@ OrthancPluginChangeType_NewStudy
Definition: OrthancCPlugin.h:832
uint32_t OrthancPluginGetFindQuerySize(OrthancPluginContext *context, const OrthancPluginFindQuery *query)
Get the number of tags in a C-Find query.
Definition: OrthancCPlugin.h:6557
struct _OrthancPluginFindQuery_t OrthancPluginFindQuery
Opaque structure to an object that represents a C-Find query.
Definition: OrthancCPlugin.h:1349
OrthancPluginErrorCode(* OrthancPluginApplyMove)(void *moveDriver)
Callback to apply one C-Move suboperation.
Definition: OrthancCPlugin.h:1929
OrthancPluginErrorCode OrthancPluginFindMarkIncomplete(OrthancPluginContext *context, OrthancPluginFindAnswers *answers)
Mark the set of C-Find answers as incomplete.
Definition: OrthancCPlugin.h:6532
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:6627
void(* OrthancPluginStorageCommitmentDestructor)(void *handler)
Callback to free one storage commitment SCP handler.
Definition: OrthancCPlugin.h:8387
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:1667
OrthancPluginErrorCode OrthancPluginRegisterMoveCallback2(OrthancPluginContext *context, OrthancPluginMoveCallback2 callback, OrthancPluginGetMoveSize getMoveSize, OrthancPluginApplyMove applyMove, OrthancPluginFreeMove freeMove)
Register a callback to handle C-Move requests (v2).
Definition: OrthancCPlugin.h:11121
OrthancPluginErrorCode OrthancPluginRegisterMoveCallback(OrthancPluginContext *context, OrthancPluginMoveCallback callback, OrthancPluginGetMoveSize getMoveSize, OrthancPluginApplyMove applyMove, OrthancPluginFreeMove freeMove)
Register a callback to handle C-Move requests.
Definition: OrthancCPlugin.h:6715
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:8327
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:11159
OrthancPluginErrorCode OrthancPluginRegisterWorklistCallback2(OrthancPluginContext *context, OrthancPluginWorklistCallback2 callback)
Register a callback to handle modality worklists requests (v2).
Definition: OrthancCPlugin.h:11060
OrthancPluginErrorCode OrthancPluginRegisterFindCallback(OrthancPluginContext *context, OrthancPluginFindCallback callback)
Register a callback to handle C-Find requests.
Definition: OrthancCPlugin.h:6462
OrthancPluginErrorCode(* OrthancPluginFindCallback2)(OrthancPluginFindAnswers *answers, const OrthancPluginFindQuery *query, const OrthancPluginDicomConnection *connection)
Callback to handle incoming C-Find SCP requests (v2).
Definition: OrthancCPlugin.h:1803
OrthancPluginErrorCode OrthancPluginWorklistGetDicomQuery(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginWorklistQuery *query)
Retrieve the worklist query as a DICOM file.
Definition: OrthancCPlugin.h:5834
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:1890
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:8408
int32_t OrthancPluginWorklistIsMatch(OrthancPluginContext *context, const OrthancPluginWorklistQuery *query, const void *dicom, uint32_t size)
Test whether a worklist matches the query.
Definition: OrthancCPlugin.h:5795
OrthancPluginErrorCode OrthancPluginFindAddAnswer(OrthancPluginContext *context, OrthancPluginFindAnswers *answers, const void *dicom, uint32_t size)
Add one answer to some C-Find request.
Definition: OrthancCPlugin.h:6502
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:1844
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:8436
struct _OrthancPluginFindAnswers_t OrthancPluginFindAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1358
struct _OrthancPluginWorklistAnswers_t OrthancPluginWorklistAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1341
OrthancPluginErrorCode(* OrthancPluginFindCallback)(OrthancPluginFindAnswers *answers, const OrthancPluginFindQuery *query, const char *issuerAet, const char *calledAet)
Callback to handle incoming C-Find SCP requests.
Definition: OrthancCPlugin.h:1782
uint32_t(* OrthancPluginGetMoveSize)(void *moveDriver)
Callback to read the size of a C-Move driver.
Definition: OrthancCPlugin.h:1914
OrthancPluginErrorCode OrthancPluginRegisterWorklistCallback(OrthancPluginContext *context, OrthancPluginWorklistCallback callback)
Register a callback to handle modality worklists requests.
Definition: OrthancCPlugin.h:5692
OrthancPluginErrorCode OrthancPluginRegisterFindCallback2(OrthancPluginContext *context, OrthancPluginFindCallback2 callback)
Register a callback to handle C-Find requests (v2).
Definition: OrthancCPlugin.h:11088
OrthancPluginErrorCode OrthancPluginWorklistMarkIncomplete(OrthancPluginContext *context, OrthancPluginWorklistAnswers *answers)
Mark the set of worklist answers as incomplete.
Definition: OrthancCPlugin.h:5757
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:6666
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:6595
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:8366
void(* OrthancPluginFreeMove)(void *moveDriver)
Callback to free one C-Move driver.
Definition: OrthancCPlugin.h:1943
struct _OrthancPluginWorklistQuery_t OrthancPluginWorklistQuery
Opaque structure to an object that represents a C-Find query for worklists.
Definition: OrthancCPlugin.h:1333
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:5727
OrthancPluginErrorCode(* OrthancPluginWorklistCallback2)(OrthancPluginWorklistAnswers *answers, const OrthancPluginWorklistQuery *query, const OrthancPluginDicomConnection *connection)
Callback to handle the C-Find SCP requests for worklists (v2).
Definition: OrthancCPlugin.h:1687
const char * OrthancPluginGetConnectionRemoteIp(OrthancPluginContext *context, const OrthancPluginDicomConnection *connection)
Get the remote IP of a DICOM connection.
Definition: OrthancCPlugin.h:10985
struct _OrthancPluginDicomConnection_t OrthancPluginDicomConnection
Opaque structure that represents the parameters of a DICOM connection.
Definition: OrthancCPlugin.h:1403
const char * OrthancPluginGetConnectionRemoteAet(OrthancPluginContext *context, const OrthancPluginDicomConnection *connection)
Get the remote AET of a DICOM connection.
Definition: OrthancCPlugin.h:10950
const char * OrthancPluginGetConnectionCalledAet(OrthancPluginContext *context, const OrthancPluginDicomConnection *connection)
Get the called AET of a DICOM connection.
Definition: OrthancCPlugin.h:11020
int32_t OrthancPluginHasInstancePixelData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Check whether the DICOM file has pixel data.
Definition: OrthancCPlugin.h:8700
char * OrthancPluginGetInstanceDicomWebXml(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb XML.
Definition: OrthancCPlugin.h:9095
struct _OrthancPluginDicomInstance_t OrthancPluginDicomInstance
Opaque structure that represents a DICOM instance that is managed by the Orthanc core.
Definition: OrthancCPlugin.h:1309
char * OrthancPluginGetInstanceTransferSyntaxUid(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the transfer syntax of a DICOM file.
Definition: OrthancCPlugin.h:8664
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:8869
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:9010
const void * OrthancPluginGetInstanceData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the data of a DICOM file.
Definition: OrthancCPlugin.h:3428
OrthancPluginDicomInstance * OrthancPluginCreateDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size)
Parse a DICOM instance.
Definition: OrthancCPlugin.h:8751
int32_t OrthancPluginHasInstanceMetadata(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, const char *metadata)
Check whether a DICOM instance is associated with some metadata.
Definition: OrthancCPlugin.h:3541
uint32_t OrthancPluginGetInstanceFramesCount(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the number of frames in a DICOM instance.
Definition: OrthancCPlugin.h:8828
OrthancPluginImage * OrthancPluginGetInstanceDecodedFrame(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:8898
OrthancPluginDicomInstance * OrthancPluginLoadDicomInstance(OrthancPluginContext *context, const char *instanceId, OrthancPluginLoadDicomInstanceMode mode)
Load a DICOM instance from the Orthanc server.
Definition: OrthancCPlugin.h:9902
OrthancPluginInstanceOrigin OrthancPluginGetInstanceOrigin(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the origin of a DICOM file.
Definition: OrthancCPlugin.h:5860
int64_t OrthancPluginGetInstanceSize(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the size of a DICOM file.
Definition: OrthancCPlugin.h:3395
char * OrthancPluginGetInstanceDicomWebJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb JSON.
Definition: OrthancCPlugin.h:9054
char * OrthancPluginGetInstanceSimplifiedJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file (with simplification).
Definition: OrthancCPlugin.h:3502
char * OrthancPluginGetInstanceJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file.
Definition: OrthancCPlugin.h:3464
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:3582
void OrthancPluginFreeDicomInstance(OrthancPluginContext *context, OrthancPluginDicomInstance *dicom)
Free a DICOM instance.
Definition: OrthancCPlugin.h:8790
OrthancPluginErrorCode OrthancPluginSerializeDicomInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginDicomInstance *instance)
Writes a DICOM instance to a memory buffer.
Definition: OrthancCPlugin.h:8977
OrthancPluginDicomInstance * OrthancPluginTranscodeDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size, const char *transferSyntax)
Parse and transcode a DICOM instance.
Definition: OrthancCPlugin.h:8938
const char * OrthancPluginGetInstanceRemoteAet(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the AET of a DICOM instance.
Definition: OrthancCPlugin.h:3362
OrthancPluginPixelFormat
Definition: OrthancCPlugin.h:700
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:5167
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:4751
uint32_t OrthancPluginGetImagePitch(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pitch of an image.
Definition: OrthancCPlugin.h:4542
OrthancPluginImage * OrthancPluginConvertPixelFormat(OrthancPluginContext *context, const OrthancPluginImage *source, OrthancPluginPixelFormat targetFormat)
Change the pixel format of an image.
Definition: OrthancCPlugin.h:5007
OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pixel format of an image.
Definition: OrthancCPlugin.h:4441
uint32_t OrthancPluginGetFontsCount(OrthancPluginContext *context)
Return the number of available fonts.
Definition: OrthancCPlugin.h:5042
uint32_t OrthancPluginGetImageHeight(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the height of an image.
Definition: OrthancCPlugin.h:4507
void OrthancPluginFreeImage(OrthancPluginContext *context, OrthancPluginImage *image)
Free an image.
Definition: OrthancCPlugin.h:4661
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:4706
OrthancPluginImage * OrthancPluginCreateImage(OrthancPluginContext *context, OrthancPluginPixelFormat format, uint32_t width, uint32_t height)
Create an image.
Definition: OrthancCPlugin.h:5990
OrthancPluginImage * OrthancPluginUncompressImage(OrthancPluginContext *context, const void *data, uint32_t size, OrthancPluginImageFormat format)
Decode a compressed image.
Definition: OrthancCPlugin.h:4619
const char * OrthancPluginGetFontName(OrthancPluginContext *context, uint32_t fontIndex)
Return the name of a font.
Definition: OrthancCPlugin.h:5082
void * OrthancPluginGetImageBuffer(OrthancPluginContext *context, const OrthancPluginImage *image)
Return a pointer to the content of an image.
Definition: OrthancCPlugin.h:4576
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:6033
OrthancPluginImageFormat
Definition: OrthancCPlugin.h:871
struct _OrthancPluginStorageArea_t OrthancPluginStorageArea
Opaque structure that represents the storage area that is actually used by Orthanc.
Definition: OrthancCPlugin.h:1325
OrthancPluginCompressionType
Definition: OrthancCPlugin.h:855
uint32_t OrthancPluginGetImageWidth(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the width of an image.
Definition: OrthancCPlugin.h:4474
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:4253
OrthancPluginImage * OrthancPluginDecodeDicomImage(OrthancPluginContext *context, const void *buffer, uint32_t bufferSize, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:6079
uint32_t OrthancPluginGetFontSize(OrthancPluginContext *context, uint32_t fontIndex)
Return the size of a font.
Definition: OrthancCPlugin.h:5114
struct _OrthancPluginImage_t OrthancPluginImage
Opaque structure that represents an image that is uncompressed in memory.
Definition: OrthancCPlugin.h:1317
@ OrthancPluginPixelFormat_RGBA32
Color image in RGBA32 format.
Definition: OrthancCPlugin.h:739
@ OrthancPluginPixelFormat_RGB48
Color image in RGB48 format.
Definition: OrthancCPlugin.h:749
@ OrthancPluginPixelFormat_Grayscale8
Graylevel 8bpp image.
Definition: OrthancCPlugin.h:707
@ OrthancPluginPixelFormat_SignedGrayscale16
Graylevel, signed 16bpp image.
Definition: OrthancCPlugin.h:723
@ OrthancPluginPixelFormat_Float32
Graylevel, floating-point 32bpp image.
Definition: OrthancCPlugin.h:765
@ OrthancPluginPixelFormat_RGB24
Color image in RGB24 format.
Definition: OrthancCPlugin.h:731
@ OrthancPluginPixelFormat_BGRA32
Color image in BGRA32 format.
Definition: OrthancCPlugin.h:773
@ OrthancPluginPixelFormat_Unknown
Definition: OrthancCPlugin.h:741
@ OrthancPluginPixelFormat_Grayscale64
Graylevel, unsigned 64bpp image.
Definition: OrthancCPlugin.h:781
@ OrthancPluginPixelFormat_Grayscale32
Graylevel, unsigned 32bpp image.
Definition: OrthancCPlugin.h:757
@ OrthancPluginPixelFormat_Grayscale16
Graylevel, unsigned 16bpp image.
Definition: OrthancCPlugin.h:715
@ OrthancPluginImageFormat_Png
Definition: OrthancCPlugin.h:872
@ OrthancPluginImageFormat_Jpeg
Definition: OrthancCPlugin.h:873
@ OrthancPluginImageFormat_Dicom
Definition: OrthancCPlugin.h:874
@ OrthancPluginCompressionType_Gzip
Definition: OrthancCPlugin.h:858
@ OrthancPluginCompressionType_ZlibWithSize
Definition: OrthancCPlugin.h:857
@ OrthancPluginCompressionType_None
Definition: OrthancCPlugin.h:860
@ OrthancPluginCompressionType_Zlib
Definition: OrthancCPlugin.h:856
@ OrthancPluginCompressionType_GzipWithSize
Definition: OrthancCPlugin.h:859
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:2826
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:2861
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:2974
char * OrthancPluginLookupStudy(OrthancPluginContext *context, const char *studyUID)
Look for a study.
Definition: OrthancCPlugin.h:3075
OrthancPluginErrorCode OrthancPluginSetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *value)
Set the value of a global property.
Definition: OrthancCPlugin.h:4011
char * OrthancPluginGetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *defaultValue)
Get the value of a global property.
Definition: OrthancCPlugin.h:3972
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:2938
char * OrthancPluginLookupSeries(OrthancPluginContext *context, const char *seriesUID)
Look for a series.
Definition: OrthancCPlugin.h:3145
char * OrthancPluginLookupStudyWithAccessionNumber(OrthancPluginContext *context, const char *accessionNumber)
Look for a study, using the accession number.
Definition: OrthancCPlugin.h:3110
char * OrthancPluginGenerateRestApiAuthorizationToken(OrthancPluginContext *context)
Generate a token to grant full access to the REST API of Orthanc.
Definition: OrthancCPlugin.h:9243
OrthancPluginErrorCode OrthancPluginRestApiGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2759
char * OrthancPluginLookupInstance(OrthancPluginContext *context, const char *sopInstanceUID)
Look for an instance.
Definition: OrthancCPlugin.h:3180
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:2789
char * OrthancPluginLookupPatient(OrthancPluginContext *context, const char *patientID)
Look for a patient.
Definition: OrthancCPlugin.h:3040
OrthancPluginErrorCode OrthancPluginRestApiDelete(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2890
OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:2913
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:9446
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:5654
OrthancPluginErrorCode OrthancPluginGetDicomForInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *instanceId)
Retrieve a DICOM instance using its Orthanc identifier.
Definition: OrthancCPlugin.h:2726
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:2685
void OrthancPluginSendUnauthorized(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *realm)
Signal that a REST request is not authorized.
Definition: OrthancCPlugin.h:3248
void OrthancPluginSetHttpErrorDetails(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *details, uint8_t log)
Provide a detailed description for an HTTP error.
Definition: OrthancCPlugin.h:7532
void OrthancPluginSendMethodNotAllowed(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *allowedMethods)
Signal that this URI does not support this HTTP method.
Definition: OrthancCPlugin.h:3271
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:10078
void OrthancPluginAnswerBuffer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const void *answer, uint32_t answerSize, const char *mimeType)
Answer to a REST request.
Definition: OrthancCPlugin.h:2628
void OrthancPluginSendHttpStatusCode(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status)
Send a HTTP status code.
Definition: OrthancCPlugin.h:3225
void OrthancPluginSetHttpHeader(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *key, const char *value)
Set some HTTP header.
Definition: OrthancCPlugin.h:3326
OrthancPluginErrorCode OrthancPluginStartStreamAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *contentType)
Start an HTTP stream answer.
Definition: OrthancCPlugin.h:10050
void OrthancPluginSetCookie(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *cookie, const char *value)
Set a cookie.
Definition: OrthancCPlugin.h:3301
void OrthancPluginRedirect(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *redirection)
Redirect a REST request.
Definition: OrthancCPlugin.h:3008
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:4798
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:4211
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:6251
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:4405
OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *subType, const char *contentType)
Start an HTTP multipart answer.
Definition: OrthancCPlugin.h:4182
An entry in the dictionary of DICOM tags.
Definition: OrthancCPlugin.h:2234
uint32_t minMultiplicity
Definition: OrthancCPlugin.h:2238
uint32_t maxMultiplicity
Definition: OrthancCPlugin.h:2239
OrthancPluginValueRepresentation vr
Definition: OrthancCPlugin.h:2237
uint16_t element
Definition: OrthancCPlugin.h:2236
uint16_t group
Definition: OrthancCPlugin.h:2235
The parameters of a REST request.
Definition: OrthancCPlugin.h:380
uint32_t authenticationPayloadSize
The size of the custom authentication payload (0 if no authentication callback is registered).
Definition: OrthancCPlugin.h:456
const char *const * getValues
For a GET request, the values of the GET parameters.
Definition: OrthancCPlugin.h:409
const char *const * groups
The matched values for the groups of the regular expression.
Definition: OrthancCPlugin.h:394
const void * authenticationPayload
If a HTTP authentication callback is registered, the content of the custom payload generated by the c...
Definition: OrthancCPlugin.h:450
uint32_t bodySize
For a PUT or POST request, the number of bytes of the body.
Definition: OrthancCPlugin.h:419
uint32_t groupsCount
The number of groups of the regular expression.
Definition: OrthancCPlugin.h:389
const char *const * headersKeys
The keys of the HTTP headers (always converted to low-case).
Definition: OrthancCPlugin.h:434
const void * body
For a PUT or POST request, the content of the body.
Definition: OrthancCPlugin.h:414
const char *const * getKeys
For a GET request, the keys of the GET parameters.
Definition: OrthancCPlugin.h:404
uint32_t headersCount
The number of HTTP headers.
Definition: OrthancCPlugin.h:429
OrthancPluginHttpMethod method
The HTTP method.
Definition: OrthancCPlugin.h:384
uint32_t getCount
For a GET request, the number of GET parameters.
Definition: OrthancCPlugin.h:399
const char *const * headersValues
The values of the HTTP headers.
Definition: OrthancCPlugin.h:439
A 64-bit memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:1282
uint64_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:1291
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:1286
A 32-bit memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:1260
uint32_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:1269
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:1264