 |
Orthanc Plugin SDK
1.5.8
Documentation of the plugin interface of Orthanc
|
117 # define ORTHANC_PLUGINS_API __declspec(dllexport)
119 # define ORTHANC_PLUGINS_API __attribute__ ((visibility ("default")))
121 # define ORTHANC_PLUGINS_API
124 #define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 1
125 #define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 5
126 #define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 7
129 #if !defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE)
130 #define ORTHANC_PLUGINS_VERSION_IS_ABOVE(major, minor, revision) \
131 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER > major || \
132 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER == major && \
133 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER > minor || \
134 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER == minor && \
135 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER >= revision))))
154 #ifndef ORTHANC_PLUGIN_INLINE
155 # if __STDC_VERSION__ >= 199901L
157 # define ORTHANC_PLUGIN_INLINE static inline
158 # elif defined(__cplusplus)
160 # define ORTHANC_PLUGIN_INLINE static inline
161 # elif defined(__GNUC__)
163 # define ORTHANC_PLUGIN_INLINE static __inline
164 # elif defined(_MSC_VER)
166 # define ORTHANC_PLUGIN_INLINE static __inline
168 # error Your compiler is not known to support the "inline" keyword
306 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
314 ORTHANC_PLUGINS_API
const char* OrthancPluginGetName();
327 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
345 uint32_t groupsCount;
350 const char*
const* groups;
360 const char*
const* getKeys;
365 const char*
const* getValues;
385 uint32_t headersCount;
390 const char*
const* headersKeys;
395 const char*
const* headersValues;
403 _OrthancPluginService_LogInfo = 1,
404 _OrthancPluginService_LogWarning = 2,
405 _OrthancPluginService_LogError = 3,
406 _OrthancPluginService_GetOrthancPath = 4,
407 _OrthancPluginService_GetOrthancDirectory = 5,
408 _OrthancPluginService_GetConfigurationPath = 6,
409 _OrthancPluginService_SetPluginProperty = 7,
410 _OrthancPluginService_GetGlobalProperty = 8,
411 _OrthancPluginService_SetGlobalProperty = 9,
412 _OrthancPluginService_GetCommandLineArgumentsCount = 10,
413 _OrthancPluginService_GetCommandLineArgument = 11,
414 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
415 _OrthancPluginService_GetConfiguration = 13,
416 _OrthancPluginService_BufferCompression = 14,
417 _OrthancPluginService_ReadFile = 15,
418 _OrthancPluginService_WriteFile = 16,
419 _OrthancPluginService_GetErrorDescription = 17,
420 _OrthancPluginService_CallHttpClient = 18,
421 _OrthancPluginService_RegisterErrorCode = 19,
422 _OrthancPluginService_RegisterDictionaryTag = 20,
423 _OrthancPluginService_DicomBufferToJson = 21,
424 _OrthancPluginService_DicomInstanceToJson = 22,
425 _OrthancPluginService_CreateDicom = 23,
426 _OrthancPluginService_ComputeMd5 = 24,
427 _OrthancPluginService_ComputeSha1 = 25,
428 _OrthancPluginService_LookupDictionary = 26,
429 _OrthancPluginService_CallHttpClient2 = 27,
430 _OrthancPluginService_GenerateUuid = 28,
431 _OrthancPluginService_RegisterPrivateDictionaryTag = 29,
432 _OrthancPluginService_AutodetectMimeType = 30,
433 _OrthancPluginService_SetMetricsValue = 31,
434 _OrthancPluginService_EncodeDicomWebJson = 32,
435 _OrthancPluginService_EncodeDicomWebXml = 33,
436 _OrthancPluginService_ChunkedHttpClient = 34,
437 _OrthancPluginService_GetTagName = 35,
440 _OrthancPluginService_RegisterRestCallback = 1000,
441 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
442 _OrthancPluginService_RegisterStorageArea = 1002,
443 _OrthancPluginService_RegisterOnChangeCallback = 1003,
444 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
445 _OrthancPluginService_RegisterWorklistCallback = 1005,
446 _OrthancPluginService_RegisterDecodeImageCallback = 1006,
447 _OrthancPluginService_RegisterIncomingHttpRequestFilter = 1007,
448 _OrthancPluginService_RegisterFindCallback = 1008,
449 _OrthancPluginService_RegisterMoveCallback = 1009,
450 _OrthancPluginService_RegisterIncomingHttpRequestFilter2 = 1010,
451 _OrthancPluginService_RegisterRefreshMetricsCallback = 1011,
452 _OrthancPluginService_RegisterChunkedRestCallback = 1012,
455 _OrthancPluginService_AnswerBuffer = 2000,
456 _OrthancPluginService_CompressAndAnswerPngImage = 2001,
457 _OrthancPluginService_Redirect = 2002,
458 _OrthancPluginService_SendHttpStatusCode = 2003,
459 _OrthancPluginService_SendUnauthorized = 2004,
460 _OrthancPluginService_SendMethodNotAllowed = 2005,
461 _OrthancPluginService_SetCookie = 2006,
462 _OrthancPluginService_SetHttpHeader = 2007,
463 _OrthancPluginService_StartMultipartAnswer = 2008,
464 _OrthancPluginService_SendMultipartItem = 2009,
465 _OrthancPluginService_SendHttpStatus = 2010,
466 _OrthancPluginService_CompressAndAnswerImage = 2011,
467 _OrthancPluginService_SendMultipartItem2 = 2012,
468 _OrthancPluginService_SetHttpErrorDetails = 2013,
471 _OrthancPluginService_GetDicomForInstance = 3000,
472 _OrthancPluginService_RestApiGet = 3001,
473 _OrthancPluginService_RestApiPost = 3002,
474 _OrthancPluginService_RestApiDelete = 3003,
475 _OrthancPluginService_RestApiPut = 3004,
476 _OrthancPluginService_LookupPatient = 3005,
477 _OrthancPluginService_LookupStudy = 3006,
478 _OrthancPluginService_LookupSeries = 3007,
479 _OrthancPluginService_LookupInstance = 3008,
480 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
481 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
482 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
483 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
484 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
485 _OrthancPluginService_ReconstructMainDicomTags = 3014,
486 _OrthancPluginService_RestApiGet2 = 3015,
489 _OrthancPluginService_GetInstanceRemoteAet = 4000,
490 _OrthancPluginService_GetInstanceSize = 4001,
491 _OrthancPluginService_GetInstanceData = 4002,
492 _OrthancPluginService_GetInstanceJson = 4003,
493 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
494 _OrthancPluginService_HasInstanceMetadata = 4005,
495 _OrthancPluginService_GetInstanceMetadata = 4006,
496 _OrthancPluginService_GetInstanceOrigin = 4007,
499 _OrthancPluginService_RegisterDatabaseBackend = 5000,
500 _OrthancPluginService_DatabaseAnswer = 5001,
501 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002,
502 _OrthancPluginService_StorageAreaCreate = 5003,
503 _OrthancPluginService_StorageAreaRead = 5004,
504 _OrthancPluginService_StorageAreaRemove = 5005,
507 _OrthancPluginService_GetImagePixelFormat = 6000,
508 _OrthancPluginService_GetImageWidth = 6001,
509 _OrthancPluginService_GetImageHeight = 6002,
510 _OrthancPluginService_GetImagePitch = 6003,
511 _OrthancPluginService_GetImageBuffer = 6004,
512 _OrthancPluginService_UncompressImage = 6005,
513 _OrthancPluginService_FreeImage = 6006,
514 _OrthancPluginService_CompressImage = 6007,
515 _OrthancPluginService_ConvertPixelFormat = 6008,
516 _OrthancPluginService_GetFontsCount = 6009,
517 _OrthancPluginService_GetFontInfo = 6010,
518 _OrthancPluginService_DrawText = 6011,
519 _OrthancPluginService_CreateImage = 6012,
520 _OrthancPluginService_CreateImageAccessor = 6013,
521 _OrthancPluginService_DecodeDicomImage = 6014,
524 _OrthancPluginService_WorklistAddAnswer = 7000,
525 _OrthancPluginService_WorklistMarkIncomplete = 7001,
526 _OrthancPluginService_WorklistIsMatch = 7002,
527 _OrthancPluginService_WorklistGetDicomQuery = 7003,
528 _OrthancPluginService_FindAddAnswer = 7004,
529 _OrthancPluginService_FindMarkIncomplete = 7005,
530 _OrthancPluginService_GetFindQuerySize = 7006,
531 _OrthancPluginService_GetFindQueryTag = 7007,
532 _OrthancPluginService_GetFindQueryTagName = 7008,
533 _OrthancPluginService_GetFindQueryValue = 7009,
534 _OrthancPluginService_CreateFindMatcher = 7010,
535 _OrthancPluginService_FreeFindMatcher = 7011,
536 _OrthancPluginService_FindMatcherIsMatch = 7012,
539 _OrthancPluginService_GetPeers = 8000,
540 _OrthancPluginService_FreePeers = 8001,
541 _OrthancPluginService_GetPeersCount = 8003,
542 _OrthancPluginService_GetPeerName = 8004,
543 _OrthancPluginService_GetPeerUrl = 8005,
544 _OrthancPluginService_CallPeerApi = 8006,
545 _OrthancPluginService_GetPeerUserProperty = 8007,
548 _OrthancPluginService_CreateJob = 9000,
549 _OrthancPluginService_FreeJob = 9001,
550 _OrthancPluginService_SubmitJob = 9002,
551 _OrthancPluginService_RegisterJobsUnserializer = 9003,
553 _OrthancPluginService_INTERNAL = 0x7fffffff
554 } _OrthancPluginService;
559 _OrthancPluginProperty_Description = 1,
560 _OrthancPluginProperty_RootUri = 2,
561 _OrthancPluginProperty_OrthancExplorer = 3,
563 _OrthancPluginProperty_INTERNAL = 0x7fffffff
564 } _OrthancPluginProperty;
656 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
670 _OrthancPluginContentType_INTERNAL = 0x7fffffff
686 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
714 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
729 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
743 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
781 _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff
796 _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff
807 OrthancPluginDicomToJsonFlags_None = 0,
815 _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff
826 OrthancPluginCreateDicomFlags_None = 0,
830 _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff
846 _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff
862 _OrthancPluginConstraintType_INTERNAL = 0x7fffffff
877 _OrthancPluginInstanceOrigin_INTERNAL = 0x7fffffff
1072 const char* instanceId);
1083 const char* resourceId);
1094 const uint32_t size,
1095 uint32_t frameIndex);
1116 const char* bulkDataUri);
1134 const void* content,
1192 const char* issuerAet,
1193 const char* calledAet);
1220 uint32_t headersCount,
1221 const char*
const* headersKeys,
1222 const char*
const* headersValues);
1251 uint32_t headersCount,
1252 const char*
const* headersKeys,
1253 const char*
const* headersValues,
1254 uint32_t getArgumentsCount,
1255 const char*
const* getArgumentsKeys,
1256 const char*
const* getArgumentsValues);
1277 const char* issuerAet,
1278 const char* calledAet);
1317 typedef void* (*OrthancPluginMoveCallback) (
1319 const char* patientId,
1320 const char* accessionNumber,
1321 const char* studyInstanceUid,
1322 const char* seriesInstanceUid,
1323 const char* sopInstanceUid,
1324 const char* originatorAet,
1325 const char* sourceAet,
1326 const char* targetAet,
1327 uint16_t originatorId);
1412 typedef const char* (*OrthancPluginJobGetContent) (
void* job);
1430 typedef const char* (*OrthancPluginJobGetSerialized) (
void* job);
1502 typedef OrthancPluginJob* (*OrthancPluginJobsUnserializer) (
const char* jobType,
1503 const char* serialized);
1551 uint32_t levelDepth,
1552 const uint16_t* levelTagGroup,
1553 const uint16_t* levelTagElement,
1554 const uint32_t* levelIndex,
1556 uint16_t tagElement,
1564 typedef struct _OrthancPluginContext_t
1566 void* pluginsManager;
1567 const char* orthancVersion;
1570 _OrthancPluginService service,
1571 const void* params);
1584 uint32_t minMultiplicity;
1585 uint32_t maxMultiplicity;
1632 int expectedRevision)
1634 int major, minor, revision;
1638 sizeof(int32_t) !=
sizeof(_OrthancPluginService) ||
1639 sizeof(int32_t) !=
sizeof(_OrthancPluginProperty) ||
1662 if (!strcmp(context->orthancVersion,
"mainline"))
1674 (context->orthancVersion,
"%4d.%4d.%4d", &major, &minor, &revision) != 3)
1681 if (major > expectedMajor)
1686 if (major < expectedMajor)
1693 if (minor > expectedMinor)
1698 if (minor < expectedMinor)
1705 if (revision >= expectedRevision)
1737 ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER,
1738 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER,
1739 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER);
1755 context->Free(buffer->
data);
1769 const char* message)
1771 context->InvokeService(context, _OrthancPluginService_LogError, message);
1785 const char* message)
1787 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
1801 const char* message)
1803 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
1810 const char* pathRegularExpression;
1812 } _OrthancPluginRestCallback;
1837 const char* pathRegularExpression,
1840 _OrthancPluginRestCallback params;
1841 params.pathRegularExpression = pathRegularExpression;
1842 params.callback = callback;
1843 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
1877 const char* pathRegularExpression,
1880 _OrthancPluginRestCallback params;
1881 params.pathRegularExpression = pathRegularExpression;
1882 params.callback = callback;
1883 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms);
1891 } _OrthancPluginOnStoredInstanceCallback;
1907 _OrthancPluginOnStoredInstanceCallback params;
1908 params.callback = callback;
1910 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
1919 uint32_t answerSize;
1920 const char* mimeType;
1921 } _OrthancPluginAnswerBuffer;
1939 uint32_t answerSize,
1940 const char* mimeType)
1942 _OrthancPluginAnswerBuffer params;
1943 params.output = output;
1944 params.answer = answer;
1945 params.answerSize = answerSize;
1946 params.mimeType = mimeType;
1947 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms);
1959 } _OrthancPluginCompressAndAnswerPngImage;
1971 } _OrthancPluginCompressAndAnswerImage;
2001 _OrthancPluginCompressAndAnswerImage params;
2002 params.output = output;
2004 params.pixelFormat = format;
2005 params.width = width;
2006 params.height = height;
2007 params.pitch = pitch;
2008 params.buffer = buffer;
2010 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
2018 const char* instanceId;
2019 } _OrthancPluginGetDicomForInstance;
2036 const char* instanceId)
2038 _OrthancPluginGetDicomForInstance params;
2039 params.target = target;
2040 params.instanceId = instanceId;
2041 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
2050 } _OrthancPluginRestApiGet;
2071 _OrthancPluginRestApiGet params;
2072 params.target = target;
2074 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
2101 _OrthancPluginRestApiGet params;
2102 params.target = target;
2104 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms);
2115 } _OrthancPluginRestApiPostPut;
2140 _OrthancPluginRestApiPostPut params;
2141 params.target = target;
2144 params.bodySize = bodySize;
2145 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
2175 _OrthancPluginRestApiPostPut params;
2176 params.target = target;
2179 params.bodySize = bodySize;
2180 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms);
2201 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
2224 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
2252 _OrthancPluginRestApiPostPut params;
2253 params.target = target;
2256 params.bodySize = bodySize;
2257 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
2288 _OrthancPluginRestApiPostPut params;
2289 params.target = target;
2292 params.bodySize = bodySize;
2293 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms);
2301 const char* argument;
2302 } _OrthancPluginOutputPlusArgument;
2318 const char* redirection)
2320 _OrthancPluginOutputPlusArgument params;
2321 params.output = output;
2322 params.argument = redirection;
2323 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
2331 const char* argument;
2332 } _OrthancPluginRetrieveDynamicString;
2349 const char* patientID)
2353 _OrthancPluginRetrieveDynamicString params;
2354 params.result = &result;
2355 params.argument = patientID;
2384 const char* studyUID)
2388 _OrthancPluginRetrieveDynamicString params;
2389 params.result = &result;
2390 params.argument = studyUID;
2419 const char* accessionNumber)
2423 _OrthancPluginRetrieveDynamicString params;
2424 params.result = &result;
2425 params.argument = accessionNumber;
2454 const char* seriesUID)
2458 _OrthancPluginRetrieveDynamicString params;
2459 params.result = &result;
2460 params.argument = seriesUID;
2489 const char* sopInstanceUID)
2493 _OrthancPluginRetrieveDynamicString params;
2494 params.result = &result;
2495 params.argument = sopInstanceUID;
2514 } _OrthancPluginSendHttpStatusCode;
2537 _OrthancPluginSendHttpStatusCode params;
2538 params.output = output;
2539 params.status = status;
2540 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
2560 _OrthancPluginOutputPlusArgument params;
2561 params.output = output;
2562 params.argument = realm;
2563 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
2581 const char* allowedMethods)
2583 _OrthancPluginOutputPlusArgument params;
2584 params.output = output;
2585 params.argument = allowedMethods;
2586 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
2595 } _OrthancPluginSetHttpHeader;
2614 _OrthancPluginSetHttpHeader params;
2615 params.output = output;
2616 params.key = cookie;
2617 params.value = value;
2618 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
2639 _OrthancPluginSetHttpHeader params;
2640 params.output = output;
2642 params.value = value;
2643 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
2649 char** resultStringToFree;
2650 const char** resultString;
2651 int64_t* resultInt64;
2655 } _OrthancPluginAccessDicomInstance;
2675 _OrthancPluginAccessDicomInstance params;
2676 memset(¶ms, 0,
sizeof(params));
2677 params.resultString = &result;
2678 params.instance = instance;
2708 _OrthancPluginAccessDicomInstance params;
2709 memset(¶ms, 0,
sizeof(params));
2710 params.resultInt64 = &size;
2711 params.instance = instance;
2741 _OrthancPluginAccessDicomInstance params;
2742 memset(¶ms, 0,
sizeof(params));
2743 params.resultString = &result;
2744 params.instance = instance;
2777 _OrthancPluginAccessDicomInstance params;
2778 memset(¶ms, 0,
sizeof(params));
2779 params.resultStringToFree = &result;
2780 params.instance = instance;
2815 _OrthancPluginAccessDicomInstance params;
2816 memset(¶ms, 0,
sizeof(params));
2817 params.resultStringToFree = &result;
2818 params.instance = instance;
2851 const char* metadata)
2855 _OrthancPluginAccessDicomInstance params;
2856 memset(¶ms, 0,
sizeof(params));
2857 params.resultInt64 = &result;
2858 params.instance = instance;
2859 params.key = metadata;
2868 return (result != 0);
2889 const char* metadata)
2893 _OrthancPluginAccessDicomInstance params;
2894 memset(¶ms, 0,
sizeof(params));
2895 params.resultString = &result;
2896 params.instance = instance;
2897 params.key = metadata;
2918 } _OrthancPluginRegisterStorageArea;
2940 _OrthancPluginRegisterStorageArea params;
2941 params.create = create;
2943 params.remove = remove;
2946 params.free = ::free;
2951 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
2970 _OrthancPluginRetrieveDynamicString params;
2971 params.result = &result;
2972 params.argument = NULL;
3000 _OrthancPluginRetrieveDynamicString params;
3001 params.result = &result;
3002 params.argument = NULL;
3035 _OrthancPluginRetrieveDynamicString params;
3036 params.result = &result;
3037 params.argument = NULL;
3055 } _OrthancPluginOnChangeCallback;
3077 _OrthancPluginOnChangeCallback params;
3078 params.callback = callback;
3080 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms);
3088 _OrthancPluginProperty property;
3090 } _OrthancPluginSetPluginProperty;
3108 _OrthancPluginSetPluginProperty params;
3109 params.plugin = OrthancPluginGetName();
3110 params.property = _OrthancPluginProperty_RootUri;
3113 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3128 const char* description)
3130 _OrthancPluginSetPluginProperty params;
3131 params.plugin = OrthancPluginGetName();
3132 params.property = _OrthancPluginProperty_Description;
3133 params.value = description;
3135 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3150 const char* javascript)
3152 _OrthancPluginSetPluginProperty params;
3153 params.plugin = OrthancPluginGetName();
3154 params.property = _OrthancPluginProperty_OrthancExplorer;
3155 params.value = javascript;
3157 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3166 } _OrthancPluginGlobalProperty;
3185 const char* defaultValue)
3189 _OrthancPluginGlobalProperty params;
3190 params.result = &result;
3191 params.property = property;
3192 params.value = defaultValue;
3226 _OrthancPluginGlobalProperty params;
3227 params.result = NULL;
3228 params.property = property;
3229 params.value = value;
3231 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms);
3238 int32_t *resultInt32;
3239 uint32_t *resultUint32;
3240 int64_t *resultInt64;
3241 uint64_t *resultUint64;
3242 } _OrthancPluginReturnSingleValue;
3257 _OrthancPluginReturnSingleValue params;
3258 memset(¶ms, 0,
sizeof(params));
3259 params.resultUint32 = &count;
3292 _OrthancPluginGlobalProperty params;
3293 params.result = &result;
3294 params.property = (int32_t) argument;
3295 params.value = NULL;
3323 _OrthancPluginReturnSingleValue params;
3324 memset(¶ms, 0,
sizeof(params));
3325 params.resultUint32 = &count;
3355 _OrthancPluginRetrieveDynamicString params;
3356 params.result = &result;
3357 params.argument = NULL;
3375 const char* subType;
3376 const char* contentType;
3377 } _OrthancPluginStartMultipartAnswer;
3395 const char* subType,
3396 const char* contentType)
3398 _OrthancPluginStartMultipartAnswer params;
3399 params.output = output;
3400 params.subType = subType;
3401 params.contentType = contentType;
3402 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms);
3425 uint32_t answerSize)
3427 _OrthancPluginAnswerBuffer params;
3428 params.output = output;
3429 params.answer = answer;
3430 params.answerSize = answerSize;
3431 params.mimeType = NULL;
3432 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms);
3444 } _OrthancPluginBufferCompression;
3471 _OrthancPluginBufferCompression params;
3472 params.target = target;
3473 params.source = source;
3475 params.compression = compression;
3476 params.uncompress = uncompress;
3478 return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms);
3487 } _OrthancPluginReadFile;
3505 _OrthancPluginReadFile params;
3506 params.target = target;
3508 return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms);
3518 } _OrthancPluginWriteFile;
3537 _OrthancPluginWriteFile params;
3541 return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms);
3548 const char** target;
3550 } _OrthancPluginGetErrorDescription;
3566 const char* result = NULL;
3568 _OrthancPluginGetErrorDescription params;
3569 params.target = &result;
3570 params.error = error;
3575 return "Unknown error code";
3591 } _OrthancPluginSendHttpStatus;
3622 _OrthancPluginSendHttpStatus params;
3623 params.output = output;
3624 params.status = status;
3626 params.bodySize = bodySize;
3627 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms);
3635 uint32_t* resultUint32;
3637 void** resultBuffer;
3638 } _OrthancPluginGetImageInfo;
3657 _OrthancPluginGetImageInfo params;
3658 memset(¶ms, 0,
sizeof(params));
3659 params.image = image;
3660 params.resultPixelFormat = ⌖
3690 _OrthancPluginGetImageInfo params;
3691 memset(¶ms, 0,
sizeof(params));
3692 params.image = image;
3693 params.resultUint32 = &width;
3723 _OrthancPluginGetImageInfo params;
3724 memset(¶ms, 0,
sizeof(params));
3725 params.image = image;
3726 params.resultUint32 = &height;
3758 _OrthancPluginGetImageInfo params;
3759 memset(¶ms, 0,
sizeof(params));
3760 params.image = image;
3761 params.resultUint32 = &pitch;
3790 void* target = NULL;
3792 _OrthancPluginGetImageInfo params;
3793 memset(¶ms, 0,
sizeof(params));
3794 params.resultBuffer = ⌖
3795 params.image = image;
3814 } _OrthancPluginUncompressImage;
3837 _OrthancPluginUncompressImage params;
3838 memset(¶ms, 0,
sizeof(params));
3839 params.target = ⌖
3842 params.format = format;
3860 } _OrthancPluginFreeImage;
3875 _OrthancPluginFreeImage params;
3876 params.image = image;
3878 context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms);
3894 } _OrthancPluginCompressImage;
3925 _OrthancPluginCompressImage params;
3926 memset(¶ms, 0,
sizeof(params));
3927 params.target = target;
3929 params.pixelFormat = format;
3930 params.width = width;
3931 params.height = height;
3932 params.pitch = pitch;
3933 params.buffer = buffer;
3936 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
3971 _OrthancPluginCompressImage params;
3972 memset(¶ms, 0,
sizeof(params));
3973 params.target = target;
3975 params.pixelFormat = format;
3976 params.width = width;
3977 params.height = height;
3978 params.pitch = pitch;
3979 params.buffer = buffer;
3980 params.quality = quality;
3982 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4018 _OrthancPluginCompressAndAnswerImage params;
4019 params.output = output;
4021 params.pixelFormat = format;
4022 params.width = width;
4023 params.height = height;
4024 params.pitch = pitch;
4025 params.buffer = buffer;
4026 params.quality = quality;
4027 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
4038 const char* username;
4039 const char* password;
4042 } _OrthancPluginCallHttpClient;
4065 const char* username,
4066 const char* password)
4068 _OrthancPluginCallHttpClient params;
4069 memset(¶ms, 0,
sizeof(params));
4071 params.target = target;
4074 params.username = username;
4075 params.password = password;
4077 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4105 const char* username,
4106 const char* password)
4108 _OrthancPluginCallHttpClient params;
4109 memset(¶ms, 0,
sizeof(params));
4111 params.target = target;
4115 params.bodySize = bodySize;
4116 params.username = username;
4117 params.password = password;
4119 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4147 const char* username,
4148 const char* password)
4150 _OrthancPluginCallHttpClient params;
4151 memset(¶ms, 0,
sizeof(params));
4153 params.target = target;
4157 params.bodySize = bodySize;
4158 params.username = username;
4159 params.password = password;
4161 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4182 const char* username,
4183 const char* password)
4185 _OrthancPluginCallHttpClient params;
4186 memset(¶ms, 0,
sizeof(params));
4190 params.username = username;
4191 params.password = password;
4193 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4203 } _OrthancPluginConvertPixelFormat;
4224 _OrthancPluginConvertPixelFormat params;
4225 params.target = ⌖
4226 params.source = source;
4227 params.targetFormat = targetFormat;
4257 _OrthancPluginReturnSingleValue params;
4258 memset(¶ms, 0,
sizeof(params));
4259 params.resultUint32 = &count;
4280 } _OrthancPluginGetFontInfo;
4296 const char* result = NULL;
4298 _OrthancPluginGetFontInfo params;
4299 memset(¶ms, 0,
sizeof(params));
4300 params.name = &result;
4301 params.fontIndex = fontIndex;
4330 _OrthancPluginGetFontInfo params;
4331 memset(¶ms, 0,
sizeof(params));
4332 params.size = &result;
4333 params.fontIndex = fontIndex;
4351 const char* utf8Text;
4357 } _OrthancPluginDrawText;
4381 const char* utf8Text,
4388 _OrthancPluginDrawText params;
4389 memset(¶ms, 0,
sizeof(params));
4390 params.image = image;
4391 params.fontIndex = fontIndex;
4392 params.utf8Text = utf8Text;
4399 return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms);
4408 const void* content;
4411 } _OrthancPluginStorageAreaCreate;
4433 const void* content,
4437 _OrthancPluginStorageAreaCreate params;
4438 params.storageArea = storageArea;
4440 params.content = content;
4444 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms);
4454 } _OrthancPluginStorageAreaRead;
4478 _OrthancPluginStorageAreaRead params;
4479 params.target = target;
4480 params.storageArea = storageArea;
4484 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms);
4493 } _OrthancPluginStorageAreaRemove;
4514 _OrthancPluginStorageAreaRemove params;
4515 params.storageArea = storageArea;
4519 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms);
4528 uint16_t httpStatus;
4529 const char* message;
4530 } _OrthancPluginRegisterErrorCode;
4550 uint16_t httpStatus,
4551 const char* message)
4555 _OrthancPluginRegisterErrorCode params;
4556 params.target = ⌖
4558 params.httpStatus = httpStatus;
4559 params.message = message;
4580 uint32_t minMultiplicity;
4581 uint32_t maxMultiplicity;
4582 } _OrthancPluginRegisterDictionaryTag;
4609 uint32_t minMultiplicity,
4610 uint32_t maxMultiplicity)
4612 _OrthancPluginRegisterDictionaryTag params;
4613 params.group = group;
4614 params.element = element;
4617 params.minMultiplicity = minMultiplicity;
4618 params.maxMultiplicity = maxMultiplicity;
4620 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, ¶ms);
4631 uint32_t minMultiplicity;
4632 uint32_t maxMultiplicity;
4633 const char* privateCreator;
4634 } _OrthancPluginRegisterPrivateDictionaryTag;
4662 uint32_t minMultiplicity,
4663 uint32_t maxMultiplicity,
4664 const char* privateCreator)
4666 _OrthancPluginRegisterPrivateDictionaryTag params;
4667 params.group = group;
4668 params.element = element;
4671 params.minMultiplicity = minMultiplicity;
4672 params.maxMultiplicity = maxMultiplicity;
4673 params.privateCreator = privateCreator;
4675 return context->InvokeService(context, _OrthancPluginService_RegisterPrivateDictionaryTag, ¶ms);
4684 } _OrthancPluginReconstructMainDicomTags;
4705 _OrthancPluginReconstructMainDicomTags params;
4706 params.level = level;
4707 params.storageArea = storageArea;
4709 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, ¶ms);
4716 const char* instanceId;
4721 uint32_t maxStringLength;
4722 } _OrthancPluginDicomToJson;
4750 uint32_t maxStringLength)
4754 _OrthancPluginDicomToJson params;
4755 memset(¶ms, 0,
sizeof(params));
4756 params.result = &result;
4757 params.buffer = buffer;
4759 params.format = format;
4760 params.flags = flags;
4761 params.maxStringLength = maxStringLength;
4795 const char* instanceId,
4798 uint32_t maxStringLength)
4802 _OrthancPluginDicomToJson params;
4803 memset(¶ms, 0,
sizeof(params));
4804 params.result = &result;
4805 params.instanceId = instanceId;
4806 params.format = format;
4807 params.flags = flags;
4808 params.maxStringLength = maxStringLength;
4826 uint32_t headersCount;
4827 const char*
const* headersKeys;
4828 const char*
const* headersValues;
4829 int32_t afterPlugins;
4830 } _OrthancPluginRestApiGet2;
4855 uint32_t headersCount,
4856 const char*
const* headersKeys,
4857 const char*
const* headersValues,
4858 int32_t afterPlugins)
4860 _OrthancPluginRestApiGet2 params;
4861 params.target = target;
4863 params.headersCount = headersCount;
4864 params.headersKeys = headersKeys;
4865 params.headersValues = headersValues;
4866 params.afterPlugins = afterPlugins;
4868 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, ¶ms);
4876 } _OrthancPluginWorklistCallback;
4893 _OrthancPluginWorklistCallback params;
4894 params.callback = callback;
4896 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, ¶ms);
4907 } _OrthancPluginWorklistAnswersOperation;
4932 _OrthancPluginWorklistAnswersOperation params;
4933 params.answers = answers;
4934 params.query = query;
4935 params.dicom = dicom;
4938 return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, ¶ms);
4959 _OrthancPluginWorklistAnswersOperation params;
4960 params.answers = answers;
4961 params.query = NULL;
4962 params.dicom = NULL;
4965 return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, ¶ms);
4976 } _OrthancPluginWorklistQueryOperation;
4999 int32_t isMatch = 0;
5001 _OrthancPluginWorklistQueryOperation params;
5002 params.query = query;
5003 params.dicom = dicom;
5005 params.isMatch = &isMatch;
5006 params.target = NULL;
5037 _OrthancPluginWorklistQueryOperation params;
5038 params.query = query;
5039 params.dicom = NULL;
5041 params.isMatch = NULL;
5042 params.target = target;
5044 return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, ¶ms);
5064 _OrthancPluginAccessDicomInstance params;
5065 memset(¶ms, 0,
sizeof(params));
5066 params.resultOrigin = &origin;
5067 params.instance = instance;
5087 } _OrthancPluginCreateDicom;
5114 _OrthancPluginCreateDicom params;
5115 params.target = target;
5117 params.pixelData = pixelData;
5118 params.flags = flags;
5120 return context->InvokeService(context, _OrthancPluginService_CreateDicom, ¶ms);
5127 } _OrthancPluginDecodeImageCallback;
5144 _OrthancPluginDecodeImageCallback params;
5145 params.callback = callback;
5147 return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, ¶ms);
5160 const void* constBuffer;
5161 uint32_t bufferSize;
5162 uint32_t frameIndex;
5163 } _OrthancPluginCreateImage;
5186 _OrthancPluginCreateImage params;
5187 memset(¶ms, 0,
sizeof(params));
5188 params.target = ⌖
5189 params.format = format;
5190 params.width = width;
5191 params.height = height;
5231 _OrthancPluginCreateImage params;
5232 memset(¶ms, 0,
sizeof(params));
5233 params.target = ⌖
5234 params.format = format;
5235 params.width = width;
5236 params.height = height;
5237 params.pitch = pitch;
5238 params.buffer = buffer;
5269 uint32_t bufferSize,
5270 uint32_t frameIndex)
5274 _OrthancPluginCreateImage params;
5275 memset(¶ms, 0,
sizeof(params));
5276 params.target = ⌖
5277 params.constBuffer = buffer;
5278 params.bufferSize = bufferSize;
5279 params.frameIndex = frameIndex;
5298 } _OrthancPluginComputeHash;
5319 _OrthancPluginComputeHash params;
5320 params.result = &result;
5321 params.buffer = buffer;
5355 _OrthancPluginComputeHash params;
5356 params.result = &result;
5357 params.buffer = buffer;
5377 } _OrthancPluginLookupDictionary;
5399 _OrthancPluginLookupDictionary params;
5400 params.target = target;
5402 return context->InvokeService(context, _OrthancPluginService_LookupDictionary, ¶ms);
5411 uint32_t answerSize;
5412 uint32_t headersCount;
5413 const char*
const* headersKeys;
5414 const char*
const* headersValues;
5415 } _OrthancPluginSendMultipartItem2;
5441 uint32_t answerSize,
5442 uint32_t headersCount,
5443 const char*
const* headersKeys,
5444 const char*
const* headersValues)
5446 _OrthancPluginSendMultipartItem2 params;
5447 params.output = output;
5448 params.answer = answer;
5449 params.answerSize = answerSize;
5450 params.headersCount = headersCount;
5451 params.headersKeys = headersKeys;
5452 params.headersValues = headersValues;
5454 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem2, ¶ms);
5461 } _OrthancPluginIncomingHttpRequestFilter;
5479 _OrthancPluginIncomingHttpRequestFilter params;
5480 params.callback = callback;
5482 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter, ¶ms);
5491 uint16_t* httpStatus;
5494 uint32_t headersCount;
5495 const char*
const* headersKeys;
5496 const char*
const* headersValues;
5499 const char* username;
5500 const char* password;
5502 const char* certificateFile;
5503 const char* certificateKeyFile;
5504 const char* certificateKeyPassword;
5506 } _OrthancPluginCallHttpClient2;
5553 uint16_t* httpStatus,
5556 uint32_t headersCount,
5557 const char*
const* headersKeys,
5558 const char*
const* headersValues,
5561 const char* username,
5562 const char* password,
5564 const char* certificateFile,
5565 const char* certificateKeyFile,
5566 const char* certificateKeyPassword,
5569 _OrthancPluginCallHttpClient2 params;
5570 memset(¶ms, 0,
sizeof(params));
5572 params.answerBody = answerBody;
5573 params.answerHeaders = answerHeaders;
5574 params.httpStatus = httpStatus;
5575 params.method = method;
5577 params.headersCount = headersCount;
5578 params.headersKeys = headersKeys;
5579 params.headersValues = headersValues;
5581 params.bodySize = bodySize;
5582 params.username = username;
5583 params.password = password;
5584 params.timeout = timeout;
5585 params.certificateFile = certificateFile;
5586 params.certificateKeyFile = certificateKeyFile;
5587 params.certificateKeyPassword = certificateKeyPassword;
5588 params.pkcs11 = pkcs11;
5590 return context->InvokeService(context, _OrthancPluginService_CallHttpClient2, ¶ms);
5609 _OrthancPluginRetrieveDynamicString params;
5610 params.result = &result;
5611 params.argument = NULL;
5630 } _OrthancPluginFindCallback;
5647 _OrthancPluginFindCallback params;
5648 params.callback = callback;
5650 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback, ¶ms);
5661 uint32_t *resultUint32;
5662 uint16_t *resultGroup;
5663 uint16_t *resultElement;
5664 char **resultString;
5665 } _OrthancPluginFindOperation;
5688 _OrthancPluginFindOperation params;
5689 memset(¶ms, 0,
sizeof(params));
5690 params.answers = answers;
5691 params.dicom = dicom;
5694 return context->InvokeService(context, _OrthancPluginService_FindAddAnswer, ¶ms);
5715 _OrthancPluginFindOperation params;
5716 memset(¶ms, 0,
sizeof(params));
5717 params.answers = answers;
5719 return context->InvokeService(context, _OrthancPluginService_FindMarkIncomplete, ¶ms);
5741 _OrthancPluginFindOperation params;
5742 memset(¶ms, 0,
sizeof(params));
5743 params.query = query;
5744 params.resultUint32 = &count;
5779 _OrthancPluginFindOperation params;
5780 memset(¶ms, 0,
sizeof(params));
5781 params.query = query;
5782 params.index = index;
5783 params.resultGroup = group;
5784 params.resultElement = element;
5786 return context->InvokeService(context, _OrthancPluginService_GetFindQueryTag, ¶ms);
5810 _OrthancPluginFindOperation params;
5811 memset(¶ms, 0,
sizeof(params));
5812 params.query = query;
5813 params.index = index;
5814 params.resultString = &result;
5848 _OrthancPluginFindOperation params;
5849 memset(¶ms, 0,
sizeof(params));
5850 params.query = query;
5851 params.index = index;
5852 params.resultString = &result;
5874 } _OrthancPluginMoveCallback;
5896 _OrthancPluginMoveCallback params;
5897 params.callback = callback;
5898 params.getMoveSize = getMoveSize;
5899 params.applyMove = applyMove;
5900 params.freeMove = freeMove;
5902 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback, ¶ms);
5912 } _OrthancPluginCreateFindMatcher;
5935 _OrthancPluginCreateFindMatcher params;
5936 memset(¶ms, 0,
sizeof(params));
5937 params.target = ⌖
5938 params.query = query;
5955 } _OrthancPluginFreeFindMatcher;
5970 _OrthancPluginFreeFindMatcher params;
5971 params.matcher = matcher;
5973 context->InvokeService(context, _OrthancPluginService_FreeFindMatcher, ¶ms);
5983 } _OrthancPluginFindMatcherIsMatch;
6005 int32_t isMatch = 0;
6007 _OrthancPluginFindMatcherIsMatch params;
6008 params.matcher = matcher;
6009 params.dicom = dicom;
6011 params.isMatch = &isMatch;
6028 } _OrthancPluginIncomingHttpRequestFilter2;
6045 _OrthancPluginIncomingHttpRequestFilter2 params;
6046 params.callback = callback;
6048 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter2, ¶ms);
6056 } _OrthancPluginGetPeers;
6074 _OrthancPluginGetPeers params;
6075 memset(¶ms, 0,
sizeof(params));
6076 params.peers = &peers;
6092 } _OrthancPluginFreePeers;
6107 _OrthancPluginFreePeers params;
6108 params.peers = peers;
6110 context->InvokeService(context, _OrthancPluginService_FreePeers, ¶ms);
6118 } _OrthancPluginGetPeersCount;
6137 uint32_t target = 0;
6139 _OrthancPluginGetPeersCount params;
6140 memset(¶ms, 0,
sizeof(params));
6141 params.target = ⌖
6142 params.peers = peers;
6158 const char** target;
6161 const char* userProperty;
6162 } _OrthancPluginGetPeerProperty;
6186 const char* target = NULL;
6188 _OrthancPluginGetPeerProperty params;
6189 memset(¶ms, 0,
sizeof(params));
6190 params.target = ⌖
6191 params.peers = peers;
6192 params.peerIndex = peerIndex;
6193 params.userProperty = NULL;
6227 const char* target = NULL;
6229 _OrthancPluginGetPeerProperty params;
6230 memset(¶ms, 0,
sizeof(params));
6231 params.target = ⌖
6232 params.peers = peers;
6233 params.peerIndex = peerIndex;
6234 params.userProperty = NULL;
6272 const char* userProperty)
6274 const char* target = NULL;
6276 _OrthancPluginGetPeerProperty params;
6277 memset(¶ms, 0,
sizeof(params));
6278 params.target = ⌖
6279 params.peers = peers;
6280 params.peerIndex = peerIndex;
6281 params.userProperty = userProperty;
6300 uint16_t* httpStatus;
6305 uint32_t additionalHeadersCount;
6306 const char*
const* additionalHeadersKeys;
6307 const char*
const* additionalHeadersValues;
6311 } _OrthancPluginCallPeerApi;
6352 uint16_t* httpStatus,
6357 uint32_t additionalHeadersCount,
6358 const char*
const* additionalHeadersKeys,
6359 const char*
const* additionalHeadersValues,
6364 _OrthancPluginCallPeerApi params;
6365 memset(¶ms, 0,
sizeof(params));
6367 params.answerBody = answerBody;
6368 params.answerHeaders = answerHeaders;
6369 params.httpStatus = httpStatus;
6370 params.peers = peers;
6371 params.peerIndex = peerIndex;
6372 params.method = method;
6374 params.additionalHeadersCount = additionalHeadersCount;
6375 params.additionalHeadersKeys = additionalHeadersKeys;
6376 params.additionalHeadersValues = additionalHeadersValues;
6378 params.bodySize = bodySize;
6379 params.timeout = timeout;
6381 return context->InvokeService(context, _OrthancPluginService_CallPeerApi, ¶ms);
6400 } _OrthancPluginCreateJob;
6447 _OrthancPluginCreateJob params;
6448 memset(¶ms, 0,
sizeof(params));
6450 params.target = ⌖
6452 params.finalize = finalize;
6454 params.getProgress = getProgress;
6455 params.getContent = getContent;
6456 params.getSerialized = getSerialized;
6459 params.reset = reset;
6477 } _OrthancPluginFreeJob;
6492 _OrthancPluginFreeJob params;
6495 context->InvokeService(context, _OrthancPluginService_FreeJob, ¶ms);
6505 } _OrthancPluginSubmitJob;
6525 char* resultId = NULL;
6527 _OrthancPluginSubmitJob params;
6528 memset(¶ms, 0,
sizeof(params));
6530 params.resultId = &resultId;
6532 params.priority = priority;
6551 } _OrthancPluginJobsUnserializer;
6569 _OrthancPluginJobsUnserializer params;
6570 params.unserializer = unserializer;
6572 context->InvokeService(context, _OrthancPluginService_RegisterJobsUnserializer, ¶ms);
6580 const char* details;
6582 } _OrthancPluginSetHttpErrorDetails;
6604 const char* details,
6607 _OrthancPluginSetHttpErrorDetails params;
6608 params.output = output;
6609 params.details = details;
6611 context->InvokeService(context, _OrthancPluginService_SetHttpErrorDetails, ¶ms);
6618 const char** result;
6619 const char* argument;
6620 } _OrthancPluginRetrieveStaticString;
6637 const char* result = NULL;
6639 _OrthancPluginRetrieveStaticString params;
6640 params.result = &result;
6641 params.argument = path;
6661 } _OrthancPluginSetMetricsValue;
6683 _OrthancPluginSetMetricsValue params;
6685 params.value = value;
6687 context->InvokeService(context, _OrthancPluginService_SetMetricsValue, ¶ms);
6695 } _OrthancPluginRegisterRefreshMetricsCallback;
6711 _OrthancPluginRegisterRefreshMetricsCallback params;
6712 params.callback = callback;
6713 context->InvokeService(context, _OrthancPluginService_RegisterRefreshMetricsCallback, ¶ms);
6725 } _OrthancPluginEncodeDicomWeb;
6748 char* target = NULL;
6750 _OrthancPluginEncodeDicomWeb params;
6751 params.target = ⌖
6752 params.dicom = dicom;
6753 params.dicomSize = dicomSize;
6754 params.callback = callback;
6789 char* target = NULL;
6791 _OrthancPluginEncodeDicomWeb params;
6792 params.target = ⌖
6793 params.dicom = dicom;
6794 params.dicomSize = dicomSize;
6795 params.callback = callback;
6899 typedef const void* (*OrthancPluginChunkedClientRequestGetChunkData) (
void* request);
6923 uint16_t* httpStatus;
6926 uint32_t headersCount;
6927 const char*
const* headersKeys;
6928 const char*
const* headersValues;
6934 const char* username;
6935 const char* password;
6937 const char* certificateFile;
6938 const char* certificateKeyFile;
6939 const char* certificateKeyPassword;
6941 } _OrthancPluginChunkedHttpClient;
6999 uint16_t* httpStatus,
7002 uint32_t headersCount,
7003 const char*
const* headersKeys,
7004 const char*
const* headersValues,
7010 const char* username,
7011 const char* password,
7013 const char* certificateFile,
7014 const char* certificateKeyFile,
7015 const char* certificateKeyPassword,
7018 _OrthancPluginChunkedHttpClient params;
7019 memset(¶ms, 0,
sizeof(params));
7022 params.httpStatus = httpStatus;
7023 params.method = method;
7025 params.headersCount = headersCount;
7026 params.headersKeys = headersKeys;
7027 params.headersValues = headersValues;
7028 params.username = username;
7029 params.password = password;
7030 params.timeout = timeout;
7031 params.certificateFile = certificateFile;
7032 params.certificateKeyFile = certificateKeyFile;
7033 params.certificateKeyPassword = certificateKeyPassword;
7034 params.pkcs11 = pkcs11;
7037 params.answer = answer;
7038 params.answerAddChunk = answerAddChunk;
7039 params.answerAddHeader = answerAddHeader;
7040 params.request = request;
7041 params.requestIsDone = requestIsDone;
7042 params.requestChunkData = requestChunkData;
7043 params.requestChunkSize = requestChunkSize;
7044 params.requestNext = requestNext;
7046 return context->InvokeService(context, _OrthancPluginService_ChunkedHttpClient, ¶ms);
7136 const char* pathRegularExpression;
7144 } _OrthancPluginChunkedRestCallback;
7178 const char* pathRegularExpression,
7187 _OrthancPluginChunkedRestCallback params;
7188 params.pathRegularExpression = pathRegularExpression;
7189 params.getHandler = getHandler;
7190 params.postHandler = postHandler;
7191 params.deleteHandler = deleteHandler;
7192 params.putHandler = putHandler;
7193 params.addChunk = addChunk;
7194 params.execute = execute;
7195 params.finalize = finalize;
7197 context->InvokeService(context, _OrthancPluginService_RegisterChunkedRestCallback, ¶ms);
7209 const char* privateCreator;
7210 } _OrthancPluginGetTagName;
7231 const char* privateCreator)
7235 _OrthancPluginGetTagName params;
7236 params.result = &result;
7237 params.group = group;
7238 params.element = element;
7239 params.privateCreator = privateCreator;
Definition: OrthancCPlugin.h:698
OrthancPluginImage * OrthancPluginConvertPixelFormat(OrthancPluginContext *context, const OrthancPluginImage *source, OrthancPluginPixelFormat targetFormat)
Change the pixel format of an image.
Definition: OrthancCPlugin.h:4214
uint32_t(* OrthancPluginGetMoveSize)(void *moveDriver)
Callback to read the size of a C-Move driver.
Definition: OrthancCPlugin.h:1339
OrthancPluginInstanceOrigin OrthancPluginGetInstanceOrigin(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the origin of a DICOM file.
Definition: OrthancCPlugin.h:5055
int OrthancPluginCheckVersion(OrthancPluginContext *context)
Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
Definition: OrthancCPlugin.h:1729
Definition: OrthancCPlugin.h:723
void OrthancPluginRegisterOnStoredInstanceCallback(OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback)
Register a callback for received instances.
Definition: OrthancCPlugin.h:1900
Definition: OrthancCPlugin.h:706
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:3612
OrthancPluginErrorCode OrthancPluginFindAddAnswer(OrthancPluginContext *context, OrthancPluginFindAnswers *answers, const void *dicom, uint32_t size)
Add one answer to some C-Find request.
Definition: OrthancCPlugin.h:5679
void OrthancPluginAnswerBuffer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const void *answer, uint32_t answerSize, const char *mimeType)
Answer to a REST request.
Definition: OrthancCPlugin.h:1932
Color image in RGBA32 format.
Definition: OrthancCPlugin.h:609
Definition: OrthancCPlugin.h:703
OrthancPluginErrorCode OrthancPluginRestApiDelete(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2194
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:2278
Color image in BGRA32 format.
Definition: OrthancCPlugin.h:643
Graylevel, floating-point 32bpp image.
Definition: OrthancCPlugin.h:635
OrthancPluginImage * OrthancPluginCreateImage(OrthancPluginContext *context, OrthancPluginPixelFormat format, uint32_t width, uint32_t height)
Create an image.
Definition: OrthancCPlugin.h:5175
char * OrthancPluginLookupSeries(OrthancPluginContext *context, const char *seriesUID)
Look for a series.
Definition: OrthancCPlugin.h:2449
Definition: OrthancCPlugin.h:705
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:4005
OrthancPluginImageFormat
Definition: OrthancCPlugin.h:734
OrthancPluginErrorCode OrthancPluginStorageAreaRead(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Read a file from the storage area.
Definition: OrthancCPlugin.h:4468
OrthancPluginErrorCode OrthancPluginRegisterDecodeImageCallback(OrthancPluginContext *context, OrthancPluginDecodeImageCallback callback)
Register a callback to handle the decoding of DICOM images.
Definition: OrthancCPlugin.h:5137
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:2165
Definition: OrthancCPlugin.h:694
The parameters of a REST request.
Definition: OrthancCPlugin.h:332
const char * OrthancPluginGetInstanceRemoteAet(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the AET of a DICOM instance.
Definition: OrthancCPlugin.h:2666
uint32_t OrthancPluginGetImageWidth(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the width of an image.
Definition: OrthancCPlugin.h:3681
Definition: OrthancCPlugin.h:696
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:1186
Definition: OrthancCPlugin.h:708
uint32_t OrthancPluginGetImagePitch(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pitch of an image.
Definition: OrthancCPlugin.h:3749
char * OrthancPluginGetInstanceJson(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file.
Definition: OrthancCPlugin.h:2768
OrthancPluginErrorCode(* OrthancPluginRestCallback)(OrthancPluginRestOutput *output, const char *url, const OrthancPluginHttpRequest *request)
Signature of a callback function that answers to a REST request.
Definition: OrthancCPlugin.h:1056
OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, OrthancPluginResourceType level)
Reconstruct the main DICOM tags.
Definition: OrthancCPlugin.h:4697
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:5769
OrthancPluginCompressionType
Definition: OrthancCPlugin.h:719
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:5472
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:3913
Definition: OrthancCPlugin.h:697
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:4374
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:4922
Graylevel 8bpp image.
Definition: OrthancCPlugin.h:577
struct _OrthancPluginStorageArea_t OrthancPluginStorageArea
Opaque structure that represents the storage area that is actually used by Orthanc.
Definition: OrthancCPlugin.h:983
void OrthancPluginSendHttpStatusCode(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status)
Send a HTTP status code.
Definition: OrthancCPlugin.h:2529
OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:2217
void(* OrthancPluginRefreshMetricsCallback)()
Callback executed to update the metrics of the plugin.
Definition: OrthancCPlugin.h:1517
Definition: OrthancCPlugin.h:611
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter2(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter2 callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:6038
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:4848
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:1077
char * OrthancPluginLookupStudyWithAccessionNumber(OrthancPluginContext *context, const char *accessionNumber)
Look for a study, using the accession number.
Definition: OrthancCPlugin.h:2414
Definition: OrthancCPlugin.h:722
struct _OrthancPluginWorklistQuery_t OrthancPluginWorklistQuery
Opaque structure to an object that represents a C-Find query for worklists.
Definition: OrthancCPlugin.h:991
Definition: OrthancCPlugin.h:737
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:1110
OrthancPluginErrorCode OrthancPluginRestApiGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2063
Definition: OrthancCPlugin.h:721
Color image in RGB48 format.
Definition: OrthancCPlugin.h:619
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:1989
int64_t OrthancPluginGetInstanceSize(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the size of a DICOM file.
Definition: OrthancCPlugin.h:2699
Definition: OrthancCPlugin.h:702
OrthancPluginErrorCode(* OrthancPluginStorageCreate)(const char *uuid, const void *content, int64_t size, OrthancPluginContentType type)
Callback for writing to the storage area.
Definition: OrthancCPlugin.h:1129
OrthancPluginErrorCode OrthancPluginSendMultipartItem(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *answer, uint32_t answerSize)
Send an item as a part of some HTTP multipart answer.
Definition: OrthancCPlugin.h:3418
const char * OrthancPluginGetInstanceData(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the data of a DICOM file.
Definition: OrthancCPlugin.h:2732
Definition: OrthancCPlugin.h:724
OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *subType, const char *contentType)
Start an HTTP multipart answer.
Definition: OrthancCPlugin.h:3389
void * OrthancPluginGetImageBuffer(OrthancPluginContext *context, const OrthancPluginImage *image)
Return a pointer to the content of an image.
Definition: OrthancCPlugin.h:3783
OrthancPluginErrorCode(* OrthancPluginStorageRemove)(const char *uuid, OrthancPluginContentType type)
Callback for removing a file from the storage area.
Definition: OrthancCPlugin.h:1167
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:2242
uint32_t OrthancPluginGetFontsCount(OrthancPluginContext *context)
Return the number of available fonts.
Definition: OrthancCPlugin.h:4249
Definition: OrthancCPlugin.h:701
char * OrthancPluginGetInstanceSimplifiedJson(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file (with simplification).
Definition: OrthancCPlugin.h:2806
uint32_t OrthancPluginGetExpectedDatabaseVersion(OrthancPluginContext *context)
Get the expected version of the database schema.
Definition: OrthancCPlugin.h:3315
void OrthancPluginRegisterOnChangeCallback(OrthancPluginContext *context, OrthancPluginOnChangeCallback callback)
Register a callback to monitor changes.
Definition: OrthancCPlugin.h:3070
Definition: OrthancCPlugin.h:704
Definition: OrthancCPlugin.h:699
const char * OrthancPluginGetInstanceMetadata(OrthancPluginContext *context, OrthancPluginDicomInstance *instance, const char *metadata)
Get the value of some metadata associated with a given DICOM instance.
Definition: OrthancCPlugin.h:2883
OrthancPluginErrorCode OrthancPluginRegisterWorklistCallback(OrthancPluginContext *context, OrthancPluginWorklistCallback callback)
Register a callback to handle modality worklists requests.
Definition: OrthancCPlugin.h:4886
uint32_t OrthancPluginGetFontSize(OrthancPluginContext *context, uint32_t fontIndex)
Return the size of a font.
Definition: OrthancCPlugin.h:4321
OrthancPluginErrorCode OrthancPluginSetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *value)
Set the value of a global property.
Definition: OrthancCPlugin.h:3218
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:1088
void OrthancPluginRegisterRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback.
Definition: OrthancCPlugin.h:1832
Definition: OrthancCPlugin.h:695
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:1314
Definition: OrthancCPlugin.h:738
char * OrthancPluginGetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *defaultValue)
Get the value of a global property.
Definition: OrthancCPlugin.h:3179
uint32_t OrthancPluginGetImageHeight(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the height of an image.
Definition: OrthancCPlugin.h:3714
Color image in RGB24 format.
Definition: OrthancCPlugin.h:601
struct _OrthancPluginFindAnswers_t OrthancPluginFindAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1015
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:945
Graylevel, signed 16bpp image.
Definition: OrthancCPlugin.h:593
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:3958
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:4426
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:7173
OrthancPluginErrorCode OrthancPluginRegisterMoveCallback(OrthancPluginContext *context, OrthancPluginMoveCallback callback, OrthancPluginGetMoveSize getMoveSize, OrthancPluginApplyMove applyMove, OrthancPluginFreeMove freeMove)
Register a callback to handle C-Move requests.
Definition: OrthancCPlugin.h:5886
void OrthancPluginRegisterJobsUnserializer(OrthancPluginContext *context, OrthancPluginJobsUnserializer unserializer)
Register an unserializer for custom jobs.
Definition: OrthancCPlugin.h:6562
Definition: OrthancCPlugin.h:709
Graylevel, unsigned 64bpp image.
Definition: OrthancCPlugin.h:651
OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pixel format of an image.
Definition: OrthancCPlugin.h:3648
void(* OrthancPluginFree)(void *buffer)
Signature of a function to free dynamic memory.
Definition: OrthancCPlugin.h:1100
void OrthancPluginRedirect(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *redirection)
Redirect a REST request.
Definition: OrthancCPlugin.h:2312
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:5800
OrthancPluginErrorCode OrthancPluginWorklistMarkIncomplete(OrthancPluginContext *context, OrthancPluginWorklistAnswers *answers)
Mark the set of worklist answers as incomplete.
Definition: OrthancCPlugin.h:4952
OrthancPluginErrorCode(* OrthancPluginStorageRead)(void **content, int64_t *size, const char *uuid, OrthancPluginContentType type)
Callback for reading from the storage area.
Definition: OrthancCPlugin.h:1149
OrthancPluginJob *(* OrthancPluginJobsUnserializer)(const char *jobType, const char *serialized)
Callback executed to unserialize a custom job.
Definition: OrthancCPlugin.h:1499
Definition: OrthancCPlugin.h:707
A memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:940
struct _OrthancPluginWorklistAnswers_t OrthancPluginWorklistAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:999
OrthancPluginErrorCode OrthancPluginRegisterFindCallback(OrthancPluginContext *context, OrthancPluginFindCallback callback)
Register a callback to handle C-Find requests.
Definition: OrthancCPlugin.h:5640
struct _OrthancPluginImage_t OrthancPluginImage
Opaque structure that represents an image that is uncompressed in memory.
Definition: OrthancCPlugin.h:975
OrthancPluginErrorCode(* OrthancPluginFindCallback)(OrthancPluginFindAnswers *answers, const OrthancPluginFindQuery *query, const char *issuerAet, const char *calledAet)
Callback to handle incoming C-Find SCP requests.
Definition: OrthancCPlugin.h:1271
void OrthancPluginFreeImage(OrthancPluginContext *context, OrthancPluginImage *image)
Free an image.
Definition: OrthancCPlugin.h:3868
void(* OrthancPluginFreeMove)(void *moveDriver)
Callback to free one C-Move driver.
Definition: OrthancCPlugin.h:1368
const char * OrthancPluginGetFontName(OrthancPluginContext *context, uint32_t fontIndex)
Return the name of a font.
Definition: OrthancCPlugin.h:4289
void OrthancPluginSetCookie(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *cookie, const char *value)
Set a cookie.
Definition: OrthancCPlugin.h:2605
OrthancPluginErrorCode(* OrthancPluginApplyMove)(void *moveDriver)
Callback to apply one C-Move suboperation.
Definition: OrthancCPlugin.h:1354
Graylevel, unsigned 32bpp image.
Definition: OrthancCPlugin.h:627
void OrthancPluginRegisterRefreshMetricsCallback(OrthancPluginContext *context, OrthancPluginRefreshMetricsCallback callback)
Register a callback to refresh the metrics.
Definition: OrthancCPlugin.h:6704
Definition: OrthancCPlugin.h:700
An entry in the dictionary of DICOM tags.
Definition: OrthancCPlugin.h:1576
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:5218
char * OrthancPluginLookupPatient(OrthancPluginContext *context, const char *patientID)
Look for a patient.
Definition: OrthancCPlugin.h:2344
char * OrthancPluginLookupInstance(OrthancPluginContext *context, const char *sopInstanceUID)
Look for an instance.
Definition: OrthancCPlugin.h:2484
OrthancPluginChangeType
Definition: OrthancCPlugin.h:692
OrthancPluginImage * OrthancPluginUncompressImage(OrthancPluginContext *context, const void *data, uint32_t size, OrthancPluginImageFormat format)
Decode a compressed image.
Definition: OrthancCPlugin.h:3826
void OrthancPluginRegisterRestCallbackNoLock(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback, without locking.
Definition: OrthancCPlugin.h:1872
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:1625
int32_t OrthancPluginWorklistIsMatch(OrthancPluginContext *context, const OrthancPluginWorklistQuery *query, const void *dicom, uint32_t size)
Test whether a worklist matches the query.
Definition: OrthancCPlugin.h:4990
uint32_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:950
OrthancPluginErrorCode OrthancPluginStorageAreaRemove(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Remove a file from the storage area.
Definition: OrthancCPlugin.h:4505
uint32_t OrthancPluginGetFindQuerySize(OrthancPluginContext *context, const OrthancPluginFindQuery *query)
Get the number of tags in a C-Find query.
Definition: OrthancCPlugin.h:5732
int OrthancPluginHasInstanceMetadata(OrthancPluginContext *context, OrthancPluginDicomInstance *instance, const char *metadata)
Check whether a DICOM instance is associated with some metadata.
Definition: OrthancCPlugin.h:2845
OrthancPluginErrorCode OrthancPluginFindMarkIncomplete(OrthancPluginContext *context, OrthancPluginFindAnswers *answers)
Mark the set of C-Find answers as incomplete.
Definition: OrthancCPlugin.h:5708
struct _OrthancPluginFindQuery_t OrthancPluginFindQuery
Opaque structure to an object that represents a C-Find query.
Definition: OrthancCPlugin.h:1007
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:1545
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:3460
OrthancPluginErrorCode OrthancPluginGetDicomForInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *instanceId)
Retrieve a DICOM instance using its Orthanc identifier.
Definition: OrthancCPlugin.h:2030
OrthancPluginErrorCode(* OrthancPluginOnStoredInstanceCallback)(OrthancPluginDicomInstance *instance, const char *instanceId)
Signature of a callback function that is triggered when Orthanc receives a DICOM instance.
Definition: OrthancCPlugin.h:1067
OrthancPluginErrorCode OrthancPluginWorklistGetDicomQuery(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginWorklistQuery *query)
Retrieve the worklist query as a DICOM file.
Definition: OrthancCPlugin.h:5029
void OrthancPluginSetHttpErrorDetails(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *details, uint8_t log)
Provide a detailed description for an HTTP error.
Definition: OrthancCPlugin.h:6598
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:2130
void OrthancPluginRegisterStorageArea(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove)
Register a custom storage area.
Definition: OrthancCPlugin.h:2931
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:2093
OrthancPluginErrorCode OrthancPluginSendMultipartItem2(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *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:5434
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:5838
Definition: OrthancCPlugin.h:736
OrthancPluginPixelFormat
Definition: OrthancCPlugin.h:569
void OrthancPluginSendUnauthorized(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *realm)
Signal that a REST request is not authorized.
Definition: OrthancCPlugin.h:2552
Graylevel, unsigned 16bpp image.
Definition: OrthancCPlugin.h:585
void OrthancPluginSendMethodNotAllowed(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *allowedMethods)
Signal that this URI does not support this HTTP method.
Definition: OrthancCPlugin.h:2575
void OrthancPluginSetHttpHeader(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *key, const char *value)
Set some HTTP header.
Definition: OrthancCPlugin.h:2630
char * OrthancPluginLookupStudy(OrthancPluginContext *context, const char *studyUID)
Look for a study.
Definition: OrthancCPlugin.h:2379
OrthancPluginImage * OrthancPluginDecodeDicomImage(OrthancPluginContext *context, const void *buffer, uint32_t bufferSize, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:5263