115 # define ORTHANC_PLUGINS_API __declspec(dllexport)
117 # define ORTHANC_PLUGINS_API __attribute__ ((visibility ("default")))
119 # define ORTHANC_PLUGINS_API
122 #define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 1
123 #define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 12
124 #define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 4
127 #if !defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE)
128 #define ORTHANC_PLUGINS_VERSION_IS_ABOVE(major, minor, revision) \
129 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER > major || \
130 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER == major && \
131 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER > minor || \
132 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER == minor && \
133 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER >= revision))))
152 #ifndef ORTHANC_PLUGIN_INLINE
153 # if __STDC_VERSION__ >= 199901L
155 # define ORTHANC_PLUGIN_INLINE static inline
156 # elif defined(__cplusplus)
158 # define ORTHANC_PLUGIN_INLINE static inline
159 # elif defined(__GNUC__)
161 # define ORTHANC_PLUGIN_INLINE static __inline
162 # elif defined(_MSC_VER)
164 # define ORTHANC_PLUGIN_INLINE static __inline
166 # error Your compiler is not known to support the "inline" keyword
171 #ifndef ORTHANC_PLUGIN_DEPRECATED
172 # if defined(_MSC_VER)
173 # define ORTHANC_PLUGIN_DEPRECATED __declspec(deprecated)
175 # define ORTHANC_PLUGIN_DEPRECATED __attribute__ ((deprecated))
176 # elif defined(__clang__)
177 # define ORTHANC_PLUGIN_DEPRECATED __attribute__ ((deprecated))
179 # pragma message("WARNING: You need to implement ORTHANC_PLUGINS_DEPRECATED for this compiler")
180 # define ORTHANC_PLUGIN_DEPRECATED
328 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
336 ORTHANC_PLUGINS_API
const char* OrthancPluginGetName();
349 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
425 _OrthancPluginService_LogInfo = 1,
426 _OrthancPluginService_LogWarning = 2,
427 _OrthancPluginService_LogError = 3,
428 _OrthancPluginService_GetOrthancPath = 4,
429 _OrthancPluginService_GetOrthancDirectory = 5,
430 _OrthancPluginService_GetConfigurationPath = 6,
431 _OrthancPluginService_SetPluginProperty = 7,
432 _OrthancPluginService_GetGlobalProperty = 8,
433 _OrthancPluginService_SetGlobalProperty = 9,
434 _OrthancPluginService_GetCommandLineArgumentsCount = 10,
435 _OrthancPluginService_GetCommandLineArgument = 11,
436 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
437 _OrthancPluginService_GetConfiguration = 13,
438 _OrthancPluginService_BufferCompression = 14,
439 _OrthancPluginService_ReadFile = 15,
440 _OrthancPluginService_WriteFile = 16,
441 _OrthancPluginService_GetErrorDescription = 17,
442 _OrthancPluginService_CallHttpClient = 18,
443 _OrthancPluginService_RegisterErrorCode = 19,
444 _OrthancPluginService_RegisterDictionaryTag = 20,
445 _OrthancPluginService_DicomBufferToJson = 21,
446 _OrthancPluginService_DicomInstanceToJson = 22,
447 _OrthancPluginService_CreateDicom = 23,
448 _OrthancPluginService_ComputeMd5 = 24,
449 _OrthancPluginService_ComputeSha1 = 25,
450 _OrthancPluginService_LookupDictionary = 26,
451 _OrthancPluginService_CallHttpClient2 = 27,
452 _OrthancPluginService_GenerateUuid = 28,
453 _OrthancPluginService_RegisterPrivateDictionaryTag = 29,
454 _OrthancPluginService_AutodetectMimeType = 30,
455 _OrthancPluginService_SetMetricsValue = 31,
456 _OrthancPluginService_EncodeDicomWebJson = 32,
457 _OrthancPluginService_EncodeDicomWebXml = 33,
458 _OrthancPluginService_ChunkedHttpClient = 34,
459 _OrthancPluginService_GetTagName = 35,
460 _OrthancPluginService_EncodeDicomWebJson2 = 36,
461 _OrthancPluginService_EncodeDicomWebXml2 = 37,
462 _OrthancPluginService_CreateMemoryBuffer = 38,
463 _OrthancPluginService_GenerateRestApiAuthorizationToken = 39,
464 _OrthancPluginService_CreateMemoryBuffer64 = 40,
465 _OrthancPluginService_CreateDicom2 = 41,
466 _OrthancPluginService_GetDatabaseServerIdentifier = 42,
467 _OrthancPluginService_SetMetricsIntegerValue = 43,
468 _OrthancPluginService_SetCurrentThreadName = 44,
469 _OrthancPluginService_LogMessage = 45,
473 _OrthancPluginService_RegisterRestCallback = 1000,
474 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
475 _OrthancPluginService_RegisterStorageArea = 1002,
476 _OrthancPluginService_RegisterOnChangeCallback = 1003,
477 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
478 _OrthancPluginService_RegisterWorklistCallback = 1005,
479 _OrthancPluginService_RegisterDecodeImageCallback = 1006,
480 _OrthancPluginService_RegisterIncomingHttpRequestFilter = 1007,
481 _OrthancPluginService_RegisterFindCallback = 1008,
482 _OrthancPluginService_RegisterMoveCallback = 1009,
483 _OrthancPluginService_RegisterIncomingHttpRequestFilter2 = 1010,
484 _OrthancPluginService_RegisterRefreshMetricsCallback = 1011,
485 _OrthancPluginService_RegisterChunkedRestCallback = 1012,
486 _OrthancPluginService_RegisterStorageCommitmentScpCallback = 1013,
487 _OrthancPluginService_RegisterIncomingDicomInstanceFilter = 1014,
488 _OrthancPluginService_RegisterTranscoderCallback = 1015,
489 _OrthancPluginService_RegisterStorageArea2 = 1016,
490 _OrthancPluginService_RegisterIncomingCStoreInstanceFilter = 1017,
491 _OrthancPluginService_RegisterReceivedInstanceCallback = 1018,
492 _OrthancPluginService_RegisterWebDavCollection = 1019,
495 _OrthancPluginService_AnswerBuffer = 2000,
496 _OrthancPluginService_CompressAndAnswerPngImage = 2001,
497 _OrthancPluginService_Redirect = 2002,
498 _OrthancPluginService_SendHttpStatusCode = 2003,
499 _OrthancPluginService_SendUnauthorized = 2004,
500 _OrthancPluginService_SendMethodNotAllowed = 2005,
501 _OrthancPluginService_SetCookie = 2006,
502 _OrthancPluginService_SetHttpHeader = 2007,
503 _OrthancPluginService_StartMultipartAnswer = 2008,
504 _OrthancPluginService_SendMultipartItem = 2009,
505 _OrthancPluginService_SendHttpStatus = 2010,
506 _OrthancPluginService_CompressAndAnswerImage = 2011,
507 _OrthancPluginService_SendMultipartItem2 = 2012,
508 _OrthancPluginService_SetHttpErrorDetails = 2013,
511 _OrthancPluginService_GetDicomForInstance = 3000,
512 _OrthancPluginService_RestApiGet = 3001,
513 _OrthancPluginService_RestApiPost = 3002,
514 _OrthancPluginService_RestApiDelete = 3003,
515 _OrthancPluginService_RestApiPut = 3004,
516 _OrthancPluginService_LookupPatient = 3005,
517 _OrthancPluginService_LookupStudy = 3006,
518 _OrthancPluginService_LookupSeries = 3007,
519 _OrthancPluginService_LookupInstance = 3008,
520 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
521 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
522 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
523 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
524 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
525 _OrthancPluginService_ReconstructMainDicomTags = 3014,
526 _OrthancPluginService_RestApiGet2 = 3015,
527 _OrthancPluginService_CallRestApi = 3016,
530 _OrthancPluginService_GetInstanceRemoteAet = 4000,
531 _OrthancPluginService_GetInstanceSize = 4001,
532 _OrthancPluginService_GetInstanceData = 4002,
533 _OrthancPluginService_GetInstanceJson = 4003,
534 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
535 _OrthancPluginService_HasInstanceMetadata = 4005,
536 _OrthancPluginService_GetInstanceMetadata = 4006,
537 _OrthancPluginService_GetInstanceOrigin = 4007,
538 _OrthancPluginService_GetInstanceTransferSyntaxUid = 4008,
539 _OrthancPluginService_HasInstancePixelData = 4009,
540 _OrthancPluginService_CreateDicomInstance = 4010,
541 _OrthancPluginService_FreeDicomInstance = 4011,
542 _OrthancPluginService_GetInstanceFramesCount = 4012,
543 _OrthancPluginService_GetInstanceRawFrame = 4013,
544 _OrthancPluginService_GetInstanceDecodedFrame = 4014,
545 _OrthancPluginService_TranscodeDicomInstance = 4015,
546 _OrthancPluginService_SerializeDicomInstance = 4016,
547 _OrthancPluginService_GetInstanceAdvancedJson = 4017,
548 _OrthancPluginService_GetInstanceDicomWebJson = 4018,
549 _OrthancPluginService_GetInstanceDicomWebXml = 4019,
550 _OrthancPluginService_LoadDicomInstance = 4020,
553 _OrthancPluginService_RegisterDatabaseBackend = 5000,
554 _OrthancPluginService_DatabaseAnswer = 5001,
555 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002,
556 _OrthancPluginService_StorageAreaCreate = 5003,
557 _OrthancPluginService_StorageAreaRead = 5004,
558 _OrthancPluginService_StorageAreaRemove = 5005,
559 _OrthancPluginService_RegisterDatabaseBackendV3 = 5006,
560 _OrthancPluginService_RegisterDatabaseBackendV4 = 5007,
563 _OrthancPluginService_GetImagePixelFormat = 6000,
564 _OrthancPluginService_GetImageWidth = 6001,
565 _OrthancPluginService_GetImageHeight = 6002,
566 _OrthancPluginService_GetImagePitch = 6003,
567 _OrthancPluginService_GetImageBuffer = 6004,
568 _OrthancPluginService_UncompressImage = 6005,
569 _OrthancPluginService_FreeImage = 6006,
570 _OrthancPluginService_CompressImage = 6007,
571 _OrthancPluginService_ConvertPixelFormat = 6008,
572 _OrthancPluginService_GetFontsCount = 6009,
573 _OrthancPluginService_GetFontInfo = 6010,
574 _OrthancPluginService_DrawText = 6011,
575 _OrthancPluginService_CreateImage = 6012,
576 _OrthancPluginService_CreateImageAccessor = 6013,
577 _OrthancPluginService_DecodeDicomImage = 6014,
580 _OrthancPluginService_WorklistAddAnswer = 7000,
581 _OrthancPluginService_WorklistMarkIncomplete = 7001,
582 _OrthancPluginService_WorklistIsMatch = 7002,
583 _OrthancPluginService_WorklistGetDicomQuery = 7003,
584 _OrthancPluginService_FindAddAnswer = 7004,
585 _OrthancPluginService_FindMarkIncomplete = 7005,
586 _OrthancPluginService_GetFindQuerySize = 7006,
587 _OrthancPluginService_GetFindQueryTag = 7007,
588 _OrthancPluginService_GetFindQueryTagName = 7008,
589 _OrthancPluginService_GetFindQueryValue = 7009,
590 _OrthancPluginService_CreateFindMatcher = 7010,
591 _OrthancPluginService_FreeFindMatcher = 7011,
592 _OrthancPluginService_FindMatcherIsMatch = 7012,
595 _OrthancPluginService_GetPeers = 8000,
596 _OrthancPluginService_FreePeers = 8001,
597 _OrthancPluginService_GetPeersCount = 8003,
598 _OrthancPluginService_GetPeerName = 8004,
599 _OrthancPluginService_GetPeerUrl = 8005,
600 _OrthancPluginService_CallPeerApi = 8006,
601 _OrthancPluginService_GetPeerUserProperty = 8007,
604 _OrthancPluginService_CreateJob = 9000,
605 _OrthancPluginService_FreeJob = 9001,
606 _OrthancPluginService_SubmitJob = 9002,
607 _OrthancPluginService_RegisterJobsUnserializer = 9003,
608 _OrthancPluginService_CreateJob2 = 9004,
610 _OrthancPluginService_INTERNAL = 0x7fffffff
611 } _OrthancPluginService;
616 _OrthancPluginProperty_Description = 1,
617 _OrthancPluginProperty_RootUri = 2,
618 _OrthancPluginProperty_OrthancExplorer = 3,
620 _OrthancPluginProperty_INTERNAL = 0x7fffffff
621 } _OrthancPluginProperty;
713 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
728 _OrthancPluginContentType_INTERNAL = 0x7fffffff
744 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
775 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
790 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
804 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
842 _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff
857 _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff
878 _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff
893 _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff
909 _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff
925 _OrthancPluginConstraintType_INTERNAL = 0x7fffffff
941 _OrthancPluginInstanceOrigin_INTERNAL = 0x7fffffff
1058 _OrthancPluginReceivedInstanceAction_INTERNAL = 0x7fffffff
1086 _OrthancPluginLoadDicomInstanceMode_INTERNAL = 0x7fffffff
1103 _OrthancPluginLogLevel_INTERNAL = 0x7fffffff
1123 _OrthancPluginLogCategory_INTERNAL = 0x7fffffff
1286 const char* instanceId);
1297 const char* resourceId);
1308 const uint32_t size,
1309 uint32_t frameIndex);
1330 const char* bulkDataUri);
1348 const void* content,
1420 uint64_t rangeStart);
1456 const char* issuerAet,
1457 const char* calledAet);
1488 uint32_t headersCount,
1489 const char*
const* headersKeys,
1490 const char*
const* headersValues);
1523 uint32_t headersCount,
1524 const char*
const* headersKeys,
1525 const char*
const* headersValues,
1526 uint32_t getArgumentsCount,
1527 const char*
const* getArgumentsKeys,
1528 const char*
const* getArgumentsValues);
1549 const char* issuerAet,
1550 const char* calledAet);
1589 typedef void* (*OrthancPluginMoveCallback) (
1591 const char* patientId,
1592 const char* accessionNumber,
1593 const char* studyInstanceUid,
1594 const char* seriesInstanceUid,
1595 const char* sopInstanceUid,
1596 const char* originatorAet,
1597 const char* sourceAet,
1598 const char* targetAet,
1599 uint16_t originatorId);
1685 typedef const char* (*OrthancPluginJobGetContent) (
void* job);
1723 typedef const char* (*OrthancPluginJobGetSerialized) (
void* job);
1817 const char* serialized);
1866 uint32_t levelDepth,
1867 const uint16_t* levelTagGroup,
1868 const uint16_t* levelTagElement,
1869 const uint32_t* levelIndex,
1871 uint16_t tagElement,
1904 uint32_t levelDepth,
1905 const uint16_t* levelTagGroup,
1906 const uint16_t* levelTagElement,
1907 const uint32_t* levelIndex,
1909 uint16_t tagElement,
1918 typedef struct _OrthancPluginContext_t
1920 void* pluginsManager;
1921 const char* orthancVersion;
1924 _OrthancPluginService service,
1925 const void* params);
1984 int32_t expectedMajor,
1985 int32_t expectedMinor,
1986 int32_t expectedRevision)
1988 int32_t major, minor, revision;
1990 if (
sizeof(
int) !=
sizeof(int32_t) ||
1993 sizeof(int32_t) !=
sizeof(_OrthancPluginService) ||
1994 sizeof(int32_t) !=
sizeof(_OrthancPluginProperty) ||
2021 if (!strcmp(context->orthancVersion,
"mainline"))
2033 (context->orthancVersion,
"%4d.%4d.%4d", &major, &minor, &revision) != 3)
2040 if (major > expectedMajor)
2045 if (major < expectedMajor)
2052 if (minor > expectedMinor)
2057 if (minor < expectedMinor)
2064 if (revision >= expectedRevision)
2096 ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER,
2097 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER,
2098 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER);
2114 context->Free(buffer->
data);
2130 context->Free(buffer->
data);
2144 const char* message)
2146 context->InvokeService(context, _OrthancPluginService_LogError, message);
2160 const char* message)
2162 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
2176 const char* message)
2178 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
2185 const char* pathRegularExpression;
2187 } _OrthancPluginRestCallback;
2212 const char* pathRegularExpression,
2215 _OrthancPluginRestCallback params;
2216 params.pathRegularExpression = pathRegularExpression;
2217 params.callback = callback;
2218 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
2252 const char* pathRegularExpression,
2255 _OrthancPluginRestCallback params;
2256 params.pathRegularExpression = pathRegularExpression;
2257 params.callback = callback;
2258 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms);
2266 } _OrthancPluginOnStoredInstanceCallback;
2292 _OrthancPluginOnStoredInstanceCallback params;
2293 params.callback = callback;
2295 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
2304 uint32_t answerSize;
2305 const char* mimeType;
2306 } _OrthancPluginAnswerBuffer;
2324 uint32_t answerSize,
2325 const char* mimeType)
2327 _OrthancPluginAnswerBuffer params;
2328 params.output = output;
2329 params.answer = answer;
2330 params.answerSize = answerSize;
2331 params.mimeType = mimeType;
2332 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms);
2344 } _OrthancPluginCompressAndAnswerPngImage;
2356 } _OrthancPluginCompressAndAnswerImage;
2386 _OrthancPluginCompressAndAnswerImage params;
2387 params.output = output;
2389 params.pixelFormat = format;
2390 params.width = width;
2391 params.height = height;
2392 params.pitch = pitch;
2393 params.buffer = buffer;
2395 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
2403 const char* instanceId;
2404 } _OrthancPluginGetDicomForInstance;
2421 const char* instanceId)
2423 _OrthancPluginGetDicomForInstance params;
2424 params.target = target;
2425 params.instanceId = instanceId;
2426 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
2435 } _OrthancPluginRestApiGet;
2456 _OrthancPluginRestApiGet params;
2457 params.target = target;
2459 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
2486 _OrthancPluginRestApiGet params;
2487 params.target = target;
2489 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms);
2500 } _OrthancPluginRestApiPostPut;
2525 _OrthancPluginRestApiPostPut params;
2526 params.target = target;
2529 params.bodySize = bodySize;
2530 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
2560 _OrthancPluginRestApiPostPut params;
2561 params.target = target;
2564 params.bodySize = bodySize;
2565 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms);
2586 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
2609 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
2637 _OrthancPluginRestApiPostPut params;
2638 params.target = target;
2641 params.bodySize = bodySize;
2642 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
2673 _OrthancPluginRestApiPostPut params;
2674 params.target = target;
2677 params.bodySize = bodySize;
2678 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms);
2686 const char* argument;
2687 } _OrthancPluginOutputPlusArgument;
2703 const char* redirection)
2705 _OrthancPluginOutputPlusArgument params;
2706 params.output = output;
2707 params.argument = redirection;
2708 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
2716 const char* argument;
2717 } _OrthancPluginRetrieveDynamicString;
2734 const char* patientID)
2738 _OrthancPluginRetrieveDynamicString params;
2739 params.result = &result;
2740 params.argument = patientID;
2769 const char* studyUID)
2773 _OrthancPluginRetrieveDynamicString params;
2774 params.result = &result;
2775 params.argument = studyUID;
2804 const char* accessionNumber)
2808 _OrthancPluginRetrieveDynamicString params;
2809 params.result = &result;
2810 params.argument = accessionNumber;
2839 const char* seriesUID)
2843 _OrthancPluginRetrieveDynamicString params;
2844 params.result = &result;
2845 params.argument = seriesUID;
2874 const char* sopInstanceUID)
2878 _OrthancPluginRetrieveDynamicString params;
2879 params.result = &result;
2880 params.argument = sopInstanceUID;
2899 } _OrthancPluginSendHttpStatusCode;
2922 _OrthancPluginSendHttpStatusCode params;
2923 params.output = output;
2924 params.status = status;
2925 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
2945 _OrthancPluginOutputPlusArgument params;
2946 params.output = output;
2947 params.argument = realm;
2948 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
2966 const char* allowedMethods)
2968 _OrthancPluginOutputPlusArgument params;
2969 params.output = output;
2970 params.argument = allowedMethods;
2971 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
2980 } _OrthancPluginSetHttpHeader;
2999 _OrthancPluginSetHttpHeader params;
3000 params.output = output;
3001 params.key = cookie;
3002 params.value = value;
3003 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
3024 _OrthancPluginSetHttpHeader params;
3025 params.output = output;
3027 params.value = value;
3028 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
3034 char** resultStringToFree;
3035 const char** resultString;
3036 int64_t* resultInt64;
3040 } _OrthancPluginAccessDicomInstance;
3060 _OrthancPluginAccessDicomInstance params;
3061 memset(¶ms, 0,
sizeof(params));
3062 params.resultString = &result;
3063 params.instance = instance;
3093 _OrthancPluginAccessDicomInstance params;
3094 memset(¶ms, 0,
sizeof(params));
3095 params.resultInt64 = &size;
3096 params.instance = instance;
3126 _OrthancPluginAccessDicomInstance params;
3127 memset(¶ms, 0,
sizeof(params));
3128 params.resultString = &result;
3129 params.instance = instance;
3162 _OrthancPluginAccessDicomInstance params;
3163 memset(¶ms, 0,
sizeof(params));
3164 params.resultStringToFree = &result;
3165 params.instance = instance;
3200 _OrthancPluginAccessDicomInstance params;
3201 memset(¶ms, 0,
sizeof(params));
3202 params.resultStringToFree = &result;
3203 params.instance = instance;
3236 const char* metadata)
3240 _OrthancPluginAccessDicomInstance params;
3241 memset(¶ms, 0,
sizeof(params));
3242 params.resultInt64 = &result;
3243 params.instance = instance;
3244 params.key = metadata;
3253 return (result != 0);
3277 const char* metadata)
3281 _OrthancPluginAccessDicomInstance params;
3282 memset(¶ms, 0,
sizeof(params));
3283 params.resultString = &result;
3284 params.instance = instance;
3285 params.key = metadata;
3306 } _OrthancPluginRegisterStorageArea;
3329 _OrthancPluginRegisterStorageArea params;
3330 params.create = create;
3332 params.remove = remove;
3335 params.free = ::free;
3340 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
3359 _OrthancPluginRetrieveDynamicString params;
3360 params.result = &result;
3361 params.argument = NULL;
3389 _OrthancPluginRetrieveDynamicString params;
3390 params.result = &result;
3391 params.argument = NULL;
3424 _OrthancPluginRetrieveDynamicString params;
3425 params.result = &result;
3426 params.argument = NULL;
3444 } _OrthancPluginOnChangeCallback;
3470 _OrthancPluginOnChangeCallback params;
3471 params.callback = callback;
3473 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms);
3481 _OrthancPluginProperty property;
3483 } _OrthancPluginSetPluginProperty;
3505 _OrthancPluginSetPluginProperty params;
3506 params.plugin = OrthancPluginGetName();
3507 params.property = _OrthancPluginProperty_RootUri;
3510 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3531 _OrthancPluginSetPluginProperty params;
3532 params.plugin = plugin;
3533 params.property = _OrthancPluginProperty_RootUri;
3536 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3555 const char* description)
3557 _OrthancPluginSetPluginProperty params;
3558 params.plugin = OrthancPluginGetName();
3559 params.property = _OrthancPluginProperty_Description;
3560 params.value = description;
3562 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3579 const char* description)
3581 _OrthancPluginSetPluginProperty params;
3582 params.plugin = plugin;
3583 params.property = _OrthancPluginProperty_Description;
3584 params.value = description;
3586 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3605 const char* javascript)
3607 _OrthancPluginSetPluginProperty params;
3608 params.plugin = OrthancPluginGetName();
3609 params.property = _OrthancPluginProperty_OrthancExplorer;
3610 params.value = javascript;
3612 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3629 const char* javascript)
3631 _OrthancPluginSetPluginProperty params;
3632 params.plugin = plugin;
3633 params.property = _OrthancPluginProperty_OrthancExplorer;
3634 params.value = javascript;
3636 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3645 } _OrthancPluginGlobalProperty;
3664 const char* defaultValue)
3668 _OrthancPluginGlobalProperty params;
3669 params.result = &result;
3670 params.property = property;
3671 params.value = defaultValue;
3705 _OrthancPluginGlobalProperty params;
3706 params.result = NULL;
3707 params.property = property;
3708 params.value = value;
3710 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms);
3717 int32_t *resultInt32;
3718 uint32_t *resultUint32;
3719 int64_t *resultInt64;
3720 uint64_t *resultUint64;
3721 } _OrthancPluginReturnSingleValue;
3736 _OrthancPluginReturnSingleValue params;
3737 memset(¶ms, 0,
sizeof(params));
3738 params.resultUint32 = &count;
3771 _OrthancPluginGlobalProperty params;
3772 params.result = &result;
3773 params.property = (int32_t) argument;
3774 params.value = NULL;
3802 _OrthancPluginReturnSingleValue params;
3803 memset(¶ms, 0,
sizeof(params));
3804 params.resultUint32 = &count;
3834 _OrthancPluginRetrieveDynamicString params;
3835 params.result = &result;
3836 params.argument = NULL;
3854 const char* subType;
3855 const char* contentType;
3856 } _OrthancPluginStartMultipartAnswer;
3874 const char* subType,
3875 const char* contentType)
3877 _OrthancPluginStartMultipartAnswer params;
3878 params.output = output;
3879 params.subType = subType;
3880 params.contentType = contentType;
3881 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms);
3904 uint32_t answerSize)
3906 _OrthancPluginAnswerBuffer params;
3907 params.output = output;
3908 params.answer = answer;
3909 params.answerSize = answerSize;
3910 params.mimeType = NULL;
3911 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms);
3923 } _OrthancPluginBufferCompression;
3950 _OrthancPluginBufferCompression params;
3951 params.target = target;
3952 params.source = source;
3954 params.compression = compression;
3955 params.uncompress = uncompress;
3957 return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms);
3966 } _OrthancPluginReadFile;
3984 _OrthancPluginReadFile params;
3985 params.target = target;
3987 return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms);
3997 } _OrthancPluginWriteFile;
4016 _OrthancPluginWriteFile params;
4020 return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms);
4027 const char** target;
4029 } _OrthancPluginGetErrorDescription;
4045 const char* result = NULL;
4047 _OrthancPluginGetErrorDescription params;
4048 params.target = &result;
4049 params.error = error;
4054 return "Unknown error code";
4070 } _OrthancPluginSendHttpStatus;
4101 _OrthancPluginSendHttpStatus params;
4102 params.output = output;
4103 params.status = status;
4105 params.bodySize = bodySize;
4106 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms);
4114 uint32_t* resultUint32;
4116 void** resultBuffer;
4117 } _OrthancPluginGetImageInfo;
4136 _OrthancPluginGetImageInfo params;
4137 memset(¶ms, 0,
sizeof(params));
4138 params.image = image;
4139 params.resultPixelFormat = ⌖
4169 _OrthancPluginGetImageInfo params;
4170 memset(¶ms, 0,
sizeof(params));
4171 params.image = image;
4172 params.resultUint32 = &width;
4202 _OrthancPluginGetImageInfo params;
4203 memset(¶ms, 0,
sizeof(params));
4204 params.image = image;
4205 params.resultUint32 = &height;
4237 _OrthancPluginGetImageInfo params;
4238 memset(¶ms, 0,
sizeof(params));
4239 params.image = image;
4240 params.resultUint32 = &pitch;
4269 void* target = NULL;
4271 _OrthancPluginGetImageInfo params;
4272 memset(¶ms, 0,
sizeof(params));
4273 params.resultBuffer = ⌖
4274 params.image = image;
4293 } _OrthancPluginUncompressImage;
4316 _OrthancPluginUncompressImage params;
4317 memset(¶ms, 0,
sizeof(params));
4318 params.target = ⌖
4321 params.format = format;
4339 } _OrthancPluginFreeImage;
4354 _OrthancPluginFreeImage params;
4355 params.image = image;
4357 context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms);
4373 } _OrthancPluginCompressImage;
4404 _OrthancPluginCompressImage params;
4405 memset(¶ms, 0,
sizeof(params));
4406 params.target = target;
4408 params.pixelFormat = format;
4409 params.width = width;
4410 params.height = height;
4411 params.pitch = pitch;
4412 params.buffer = buffer;
4415 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4450 _OrthancPluginCompressImage params;
4451 memset(¶ms, 0,
sizeof(params));
4452 params.target = target;
4454 params.pixelFormat = format;
4455 params.width = width;
4456 params.height = height;
4457 params.pitch = pitch;
4458 params.buffer = buffer;
4459 params.quality = quality;
4461 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4497 _OrthancPluginCompressAndAnswerImage params;
4498 params.output = output;
4500 params.pixelFormat = format;
4501 params.width = width;
4502 params.height = height;
4503 params.pitch = pitch;
4504 params.buffer = buffer;
4505 params.quality = quality;
4506 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
4517 const char* username;
4518 const char* password;
4521 } _OrthancPluginCallHttpClient;
4544 const char* username,
4545 const char* password)
4547 _OrthancPluginCallHttpClient params;
4548 memset(¶ms, 0,
sizeof(params));
4550 params.target = target;
4553 params.username = username;
4554 params.password = password;
4556 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4584 const char* username,
4585 const char* password)
4587 _OrthancPluginCallHttpClient params;
4588 memset(¶ms, 0,
sizeof(params));
4590 params.target = target;
4594 params.bodySize = bodySize;
4595 params.username = username;
4596 params.password = password;
4598 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4626 const char* username,
4627 const char* password)
4629 _OrthancPluginCallHttpClient params;
4630 memset(¶ms, 0,
sizeof(params));
4632 params.target = target;
4636 params.bodySize = bodySize;
4637 params.username = username;
4638 params.password = password;
4640 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4661 const char* username,
4662 const char* password)
4664 _OrthancPluginCallHttpClient params;
4665 memset(¶ms, 0,
sizeof(params));
4669 params.username = username;
4670 params.password = password;
4672 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4682 } _OrthancPluginConvertPixelFormat;
4703 _OrthancPluginConvertPixelFormat params;
4704 params.target = ⌖
4705 params.source = source;
4706 params.targetFormat = targetFormat;
4736 _OrthancPluginReturnSingleValue params;
4737 memset(¶ms, 0,
sizeof(params));
4738 params.resultUint32 = &count;
4759 } _OrthancPluginGetFontInfo;
4775 const char* result = NULL;
4777 _OrthancPluginGetFontInfo params;
4778 memset(¶ms, 0,
sizeof(params));
4779 params.name = &result;
4780 params.fontIndex = fontIndex;
4809 _OrthancPluginGetFontInfo params;
4810 memset(¶ms, 0,
sizeof(params));
4811 params.size = &result;
4812 params.fontIndex = fontIndex;
4830 const char* utf8Text;
4836 } _OrthancPluginDrawText;
4860 const char* utf8Text,
4867 _OrthancPluginDrawText params;
4868 memset(¶ms, 0,
sizeof(params));
4869 params.image = image;
4870 params.fontIndex = fontIndex;
4871 params.utf8Text = utf8Text;
4878 return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms);
4887 const void* content;
4890 } _OrthancPluginStorageAreaCreate;
4914 const void* content,
4918 _OrthancPluginStorageAreaCreate params;
4919 params.storageArea = storageArea;
4921 params.content = content;
4925 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms);
4935 } _OrthancPluginStorageAreaRead;
4961 _OrthancPluginStorageAreaRead params;
4962 params.target = target;
4963 params.storageArea = storageArea;
4967 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms);
4976 } _OrthancPluginStorageAreaRemove;
4999 _OrthancPluginStorageAreaRemove params;
5000 params.storageArea = storageArea;
5004 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms);
5013 uint16_t httpStatus;
5014 const char* message;
5015 } _OrthancPluginRegisterErrorCode;
5035 uint16_t httpStatus,
5036 const char* message)
5040 _OrthancPluginRegisterErrorCode params;
5041 params.target = ⌖
5043 params.httpStatus = httpStatus;
5044 params.message = message;
5065 uint32_t minMultiplicity;
5066 uint32_t maxMultiplicity;
5067 } _OrthancPluginRegisterDictionaryTag;
5094 uint32_t minMultiplicity,
5095 uint32_t maxMultiplicity)
5097 _OrthancPluginRegisterDictionaryTag params;
5098 params.group = group;
5099 params.element = element;
5102 params.minMultiplicity = minMultiplicity;
5103 params.maxMultiplicity = maxMultiplicity;
5105 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, ¶ms);
5116 uint32_t minMultiplicity;
5117 uint32_t maxMultiplicity;
5118 const char* privateCreator;
5119 } _OrthancPluginRegisterPrivateDictionaryTag;
5147 uint32_t minMultiplicity,
5148 uint32_t maxMultiplicity,
5149 const char* privateCreator)
5151 _OrthancPluginRegisterPrivateDictionaryTag params;
5152 params.group = group;
5153 params.element = element;
5156 params.minMultiplicity = minMultiplicity;
5157 params.maxMultiplicity = maxMultiplicity;
5158 params.privateCreator = privateCreator;
5160 return context->InvokeService(context, _OrthancPluginService_RegisterPrivateDictionaryTag, ¶ms);
5169 } _OrthancPluginReconstructMainDicomTags;
5190 _OrthancPluginReconstructMainDicomTags params;
5191 params.level = level;
5192 params.storageArea = storageArea;
5194 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, ¶ms);
5201 const char* instanceId;
5206 uint32_t maxStringLength;
5207 } _OrthancPluginDicomToJson;
5235 uint32_t maxStringLength)
5239 _OrthancPluginDicomToJson params;
5240 memset(¶ms, 0,
sizeof(params));
5241 params.result = &result;
5242 params.buffer = buffer;
5244 params.format = format;
5245 params.flags = flags;
5246 params.maxStringLength = maxStringLength;
5280 const char* instanceId,
5283 uint32_t maxStringLength)
5287 _OrthancPluginDicomToJson params;
5288 memset(¶ms, 0,
sizeof(params));
5289 params.result = &result;
5290 params.instanceId = instanceId;
5291 params.format = format;
5292 params.flags = flags;
5293 params.maxStringLength = maxStringLength;
5311 uint32_t headersCount;
5312 const char*
const* headersKeys;
5313 const char*
const* headersValues;
5314 int32_t afterPlugins;
5315 } _OrthancPluginRestApiGet2;
5340 uint32_t headersCount,
5341 const char*
const* headersKeys,
5342 const char*
const* headersValues,
5343 int32_t afterPlugins)
5345 _OrthancPluginRestApiGet2 params;
5346 params.target = target;
5348 params.headersCount = headersCount;
5349 params.headersKeys = headersKeys;
5350 params.headersValues = headersValues;
5351 params.afterPlugins = afterPlugins;
5353 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, ¶ms);
5361 } _OrthancPluginWorklistCallback;
5378 _OrthancPluginWorklistCallback params;
5379 params.callback = callback;
5381 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, ¶ms);
5392 } _OrthancPluginWorklistAnswersOperation;
5417 _OrthancPluginWorklistAnswersOperation params;
5418 params.answers = answers;
5419 params.query = query;
5420 params.dicom = dicom;
5423 return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, ¶ms);
5444 _OrthancPluginWorklistAnswersOperation params;
5445 params.answers = answers;
5446 params.query = NULL;
5447 params.dicom = NULL;
5450 return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, ¶ms);
5461 } _OrthancPluginWorklistQueryOperation;
5484 int32_t isMatch = 0;
5486 _OrthancPluginWorklistQueryOperation params;
5487 params.query = query;
5488 params.dicom = dicom;
5490 params.isMatch = &isMatch;
5491 params.target = NULL;
5522 _OrthancPluginWorklistQueryOperation params;
5523 params.query = query;
5524 params.dicom = NULL;
5526 params.isMatch = NULL;
5527 params.target = target;
5529 return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, ¶ms);
5549 _OrthancPluginAccessDicomInstance params;
5550 memset(¶ms, 0,
sizeof(params));
5551 params.resultOrigin = &origin;
5552 params.instance = instance;
5572 } _OrthancPluginCreateDicom;
5606 _OrthancPluginCreateDicom params;
5607 params.target = target;
5609 params.pixelData = pixelData;
5610 params.flags = flags;
5612 return context->InvokeService(context, _OrthancPluginService_CreateDicom, ¶ms);
5619 } _OrthancPluginDecodeImageCallback;
5639 _OrthancPluginDecodeImageCallback params;
5640 params.callback = callback;
5642 return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, ¶ms);
5655 const void* constBuffer;
5656 uint32_t bufferSize;
5657 uint32_t frameIndex;
5658 } _OrthancPluginCreateImage;
5681 _OrthancPluginCreateImage params;
5682 memset(¶ms, 0,
sizeof(params));
5683 params.target = ⌖
5684 params.format = format;
5685 params.width = width;
5686 params.height = height;
5726 _OrthancPluginCreateImage params;
5727 memset(¶ms, 0,
sizeof(params));
5728 params.target = ⌖
5729 params.format = format;
5730 params.width = width;
5731 params.height = height;
5732 params.pitch = pitch;
5733 params.buffer = buffer;
5765 uint32_t bufferSize,
5766 uint32_t frameIndex)
5770 _OrthancPluginCreateImage params;
5771 memset(¶ms, 0,
sizeof(params));
5772 params.target = ⌖
5773 params.constBuffer = buffer;
5774 params.bufferSize = bufferSize;
5775 params.frameIndex = frameIndex;
5794 } _OrthancPluginComputeHash;
5815 _OrthancPluginComputeHash params;
5816 params.result = &result;
5817 params.buffer = buffer;
5851 _OrthancPluginComputeHash params;
5852 params.result = &result;
5853 params.buffer = buffer;
5873 } _OrthancPluginLookupDictionary;
5895 _OrthancPluginLookupDictionary params;
5896 params.target = target;
5898 return context->InvokeService(context, _OrthancPluginService_LookupDictionary, ¶ms);
5907 uint32_t answerSize;
5908 uint32_t headersCount;
5909 const char*
const* headersKeys;
5910 const char*
const* headersValues;
5911 } _OrthancPluginSendMultipartItem2;
5937 uint32_t answerSize,
5938 uint32_t headersCount,
5939 const char*
const* headersKeys,
5940 const char*
const* headersValues)
5942 _OrthancPluginSendMultipartItem2 params;
5943 params.output = output;
5944 params.answer = answer;
5945 params.answerSize = answerSize;
5946 params.headersCount = headersCount;
5947 params.headersKeys = headersKeys;
5948 params.headersValues = headersValues;
5950 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem2, ¶ms);
5957 } _OrthancPluginIncomingHttpRequestFilter;
5975 _OrthancPluginIncomingHttpRequestFilter params;
5976 params.callback = callback;
5978 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter, ¶ms);
5987 uint16_t* httpStatus;
5990 uint32_t headersCount;
5991 const char*
const* headersKeys;
5992 const char*
const* headersValues;
5995 const char* username;
5996 const char* password;
5998 const char* certificateFile;
5999 const char* certificateKeyFile;
6000 const char* certificateKeyPassword;
6002 } _OrthancPluginCallHttpClient2;
6050 uint16_t* httpStatus,
6053 uint32_t headersCount,
6054 const char*
const* headersKeys,
6055 const char*
const* headersValues,
6058 const char* username,
6059 const char* password,
6061 const char* certificateFile,
6062 const char* certificateKeyFile,
6063 const char* certificateKeyPassword,
6066 _OrthancPluginCallHttpClient2 params;
6067 memset(¶ms, 0,
sizeof(params));
6069 params.answerBody = answerBody;
6070 params.answerHeaders = answerHeaders;
6071 params.httpStatus = httpStatus;
6072 params.method = method;
6074 params.headersCount = headersCount;
6075 params.headersKeys = headersKeys;
6076 params.headersValues = headersValues;
6078 params.bodySize = bodySize;
6079 params.username = username;
6080 params.password = password;
6081 params.timeout = timeout;
6082 params.certificateFile = certificateFile;
6083 params.certificateKeyFile = certificateKeyFile;
6084 params.certificateKeyPassword = certificateKeyPassword;
6085 params.pkcs11 = pkcs11;
6087 return context->InvokeService(context, _OrthancPluginService_CallHttpClient2, ¶ms);
6106 _OrthancPluginRetrieveDynamicString params;
6107 params.result = &result;
6108 params.argument = NULL;
6127 } _OrthancPluginFindCallback;
6144 _OrthancPluginFindCallback params;
6145 params.callback = callback;
6147 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback, ¶ms);
6158 uint32_t *resultUint32;
6159 uint16_t *resultGroup;
6160 uint16_t *resultElement;
6161 char **resultString;
6162 } _OrthancPluginFindOperation;
6185 _OrthancPluginFindOperation params;
6186 memset(¶ms, 0,
sizeof(params));
6187 params.answers = answers;
6188 params.dicom = dicom;
6191 return context->InvokeService(context, _OrthancPluginService_FindAddAnswer, ¶ms);
6212 _OrthancPluginFindOperation params;
6213 memset(¶ms, 0,
sizeof(params));
6214 params.answers = answers;
6216 return context->InvokeService(context, _OrthancPluginService_FindMarkIncomplete, ¶ms);
6238 _OrthancPluginFindOperation params;
6239 memset(¶ms, 0,
sizeof(params));
6240 params.query = query;
6241 params.resultUint32 = &count;
6276 _OrthancPluginFindOperation params;
6277 memset(¶ms, 0,
sizeof(params));
6278 params.query = query;
6279 params.index = index;
6280 params.resultGroup = group;
6281 params.resultElement = element;
6283 return context->InvokeService(context, _OrthancPluginService_GetFindQueryTag, ¶ms);
6307 _OrthancPluginFindOperation params;
6308 memset(¶ms, 0,
sizeof(params));
6309 params.query = query;
6310 params.index = index;
6311 params.resultString = &result;
6345 _OrthancPluginFindOperation params;
6346 memset(¶ms, 0,
sizeof(params));
6347 params.query = query;
6348 params.index = index;
6349 params.resultString = &result;
6371 } _OrthancPluginMoveCallback;
6393 _OrthancPluginMoveCallback params;
6394 params.callback = callback;
6395 params.getMoveSize = getMoveSize;
6396 params.applyMove = applyMove;
6397 params.freeMove = freeMove;
6399 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback, ¶ms);
6409 } _OrthancPluginCreateFindMatcher;
6432 _OrthancPluginCreateFindMatcher params;
6433 memset(¶ms, 0,
sizeof(params));
6434 params.target = ⌖
6435 params.query = query;
6452 } _OrthancPluginFreeFindMatcher;
6467 _OrthancPluginFreeFindMatcher params;
6468 params.matcher = matcher;
6470 context->InvokeService(context, _OrthancPluginService_FreeFindMatcher, ¶ms);
6480 } _OrthancPluginFindMatcherIsMatch;
6502 int32_t isMatch = 0;
6504 _OrthancPluginFindMatcherIsMatch params;
6505 params.matcher = matcher;
6506 params.dicom = dicom;
6508 params.isMatch = &isMatch;
6525 } _OrthancPluginIncomingHttpRequestFilter2;
6542 _OrthancPluginIncomingHttpRequestFilter2 params;
6543 params.callback = callback;
6545 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter2, ¶ms);
6553 } _OrthancPluginGetPeers;
6571 _OrthancPluginGetPeers params;
6572 memset(¶ms, 0,
sizeof(params));
6573 params.peers = &peers;
6589 } _OrthancPluginFreePeers;
6604 _OrthancPluginFreePeers params;
6605 params.peers = peers;
6607 context->InvokeService(context, _OrthancPluginService_FreePeers, ¶ms);
6615 } _OrthancPluginGetPeersCount;
6634 uint32_t target = 0;
6636 _OrthancPluginGetPeersCount params;
6637 memset(¶ms, 0,
sizeof(params));
6638 params.target = ⌖
6639 params.peers = peers;
6655 const char** target;
6658 const char* userProperty;
6659 } _OrthancPluginGetPeerProperty;
6683 const char* target = NULL;
6685 _OrthancPluginGetPeerProperty params;
6686 memset(¶ms, 0,
sizeof(params));
6687 params.target = ⌖
6688 params.peers = peers;
6689 params.peerIndex = peerIndex;
6690 params.userProperty = NULL;
6724 const char* target = NULL;
6726 _OrthancPluginGetPeerProperty params;
6727 memset(¶ms, 0,
sizeof(params));
6728 params.target = ⌖
6729 params.peers = peers;
6730 params.peerIndex = peerIndex;
6731 params.userProperty = NULL;
6769 const char* userProperty)
6771 const char* target = NULL;
6773 _OrthancPluginGetPeerProperty params;
6774 memset(¶ms, 0,
sizeof(params));
6775 params.target = ⌖
6776 params.peers = peers;
6777 params.peerIndex = peerIndex;
6778 params.userProperty = userProperty;
6797 uint16_t* httpStatus;
6802 uint32_t additionalHeadersCount;
6803 const char*
const* additionalHeadersKeys;
6804 const char*
const* additionalHeadersValues;
6808 } _OrthancPluginCallPeerApi;
6850 uint16_t* httpStatus,
6855 uint32_t additionalHeadersCount,
6856 const char*
const* additionalHeadersKeys,
6857 const char*
const* additionalHeadersValues,
6862 _OrthancPluginCallPeerApi params;
6863 memset(¶ms, 0,
sizeof(params));
6865 params.answerBody = answerBody;
6866 params.answerHeaders = answerHeaders;
6867 params.httpStatus = httpStatus;
6868 params.peers = peers;
6869 params.peerIndex = peerIndex;
6870 params.method = method;
6872 params.additionalHeadersCount = additionalHeadersCount;
6873 params.additionalHeadersKeys = additionalHeadersKeys;
6874 params.additionalHeadersValues = additionalHeadersValues;
6876 params.bodySize = bodySize;
6877 params.timeout = timeout;
6879 return context->InvokeService(context, _OrthancPluginService_CallPeerApi, ¶ms);
6898 } _OrthancPluginCreateJob;
6946 _OrthancPluginCreateJob params;
6947 memset(¶ms, 0,
sizeof(params));
6949 params.target = ⌖
6951 params.finalize = finalize;
6953 params.getProgress = getProgress;
6954 params.getContent = getContent;
6955 params.getSerialized = getSerialized;
6958 params.reset = reset;
6985 } _OrthancPluginCreateJob2;
7032 _OrthancPluginCreateJob2 params;
7033 memset(¶ms, 0,
sizeof(params));
7035 params.target = ⌖
7037 params.finalize = finalize;
7039 params.getProgress = getProgress;
7040 params.getContent = getContent;
7041 params.getSerialized = getSerialized;
7044 params.reset = reset;
7062 } _OrthancPluginFreeJob;
7077 _OrthancPluginFreeJob params;
7080 context->InvokeService(context, _OrthancPluginService_FreeJob, ¶ms);
7090 } _OrthancPluginSubmitJob;
7110 char* resultId = NULL;
7112 _OrthancPluginSubmitJob params;
7113 memset(¶ms, 0,
sizeof(params));
7115 params.resultId = &resultId;
7117 params.priority = priority;
7136 } _OrthancPluginJobsUnserializer;
7154 _OrthancPluginJobsUnserializer params;
7155 params.unserializer = unserializer;
7157 context->InvokeService(context, _OrthancPluginService_RegisterJobsUnserializer, ¶ms);
7165 const char* details;
7167 } _OrthancPluginSetHttpErrorDetails;
7189 const char* details,
7192 _OrthancPluginSetHttpErrorDetails params;
7193 params.output = output;
7194 params.details = details;
7196 context->InvokeService(context, _OrthancPluginService_SetHttpErrorDetails, ¶ms);
7203 const char** result;
7204 const char* argument;
7205 } _OrthancPluginRetrieveStaticString;
7222 const char* result = NULL;
7224 _OrthancPluginRetrieveStaticString params;
7225 params.result = &result;
7226 params.argument = path;
7246 } _OrthancPluginSetMetricsValue;
7270 _OrthancPluginSetMetricsValue params;
7272 params.value = value;
7274 context->InvokeService(context, _OrthancPluginService_SetMetricsValue, ¶ms);
7282 } _OrthancPluginRegisterRefreshMetricsCallback;
7299 _OrthancPluginRegisterRefreshMetricsCallback params;
7300 params.callback = callback;
7301 context->InvokeService(context, _OrthancPluginService_RegisterRefreshMetricsCallback, ¶ms);
7313 } _OrthancPluginEncodeDicomWeb;
7337 char* target = NULL;
7339 _OrthancPluginEncodeDicomWeb params;
7340 params.target = ⌖
7341 params.dicom = dicom;
7342 params.dicomSize = dicomSize;
7343 params.callback = callback;
7379 char* target = NULL;
7381 _OrthancPluginEncodeDicomWeb params;
7382 params.target = ⌖
7383 params.dicom = dicom;
7384 params.dicomSize = dicomSize;
7385 params.callback = callback;
7407 } _OrthancPluginEncodeDicomWeb2;
7432 char* target = NULL;
7434 _OrthancPluginEncodeDicomWeb2 params;
7435 params.target = ⌖
7436 params.dicom = dicom;
7437 params.dicomSize = dicomSize;
7438 params.callback = callback;
7439 params.payload = payload;
7476 char* target = NULL;
7478 _OrthancPluginEncodeDicomWeb2 params;
7479 params.target = ⌖
7480 params.dicom = dicom;
7481 params.dicomSize = dicomSize;
7482 params.callback = callback;
7483 params.payload = payload;
7587 typedef const void* (*OrthancPluginChunkedClientRequestGetChunkData) (
void* request);
7611 uint16_t* httpStatus;
7614 uint32_t headersCount;
7615 const char*
const* headersKeys;
7616 const char*
const* headersValues;
7622 const char* username;
7623 const char* password;
7625 const char* certificateFile;
7626 const char* certificateKeyFile;
7627 const char* certificateKeyPassword;
7629 } _OrthancPluginChunkedHttpClient;
7687 uint16_t* httpStatus,
7690 uint32_t headersCount,
7691 const char*
const* headersKeys,
7692 const char*
const* headersValues,
7698 const char* username,
7699 const char* password,
7701 const char* certificateFile,
7702 const char* certificateKeyFile,
7703 const char* certificateKeyPassword,
7706 _OrthancPluginChunkedHttpClient params;
7707 memset(¶ms, 0,
sizeof(params));
7710 params.httpStatus = httpStatus;
7711 params.method = method;
7713 params.headersCount = headersCount;
7714 params.headersKeys = headersKeys;
7715 params.headersValues = headersValues;
7716 params.username = username;
7717 params.password = password;
7718 params.timeout = timeout;
7719 params.certificateFile = certificateFile;
7720 params.certificateKeyFile = certificateKeyFile;
7721 params.certificateKeyPassword = certificateKeyPassword;
7722 params.pkcs11 = pkcs11;
7725 params.answer = answer;
7726 params.answerAddChunk = answerAddChunk;
7727 params.answerAddHeader = answerAddHeader;
7728 params.request = request;
7729 params.requestIsDone = requestIsDone;
7730 params.requestChunkData = requestChunkData;
7731 params.requestChunkSize = requestChunkSize;
7732 params.requestNext = requestNext;
7734 return context->InvokeService(context, _OrthancPluginService_ChunkedHttpClient, ¶ms);
7824 const char* pathRegularExpression;
7832 } _OrthancPluginChunkedRestCallback;
7866 const char* pathRegularExpression,
7875 _OrthancPluginChunkedRestCallback params;
7876 params.pathRegularExpression = pathRegularExpression;
7877 params.getHandler = getHandler;
7878 params.postHandler = postHandler;
7879 params.deleteHandler = deleteHandler;
7880 params.putHandler = putHandler;
7881 params.addChunk = addChunk;
7882 params.execute = execute;
7883 params.finalize = finalize;
7885 context->InvokeService(context, _OrthancPluginService_RegisterChunkedRestCallback, ¶ms);
7897 const char* privateCreator;
7898 } _OrthancPluginGetTagName;
7919 const char* privateCreator)
7923 _OrthancPluginGetTagName params;
7924 params.result = &result;
7925 params.group = group;
7926 params.element = element;
7927 params.privateCreator = privateCreator;
7973 const char* transactionUid,
7974 const char*
const* sopClassUids,
7975 const char*
const* sopInstanceUids,
7976 uint32_t countInstances,
7977 const char* remoteAet,
7978 const char* calledAet);
8016 const char* sopClassUid,
8017 const char* sopInstanceUid);
8025 } _OrthancPluginRegisterStorageCommitmentScpCallback;
8046 _OrthancPluginRegisterStorageCommitmentScpCallback params;
8047 params.factory = factory;
8048 params.destructor = destructor;
8049 params.lookup = lookup;
8050 return context->InvokeService(context, _OrthancPluginService_RegisterStorageCommitmentScpCallback, ¶ms);
8087 } _OrthancPluginIncomingDicomInstanceFilter;
8105 _OrthancPluginIncomingDicomInstanceFilter params;
8106 params.callback = callback;
8108 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingDicomInstanceFilter, ¶ms);
8143 uint16_t* dimseStatus ,
8150 } _OrthancPluginIncomingCStoreInstanceFilter;
8168 _OrthancPluginIncomingCStoreInstanceFilter params;
8169 params.callback = callback;
8171 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingCStoreInstanceFilter, ¶ms);
8211 const void* receivedDicomBuffer,
8212 uint64_t receivedDicomBufferSize,
8219 } _OrthancPluginReceivedInstanceCallback;
8245 _OrthancPluginReceivedInstanceCallback params;
8246 params.callback = callback;
8248 return context->InvokeService(context, _OrthancPluginService_RegisterReceivedInstanceCallback, ¶ms);
8270 _OrthancPluginAccessDicomInstance params;
8271 memset(¶ms, 0,
sizeof(params));
8272 params.resultStringToFree = &result;
8273 params.instance = instance;
8303 int64_t hasPixelData;
8305 _OrthancPluginAccessDicomInstance params;
8306 memset(¶ms, 0,
sizeof(params));
8307 params.resultInt64 = &hasPixelData;
8308 params.instance = instance;
8319 return (hasPixelData != 0);
8333 const char* transferSyntax;
8334 } _OrthancPluginCreateDicomInstance;
8356 _OrthancPluginCreateDicomInstance params;
8357 params.target = ⌖
8358 params.buffer = buffer;
8375 } _OrthancPluginFreeDicomInstance;
8391 _OrthancPluginFreeDicomInstance params;
8392 params.dicom = dicom;
8394 context->InvokeService(context, _OrthancPluginService_FreeDicomInstance, ¶ms);
8400 uint32_t* targetUint32;
8403 char** targetStringToFree;
8405 uint32_t frameIndex;
8408 uint32_t maxStringLength;
8410 void* dicomWebPayload;
8411 } _OrthancPluginAccessDicomInstance2;
8430 _OrthancPluginAccessDicomInstance2 params;
8431 memset(¶ms, 0,
sizeof(params));
8432 params.targetUint32 = &count;
8433 params.instance = instance;
8468 uint32_t frameIndex)
8470 _OrthancPluginAccessDicomInstance2 params;
8471 memset(¶ms, 0,
sizeof(params));
8472 params.targetBuffer = target;
8473 params.instance = instance;
8474 params.frameIndex = frameIndex;
8476 return context->InvokeService(context, _OrthancPluginService_GetInstanceRawFrame, ¶ms);
8495 uint32_t frameIndex)
8499 _OrthancPluginAccessDicomInstance2 params;
8500 memset(¶ms, 0,
sizeof(params));
8501 params.targetImage = ⌖
8502 params.instance = instance;
8503 params.frameIndex = frameIndex;
8535 const char* transferSyntax)
8539 _OrthancPluginCreateDicomInstance params;
8540 params.target = ⌖
8541 params.buffer = buffer;
8543 params.transferSyntax = transferSyntax;
8574 _OrthancPluginAccessDicomInstance2 params;
8575 memset(¶ms, 0,
sizeof(params));
8576 params.targetBuffer = target;
8577 params.instance = instance;
8579 return context->InvokeService(context, _OrthancPluginService_SerializeDicomInstance, ¶ms);
8606 uint32_t maxStringLength)
8608 char* result = NULL;
8610 _OrthancPluginAccessDicomInstance2 params;
8611 memset(¶ms, 0,
sizeof(params));
8612 params.targetStringToFree = &result;
8613 params.instance = instance;
8614 params.format = format;
8615 params.flags = flags;
8616 params.maxStringLength = maxStringLength;
8650 char* target = NULL;
8652 _OrthancPluginAccessDicomInstance2 params;
8653 params.targetStringToFree = ⌖
8654 params.instance = instance;
8655 params.dicomWebCallback = callback;
8656 params.dicomWebPayload = payload;
8690 char* target = NULL;
8692 _OrthancPluginAccessDicomInstance2 params;
8693 params.targetStringToFree = ⌖
8694 params.instance = instance;
8695 params.dicomWebCallback = callback;
8696 params.dicomWebPayload = payload;
8733 const char*
const* allowedSyntaxes,
8734 uint32_t countSyntaxes,
8735 uint8_t allowNewSopInstanceUid);
8741 } _OrthancPluginTranscoderCallback;
8760 _OrthancPluginTranscoderCallback params;
8761 params.callback = callback;
8763 return context->InvokeService(context, _OrthancPluginService_RegisterTranscoderCallback, ¶ms);
8772 } _OrthancPluginCreateMemoryBuffer;
8796 _OrthancPluginCreateMemoryBuffer params;
8797 params.target = target;
8800 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer, ¶ms);
8834 _OrthancPluginRetrieveDynamicString params;
8835 params.result = &result;
8836 params.argument = NULL;
8838 if (context->InvokeService(context, _OrthancPluginService_GenerateRestApiAuthorizationToken,
8856 } _OrthancPluginCreateMemoryBuffer64;
8880 _OrthancPluginCreateMemoryBuffer64 params;
8881 params.target = target;
8884 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer64, ¶ms);
8894 } _OrthancPluginRegisterStorageArea2;
8919 _OrthancPluginRegisterStorageArea2 params;
8920 params.create = create;
8921 params.readWhole = readWhole;
8922 params.readRange = readRange;
8923 params.remove = remove;
8924 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea2, ¶ms);
8931 _OrthancPluginCreateDicom createDicom;
8932 const char* privateCreator;
8933 } _OrthancPluginCreateDicom2;
8965 const char* privateCreator)
8967 _OrthancPluginCreateDicom2 params;
8968 params.createDicom.target = target;
8969 params.createDicom.json = json;
8970 params.createDicom.pixelData = pixelData;
8971 params.createDicom.flags = flags;
8972 params.privateCreator = privateCreator;
8974 return context->InvokeService(context, _OrthancPluginService_CreateDicom2, ¶ms);
8986 uint16_t* httpStatus;
8989 uint32_t headersCount;
8990 const char*
const* headersKeys;
8991 const char*
const* headersValues;
8994 uint8_t afterPlugins;
8995 } _OrthancPluginCallRestApi;
9031 uint16_t* httpStatus,
9034 uint32_t headersCount,
9035 const char*
const* headersKeys,
9036 const char*
const* headersValues,
9039 uint8_t afterPlugins)
9041 _OrthancPluginCallRestApi params;
9042 memset(¶ms, 0,
sizeof(params));
9044 params.answerBody = answerBody;
9045 params.answerHeaders = answerHeaders;
9046 params.httpStatus = httpStatus;
9047 params.method = method;
9049 params.headersCount = headersCount;
9050 params.headersKeys = headersKeys;
9051 params.headersValues = headersValues;
9053 params.bodySize = bodySize;
9054 params.afterPlugins = afterPlugins;
9056 return context->InvokeService(context, _OrthancPluginService_CallRestApi, ¶ms);
9088 const char* mimeType,
9089 const char* dateTime);
9108 const char* dateTime);
9136 const char* mimeType,
9137 const char* dateTime);
9154 uint8_t* isExisting,
9156 const char*
const* pathItems,
9179 uint8_t* isExisting,
9184 const char*
const* pathItems,
9208 const char*
const* pathItems,
9228 uint8_t* isReadOnly,
9230 const char*
const* pathItems,
9250 uint8_t* isReadOnly,
9252 const char*
const* pathItems,
9270 uint8_t* isReadOnly,
9272 const char*
const* pathItems,
9286 } _OrthancPluginRegisterWebDavCollection;
9319 _OrthancPluginRegisterWebDavCollection params;
9321 params.isExistingFolder = isExistingFolder;
9322 params.listFolder = listFolder;
9323 params.retrieveFile = retrieveFile;
9324 params.storeFile = storeFile;
9325 params.createFolder = createFolder;
9326 params.deleteItem = deleteItem;
9327 params.payload = payload;
9329 return context->InvokeService(context, _OrthancPluginService_RegisterWebDavCollection, ¶ms);
9346 _OrthancPluginRetrieveStaticString params;
9347 params.result = &result;
9348 params.argument = NULL;
9371 const void* request,
9372 uint64_t requestSize);
9384 uint32_t maxDatabaseRetries;
9387 } _OrthancPluginRegisterDatabaseBackendV4;
9409 uint32_t maxDatabaseRetries,
9413 _OrthancPluginRegisterDatabaseBackendV4 params;
9414 params.backend = backend;
9415 params.maxDatabaseRetries = maxDatabaseRetries;
9416 params.operations = operations;
9417 params.finalize = finalize;
9419 return context->InvokeService(context, _OrthancPluginService_RegisterDatabaseBackendV4, ¶ms);
9426 const char* instanceId;
9428 } _OrthancPluginLoadDicomInstance;
9445 const char* instanceId,
9450 _OrthancPluginLoadDicomInstance params;
9451 params.target = ⌖
9452 params.instanceId = instanceId;
9472 } _OrthancPluginSetMetricsIntegerValue;
9495 _OrthancPluginSetMetricsIntegerValue params;
9497 params.value = value;
9499 context->InvokeService(context, _OrthancPluginService_SetMetricsIntegerValue, ¶ms);
9518 const char* threadName)
9520 return context->InvokeService(context, _OrthancPluginService_SetCurrentThreadName, threadName);
9527 const char* message;
9533 } _OrthancPluginLogMessage;
9551 const char* message,
9558 _OrthancPluginLogMessage m;
9559 m.message = message;
9563 m.category = category;
9565 context->InvokeService(context, _OrthancPluginService_LogMessage, &m);
OrthancPluginErrorCode OrthancPluginRegisterDatabaseBackendV4(OrthancPluginContext *context, void *backend, uint32_t maxDatabaseRetries, OrthancPluginCallDatabaseBackendV4 operations, OrthancPluginFinalizeDatabaseBackendV4 finalize)
Register a custom database back-end.
Definition: OrthancCPlugin.h:9406
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:9368
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:8209
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:9084
void OrthancPluginRegisterStorageArea(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove)
Register a custom storage area.
Definition: OrthancCPlugin.h:3323
void OrthancPluginRegisterOnStoredInstanceCallback(OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback)
Register a callback for received instances.
Definition: OrthancCPlugin.h:2288
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:1327
OrthancPluginErrorCode OrthancPluginRegisterDecodeImageCallback(OrthancPluginContext *context, OrthancPluginDecodeImageCallback callback)
Register a callback to handle the decoding of DICOM images.
Definition: OrthancCPlugin.h:5635
OrthancPluginChangeType
Definition: OrthancCPlugin.h:754
OrthancPluginErrorCode(* OrthancPluginStorageReadWhole)(OrthancPluginMemoryBuffer64 *target, const char *uuid, OrthancPluginContentType type)
Callback for reading a whole file from the storage area.
Definition: OrthancCPlugin.h:1393
OrthancPluginErrorCode OrthancPluginRegisterIncomingCStoreInstanceFilter(OrthancPluginContext *context, OrthancPluginIncomingCStoreInstanceFilter callback)
Register a callback to filter incoming DICOM instances received by Orthanc through C-STORE.
Definition: OrthancCPlugin.h:8164
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:1305
void OrthancPluginRegisterRefreshMetricsCallback(OrthancPluginContext *context, OrthancPluginRefreshMetricsCallback callback)
Register a callback to refresh the metrics.
Definition: OrthancCPlugin.h:7295
OrthancPluginErrorCode(* OrthancPluginWebDavCreateFolderCallback)(uint8_t *isReadOnly, uint32_t pathSize, const char *const *pathItems, void *payload)
Callback to create a folder.
Definition: OrthancCPlugin.h:9249
struct _OrthancPluginWebDavCollection_t OrthancPluginWebDavCollection
Opaque structure that represents a WebDAV collection.
Definition: OrthancCPlugin.h:9065
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:1863
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:9204
int32_t(* OrthancPluginIncomingDicomInstanceFilter)(const OrthancPluginDicomInstance *instance)
Callback to filter incoming DICOM instances received by Orthanc.
Definition: OrthancCPlugin.h:8080
OrthancPluginErrorCode OrthancPluginStorageAreaRemove(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Remove a file from the storage area.
Definition: OrthancCPlugin.h:4993
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:8729
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter2(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter2 callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:6538
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:9132
OrthancPluginErrorCode(* OrthancPluginStorageRead)(void **content, int64_t *size, const char *uuid, OrthancPluginContentType type)
Callback for reading from the storage area.
Definition: OrthancCPlugin.h:1373
void OrthancPluginRegisterRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback.
Definition: OrthancCPlugin.h:2210
uint32_t OrthancPluginGetExpectedDatabaseVersion(OrthancPluginContext *context)
Get the expected version of the database schema.
Definition: OrthancCPlugin.h:3797
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:8241
int32_t OrthancPluginCheckVersion(OrthancPluginContext *context)
Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
Definition: OrthancCPlugin.h:2091
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:9178
struct _OrthancPluginRestOutput_t OrthancPluginRestOutput
Opaque structure that represents the HTTP connection to the client application.
Definition: OrthancCPlugin.h:1176
void OrthancPluginRegisterOnChangeCallback(OrthancPluginContext *context, OrthancPluginOnChangeCallback callback)
Register a callback to monitor changes.
Definition: OrthancCPlugin.h:3466
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:8912
OrthancPluginErrorCode(* OrthancPluginWebDavAddFolder)(OrthancPluginWebDavCollection *collection, const char *name, const char *dateTime)
Declare a subfolder while returning the content of a folder.
Definition: OrthancCPlugin.h:9105
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:9308
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:1519
OrthancPluginErrorCode(* OrthancPluginRestCallback)(OrthancPluginRestOutput *output, const char *url, const OrthancPluginHttpRequest *request)
Signature of a callback function that answers to a REST request.
Definition: OrthancCPlugin.h:1273
void(* OrthancPluginRefreshMetricsCallback)()
Callback executed to update the metrics of the plugin.
Definition: OrthancCPlugin.h:1835
OrthancPluginErrorCode OrthancPluginRegisterTranscoderCallback(OrthancPluginContext *context, OrthancPluginTranscoderCallback callback)
Register a callback to handle the transcoding of DICOM images.
Definition: OrthancCPlugin.h:8756
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:1284
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:9227
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:9269
OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, OrthancPluginResourceType level)
Reconstruct the main DICOM tags.
Definition: OrthancCPlugin.h:5185
OrthancPluginErrorCode(* OrthancPluginStorageRemove)(const char *uuid, OrthancPluginContentType type)
Callback for removing a file from the storage area.
Definition: OrthancCPlugin.h:1434
OrthancPluginErrorCode(* OrthancPluginStorageCreate)(const char *uuid, const void *content, int64_t size, OrthancPluginContentType type)
Callback for writing to the storage area.
Definition: OrthancCPlugin.h:1346
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:1901
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:1294
void(* OrthancPluginFinalizeDatabaseBackendV4)(void *backend)
Signature of a callback function that is triggered when the database plugin must be finalized.
Definition: OrthancCPlugin.h:9379
struct _OrthancPluginServerChunkedRequestReader_t OrthancPluginServerChunkedRequestReader
Opaque structure that reads the content of a HTTP request body during a chunked HTTP transfer.
Definition: OrthancCPlugin.h:7743
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:9153
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:1484
OrthancPluginJob *(* OrthancPluginJobsUnserializer)(const char *jobType, const char *serialized)
Callback executed to unserialize a custom job.
Definition: OrthancCPlugin.h:1816
void OrthancPluginRegisterJobsUnserializer(OrthancPluginContext *context, OrthancPluginJobsUnserializer unserializer)
Register an unserializer for custom jobs.
Definition: OrthancCPlugin.h:7150
void(* OrthancPluginFree)(void *buffer)
Signature of a function to free dynamic memory.
Definition: OrthancCPlugin.h:1317
void OrthancPluginRegisterRestCallbackNoLock(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback, without locking.
Definition: OrthancCPlugin.h:2250
OrthancPluginErrorCode OrthancPluginStorageAreaRead(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Read a file from the storage area.
Definition: OrthancCPlugin.h:4954
int32_t OrthancPluginCheckVersionAdvanced(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:1982
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:1416
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:7864
int32_t(* OrthancPluginIncomingCStoreInstanceFilter)(uint16_t *dimseStatus, const OrthancPluginDicomInstance *instance)
Callback to filter incoming DICOM instances received by Orthanc through C-STORE.
Definition: OrthancCPlugin.h:8142
OrthancPluginErrorCode OrthancPluginRegisterIncomingDicomInstanceFilter(OrthancPluginContext *context, OrthancPluginIncomingDicomInstanceFilter callback)
Register a callback to filter incoming DICOM instances.
Definition: OrthancCPlugin.h:8101
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:5971
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:4910
@ OrthancPluginChangeType_OrthancStopped
Definition: OrthancCPlugin.h:766
@ OrthancPluginChangeType_OrthancStarted
Definition: OrthancCPlugin.h:765
@ OrthancPluginChangeType_Deleted
Definition: OrthancCPlugin.h:756
@ OrthancPluginChangeType_JobFailure
Definition: OrthancCPlugin.h:773
@ OrthancPluginChangeType_NewInstance
Definition: OrthancCPlugin.h:758
@ OrthancPluginChangeType_NewPatient
Definition: OrthancCPlugin.h:759
@ OrthancPluginChangeType_JobSubmitted
Definition: OrthancCPlugin.h:771
@ OrthancPluginChangeType_NewSeries
Definition: OrthancCPlugin.h:760
@ OrthancPluginChangeType_StablePatient
Definition: OrthancCPlugin.h:762
@ OrthancPluginChangeType_UpdatedPeers
Definition: OrthancCPlugin.h:769
@ OrthancPluginChangeType_StableStudy
Definition: OrthancCPlugin.h:764
@ OrthancPluginChangeType_CompletedSeries
Definition: OrthancCPlugin.h:755
@ OrthancPluginChangeType_NewChildInstance
Definition: OrthancCPlugin.h:757
@ OrthancPluginChangeType_UpdatedAttachment
Definition: OrthancCPlugin.h:767
@ OrthancPluginChangeType_UpdatedMetadata
Definition: OrthancCPlugin.h:768
@ OrthancPluginChangeType_StableSeries
Definition: OrthancCPlugin.h:763
@ OrthancPluginChangeType_UpdatedModalities
Definition: OrthancCPlugin.h:770
@ OrthancPluginChangeType_JobSuccess
Definition: OrthancCPlugin.h:772
@ OrthancPluginChangeType_NewStudy
Definition: OrthancCPlugin.h:761
uint32_t OrthancPluginGetFindQuerySize(OrthancPluginContext *context, const OrthancPluginFindQuery *query)
Get the number of tags in a C-Find query.
Definition: OrthancCPlugin.h:6232
struct _OrthancPluginFindQuery_t OrthancPluginFindQuery
Opaque structure to an object that represents a C-Find query.
Definition: OrthancCPlugin.h:1224
OrthancPluginErrorCode(* OrthancPluginApplyMove)(void *moveDriver)
Callback to apply one C-Move suboperation.
Definition: OrthancCPlugin.h:1629
OrthancPluginErrorCode OrthancPluginFindMarkIncomplete(OrthancPluginContext *context, OrthancPluginFindAnswers *answers)
Mark the set of C-Find answers as incomplete.
Definition: OrthancCPlugin.h:6208
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:6300
void(* OrthancPluginStorageCommitmentDestructor)(void *handler)
Callback to free one storage commitment SCP handler.
Definition: OrthancCPlugin.h:7992
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:1453
OrthancPluginErrorCode OrthancPluginRegisterMoveCallback(OrthancPluginContext *context, OrthancPluginMoveCallback callback, OrthancPluginGetMoveSize getMoveSize, OrthancPluginApplyMove applyMove, OrthancPluginFreeMove freeMove)
Register a callback to handle C-Move requests.
Definition: OrthancCPlugin.h:6386
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:7970
OrthancPluginErrorCode OrthancPluginRegisterFindCallback(OrthancPluginContext *context, OrthancPluginFindCallback callback)
Register a callback to handle C-Find requests.
Definition: OrthancCPlugin.h:6140
OrthancPluginErrorCode OrthancPluginWorklistGetDicomQuery(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginWorklistQuery *query)
Retrieve the worklist query as a DICOM file.
Definition: OrthancCPlugin.h:5517
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:8013
int32_t OrthancPluginWorklistIsMatch(OrthancPluginContext *context, const OrthancPluginWorklistQuery *query, const void *dicom, uint32_t size)
Test whether a worklist matches the query.
Definition: OrthancCPlugin.h:5478
OrthancPluginErrorCode OrthancPluginFindAddAnswer(OrthancPluginContext *context, OrthancPluginFindAnswers *answers, const void *dicom, uint32_t size)
Add one answer to some C-Find request.
Definition: OrthancCPlugin.h:6179
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:1589
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:8040
struct _OrthancPluginFindAnswers_t OrthancPluginFindAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1232
struct _OrthancPluginWorklistAnswers_t OrthancPluginWorklistAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1216
OrthancPluginErrorCode(* OrthancPluginFindCallback)(OrthancPluginFindAnswers *answers, const OrthancPluginFindQuery *query, const char *issuerAet, const char *calledAet)
Callback to handle incoming C-Find SCP requests.
Definition: OrthancCPlugin.h:1546
uint32_t(* OrthancPluginGetMoveSize)(void *moveDriver)
Callback to read the size of a C-Move driver.
Definition: OrthancCPlugin.h:1614
OrthancPluginErrorCode OrthancPluginRegisterWorklistCallback(OrthancPluginContext *context, OrthancPluginWorklistCallback callback)
Register a callback to handle modality worklists requests.
Definition: OrthancCPlugin.h:5374
OrthancPluginErrorCode OrthancPluginWorklistMarkIncomplete(OrthancPluginContext *context, OrthancPluginWorklistAnswers *answers)
Mark the set of worklist answers as incomplete.
Definition: OrthancCPlugin.h:5440
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:6338
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:6269
void(* OrthancPluginFreeMove)(void *moveDriver)
Callback to free one C-Move driver.
Definition: OrthancCPlugin.h:1643
struct _OrthancPluginWorklistQuery_t OrthancPluginWorklistQuery
Opaque structure to an object that represents a C-Find query for worklists.
Definition: OrthancCPlugin.h:1208
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:5410
int32_t OrthancPluginHasInstancePixelData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Check whether the DICOM file has pixel data.
Definition: OrthancCPlugin.h:8299
char * OrthancPluginGetInstanceDicomWebXml(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb XML.
Definition: OrthancCPlugin.h:8684
struct _OrthancPluginDicomInstance_t OrthancPluginDicomInstance
Opaque structure that represents a DICOM instance that is managed by the Orthanc core.
Definition: OrthancCPlugin.h:1184
char * OrthancPluginGetInstanceTransferSyntaxUid(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the transfer syntax of a DICOM file.
Definition: OrthancCPlugin.h:8264
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:8464
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:8601
const void * OrthancPluginGetInstanceData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the data of a DICOM file.
Definition: OrthancCPlugin.h:3120
OrthancPluginDicomInstance * OrthancPluginCreateDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size)
Parse a DICOM instance.
Definition: OrthancCPlugin.h:8349
int32_t OrthancPluginHasInstanceMetadata(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, const char *metadata)
Check whether a DICOM instance is associated with some metadata.
Definition: OrthancCPlugin.h:3233
uint32_t OrthancPluginGetInstanceFramesCount(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the number of frames in a DICOM instance.
Definition: OrthancCPlugin.h:8424
OrthancPluginImage * OrthancPluginGetInstanceDecodedFrame(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:8492
OrthancPluginDicomInstance * OrthancPluginLoadDicomInstance(OrthancPluginContext *context, const char *instanceId, OrthancPluginLoadDicomInstanceMode mode)
Load a DICOM instance from the Orthanc server.
Definition: OrthancCPlugin.h:9443
OrthancPluginInstanceOrigin OrthancPluginGetInstanceOrigin(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the origin of a DICOM file.
Definition: OrthancCPlugin.h:5543
int64_t OrthancPluginGetInstanceSize(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the size of a DICOM file.
Definition: OrthancCPlugin.h:3087
char * OrthancPluginGetInstanceDicomWebJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb JSON.
Definition: OrthancCPlugin.h:8644
char * OrthancPluginGetInstanceSimplifiedJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file (with simplification).
Definition: OrthancCPlugin.h:3194
char * OrthancPluginGetInstanceJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file.
Definition: OrthancCPlugin.h:3156
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:3274
void OrthancPluginFreeDicomInstance(OrthancPluginContext *context, OrthancPluginDicomInstance *dicom)
Free a DICOM instance.
Definition: OrthancCPlugin.h:8387
OrthancPluginErrorCode OrthancPluginSerializeDicomInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginDicomInstance *instance)
Writes a DICOM instance to a memory buffer.
Definition: OrthancCPlugin.h:8569
OrthancPluginDicomInstance * OrthancPluginTranscodeDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size, const char *transferSyntax)
Parse and transcode a DICOM instance.
Definition: OrthancCPlugin.h:8531
const char * OrthancPluginGetInstanceRemoteAet(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the AET of a DICOM instance.
Definition: OrthancCPlugin.h:3054
OrthancPluginPixelFormat
Definition: OrthancCPlugin.h:630
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:4856
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:4440
uint32_t OrthancPluginGetImagePitch(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pitch of an image.
Definition: OrthancCPlugin.h:4231
OrthancPluginImage * OrthancPluginConvertPixelFormat(OrthancPluginContext *context, const OrthancPluginImage *source, OrthancPluginPixelFormat targetFormat)
Change the pixel format of an image.
Definition: OrthancCPlugin.h:4696
OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pixel format of an image.
Definition: OrthancCPlugin.h:4130
uint32_t OrthancPluginGetFontsCount(OrthancPluginContext *context)
Return the number of available fonts.
Definition: OrthancCPlugin.h:4731
uint32_t OrthancPluginGetImageHeight(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the height of an image.
Definition: OrthancCPlugin.h:4196
void OrthancPluginFreeImage(OrthancPluginContext *context, OrthancPluginImage *image)
Free an image.
Definition: OrthancCPlugin.h:4350
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:4395
OrthancPluginImage * OrthancPluginCreateImage(OrthancPluginContext *context, OrthancPluginPixelFormat format, uint32_t width, uint32_t height)
Create an image.
Definition: OrthancCPlugin.h:5673
OrthancPluginImage * OrthancPluginUncompressImage(OrthancPluginContext *context, const void *data, uint32_t size, OrthancPluginImageFormat format)
Decode a compressed image.
Definition: OrthancCPlugin.h:4308
const char * OrthancPluginGetFontName(OrthancPluginContext *context, uint32_t fontIndex)
Return the name of a font.
Definition: OrthancCPlugin.h:4771
void * OrthancPluginGetImageBuffer(OrthancPluginContext *context, const OrthancPluginImage *image)
Return a pointer to the content of an image.
Definition: OrthancCPlugin.h:4265
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:5716
OrthancPluginImageFormat
Definition: OrthancCPlugin.h:799
struct _OrthancPluginStorageArea_t OrthancPluginStorageArea
Opaque structure that represents the storage area that is actually used by Orthanc.
Definition: OrthancCPlugin.h:1200
OrthancPluginCompressionType
Definition: OrthancCPlugin.h:784
uint32_t OrthancPluginGetImageWidth(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the width of an image.
Definition: OrthancCPlugin.h:4163
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:3942
OrthancPluginImage * OrthancPluginDecodeDicomImage(OrthancPluginContext *context, const void *buffer, uint32_t bufferSize, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:5762
uint32_t OrthancPluginGetFontSize(OrthancPluginContext *context, uint32_t fontIndex)
Return the size of a font.
Definition: OrthancCPlugin.h:4803
struct _OrthancPluginImage_t OrthancPluginImage
Opaque structure that represents an image that is uncompressed in memory.
Definition: OrthancCPlugin.h:1192
@ OrthancPluginPixelFormat_RGBA32
Color image in RGBA32 format.
Definition: OrthancCPlugin.h:669
@ OrthancPluginPixelFormat_RGB48
Color image in RGB48 format.
Definition: OrthancCPlugin.h:679
@ OrthancPluginPixelFormat_Grayscale8
Graylevel 8bpp image.
Definition: OrthancCPlugin.h:637
@ OrthancPluginPixelFormat_SignedGrayscale16
Graylevel, signed 16bpp image.
Definition: OrthancCPlugin.h:653
@ OrthancPluginPixelFormat_Float32
Graylevel, floating-point 32bpp image.
Definition: OrthancCPlugin.h:695
@ OrthancPluginPixelFormat_RGB24
Color image in RGB24 format.
Definition: OrthancCPlugin.h:661
@ OrthancPluginPixelFormat_BGRA32
Color image in BGRA32 format.
Definition: OrthancCPlugin.h:703
@ OrthancPluginPixelFormat_Unknown
Definition: OrthancCPlugin.h:671
@ OrthancPluginPixelFormat_Grayscale64
Graylevel, unsigned 64bpp image.
Definition: OrthancCPlugin.h:711
@ OrthancPluginPixelFormat_Grayscale32
Graylevel, unsigned 32bpp image.
Definition: OrthancCPlugin.h:687
@ OrthancPluginPixelFormat_Grayscale16
Graylevel, unsigned 16bpp image.
Definition: OrthancCPlugin.h:645
@ OrthancPluginImageFormat_Png
Definition: OrthancCPlugin.h:800
@ OrthancPluginImageFormat_Jpeg
Definition: OrthancCPlugin.h:801
@ OrthancPluginImageFormat_Dicom
Definition: OrthancCPlugin.h:802
@ OrthancPluginCompressionType_Gzip
Definition: OrthancCPlugin.h:787
@ OrthancPluginCompressionType_ZlibWithSize
Definition: OrthancCPlugin.h:786
@ OrthancPluginCompressionType_Zlib
Definition: OrthancCPlugin.h:785
@ OrthancPluginCompressionType_GzipWithSize
Definition: OrthancCPlugin.h:788
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:2518
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:2553
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:2666
char * OrthancPluginLookupStudy(OrthancPluginContext *context, const char *studyUID)
Look for a study.
Definition: OrthancCPlugin.h:2767
OrthancPluginErrorCode OrthancPluginSetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *value)
Set the value of a global property.
Definition: OrthancCPlugin.h:3700
char * OrthancPluginGetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *defaultValue)
Get the value of a global property.
Definition: OrthancCPlugin.h:3661
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:2630
char * OrthancPluginLookupSeries(OrthancPluginContext *context, const char *seriesUID)
Look for a series.
Definition: OrthancCPlugin.h:2837
char * OrthancPluginLookupStudyWithAccessionNumber(OrthancPluginContext *context, const char *accessionNumber)
Look for a study, using the accession number.
Definition: OrthancCPlugin.h:2802
char * OrthancPluginGenerateRestApiAuthorizationToken(OrthancPluginContext *context)
Generate a token to grant full access to the REST API of Orthanc.
Definition: OrthancCPlugin.h:8829
OrthancPluginErrorCode OrthancPluginRestApiGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2451
char * OrthancPluginLookupInstance(OrthancPluginContext *context, const char *sopInstanceUID)
Look for an instance.
Definition: OrthancCPlugin.h:2872
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:2481
char * OrthancPluginLookupPatient(OrthancPluginContext *context, const char *patientID)
Look for a patient.
Definition: OrthancCPlugin.h:2732
OrthancPluginErrorCode OrthancPluginRestApiDelete(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2582
OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:2605
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:9027
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:5336
OrthancPluginErrorCode OrthancPluginGetDicomForInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *instanceId)
Retrieve a DICOM instance using its Orthanc identifier.
Definition: OrthancCPlugin.h:2418
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:2377
void OrthancPluginSendUnauthorized(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *realm)
Signal that a REST request is not authorized.
Definition: OrthancCPlugin.h:2940
void OrthancPluginSetHttpErrorDetails(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *details, uint8_t log)
Provide a detailed description for an HTTP error.
Definition: OrthancCPlugin.h:7186
void OrthancPluginSendMethodNotAllowed(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *allowedMethods)
Signal that this URI does not support this HTTP method.
Definition: OrthancCPlugin.h:2963
void OrthancPluginAnswerBuffer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const void *answer, uint32_t answerSize, const char *mimeType)
Answer to a REST request.
Definition: OrthancCPlugin.h:2320
void OrthancPluginSendHttpStatusCode(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status)
Send a HTTP status code.
Definition: OrthancCPlugin.h:2917
void OrthancPluginSetHttpHeader(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *key, const char *value)
Set some HTTP header.
Definition: OrthancCPlugin.h:3018
void OrthancPluginSetCookie(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *cookie, const char *value)
Set a cookie.
Definition: OrthancCPlugin.h:2993
void OrthancPluginRedirect(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *redirection)
Redirect a REST request.
Definition: OrthancCPlugin.h:2700
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:4487
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:3900
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:5933
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:4094
OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *subType, const char *contentType)
Start an HTTP multipart answer.
Definition: OrthancCPlugin.h:3871
An entry in the dictionary of DICOM tags.
Definition: OrthancCPlugin.h:1934
uint32_t minMultiplicity
Definition: OrthancCPlugin.h:1938
uint32_t maxMultiplicity
Definition: OrthancCPlugin.h:1939
OrthancPluginValueRepresentation vr
Definition: OrthancCPlugin.h:1937
uint16_t element
Definition: OrthancCPlugin.h:1936
uint16_t group
Definition: OrthancCPlugin.h:1935
The parameters of a REST request.
Definition: OrthancCPlugin.h:358
const char *const * getValues
For a GET request, the values of the GET parameters.
Definition: OrthancCPlugin.h:387
const char *const * groups
The matched values for the groups of the regular expression.
Definition: OrthancCPlugin.h:372
uint32_t bodySize
For a PUT or POST request, the number of bytes of the body.
Definition: OrthancCPlugin.h:397
uint32_t groupsCount
The number of groups of the regular expression.
Definition: OrthancCPlugin.h:367
const char *const * headersKeys
The keys of the HTTP headers (always converted to low-case).
Definition: OrthancCPlugin.h:412
const void * body
For a PUT or POST request, the content of the body.
Definition: OrthancCPlugin.h:392
const char *const * getKeys
For a GET request, the keys of the GET parameters.
Definition: OrthancCPlugin.h:382
uint32_t headersCount
The number of HTTP headers.
Definition: OrthancCPlugin.h:407
OrthancPluginHttpMethod method
The HTTP method.
Definition: OrthancCPlugin.h:362
uint32_t getCount
For a GET request, the number of GET parameters.
Definition: OrthancCPlugin.h:377
const char *const * headersValues
The values of the HTTP headers.
Definition: OrthancCPlugin.h:417
A 64-bit memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:1157
uint64_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:1166
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:1161
A 32-bit memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:1135
uint32_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:1144
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:1139