114# define ORTHANC_PLUGINS_API __declspec(dllexport)
116# define ORTHANC_PLUGINS_API __attribute__ ((visibility ("default")))
118# define ORTHANC_PLUGINS_API
121#define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 1
122#define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 11
123#define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 0
126#if !defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE)
127#define ORTHANC_PLUGINS_VERSION_IS_ABOVE(major, minor, revision) \
128 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER > major || \
129 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER == major && \
130 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER > minor || \
131 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER == minor && \
132 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER >= revision))))
151#ifndef ORTHANC_PLUGIN_INLINE
152# if __STDC_VERSION__ >= 199901L
154# define ORTHANC_PLUGIN_INLINE static inline
155# elif defined(__cplusplus)
157# define ORTHANC_PLUGIN_INLINE static inline
158# elif defined(__GNUC__)
160# define ORTHANC_PLUGIN_INLINE static __inline
161# elif defined(_MSC_VER)
163# define ORTHANC_PLUGIN_INLINE static __inline
165# error Your compiler is not known to support the "inline" keyword
311 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
319 ORTHANC_PLUGINS_API
const char* OrthancPluginGetName();
332 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
408 _OrthancPluginService_LogInfo = 1,
409 _OrthancPluginService_LogWarning = 2,
410 _OrthancPluginService_LogError = 3,
411 _OrthancPluginService_GetOrthancPath = 4,
412 _OrthancPluginService_GetOrthancDirectory = 5,
413 _OrthancPluginService_GetConfigurationPath = 6,
414 _OrthancPluginService_SetPluginProperty = 7,
415 _OrthancPluginService_GetGlobalProperty = 8,
416 _OrthancPluginService_SetGlobalProperty = 9,
417 _OrthancPluginService_GetCommandLineArgumentsCount = 10,
418 _OrthancPluginService_GetCommandLineArgument = 11,
419 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
420 _OrthancPluginService_GetConfiguration = 13,
421 _OrthancPluginService_BufferCompression = 14,
422 _OrthancPluginService_ReadFile = 15,
423 _OrthancPluginService_WriteFile = 16,
424 _OrthancPluginService_GetErrorDescription = 17,
425 _OrthancPluginService_CallHttpClient = 18,
426 _OrthancPluginService_RegisterErrorCode = 19,
427 _OrthancPluginService_RegisterDictionaryTag = 20,
428 _OrthancPluginService_DicomBufferToJson = 21,
429 _OrthancPluginService_DicomInstanceToJson = 22,
430 _OrthancPluginService_CreateDicom = 23,
431 _OrthancPluginService_ComputeMd5 = 24,
432 _OrthancPluginService_ComputeSha1 = 25,
433 _OrthancPluginService_LookupDictionary = 26,
434 _OrthancPluginService_CallHttpClient2 = 27,
435 _OrthancPluginService_GenerateUuid = 28,
436 _OrthancPluginService_RegisterPrivateDictionaryTag = 29,
437 _OrthancPluginService_AutodetectMimeType = 30,
438 _OrthancPluginService_SetMetricsValue = 31,
439 _OrthancPluginService_EncodeDicomWebJson = 32,
440 _OrthancPluginService_EncodeDicomWebXml = 33,
441 _OrthancPluginService_ChunkedHttpClient = 34,
442 _OrthancPluginService_GetTagName = 35,
443 _OrthancPluginService_EncodeDicomWebJson2 = 36,
444 _OrthancPluginService_EncodeDicomWebXml2 = 37,
445 _OrthancPluginService_CreateMemoryBuffer = 38,
446 _OrthancPluginService_GenerateRestApiAuthorizationToken = 39,
447 _OrthancPluginService_CreateMemoryBuffer64 = 40,
448 _OrthancPluginService_CreateDicom2 = 41,
451 _OrthancPluginService_RegisterRestCallback = 1000,
452 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
453 _OrthancPluginService_RegisterStorageArea = 1002,
454 _OrthancPluginService_RegisterOnChangeCallback = 1003,
455 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
456 _OrthancPluginService_RegisterWorklistCallback = 1005,
457 _OrthancPluginService_RegisterDecodeImageCallback = 1006,
458 _OrthancPluginService_RegisterIncomingHttpRequestFilter = 1007,
459 _OrthancPluginService_RegisterFindCallback = 1008,
460 _OrthancPluginService_RegisterMoveCallback = 1009,
461 _OrthancPluginService_RegisterIncomingHttpRequestFilter2 = 1010,
462 _OrthancPluginService_RegisterRefreshMetricsCallback = 1011,
463 _OrthancPluginService_RegisterChunkedRestCallback = 1012,
464 _OrthancPluginService_RegisterStorageCommitmentScpCallback = 1013,
465 _OrthancPluginService_RegisterIncomingDicomInstanceFilter = 1014,
466 _OrthancPluginService_RegisterTranscoderCallback = 1015,
467 _OrthancPluginService_RegisterStorageArea2 = 1016,
468 _OrthancPluginService_RegisterIncomingCStoreInstanceFilter = 1017,
469 _OrthancPluginService_RegisterReceivedInstanceCallback = 1018,
470 _OrthancPluginService_RegisterWebDavCollection = 1019,
473 _OrthancPluginService_AnswerBuffer = 2000,
474 _OrthancPluginService_CompressAndAnswerPngImage = 2001,
475 _OrthancPluginService_Redirect = 2002,
476 _OrthancPluginService_SendHttpStatusCode = 2003,
477 _OrthancPluginService_SendUnauthorized = 2004,
478 _OrthancPluginService_SendMethodNotAllowed = 2005,
479 _OrthancPluginService_SetCookie = 2006,
480 _OrthancPluginService_SetHttpHeader = 2007,
481 _OrthancPluginService_StartMultipartAnswer = 2008,
482 _OrthancPluginService_SendMultipartItem = 2009,
483 _OrthancPluginService_SendHttpStatus = 2010,
484 _OrthancPluginService_CompressAndAnswerImage = 2011,
485 _OrthancPluginService_SendMultipartItem2 = 2012,
486 _OrthancPluginService_SetHttpErrorDetails = 2013,
489 _OrthancPluginService_GetDicomForInstance = 3000,
490 _OrthancPluginService_RestApiGet = 3001,
491 _OrthancPluginService_RestApiPost = 3002,
492 _OrthancPluginService_RestApiDelete = 3003,
493 _OrthancPluginService_RestApiPut = 3004,
494 _OrthancPluginService_LookupPatient = 3005,
495 _OrthancPluginService_LookupStudy = 3006,
496 _OrthancPluginService_LookupSeries = 3007,
497 _OrthancPluginService_LookupInstance = 3008,
498 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
499 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
500 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
501 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
502 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
503 _OrthancPluginService_ReconstructMainDicomTags = 3014,
504 _OrthancPluginService_RestApiGet2 = 3015,
505 _OrthancPluginService_CallRestApi = 3016,
508 _OrthancPluginService_GetInstanceRemoteAet = 4000,
509 _OrthancPluginService_GetInstanceSize = 4001,
510 _OrthancPluginService_GetInstanceData = 4002,
511 _OrthancPluginService_GetInstanceJson = 4003,
512 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
513 _OrthancPluginService_HasInstanceMetadata = 4005,
514 _OrthancPluginService_GetInstanceMetadata = 4006,
515 _OrthancPluginService_GetInstanceOrigin = 4007,
516 _OrthancPluginService_GetInstanceTransferSyntaxUid = 4008,
517 _OrthancPluginService_HasInstancePixelData = 4009,
518 _OrthancPluginService_CreateDicomInstance = 4010,
519 _OrthancPluginService_FreeDicomInstance = 4011,
520 _OrthancPluginService_GetInstanceFramesCount = 4012,
521 _OrthancPluginService_GetInstanceRawFrame = 4013,
522 _OrthancPluginService_GetInstanceDecodedFrame = 4014,
523 _OrthancPluginService_TranscodeDicomInstance = 4015,
524 _OrthancPluginService_SerializeDicomInstance = 4016,
525 _OrthancPluginService_GetInstanceAdvancedJson = 4017,
526 _OrthancPluginService_GetInstanceDicomWebJson = 4018,
527 _OrthancPluginService_GetInstanceDicomWebXml = 4019,
530 _OrthancPluginService_RegisterDatabaseBackend = 5000,
531 _OrthancPluginService_DatabaseAnswer = 5001,
532 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002,
533 _OrthancPluginService_StorageAreaCreate = 5003,
534 _OrthancPluginService_StorageAreaRead = 5004,
535 _OrthancPluginService_StorageAreaRemove = 5005,
536 _OrthancPluginService_RegisterDatabaseBackendV3 = 5006,
539 _OrthancPluginService_GetImagePixelFormat = 6000,
540 _OrthancPluginService_GetImageWidth = 6001,
541 _OrthancPluginService_GetImageHeight = 6002,
542 _OrthancPluginService_GetImagePitch = 6003,
543 _OrthancPluginService_GetImageBuffer = 6004,
544 _OrthancPluginService_UncompressImage = 6005,
545 _OrthancPluginService_FreeImage = 6006,
546 _OrthancPluginService_CompressImage = 6007,
547 _OrthancPluginService_ConvertPixelFormat = 6008,
548 _OrthancPluginService_GetFontsCount = 6009,
549 _OrthancPluginService_GetFontInfo = 6010,
550 _OrthancPluginService_DrawText = 6011,
551 _OrthancPluginService_CreateImage = 6012,
552 _OrthancPluginService_CreateImageAccessor = 6013,
553 _OrthancPluginService_DecodeDicomImage = 6014,
556 _OrthancPluginService_WorklistAddAnswer = 7000,
557 _OrthancPluginService_WorklistMarkIncomplete = 7001,
558 _OrthancPluginService_WorklistIsMatch = 7002,
559 _OrthancPluginService_WorklistGetDicomQuery = 7003,
560 _OrthancPluginService_FindAddAnswer = 7004,
561 _OrthancPluginService_FindMarkIncomplete = 7005,
562 _OrthancPluginService_GetFindQuerySize = 7006,
563 _OrthancPluginService_GetFindQueryTag = 7007,
564 _OrthancPluginService_GetFindQueryTagName = 7008,
565 _OrthancPluginService_GetFindQueryValue = 7009,
566 _OrthancPluginService_CreateFindMatcher = 7010,
567 _OrthancPluginService_FreeFindMatcher = 7011,
568 _OrthancPluginService_FindMatcherIsMatch = 7012,
571 _OrthancPluginService_GetPeers = 8000,
572 _OrthancPluginService_FreePeers = 8001,
573 _OrthancPluginService_GetPeersCount = 8003,
574 _OrthancPluginService_GetPeerName = 8004,
575 _OrthancPluginService_GetPeerUrl = 8005,
576 _OrthancPluginService_CallPeerApi = 8006,
577 _OrthancPluginService_GetPeerUserProperty = 8007,
580 _OrthancPluginService_CreateJob = 9000,
581 _OrthancPluginService_FreeJob = 9001,
582 _OrthancPluginService_SubmitJob = 9002,
583 _OrthancPluginService_RegisterJobsUnserializer = 9003,
585 _OrthancPluginService_INTERNAL = 0x7fffffff
586 } _OrthancPluginService;
591 _OrthancPluginProperty_Description = 1,
592 _OrthancPluginProperty_RootUri = 2,
593 _OrthancPluginProperty_OrthancExplorer = 3,
595 _OrthancPluginProperty_INTERNAL = 0x7fffffff
596 } _OrthancPluginProperty;
688 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
703 _OrthancPluginContentType_INTERNAL = 0x7fffffff
719 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
750 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
765 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
779 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
817 _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff
832 _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff
843 OrthancPluginDicomToJsonFlags_None = 0,
853 _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff
864 OrthancPluginCreateDicomFlags_None = 0,
868 _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff
884 _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff
900 _OrthancPluginConstraintType_INTERNAL = 0x7fffffff
916 _OrthancPluginInstanceOrigin_INTERNAL = 0x7fffffff
1019 _OrthancPluginReceivedInstanceAction_INTERNAL = 0x7fffffff
1182 const char* instanceId);
1193 const char* resourceId);
1204 const uint32_t size,
1205 uint32_t frameIndex);
1226 const char* bulkDataUri);
1244 const void* content,
1316 uint64_t rangeStart);
1352 const char* issuerAet,
1353 const char* calledAet);
1384 uint32_t headersCount,
1385 const char*
const* headersKeys,
1386 const char*
const* headersValues);
1419 uint32_t headersCount,
1420 const char*
const* headersKeys,
1421 const char*
const* headersValues,
1422 uint32_t getArgumentsCount,
1423 const char*
const* getArgumentsKeys,
1424 const char*
const* getArgumentsValues);
1445 const char* issuerAet,
1446 const char* calledAet);
1485 typedef void* (*OrthancPluginMoveCallback) (
1487 const char* patientId,
1488 const char* accessionNumber,
1489 const char* studyInstanceUid,
1490 const char* seriesInstanceUid,
1491 const char* sopInstanceUid,
1492 const char* originatorAet,
1493 const char* sourceAet,
1494 const char* targetAet,
1495 uint16_t originatorId);
1580 typedef const char* (*OrthancPluginJobGetContent) (
void* job);
1598 typedef const char* (*OrthancPluginJobGetSerialized) (
void* job);
1671 const char* serialized);
1719 uint32_t levelDepth,
1720 const uint16_t* levelTagGroup,
1721 const uint16_t* levelTagElement,
1722 const uint32_t* levelIndex,
1724 uint16_t tagElement,
1757 uint32_t levelDepth,
1758 const uint16_t* levelTagGroup,
1759 const uint16_t* levelTagElement,
1760 const uint32_t* levelIndex,
1762 uint16_t tagElement,
1771 typedef struct _OrthancPluginContext_t
1773 void* pluginsManager;
1774 const char* orthancVersion;
1777 _OrthancPluginService service,
1778 const void* params);
1839 int expectedRevision)
1841 int major, minor, revision;
1845 sizeof(int32_t) !=
sizeof(_OrthancPluginService) ||
1846 sizeof(int32_t) !=
sizeof(_OrthancPluginProperty) ||
1871 if (!strcmp(context->orthancVersion,
"mainline"))
1883 (context->orthancVersion,
"%4d.%4d.%4d", &major, &minor, &revision) != 3)
1890 if (major > expectedMajor)
1895 if (major < expectedMajor)
1902 if (minor > expectedMinor)
1907 if (minor < expectedMinor)
1914 if (revision >= expectedRevision)
1946 ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER,
1947 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER,
1948 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER);
1964 context->Free(buffer->
data);
1980 context->Free(buffer->
data);
1994 const char* message)
1996 context->InvokeService(context, _OrthancPluginService_LogError, message);
2010 const char* message)
2012 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
2026 const char* message)
2028 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
2035 const char* pathRegularExpression;
2037 } _OrthancPluginRestCallback;
2062 const char* pathRegularExpression,
2065 _OrthancPluginRestCallback params;
2066 params.pathRegularExpression = pathRegularExpression;
2067 params.callback = callback;
2068 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
2102 const char* pathRegularExpression,
2105 _OrthancPluginRestCallback params;
2106 params.pathRegularExpression = pathRegularExpression;
2107 params.callback = callback;
2108 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms);
2116 } _OrthancPluginOnStoredInstanceCallback;
2142 _OrthancPluginOnStoredInstanceCallback params;
2143 params.callback = callback;
2145 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
2154 uint32_t answerSize;
2155 const char* mimeType;
2156 } _OrthancPluginAnswerBuffer;
2174 uint32_t answerSize,
2175 const char* mimeType)
2177 _OrthancPluginAnswerBuffer params;
2178 params.output = output;
2179 params.answer = answer;
2180 params.answerSize = answerSize;
2181 params.mimeType = mimeType;
2182 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms);
2194 } _OrthancPluginCompressAndAnswerPngImage;
2206 } _OrthancPluginCompressAndAnswerImage;
2236 _OrthancPluginCompressAndAnswerImage params;
2237 params.output = output;
2239 params.pixelFormat = format;
2240 params.width = width;
2241 params.height = height;
2242 params.pitch = pitch;
2243 params.buffer = buffer;
2245 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
2253 const char* instanceId;
2254 } _OrthancPluginGetDicomForInstance;
2271 const char* instanceId)
2273 _OrthancPluginGetDicomForInstance params;
2274 params.target = target;
2275 params.instanceId = instanceId;
2276 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
2285 } _OrthancPluginRestApiGet;
2306 _OrthancPluginRestApiGet params;
2307 params.target = target;
2309 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
2336 _OrthancPluginRestApiGet params;
2337 params.target = target;
2339 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms);
2350 } _OrthancPluginRestApiPostPut;
2375 _OrthancPluginRestApiPostPut params;
2376 params.target = target;
2379 params.bodySize = bodySize;
2380 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
2410 _OrthancPluginRestApiPostPut params;
2411 params.target = target;
2414 params.bodySize = bodySize;
2415 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms);
2436 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
2459 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
2487 _OrthancPluginRestApiPostPut params;
2488 params.target = target;
2491 params.bodySize = bodySize;
2492 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
2523 _OrthancPluginRestApiPostPut params;
2524 params.target = target;
2527 params.bodySize = bodySize;
2528 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms);
2536 const char* argument;
2537 } _OrthancPluginOutputPlusArgument;
2553 const char* redirection)
2555 _OrthancPluginOutputPlusArgument params;
2556 params.output = output;
2557 params.argument = redirection;
2558 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
2566 const char* argument;
2567 } _OrthancPluginRetrieveDynamicString;
2584 const char* patientID)
2588 _OrthancPluginRetrieveDynamicString params;
2589 params.result = &result;
2590 params.argument = patientID;
2619 const char* studyUID)
2623 _OrthancPluginRetrieveDynamicString params;
2624 params.result = &result;
2625 params.argument = studyUID;
2654 const char* accessionNumber)
2658 _OrthancPluginRetrieveDynamicString params;
2659 params.result = &result;
2660 params.argument = accessionNumber;
2689 const char* seriesUID)
2693 _OrthancPluginRetrieveDynamicString params;
2694 params.result = &result;
2695 params.argument = seriesUID;
2724 const char* sopInstanceUID)
2728 _OrthancPluginRetrieveDynamicString params;
2729 params.result = &result;
2730 params.argument = sopInstanceUID;
2749 } _OrthancPluginSendHttpStatusCode;
2772 _OrthancPluginSendHttpStatusCode params;
2773 params.output = output;
2774 params.status = status;
2775 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
2795 _OrthancPluginOutputPlusArgument params;
2796 params.output = output;
2797 params.argument = realm;
2798 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
2816 const char* allowedMethods)
2818 _OrthancPluginOutputPlusArgument params;
2819 params.output = output;
2820 params.argument = allowedMethods;
2821 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
2830 } _OrthancPluginSetHttpHeader;
2849 _OrthancPluginSetHttpHeader params;
2850 params.output = output;
2851 params.key = cookie;
2852 params.value = value;
2853 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
2874 _OrthancPluginSetHttpHeader params;
2875 params.output = output;
2877 params.value = value;
2878 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
2884 char** resultStringToFree;
2885 const char** resultString;
2886 int64_t* resultInt64;
2890 } _OrthancPluginAccessDicomInstance;
2910 _OrthancPluginAccessDicomInstance params;
2911 memset(¶ms, 0,
sizeof(params));
2912 params.resultString = &result;
2913 params.instance = instance;
2943 _OrthancPluginAccessDicomInstance params;
2944 memset(¶ms, 0,
sizeof(params));
2945 params.resultInt64 = &size;
2946 params.instance = instance;
2976 _OrthancPluginAccessDicomInstance params;
2977 memset(¶ms, 0,
sizeof(params));
2978 params.resultString = &result;
2979 params.instance = instance;
3012 _OrthancPluginAccessDicomInstance params;
3013 memset(¶ms, 0,
sizeof(params));
3014 params.resultStringToFree = &result;
3015 params.instance = instance;
3050 _OrthancPluginAccessDicomInstance params;
3051 memset(¶ms, 0,
sizeof(params));
3052 params.resultStringToFree = &result;
3053 params.instance = instance;
3086 const char* metadata)
3090 _OrthancPluginAccessDicomInstance params;
3091 memset(¶ms, 0,
sizeof(params));
3092 params.resultInt64 = &result;
3093 params.instance = instance;
3094 params.key = metadata;
3103 return (result != 0);
3127 const char* metadata)
3131 _OrthancPluginAccessDicomInstance params;
3132 memset(¶ms, 0,
sizeof(params));
3133 params.resultString = &result;
3134 params.instance = instance;
3135 params.key = metadata;
3156 } _OrthancPluginRegisterStorageArea;
3179 _OrthancPluginRegisterStorageArea params;
3180 params.create = create;
3182 params.remove = remove;
3185 params.free = ::free;
3190 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
3209 _OrthancPluginRetrieveDynamicString params;
3210 params.result = &result;
3211 params.argument = NULL;
3239 _OrthancPluginRetrieveDynamicString params;
3240 params.result = &result;
3241 params.argument = NULL;
3274 _OrthancPluginRetrieveDynamicString params;
3275 params.result = &result;
3276 params.argument = NULL;
3294 } _OrthancPluginOnChangeCallback;
3320 _OrthancPluginOnChangeCallback params;
3321 params.callback = callback;
3323 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms);
3331 _OrthancPluginProperty property;
3333 } _OrthancPluginSetPluginProperty;
3351 _OrthancPluginSetPluginProperty params;
3352 params.plugin = OrthancPluginGetName();
3353 params.property = _OrthancPluginProperty_RootUri;
3356 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3371 const char* description)
3373 _OrthancPluginSetPluginProperty params;
3374 params.plugin = OrthancPluginGetName();
3375 params.property = _OrthancPluginProperty_Description;
3376 params.value = description;
3378 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3393 const char* javascript)
3395 _OrthancPluginSetPluginProperty params;
3396 params.plugin = OrthancPluginGetName();
3397 params.property = _OrthancPluginProperty_OrthancExplorer;
3398 params.value = javascript;
3400 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3409 } _OrthancPluginGlobalProperty;
3428 const char* defaultValue)
3432 _OrthancPluginGlobalProperty params;
3433 params.result = &result;
3434 params.property = property;
3435 params.value = defaultValue;
3469 _OrthancPluginGlobalProperty params;
3470 params.result = NULL;
3471 params.property = property;
3472 params.value = value;
3474 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms);
3481 int32_t *resultInt32;
3482 uint32_t *resultUint32;
3483 int64_t *resultInt64;
3484 uint64_t *resultUint64;
3485 } _OrthancPluginReturnSingleValue;
3500 _OrthancPluginReturnSingleValue params;
3501 memset(¶ms, 0,
sizeof(params));
3502 params.resultUint32 = &count;
3535 _OrthancPluginGlobalProperty params;
3536 params.result = &result;
3537 params.property = (int32_t) argument;
3538 params.value = NULL;
3566 _OrthancPluginReturnSingleValue params;
3567 memset(¶ms, 0,
sizeof(params));
3568 params.resultUint32 = &count;
3598 _OrthancPluginRetrieveDynamicString params;
3599 params.result = &result;
3600 params.argument = NULL;
3618 const char* subType;
3619 const char* contentType;
3620 } _OrthancPluginStartMultipartAnswer;
3638 const char* subType,
3639 const char* contentType)
3641 _OrthancPluginStartMultipartAnswer params;
3642 params.output = output;
3643 params.subType = subType;
3644 params.contentType = contentType;
3645 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms);
3668 uint32_t answerSize)
3670 _OrthancPluginAnswerBuffer params;
3671 params.output = output;
3672 params.answer = answer;
3673 params.answerSize = answerSize;
3674 params.mimeType = NULL;
3675 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms);
3687 } _OrthancPluginBufferCompression;
3714 _OrthancPluginBufferCompression params;
3715 params.target = target;
3716 params.source = source;
3718 params.compression = compression;
3719 params.uncompress = uncompress;
3721 return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms);
3730 } _OrthancPluginReadFile;
3748 _OrthancPluginReadFile params;
3749 params.target = target;
3751 return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms);
3761 } _OrthancPluginWriteFile;
3780 _OrthancPluginWriteFile params;
3784 return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms);
3791 const char** target;
3793 } _OrthancPluginGetErrorDescription;
3809 const char* result = NULL;
3811 _OrthancPluginGetErrorDescription params;
3812 params.target = &result;
3813 params.error = error;
3818 return "Unknown error code";
3834 } _OrthancPluginSendHttpStatus;
3865 _OrthancPluginSendHttpStatus params;
3866 params.output = output;
3867 params.status = status;
3869 params.bodySize = bodySize;
3870 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms);
3878 uint32_t* resultUint32;
3880 void** resultBuffer;
3881 } _OrthancPluginGetImageInfo;
3900 _OrthancPluginGetImageInfo params;
3901 memset(¶ms, 0,
sizeof(params));
3902 params.image = image;
3903 params.resultPixelFormat = ⌖
3933 _OrthancPluginGetImageInfo params;
3934 memset(¶ms, 0,
sizeof(params));
3935 params.image = image;
3936 params.resultUint32 = &width;
3966 _OrthancPluginGetImageInfo params;
3967 memset(¶ms, 0,
sizeof(params));
3968 params.image = image;
3969 params.resultUint32 = &height;
4001 _OrthancPluginGetImageInfo params;
4002 memset(¶ms, 0,
sizeof(params));
4003 params.image = image;
4004 params.resultUint32 = &pitch;
4033 void* target = NULL;
4035 _OrthancPluginGetImageInfo params;
4036 memset(¶ms, 0,
sizeof(params));
4037 params.resultBuffer = ⌖
4038 params.image = image;
4057 } _OrthancPluginUncompressImage;
4080 _OrthancPluginUncompressImage params;
4081 memset(¶ms, 0,
sizeof(params));
4082 params.target = ⌖
4085 params.format = format;
4103 } _OrthancPluginFreeImage;
4118 _OrthancPluginFreeImage params;
4119 params.image = image;
4121 context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms);
4137 } _OrthancPluginCompressImage;
4168 _OrthancPluginCompressImage params;
4169 memset(¶ms, 0,
sizeof(params));
4170 params.target = target;
4172 params.pixelFormat = format;
4173 params.width = width;
4174 params.height = height;
4175 params.pitch = pitch;
4176 params.buffer = buffer;
4179 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4214 _OrthancPluginCompressImage params;
4215 memset(¶ms, 0,
sizeof(params));
4216 params.target = target;
4218 params.pixelFormat = format;
4219 params.width = width;
4220 params.height = height;
4221 params.pitch = pitch;
4222 params.buffer = buffer;
4223 params.quality = quality;
4225 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4261 _OrthancPluginCompressAndAnswerImage params;
4262 params.output = output;
4264 params.pixelFormat = format;
4265 params.width = width;
4266 params.height = height;
4267 params.pitch = pitch;
4268 params.buffer = buffer;
4269 params.quality = quality;
4270 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
4281 const char* username;
4282 const char* password;
4285 } _OrthancPluginCallHttpClient;
4308 const char* username,
4309 const char* password)
4311 _OrthancPluginCallHttpClient params;
4312 memset(¶ms, 0,
sizeof(params));
4314 params.target = target;
4317 params.username = username;
4318 params.password = password;
4320 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4348 const char* username,
4349 const char* password)
4351 _OrthancPluginCallHttpClient params;
4352 memset(¶ms, 0,
sizeof(params));
4354 params.target = target;
4358 params.bodySize = bodySize;
4359 params.username = username;
4360 params.password = password;
4362 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4390 const char* username,
4391 const char* password)
4393 _OrthancPluginCallHttpClient params;
4394 memset(¶ms, 0,
sizeof(params));
4396 params.target = target;
4400 params.bodySize = bodySize;
4401 params.username = username;
4402 params.password = password;
4404 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4425 const char* username,
4426 const char* password)
4428 _OrthancPluginCallHttpClient params;
4429 memset(¶ms, 0,
sizeof(params));
4433 params.username = username;
4434 params.password = password;
4436 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4446 } _OrthancPluginConvertPixelFormat;
4467 _OrthancPluginConvertPixelFormat params;
4468 params.target = ⌖
4469 params.source = source;
4470 params.targetFormat = targetFormat;
4500 _OrthancPluginReturnSingleValue params;
4501 memset(¶ms, 0,
sizeof(params));
4502 params.resultUint32 = &count;
4523 } _OrthancPluginGetFontInfo;
4539 const char* result = NULL;
4541 _OrthancPluginGetFontInfo params;
4542 memset(¶ms, 0,
sizeof(params));
4543 params.name = &result;
4544 params.fontIndex = fontIndex;
4573 _OrthancPluginGetFontInfo params;
4574 memset(¶ms, 0,
sizeof(params));
4575 params.size = &result;
4576 params.fontIndex = fontIndex;
4594 const char* utf8Text;
4600 } _OrthancPluginDrawText;
4624 const char* utf8Text,
4631 _OrthancPluginDrawText params;
4632 memset(¶ms, 0,
sizeof(params));
4633 params.image = image;
4634 params.fontIndex = fontIndex;
4635 params.utf8Text = utf8Text;
4642 return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms);
4651 const void* content;
4654 } _OrthancPluginStorageAreaCreate;
4678 const void* content,
4682 _OrthancPluginStorageAreaCreate params;
4683 params.storageArea = storageArea;
4685 params.content = content;
4689 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms);
4699 } _OrthancPluginStorageAreaRead;
4725 _OrthancPluginStorageAreaRead params;
4726 params.target = target;
4727 params.storageArea = storageArea;
4731 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms);
4740 } _OrthancPluginStorageAreaRemove;
4763 _OrthancPluginStorageAreaRemove params;
4764 params.storageArea = storageArea;
4768 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms);
4777 uint16_t httpStatus;
4778 const char* message;
4779 } _OrthancPluginRegisterErrorCode;
4799 uint16_t httpStatus,
4800 const char* message)
4804 _OrthancPluginRegisterErrorCode params;
4805 params.target = ⌖
4807 params.httpStatus = httpStatus;
4808 params.message = message;
4829 uint32_t minMultiplicity;
4830 uint32_t maxMultiplicity;
4831 } _OrthancPluginRegisterDictionaryTag;
4858 uint32_t minMultiplicity,
4859 uint32_t maxMultiplicity)
4861 _OrthancPluginRegisterDictionaryTag params;
4862 params.group = group;
4863 params.element = element;
4866 params.minMultiplicity = minMultiplicity;
4867 params.maxMultiplicity = maxMultiplicity;
4869 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, ¶ms);
4880 uint32_t minMultiplicity;
4881 uint32_t maxMultiplicity;
4882 const char* privateCreator;
4883 } _OrthancPluginRegisterPrivateDictionaryTag;
4911 uint32_t minMultiplicity,
4912 uint32_t maxMultiplicity,
4913 const char* privateCreator)
4915 _OrthancPluginRegisterPrivateDictionaryTag params;
4916 params.group = group;
4917 params.element = element;
4920 params.minMultiplicity = minMultiplicity;
4921 params.maxMultiplicity = maxMultiplicity;
4922 params.privateCreator = privateCreator;
4924 return context->InvokeService(context, _OrthancPluginService_RegisterPrivateDictionaryTag, ¶ms);
4933 } _OrthancPluginReconstructMainDicomTags;
4954 _OrthancPluginReconstructMainDicomTags params;
4955 params.level = level;
4956 params.storageArea = storageArea;
4958 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, ¶ms);
4965 const char* instanceId;
4970 uint32_t maxStringLength;
4971 } _OrthancPluginDicomToJson;
4999 uint32_t maxStringLength)
5003 _OrthancPluginDicomToJson params;
5004 memset(¶ms, 0,
sizeof(params));
5005 params.result = &result;
5006 params.buffer = buffer;
5008 params.format = format;
5009 params.flags = flags;
5010 params.maxStringLength = maxStringLength;
5044 const char* instanceId,
5047 uint32_t maxStringLength)
5051 _OrthancPluginDicomToJson params;
5052 memset(¶ms, 0,
sizeof(params));
5053 params.result = &result;
5054 params.instanceId = instanceId;
5055 params.format = format;
5056 params.flags = flags;
5057 params.maxStringLength = maxStringLength;
5075 uint32_t headersCount;
5076 const char*
const* headersKeys;
5077 const char*
const* headersValues;
5078 int32_t afterPlugins;
5079 } _OrthancPluginRestApiGet2;
5104 uint32_t headersCount,
5105 const char*
const* headersKeys,
5106 const char*
const* headersValues,
5107 int32_t afterPlugins)
5109 _OrthancPluginRestApiGet2 params;
5110 params.target = target;
5112 params.headersCount = headersCount;
5113 params.headersKeys = headersKeys;
5114 params.headersValues = headersValues;
5115 params.afterPlugins = afterPlugins;
5117 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, ¶ms);
5125 } _OrthancPluginWorklistCallback;
5142 _OrthancPluginWorklistCallback params;
5143 params.callback = callback;
5145 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, ¶ms);
5156 } _OrthancPluginWorklistAnswersOperation;
5181 _OrthancPluginWorklistAnswersOperation params;
5182 params.answers = answers;
5183 params.query = query;
5184 params.dicom = dicom;
5187 return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, ¶ms);
5208 _OrthancPluginWorklistAnswersOperation params;
5209 params.answers = answers;
5210 params.query = NULL;
5211 params.dicom = NULL;
5214 return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, ¶ms);
5225 } _OrthancPluginWorklistQueryOperation;
5248 int32_t isMatch = 0;
5250 _OrthancPluginWorklistQueryOperation params;
5251 params.query = query;
5252 params.dicom = dicom;
5254 params.isMatch = &isMatch;
5255 params.target = NULL;
5286 _OrthancPluginWorklistQueryOperation params;
5287 params.query = query;
5288 params.dicom = NULL;
5290 params.isMatch = NULL;
5291 params.target = target;
5293 return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, ¶ms);
5313 _OrthancPluginAccessDicomInstance params;
5314 memset(¶ms, 0,
sizeof(params));
5315 params.resultOrigin = &origin;
5316 params.instance = instance;
5336 } _OrthancPluginCreateDicom;
5370 _OrthancPluginCreateDicom params;
5371 params.target = target;
5373 params.pixelData = pixelData;
5374 params.flags = flags;
5376 return context->InvokeService(context, _OrthancPluginService_CreateDicom, ¶ms);
5383 } _OrthancPluginDecodeImageCallback;
5403 _OrthancPluginDecodeImageCallback params;
5404 params.callback = callback;
5406 return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, ¶ms);
5419 const void* constBuffer;
5420 uint32_t bufferSize;
5421 uint32_t frameIndex;
5422 } _OrthancPluginCreateImage;
5445 _OrthancPluginCreateImage params;
5446 memset(¶ms, 0,
sizeof(params));
5447 params.target = ⌖
5448 params.format = format;
5449 params.width = width;
5450 params.height = height;
5490 _OrthancPluginCreateImage params;
5491 memset(¶ms, 0,
sizeof(params));
5492 params.target = ⌖
5493 params.format = format;
5494 params.width = width;
5495 params.height = height;
5496 params.pitch = pitch;
5497 params.buffer = buffer;
5529 uint32_t bufferSize,
5530 uint32_t frameIndex)
5534 _OrthancPluginCreateImage params;
5535 memset(¶ms, 0,
sizeof(params));
5536 params.target = ⌖
5537 params.constBuffer = buffer;
5538 params.bufferSize = bufferSize;
5539 params.frameIndex = frameIndex;
5558 } _OrthancPluginComputeHash;
5579 _OrthancPluginComputeHash params;
5580 params.result = &result;
5581 params.buffer = buffer;
5615 _OrthancPluginComputeHash params;
5616 params.result = &result;
5617 params.buffer = buffer;
5637 } _OrthancPluginLookupDictionary;
5659 _OrthancPluginLookupDictionary params;
5660 params.target = target;
5662 return context->InvokeService(context, _OrthancPluginService_LookupDictionary, ¶ms);
5671 uint32_t answerSize;
5672 uint32_t headersCount;
5673 const char*
const* headersKeys;
5674 const char*
const* headersValues;
5675 } _OrthancPluginSendMultipartItem2;
5701 uint32_t answerSize,
5702 uint32_t headersCount,
5703 const char*
const* headersKeys,
5704 const char*
const* headersValues)
5706 _OrthancPluginSendMultipartItem2 params;
5707 params.output = output;
5708 params.answer = answer;
5709 params.answerSize = answerSize;
5710 params.headersCount = headersCount;
5711 params.headersKeys = headersKeys;
5712 params.headersValues = headersValues;
5714 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem2, ¶ms);
5721 } _OrthancPluginIncomingHttpRequestFilter;
5739 _OrthancPluginIncomingHttpRequestFilter params;
5740 params.callback = callback;
5742 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter, ¶ms);
5751 uint16_t* httpStatus;
5754 uint32_t headersCount;
5755 const char*
const* headersKeys;
5756 const char*
const* headersValues;
5759 const char* username;
5760 const char* password;
5762 const char* certificateFile;
5763 const char* certificateKeyFile;
5764 const char* certificateKeyPassword;
5766 } _OrthancPluginCallHttpClient2;
5814 uint16_t* httpStatus,
5817 uint32_t headersCount,
5818 const char*
const* headersKeys,
5819 const char*
const* headersValues,
5822 const char* username,
5823 const char* password,
5825 const char* certificateFile,
5826 const char* certificateKeyFile,
5827 const char* certificateKeyPassword,
5830 _OrthancPluginCallHttpClient2 params;
5831 memset(¶ms, 0,
sizeof(params));
5833 params.answerBody = answerBody;
5834 params.answerHeaders = answerHeaders;
5835 params.httpStatus = httpStatus;
5836 params.method = method;
5838 params.headersCount = headersCount;
5839 params.headersKeys = headersKeys;
5840 params.headersValues = headersValues;
5842 params.bodySize = bodySize;
5843 params.username = username;
5844 params.password = password;
5845 params.timeout = timeout;
5846 params.certificateFile = certificateFile;
5847 params.certificateKeyFile = certificateKeyFile;
5848 params.certificateKeyPassword = certificateKeyPassword;
5849 params.pkcs11 = pkcs11;
5851 return context->InvokeService(context, _OrthancPluginService_CallHttpClient2, ¶ms);
5870 _OrthancPluginRetrieveDynamicString params;
5871 params.result = &result;
5872 params.argument = NULL;
5891 } _OrthancPluginFindCallback;
5908 _OrthancPluginFindCallback params;
5909 params.callback = callback;
5911 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback, ¶ms);
5922 uint32_t *resultUint32;
5923 uint16_t *resultGroup;
5924 uint16_t *resultElement;
5925 char **resultString;
5926 } _OrthancPluginFindOperation;
5949 _OrthancPluginFindOperation params;
5950 memset(¶ms, 0,
sizeof(params));
5951 params.answers = answers;
5952 params.dicom = dicom;
5955 return context->InvokeService(context, _OrthancPluginService_FindAddAnswer, ¶ms);
5976 _OrthancPluginFindOperation params;
5977 memset(¶ms, 0,
sizeof(params));
5978 params.answers = answers;
5980 return context->InvokeService(context, _OrthancPluginService_FindMarkIncomplete, ¶ms);
6002 _OrthancPluginFindOperation params;
6003 memset(¶ms, 0,
sizeof(params));
6004 params.query = query;
6005 params.resultUint32 = &count;
6040 _OrthancPluginFindOperation params;
6041 memset(¶ms, 0,
sizeof(params));
6042 params.query = query;
6043 params.index = index;
6044 params.resultGroup = group;
6045 params.resultElement = element;
6047 return context->InvokeService(context, _OrthancPluginService_GetFindQueryTag, ¶ms);
6071 _OrthancPluginFindOperation params;
6072 memset(¶ms, 0,
sizeof(params));
6073 params.query = query;
6074 params.index = index;
6075 params.resultString = &result;
6109 _OrthancPluginFindOperation params;
6110 memset(¶ms, 0,
sizeof(params));
6111 params.query = query;
6112 params.index = index;
6113 params.resultString = &result;
6135 } _OrthancPluginMoveCallback;
6157 _OrthancPluginMoveCallback params;
6158 params.callback = callback;
6159 params.getMoveSize = getMoveSize;
6160 params.applyMove = applyMove;
6161 params.freeMove = freeMove;
6163 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback, ¶ms);
6173 } _OrthancPluginCreateFindMatcher;
6196 _OrthancPluginCreateFindMatcher params;
6197 memset(¶ms, 0,
sizeof(params));
6198 params.target = ⌖
6199 params.query = query;
6216 } _OrthancPluginFreeFindMatcher;
6231 _OrthancPluginFreeFindMatcher params;
6232 params.matcher = matcher;
6234 context->InvokeService(context, _OrthancPluginService_FreeFindMatcher, ¶ms);
6244 } _OrthancPluginFindMatcherIsMatch;
6266 int32_t isMatch = 0;
6268 _OrthancPluginFindMatcherIsMatch params;
6269 params.matcher = matcher;
6270 params.dicom = dicom;
6272 params.isMatch = &isMatch;
6289 } _OrthancPluginIncomingHttpRequestFilter2;
6306 _OrthancPluginIncomingHttpRequestFilter2 params;
6307 params.callback = callback;
6309 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter2, ¶ms);
6317 } _OrthancPluginGetPeers;
6335 _OrthancPluginGetPeers params;
6336 memset(¶ms, 0,
sizeof(params));
6337 params.peers = &peers;
6353 } _OrthancPluginFreePeers;
6368 _OrthancPluginFreePeers params;
6369 params.peers = peers;
6371 context->InvokeService(context, _OrthancPluginService_FreePeers, ¶ms);
6379 } _OrthancPluginGetPeersCount;
6398 uint32_t target = 0;
6400 _OrthancPluginGetPeersCount params;
6401 memset(¶ms, 0,
sizeof(params));
6402 params.target = ⌖
6403 params.peers = peers;
6419 const char** target;
6422 const char* userProperty;
6423 } _OrthancPluginGetPeerProperty;
6447 const char* target = NULL;
6449 _OrthancPluginGetPeerProperty params;
6450 memset(¶ms, 0,
sizeof(params));
6451 params.target = ⌖
6452 params.peers = peers;
6453 params.peerIndex = peerIndex;
6454 params.userProperty = NULL;
6488 const char* target = NULL;
6490 _OrthancPluginGetPeerProperty params;
6491 memset(¶ms, 0,
sizeof(params));
6492 params.target = ⌖
6493 params.peers = peers;
6494 params.peerIndex = peerIndex;
6495 params.userProperty = NULL;
6533 const char* userProperty)
6535 const char* target = NULL;
6537 _OrthancPluginGetPeerProperty params;
6538 memset(¶ms, 0,
sizeof(params));
6539 params.target = ⌖
6540 params.peers = peers;
6541 params.peerIndex = peerIndex;
6542 params.userProperty = userProperty;
6561 uint16_t* httpStatus;
6566 uint32_t additionalHeadersCount;
6567 const char*
const* additionalHeadersKeys;
6568 const char*
const* additionalHeadersValues;
6572 } _OrthancPluginCallPeerApi;
6614 uint16_t* httpStatus,
6619 uint32_t additionalHeadersCount,
6620 const char*
const* additionalHeadersKeys,
6621 const char*
const* additionalHeadersValues,
6626 _OrthancPluginCallPeerApi params;
6627 memset(¶ms, 0,
sizeof(params));
6629 params.answerBody = answerBody;
6630 params.answerHeaders = answerHeaders;
6631 params.httpStatus = httpStatus;
6632 params.peers = peers;
6633 params.peerIndex = peerIndex;
6634 params.method = method;
6636 params.additionalHeadersCount = additionalHeadersCount;
6637 params.additionalHeadersKeys = additionalHeadersKeys;
6638 params.additionalHeadersValues = additionalHeadersValues;
6640 params.bodySize = bodySize;
6641 params.timeout = timeout;
6643 return context->InvokeService(context, _OrthancPluginService_CallPeerApi, ¶ms);
6662 } _OrthancPluginCreateJob;
6709 _OrthancPluginCreateJob params;
6710 memset(¶ms, 0,
sizeof(params));
6712 params.target = ⌖
6714 params.finalize = finalize;
6716 params.getProgress = getProgress;
6717 params.getContent = getContent;
6718 params.getSerialized = getSerialized;
6721 params.reset = reset;
6739 } _OrthancPluginFreeJob;
6754 _OrthancPluginFreeJob params;
6757 context->InvokeService(context, _OrthancPluginService_FreeJob, ¶ms);
6767 } _OrthancPluginSubmitJob;
6787 char* resultId = NULL;
6789 _OrthancPluginSubmitJob params;
6790 memset(¶ms, 0,
sizeof(params));
6792 params.resultId = &resultId;
6794 params.priority = priority;
6813 } _OrthancPluginJobsUnserializer;
6831 _OrthancPluginJobsUnserializer params;
6832 params.unserializer = unserializer;
6834 context->InvokeService(context, _OrthancPluginService_RegisterJobsUnserializer, ¶ms);
6842 const char* details;
6844 } _OrthancPluginSetHttpErrorDetails;
6866 const char* details,
6869 _OrthancPluginSetHttpErrorDetails params;
6870 params.output = output;
6871 params.details = details;
6873 context->InvokeService(context, _OrthancPluginService_SetHttpErrorDetails, ¶ms);
6880 const char** result;
6881 const char* argument;
6882 } _OrthancPluginRetrieveStaticString;
6899 const char* result = NULL;
6901 _OrthancPluginRetrieveStaticString params;
6902 params.result = &result;
6903 params.argument = path;
6923 } _OrthancPluginSetMetricsValue;
6945 _OrthancPluginSetMetricsValue params;
6947 params.value = value;
6949 context->InvokeService(context, _OrthancPluginService_SetMetricsValue, ¶ms);
6957 } _OrthancPluginRegisterRefreshMetricsCallback;
6973 _OrthancPluginRegisterRefreshMetricsCallback params;
6974 params.callback = callback;
6975 context->InvokeService(context, _OrthancPluginService_RegisterRefreshMetricsCallback, ¶ms);
6987 } _OrthancPluginEncodeDicomWeb;
7011 char* target = NULL;
7013 _OrthancPluginEncodeDicomWeb params;
7014 params.target = ⌖
7015 params.dicom = dicom;
7016 params.dicomSize = dicomSize;
7017 params.callback = callback;
7053 char* target = NULL;
7055 _OrthancPluginEncodeDicomWeb params;
7056 params.target = ⌖
7057 params.dicom = dicom;
7058 params.dicomSize = dicomSize;
7059 params.callback = callback;
7081 } _OrthancPluginEncodeDicomWeb2;
7106 char* target = NULL;
7108 _OrthancPluginEncodeDicomWeb2 params;
7109 params.target = ⌖
7110 params.dicom = dicom;
7111 params.dicomSize = dicomSize;
7112 params.callback = callback;
7113 params.payload = payload;
7150 char* target = NULL;
7152 _OrthancPluginEncodeDicomWeb2 params;
7153 params.target = ⌖
7154 params.dicom = dicom;
7155 params.dicomSize = dicomSize;
7156 params.callback = callback;
7157 params.payload = payload;
7261 typedef const void* (*OrthancPluginChunkedClientRequestGetChunkData) (
void* request);
7285 uint16_t* httpStatus;
7288 uint32_t headersCount;
7289 const char*
const* headersKeys;
7290 const char*
const* headersValues;
7296 const char* username;
7297 const char* password;
7299 const char* certificateFile;
7300 const char* certificateKeyFile;
7301 const char* certificateKeyPassword;
7303 } _OrthancPluginChunkedHttpClient;
7361 uint16_t* httpStatus,
7364 uint32_t headersCount,
7365 const char*
const* headersKeys,
7366 const char*
const* headersValues,
7372 const char* username,
7373 const char* password,
7375 const char* certificateFile,
7376 const char* certificateKeyFile,
7377 const char* certificateKeyPassword,
7380 _OrthancPluginChunkedHttpClient params;
7381 memset(¶ms, 0,
sizeof(params));
7384 params.httpStatus = httpStatus;
7385 params.method = method;
7387 params.headersCount = headersCount;
7388 params.headersKeys = headersKeys;
7389 params.headersValues = headersValues;
7390 params.username = username;
7391 params.password = password;
7392 params.timeout = timeout;
7393 params.certificateFile = certificateFile;
7394 params.certificateKeyFile = certificateKeyFile;
7395 params.certificateKeyPassword = certificateKeyPassword;
7396 params.pkcs11 = pkcs11;
7399 params.answer = answer;
7400 params.answerAddChunk = answerAddChunk;
7401 params.answerAddHeader = answerAddHeader;
7402 params.request = request;
7403 params.requestIsDone = requestIsDone;
7404 params.requestChunkData = requestChunkData;
7405 params.requestChunkSize = requestChunkSize;
7406 params.requestNext = requestNext;
7408 return context->InvokeService(context, _OrthancPluginService_ChunkedHttpClient, ¶ms);
7498 const char* pathRegularExpression;
7506 } _OrthancPluginChunkedRestCallback;
7540 const char* pathRegularExpression,
7549 _OrthancPluginChunkedRestCallback params;
7550 params.pathRegularExpression = pathRegularExpression;
7551 params.getHandler = getHandler;
7552 params.postHandler = postHandler;
7553 params.deleteHandler = deleteHandler;
7554 params.putHandler = putHandler;
7555 params.addChunk = addChunk;
7556 params.execute = execute;
7557 params.finalize = finalize;
7559 context->InvokeService(context, _OrthancPluginService_RegisterChunkedRestCallback, ¶ms);
7571 const char* privateCreator;
7572 } _OrthancPluginGetTagName;
7593 const char* privateCreator)
7597 _OrthancPluginGetTagName params;
7598 params.result = &result;
7599 params.group = group;
7600 params.element = element;
7601 params.privateCreator = privateCreator;
7647 const char* transactionUid,
7648 const char*
const* sopClassUids,
7649 const char*
const* sopInstanceUids,
7650 uint32_t countInstances,
7651 const char* remoteAet,
7652 const char* calledAet);
7690 const char* sopClassUid,
7691 const char* sopInstanceUid);
7699 } _OrthancPluginRegisterStorageCommitmentScpCallback;
7720 _OrthancPluginRegisterStorageCommitmentScpCallback params;
7721 params.factory = factory;
7722 params.destructor = destructor;
7723 params.lookup = lookup;
7724 return context->InvokeService(context, _OrthancPluginService_RegisterStorageCommitmentScpCallback, ¶ms);
7761 } _OrthancPluginIncomingDicomInstanceFilter;
7779 _OrthancPluginIncomingDicomInstanceFilter params;
7780 params.callback = callback;
7782 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingDicomInstanceFilter, ¶ms);
7817 uint16_t* dimseStatus ,
7824 } _OrthancPluginIncomingCStoreInstanceFilter;
7842 _OrthancPluginIncomingCStoreInstanceFilter params;
7843 params.callback = callback;
7845 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingCStoreInstanceFilter, ¶ms);
7885 const void* receivedDicomBuffer,
7886 uint64_t receivedDicomBufferSize,
7893 } _OrthancPluginReceivedInstanceCallback;
7919 _OrthancPluginReceivedInstanceCallback params;
7920 params.callback = callback;
7922 return context->InvokeService(context, _OrthancPluginService_RegisterReceivedInstanceCallback, ¶ms);
7944 _OrthancPluginAccessDicomInstance params;
7945 memset(¶ms, 0,
sizeof(params));
7946 params.resultStringToFree = &result;
7947 params.instance = instance;
7977 int64_t hasPixelData;
7979 _OrthancPluginAccessDicomInstance params;
7980 memset(¶ms, 0,
sizeof(params));
7981 params.resultInt64 = &hasPixelData;
7982 params.instance = instance;
7993 return (hasPixelData != 0);
8007 const char* transferSyntax;
8008 } _OrthancPluginCreateDicomInstance;
8030 _OrthancPluginCreateDicomInstance params;
8031 params.target = ⌖
8032 params.buffer = buffer;
8049 } _OrthancPluginFreeDicomInstance;
8065 _OrthancPluginFreeDicomInstance params;
8066 params.dicom = dicom;
8068 context->InvokeService(context, _OrthancPluginService_FreeDicomInstance, ¶ms);
8074 uint32_t* targetUint32;
8077 char** targetStringToFree;
8079 uint32_t frameIndex;
8082 uint32_t maxStringLength;
8084 void* dicomWebPayload;
8085 } _OrthancPluginAccessDicomInstance2;
8104 _OrthancPluginAccessDicomInstance2 params;
8105 memset(¶ms, 0,
sizeof(params));
8106 params.targetUint32 = &count;
8107 params.instance = instance;
8142 uint32_t frameIndex)
8144 _OrthancPluginAccessDicomInstance2 params;
8145 memset(¶ms, 0,
sizeof(params));
8146 params.targetBuffer = target;
8147 params.instance = instance;
8148 params.frameIndex = frameIndex;
8150 return context->InvokeService(context, _OrthancPluginService_GetInstanceRawFrame, ¶ms);
8169 uint32_t frameIndex)
8173 _OrthancPluginAccessDicomInstance2 params;
8174 memset(¶ms, 0,
sizeof(params));
8175 params.targetImage = ⌖
8176 params.instance = instance;
8177 params.frameIndex = frameIndex;
8209 const char* transferSyntax)
8213 _OrthancPluginCreateDicomInstance params;
8214 params.target = ⌖
8215 params.buffer = buffer;
8217 params.transferSyntax = transferSyntax;
8248 _OrthancPluginAccessDicomInstance2 params;
8249 memset(¶ms, 0,
sizeof(params));
8250 params.targetBuffer = target;
8251 params.instance = instance;
8253 return context->InvokeService(context, _OrthancPluginService_SerializeDicomInstance, ¶ms);
8280 uint32_t maxStringLength)
8282 char* result = NULL;
8284 _OrthancPluginAccessDicomInstance2 params;
8285 memset(¶ms, 0,
sizeof(params));
8286 params.targetStringToFree = &result;
8287 params.instance = instance;
8288 params.format = format;
8289 params.flags = flags;
8290 params.maxStringLength = maxStringLength;
8324 char* target = NULL;
8326 _OrthancPluginAccessDicomInstance2 params;
8327 params.targetStringToFree = ⌖
8328 params.instance = instance;
8329 params.dicomWebCallback = callback;
8330 params.dicomWebPayload = payload;
8364 char* target = NULL;
8366 _OrthancPluginAccessDicomInstance2 params;
8367 params.targetStringToFree = ⌖
8368 params.instance = instance;
8369 params.dicomWebCallback = callback;
8370 params.dicomWebPayload = payload;
8407 const char*
const* allowedSyntaxes,
8408 uint32_t countSyntaxes,
8409 uint8_t allowNewSopInstanceUid);
8415 } _OrthancPluginTranscoderCallback;
8434 _OrthancPluginTranscoderCallback params;
8435 params.callback = callback;
8437 return context->InvokeService(context, _OrthancPluginService_RegisterTranscoderCallback, ¶ms);
8446 } _OrthancPluginCreateMemoryBuffer;
8470 _OrthancPluginCreateMemoryBuffer params;
8471 params.target = target;
8474 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer, ¶ms);
8508 _OrthancPluginRetrieveDynamicString params;
8509 params.result = &result;
8510 params.argument = NULL;
8512 if (context->InvokeService(context, _OrthancPluginService_GenerateRestApiAuthorizationToken,
8530 } _OrthancPluginCreateMemoryBuffer64;
8554 _OrthancPluginCreateMemoryBuffer64 params;
8555 params.target = target;
8558 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer64, ¶ms);
8568 } _OrthancPluginRegisterStorageArea2;
8593 _OrthancPluginRegisterStorageArea2 params;
8594 params.create = create;
8595 params.readWhole = readWhole;
8596 params.readRange = readRange;
8597 params.remove = remove;
8598 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea2, ¶ms);
8605 _OrthancPluginCreateDicom createDicom;
8606 const char* privateCreator;
8607 } _OrthancPluginCreateDicom2;
8639 const char* privateCreator)
8641 _OrthancPluginCreateDicom2 params;
8642 params.createDicom.target = target;
8643 params.createDicom.json = json;
8644 params.createDicom.pixelData = pixelData;
8645 params.createDicom.flags = flags;
8646 params.privateCreator = privateCreator;
8648 return context->InvokeService(context, _OrthancPluginService_CreateDicom2, ¶ms);
8660 uint16_t* httpStatus;
8663 uint32_t headersCount;
8664 const char*
const* headersKeys;
8665 const char*
const* headersValues;
8668 uint8_t afterPlugins;
8669 } _OrthancPluginCallRestApi;
8705 uint16_t* httpStatus,
8708 uint32_t headersCount,
8709 const char*
const* headersKeys,
8710 const char*
const* headersValues,
8713 uint8_t afterPlugins)
8715 _OrthancPluginCallRestApi params;
8716 memset(¶ms, 0,
sizeof(params));
8718 params.answerBody = answerBody;
8719 params.answerHeaders = answerHeaders;
8720 params.httpStatus = httpStatus;
8721 params.method = method;
8723 params.headersCount = headersCount;
8724 params.headersKeys = headersKeys;
8725 params.headersValues = headersValues;
8727 params.bodySize = bodySize;
8728 params.afterPlugins = afterPlugins;
8730 return context->InvokeService(context, _OrthancPluginService_CallRestApi, ¶ms);
8762 const char* mimeType,
8763 const char* dateTime);
8782 const char* dateTime);
8810 const char* mimeType,
8811 const char* dateTime);
8828 uint8_t* isExisting,
8830 const char*
const* pathItems,
8853 uint8_t* isExisting,
8858 const char*
const* pathItems,
8882 const char*
const* pathItems,
8902 uint8_t* isReadOnly,
8904 const char*
const* pathItems,
8924 uint8_t* isReadOnly,
8926 const char*
const* pathItems,
8944 uint8_t* isReadOnly,
8946 const char*
const* pathItems,
8960 } _OrthancPluginRegisterWebDavCollection;
8993 _OrthancPluginRegisterWebDavCollection params;
8995 params.isExistingFolder = isExistingFolder;
8996 params.listFolder = listFolder;
8997 params.retrieveFile = retrieveFile;
8998 params.storeFile = storeFile;
8999 params.createFolder = createFolder;
9000 params.deleteItem = deleteItem;
9001 params.payload = payload;
9003 return context->InvokeService(context, _OrthancPluginService_RegisterWebDavCollection, ¶ms);
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:7883
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:8758
int OrthancPluginCheckVersionAdvanced(OrthancPluginContext *context, int expectedMajor, int expectedMinor, int expectedRevision)
Check that the version of the hosting Orthanc is above a given version.
Definition: OrthancCPlugin.h:1835
void OrthancPluginRegisterStorageArea(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove)
Register a custom storage area.
Definition: OrthancCPlugin.h:3173
void OrthancPluginRegisterOnStoredInstanceCallback(OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback)
Register a callback for received instances.
Definition: OrthancCPlugin.h:2138
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:1223
OrthancPluginErrorCode OrthancPluginRegisterDecodeImageCallback(OrthancPluginContext *context, OrthancPluginDecodeImageCallback callback)
Register a callback to handle the decoding of DICOM images.
Definition: OrthancCPlugin.h:5399
OrthancPluginChangeType
Definition: OrthancCPlugin.h:729
OrthancPluginErrorCode(* OrthancPluginStorageReadWhole)(OrthancPluginMemoryBuffer64 *target, const char *uuid, OrthancPluginContentType type)
Callback for reading a whole file from the storage area.
Definition: OrthancCPlugin.h:1289
OrthancPluginErrorCode OrthancPluginRegisterIncomingCStoreInstanceFilter(OrthancPluginContext *context, OrthancPluginIncomingCStoreInstanceFilter callback)
Register a callback to filter incoming DICOM instances received by Orthanc through C-STORE.
Definition: OrthancCPlugin.h:7838
int OrthancPluginCheckVersion(OrthancPluginContext *context)
Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
Definition: OrthancCPlugin.h:1941
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:1201
void OrthancPluginRegisterRefreshMetricsCallback(OrthancPluginContext *context, OrthancPluginRefreshMetricsCallback callback)
Register a callback to refresh the metrics.
Definition: OrthancCPlugin.h:6969
OrthancPluginErrorCode(* OrthancPluginWebDavCreateFolderCallback)(uint8_t *isReadOnly, uint32_t pathSize, const char *const *pathItems, void *payload)
Callback to create a folder.
Definition: OrthancCPlugin.h:8923
struct _OrthancPluginWebDavCollection_t OrthancPluginWebDavCollection
Opaque structure that represents a WebDAV collection.
Definition: OrthancCPlugin.h:8739
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:1716
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:8878
int32_t(* OrthancPluginIncomingDicomInstanceFilter)(const OrthancPluginDicomInstance *instance)
Callback to filter incoming DICOM instances received by Orthanc.
Definition: OrthancCPlugin.h:7754
OrthancPluginErrorCode OrthancPluginStorageAreaRemove(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Remove a file from the storage area.
Definition: OrthancCPlugin.h:4757
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:8403
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter2(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter2 callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:6302
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:8806
OrthancPluginErrorCode(* OrthancPluginStorageRead)(void **content, int64_t *size, const char *uuid, OrthancPluginContentType type)
Callback for reading from the storage area.
Definition: OrthancCPlugin.h:1269
void OrthancPluginRegisterRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback.
Definition: OrthancCPlugin.h:2060
uint32_t OrthancPluginGetExpectedDatabaseVersion(OrthancPluginContext *context)
Get the expected version of the database schema.
Definition: OrthancCPlugin.h:3561
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:7915
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:8852
OrthancPluginJob *(* OrthancPluginJobsUnserializer)(const char *jobType, const char *serialized)
Callback executed to unserialize a custom job.
Definition: OrthancCPlugin.h:1670
struct _OrthancPluginRestOutput_t OrthancPluginRestOutput
Opaque structure that represents the HTTP connection to the client application.
Definition: OrthancCPlugin.h:1072
void OrthancPluginRegisterOnChangeCallback(OrthancPluginContext *context, OrthancPluginOnChangeCallback callback)
Register a callback to monitor changes.
Definition: OrthancCPlugin.h:3316
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:8586
OrthancPluginErrorCode(* OrthancPluginWebDavAddFolder)(OrthancPluginWebDavCollection *collection, const char *name, const char *dateTime)
Declare a subfolder while returning the content of a folder.
Definition: OrthancCPlugin.h:8779
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:8982
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:1415
OrthancPluginErrorCode(* OrthancPluginRestCallback)(OrthancPluginRestOutput *output, const char *url, const OrthancPluginHttpRequest *request)
Signature of a callback function that answers to a REST request.
Definition: OrthancCPlugin.h:1169
void(* OrthancPluginRefreshMetricsCallback)()
Callback executed to update the metrics of the plugin.
Definition: OrthancCPlugin.h:1688
OrthancPluginErrorCode OrthancPluginRegisterTranscoderCallback(OrthancPluginContext *context, OrthancPluginTranscoderCallback callback)
Register a callback to handle the transcoding of DICOM images.
Definition: OrthancCPlugin.h:8430
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:1180
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:8901
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:8943
OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, OrthancPluginResourceType level)
Reconstruct the main DICOM tags.
Definition: OrthancCPlugin.h:4949
OrthancPluginErrorCode(* OrthancPluginStorageRemove)(const char *uuid, OrthancPluginContentType type)
Callback for removing a file from the storage area.
Definition: OrthancCPlugin.h:1330
OrthancPluginErrorCode(* OrthancPluginStorageCreate)(const char *uuid, const void *content, int64_t size, OrthancPluginContentType type)
Callback for writing to the storage area.
Definition: OrthancCPlugin.h:1242
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:1754
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:1190
struct _OrthancPluginServerChunkedRequestReader_t OrthancPluginServerChunkedRequestReader
Opaque structure that reads the content of a HTTP request body during a chunked HTTP transfer.
Definition: OrthancCPlugin.h:7417
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:8827
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:1380
void OrthancPluginRegisterJobsUnserializer(OrthancPluginContext *context, OrthancPluginJobsUnserializer unserializer)
Register an unserializer for custom jobs.
Definition: OrthancCPlugin.h:6827
void(* OrthancPluginFree)(void *buffer)
Signature of a function to free dynamic memory.
Definition: OrthancCPlugin.h:1213
void OrthancPluginRegisterRestCallbackNoLock(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback, without locking.
Definition: OrthancCPlugin.h:2100
OrthancPluginErrorCode OrthancPluginStorageAreaRead(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Read a file from the storage area.
Definition: OrthancCPlugin.h:4718
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:1312
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:7538
int32_t(* OrthancPluginIncomingCStoreInstanceFilter)(uint16_t *dimseStatus, const OrthancPluginDicomInstance *instance)
Callback to filter incoming DICOM instances received by Orthanc through C-STORE.
Definition: OrthancCPlugin.h:7816
OrthancPluginErrorCode OrthancPluginRegisterIncomingDicomInstanceFilter(OrthancPluginContext *context, OrthancPluginIncomingDicomInstanceFilter callback)
Register a callback to filter incoming DICOM instances.
Definition: OrthancCPlugin.h:7775
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:5735
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:4674
@ OrthancPluginChangeType_OrthancStopped
Definition: OrthancCPlugin.h:741
@ OrthancPluginChangeType_OrthancStarted
Definition: OrthancCPlugin.h:740
@ OrthancPluginChangeType_Deleted
Definition: OrthancCPlugin.h:731
@ OrthancPluginChangeType_JobFailure
Definition: OrthancCPlugin.h:748
@ OrthancPluginChangeType_NewInstance
Definition: OrthancCPlugin.h:733
@ OrthancPluginChangeType_NewPatient
Definition: OrthancCPlugin.h:734
@ OrthancPluginChangeType_JobSubmitted
Definition: OrthancCPlugin.h:746
@ OrthancPluginChangeType_NewSeries
Definition: OrthancCPlugin.h:735
@ OrthancPluginChangeType_StablePatient
Definition: OrthancCPlugin.h:737
@ OrthancPluginChangeType_UpdatedPeers
Definition: OrthancCPlugin.h:744
@ OrthancPluginChangeType_StableStudy
Definition: OrthancCPlugin.h:739
@ OrthancPluginChangeType_CompletedSeries
Definition: OrthancCPlugin.h:730
@ OrthancPluginChangeType_NewChildInstance
Definition: OrthancCPlugin.h:732
@ OrthancPluginChangeType_UpdatedAttachment
Definition: OrthancCPlugin.h:742
@ OrthancPluginChangeType_UpdatedMetadata
Definition: OrthancCPlugin.h:743
@ OrthancPluginChangeType_StableSeries
Definition: OrthancCPlugin.h:738
@ OrthancPluginChangeType_UpdatedModalities
Definition: OrthancCPlugin.h:745
@ OrthancPluginChangeType_JobSuccess
Definition: OrthancCPlugin.h:747
@ OrthancPluginChangeType_NewStudy
Definition: OrthancCPlugin.h:736
uint32_t OrthancPluginGetFindQuerySize(OrthancPluginContext *context, const OrthancPluginFindQuery *query)
Get the number of tags in a C-Find query.
Definition: OrthancCPlugin.h:5996
struct _OrthancPluginFindQuery_t OrthancPluginFindQuery
Opaque structure to an object that represents a C-Find query.
Definition: OrthancCPlugin.h:1120
OrthancPluginErrorCode(* OrthancPluginApplyMove)(void *moveDriver)
Callback to apply one C-Move suboperation.
Definition: OrthancCPlugin.h:1525
OrthancPluginErrorCode OrthancPluginFindMarkIncomplete(OrthancPluginContext *context, OrthancPluginFindAnswers *answers)
Mark the set of C-Find answers as incomplete.
Definition: OrthancCPlugin.h:5972
void(* OrthancPluginStorageCommitmentDestructor)(void *handler)
Callback to free one storage commitment SCP handler.
Definition: OrthancCPlugin.h:7666
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:1349
OrthancPluginErrorCode OrthancPluginRegisterMoveCallback(OrthancPluginContext *context, OrthancPluginMoveCallback callback, OrthancPluginGetMoveSize getMoveSize, OrthancPluginApplyMove applyMove, OrthancPluginFreeMove freeMove)
Register a callback to handle C-Move requests.
Definition: OrthancCPlugin.h:6150
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:6102
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:7644
OrthancPluginErrorCode OrthancPluginRegisterFindCallback(OrthancPluginContext *context, OrthancPluginFindCallback callback)
Register a callback to handle C-Find requests.
Definition: OrthancCPlugin.h:5904
OrthancPluginErrorCode OrthancPluginWorklistGetDicomQuery(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginWorklistQuery *query)
Retrieve the worklist query as a DICOM file.
Definition: OrthancCPlugin.h:5281
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:7687
int32_t OrthancPluginWorklistIsMatch(OrthancPluginContext *context, const OrthancPluginWorklistQuery *query, const void *dicom, uint32_t size)
Test whether a worklist matches the query.
Definition: OrthancCPlugin.h:5242
OrthancPluginErrorCode OrthancPluginFindAddAnswer(OrthancPluginContext *context, OrthancPluginFindAnswers *answers, const void *dicom, uint32_t size)
Add one answer to some C-Find request.
Definition: OrthancCPlugin.h:5943
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:7714
struct _OrthancPluginFindAnswers_t OrthancPluginFindAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1128
struct _OrthancPluginWorklistAnswers_t OrthancPluginWorklistAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1112
OrthancPluginErrorCode(* OrthancPluginFindCallback)(OrthancPluginFindAnswers *answers, const OrthancPluginFindQuery *query, const char *issuerAet, const char *calledAet)
Callback to handle incoming C-Find SCP requests.
Definition: OrthancCPlugin.h:1442
uint32_t(* OrthancPluginGetMoveSize)(void *moveDriver)
Callback to read the size of a C-Move driver.
Definition: OrthancCPlugin.h:1510
OrthancPluginErrorCode OrthancPluginRegisterWorklistCallback(OrthancPluginContext *context, OrthancPluginWorklistCallback callback)
Register a callback to handle modality worklists requests.
Definition: OrthancCPlugin.h:5138
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:6064
OrthancPluginErrorCode OrthancPluginWorklistMarkIncomplete(OrthancPluginContext *context, OrthancPluginWorklistAnswers *answers)
Mark the set of worklist answers as incomplete.
Definition: OrthancCPlugin.h:5204
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:6033
void(* OrthancPluginFreeMove)(void *moveDriver)
Callback to free one C-Move driver.
Definition: OrthancCPlugin.h:1539
struct _OrthancPluginWorklistQuery_t OrthancPluginWorklistQuery
Opaque structure to an object that represents a C-Find query for worklists.
Definition: OrthancCPlugin.h:1104
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:1485
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:5174
int32_t OrthancPluginHasInstancePixelData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Check whether the DICOM file has pixel data.
Definition: OrthancCPlugin.h:7973
char * OrthancPluginGetInstanceDicomWebXml(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb XML.
Definition: OrthancCPlugin.h:8358
struct _OrthancPluginDicomInstance_t OrthancPluginDicomInstance
Opaque structure that represents a DICOM instance that is managed by the Orthanc core.
Definition: OrthancCPlugin.h:1080
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:8138
const char * OrthancPluginGetInstanceRemoteAet(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the AET of a DICOM instance.
Definition: OrthancCPlugin.h:2904
char * OrthancPluginGetInstanceJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file.
Definition: OrthancCPlugin.h:3006
OrthancPluginDicomInstance * OrthancPluginTranscodeDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size, const char *transferSyntax)
Parse and transcode a DICOM instance.
Definition: OrthancCPlugin.h:8205
OrthancPluginDicomInstance * OrthancPluginCreateDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size)
Parse a DICOM instance.
Definition: OrthancCPlugin.h:8023
uint32_t OrthancPluginGetInstanceFramesCount(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the number of frames in a DICOM instance.
Definition: OrthancCPlugin.h:8098
OrthancPluginInstanceOrigin OrthancPluginGetInstanceOrigin(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the origin of a DICOM file.
Definition: OrthancCPlugin.h:5307
int64_t OrthancPluginGetInstanceSize(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the size of a DICOM file.
Definition: OrthancCPlugin.h:2937
char * OrthancPluginGetInstanceDicomWebJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb JSON.
Definition: OrthancCPlugin.h:8318
char * OrthancPluginGetInstanceTransferSyntaxUid(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the transfer syntax of a DICOM file.
Definition: OrthancCPlugin.h:7938
int OrthancPluginHasInstanceMetadata(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, const char *metadata)
Check whether a DICOM instance is associated with some metadata.
Definition: OrthancCPlugin.h:3083
void OrthancPluginFreeDicomInstance(OrthancPluginContext *context, OrthancPluginDicomInstance *dicom)
Free a DICOM instance.
Definition: OrthancCPlugin.h:8061
OrthancPluginErrorCode OrthancPluginSerializeDicomInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginDicomInstance *instance)
Writes a DICOM instance to a memory buffer.
Definition: OrthancCPlugin.h:8243
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:3124
char * OrthancPluginGetInstanceSimplifiedJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file (with simplification).
Definition: OrthancCPlugin.h:3044
const void * OrthancPluginGetInstanceData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the data of a DICOM file.
Definition: OrthancCPlugin.h:2970
OrthancPluginImage * OrthancPluginGetInstanceDecodedFrame(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:8166
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:8275
OrthancPluginImage * OrthancPluginConvertPixelFormat(OrthancPluginContext *context, const OrthancPluginImage *source, OrthancPluginPixelFormat targetFormat)
Change the pixel format of an image.
Definition: OrthancCPlugin.h:4460
OrthancPluginPixelFormat
Definition: OrthancCPlugin.h:605
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:4620
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:4204
uint32_t OrthancPluginGetImagePitch(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pitch of an image.
Definition: OrthancCPlugin.h:3995
OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pixel format of an image.
Definition: OrthancCPlugin.h:3894
OrthancPluginImage * OrthancPluginCreateImage(OrthancPluginContext *context, OrthancPluginPixelFormat format, uint32_t width, uint32_t height)
Create an image.
Definition: OrthancCPlugin.h:5437
uint32_t OrthancPluginGetFontsCount(OrthancPluginContext *context)
Return the number of available fonts.
Definition: OrthancCPlugin.h:4495
uint32_t OrthancPluginGetImageHeight(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the height of an image.
Definition: OrthancCPlugin.h:3960
void * OrthancPluginGetImageBuffer(OrthancPluginContext *context, const OrthancPluginImage *image)
Return a pointer to the content of an image.
Definition: OrthancCPlugin.h:4029
void OrthancPluginFreeImage(OrthancPluginContext *context, OrthancPluginImage *image)
Free an image.
Definition: OrthancCPlugin.h:4114
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:4159
OrthancPluginImage * OrthancPluginDecodeDicomImage(OrthancPluginContext *context, const void *buffer, uint32_t bufferSize, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:5526
OrthancPluginImage * OrthancPluginUncompressImage(OrthancPluginContext *context, const void *data, uint32_t size, OrthancPluginImageFormat format)
Decode a compressed image.
Definition: OrthancCPlugin.h:4072
const char * OrthancPluginGetFontName(OrthancPluginContext *context, uint32_t fontIndex)
Return the name of a font.
Definition: OrthancCPlugin.h:4535
OrthancPluginImageFormat
Definition: OrthancCPlugin.h:774
struct _OrthancPluginStorageArea_t OrthancPluginStorageArea
Opaque structure that represents the storage area that is actually used by Orthanc.
Definition: OrthancCPlugin.h:1096
OrthancPluginCompressionType
Definition: OrthancCPlugin.h:759
uint32_t OrthancPluginGetImageWidth(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the width of an image.
Definition: OrthancCPlugin.h:3927
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:3706
uint32_t OrthancPluginGetFontSize(OrthancPluginContext *context, uint32_t fontIndex)
Return the size of a font.
Definition: OrthancCPlugin.h:4567
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:5480
struct _OrthancPluginImage_t OrthancPluginImage
Opaque structure that represents an image that is uncompressed in memory.
Definition: OrthancCPlugin.h:1088
@ OrthancPluginPixelFormat_RGBA32
Color image in RGBA32 format.
Definition: OrthancCPlugin.h:644
@ OrthancPluginPixelFormat_RGB48
Color image in RGB48 format.
Definition: OrthancCPlugin.h:654
@ OrthancPluginPixelFormat_Grayscale8
Graylevel 8bpp image.
Definition: OrthancCPlugin.h:612
@ OrthancPluginPixelFormat_SignedGrayscale16
Graylevel, signed 16bpp image.
Definition: OrthancCPlugin.h:628
@ OrthancPluginPixelFormat_Float32
Graylevel, floating-point 32bpp image.
Definition: OrthancCPlugin.h:670
@ OrthancPluginPixelFormat_RGB24
Color image in RGB24 format.
Definition: OrthancCPlugin.h:636
@ OrthancPluginPixelFormat_BGRA32
Color image in BGRA32 format.
Definition: OrthancCPlugin.h:678
@ OrthancPluginPixelFormat_Unknown
Definition: OrthancCPlugin.h:646
@ OrthancPluginPixelFormat_Grayscale64
Graylevel, unsigned 64bpp image.
Definition: OrthancCPlugin.h:686
@ OrthancPluginPixelFormat_Grayscale32
Graylevel, unsigned 32bpp image.
Definition: OrthancCPlugin.h:662
@ OrthancPluginPixelFormat_Grayscale16
Graylevel, unsigned 16bpp image.
Definition: OrthancCPlugin.h:620
@ OrthancPluginImageFormat_Png
Definition: OrthancCPlugin.h:775
@ OrthancPluginImageFormat_Jpeg
Definition: OrthancCPlugin.h:776
@ OrthancPluginImageFormat_Dicom
Definition: OrthancCPlugin.h:777
@ OrthancPluginCompressionType_Gzip
Definition: OrthancCPlugin.h:762
@ OrthancPluginCompressionType_ZlibWithSize
Definition: OrthancCPlugin.h:761
@ OrthancPluginCompressionType_Zlib
Definition: OrthancCPlugin.h:760
@ OrthancPluginCompressionType_GzipWithSize
Definition: OrthancCPlugin.h:763
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:2368
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:2403
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:2516
char * OrthancPluginLookupStudyWithAccessionNumber(OrthancPluginContext *context, const char *accessionNumber)
Look for a study, using the accession number.
Definition: OrthancCPlugin.h:2652
char * OrthancPluginLookupSeries(OrthancPluginContext *context, const char *seriesUID)
Look for a series.
Definition: OrthancCPlugin.h:2687
OrthancPluginErrorCode OrthancPluginSetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *value)
Set the value of a global property.
Definition: OrthancCPlugin.h:3464
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:2480
char * OrthancPluginGetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *defaultValue)
Get the value of a global property.
Definition: OrthancCPlugin.h:3425
char * OrthancPluginLookupStudy(OrthancPluginContext *context, const char *studyUID)
Look for a study.
Definition: OrthancCPlugin.h:2617
OrthancPluginErrorCode OrthancPluginRestApiGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2301
char * OrthancPluginLookupInstance(OrthancPluginContext *context, const char *sopInstanceUID)
Look for an instance.
Definition: OrthancCPlugin.h:2722
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:2331
char * OrthancPluginLookupPatient(OrthancPluginContext *context, const char *patientID)
Look for a patient.
Definition: OrthancCPlugin.h:2582
OrthancPluginErrorCode OrthancPluginRestApiDelete(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2432
OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:2455
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:8701
char * OrthancPluginGenerateRestApiAuthorizationToken(OrthancPluginContext *context)
Generate a token to grant full access to the REST API of Orthanc.
Definition: OrthancCPlugin.h:8503
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:5100
OrthancPluginErrorCode OrthancPluginGetDicomForInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *instanceId)
Retrieve a DICOM instance using its Orthanc identifier.
Definition: OrthancCPlugin.h:2268
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:2227
void OrthancPluginSendUnauthorized(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *realm)
Signal that a REST request is not authorized.
Definition: OrthancCPlugin.h:2790
void OrthancPluginSetHttpErrorDetails(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *details, uint8_t log)
Provide a detailed description for an HTTP error.
Definition: OrthancCPlugin.h:6863
void OrthancPluginSendMethodNotAllowed(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *allowedMethods)
Signal that this URI does not support this HTTP method.
Definition: OrthancCPlugin.h:2813
void OrthancPluginAnswerBuffer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const void *answer, uint32_t answerSize, const char *mimeType)
Answer to a REST request.
Definition: OrthancCPlugin.h:2170
void OrthancPluginSendHttpStatusCode(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status)
Send a HTTP status code.
Definition: OrthancCPlugin.h:2767
void OrthancPluginSetHttpHeader(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *key, const char *value)
Set some HTTP header.
Definition: OrthancCPlugin.h:2868
void OrthancPluginSetCookie(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *cookie, const char *value)
Set a cookie.
Definition: OrthancCPlugin.h:2843
void OrthancPluginRedirect(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *redirection)
Redirect a REST request.
Definition: OrthancCPlugin.h:2550
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:4251
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:3664
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:5697
OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *subType, const char *contentType)
Start an HTTP multipart answer.
Definition: OrthancCPlugin.h:3635
void OrthancPluginSendHttpStatus(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status, const char *body, uint32_t bodySize)
Send a HTTP status, with a custom body.
Definition: OrthancCPlugin.h:3858
An entry in the dictionary of DICOM tags.
Definition: OrthancCPlugin.h:1787
uint32_t minMultiplicity
Definition: OrthancCPlugin.h:1791
uint32_t maxMultiplicity
Definition: OrthancCPlugin.h:1792
OrthancPluginValueRepresentation vr
Definition: OrthancCPlugin.h:1790
uint16_t element
Definition: OrthancCPlugin.h:1789
uint16_t group
Definition: OrthancCPlugin.h:1788
The parameters of a REST request.
Definition: OrthancCPlugin.h:341
const char *const * getValues
For a GET request, the values of the GET parameters.
Definition: OrthancCPlugin.h:370
const char *const * groups
The matched values for the groups of the regular expression.
Definition: OrthancCPlugin.h:355
uint32_t bodySize
For a PUT or POST request, the number of bytes of the body.
Definition: OrthancCPlugin.h:380
uint32_t groupsCount
The number of groups of the regular expression.
Definition: OrthancCPlugin.h:350
const char *const * headersKeys
The keys of the HTTP headers (always converted to low-case).
Definition: OrthancCPlugin.h:395
const void * body
For a PUT or POST request, the content of the body.
Definition: OrthancCPlugin.h:375
const char *const * getKeys
For a GET request, the keys of the GET parameters.
Definition: OrthancCPlugin.h:365
uint32_t headersCount
The number of HTTP headers.
Definition: OrthancCPlugin.h:390
OrthancPluginHttpMethod method
The HTTP method.
Definition: OrthancCPlugin.h:345
uint32_t getCount
For a GET request, the number of GET parameters.
Definition: OrthancCPlugin.h:360
const char *const * headersValues
The values of the HTTP headers.
Definition: OrthancCPlugin.h:400
A 64-bit memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:1053
uint64_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:1062
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:1057
A 32-bit memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:1031
uint32_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:1040
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:1035