114 #define ORTHANC_PLUGINS_API __declspec(dllexport) 116 #define ORTHANC_PLUGINS_API 119 #define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 1 120 #define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 3 121 #define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 1 124 #if !defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE) 125 #define ORTHANC_PLUGINS_VERSION_IS_ABOVE(major, minor, revision) \ 126 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER > major || \ 127 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER == major && \ 128 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER > minor || \ 129 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER == minor && \ 130 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER >= revision)))) 149 #ifndef ORTHANC_PLUGIN_INLINE 150 # if __STDC_VERSION__ >= 199901L 152 # define ORTHANC_PLUGIN_INLINE static inline 153 # elif defined(__cplusplus) 155 # define ORTHANC_PLUGIN_INLINE static inline 156 # elif defined(__GNUC__) 158 # define ORTHANC_PLUGIN_INLINE static __inline 159 # elif defined(_MSC_VER) 161 # define ORTHANC_PLUGIN_INLINE static __inline 163 # error Your compiler is not known to support the "inline" keyword 297 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
305 ORTHANC_PLUGINS_API
const char* OrthancPluginGetName();
318 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
394 _OrthancPluginService_LogInfo = 1,
395 _OrthancPluginService_LogWarning = 2,
396 _OrthancPluginService_LogError = 3,
397 _OrthancPluginService_GetOrthancPath = 4,
398 _OrthancPluginService_GetOrthancDirectory = 5,
399 _OrthancPluginService_GetConfigurationPath = 6,
400 _OrthancPluginService_SetPluginProperty = 7,
401 _OrthancPluginService_GetGlobalProperty = 8,
402 _OrthancPluginService_SetGlobalProperty = 9,
403 _OrthancPluginService_GetCommandLineArgumentsCount = 10,
404 _OrthancPluginService_GetCommandLineArgument = 11,
405 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
406 _OrthancPluginService_GetConfiguration = 13,
407 _OrthancPluginService_BufferCompression = 14,
408 _OrthancPluginService_ReadFile = 15,
409 _OrthancPluginService_WriteFile = 16,
410 _OrthancPluginService_GetErrorDescription = 17,
411 _OrthancPluginService_CallHttpClient = 18,
412 _OrthancPluginService_RegisterErrorCode = 19,
413 _OrthancPluginService_RegisterDictionaryTag = 20,
414 _OrthancPluginService_DicomBufferToJson = 21,
415 _OrthancPluginService_DicomInstanceToJson = 22,
416 _OrthancPluginService_CreateDicom = 23,
417 _OrthancPluginService_ComputeMd5 = 24,
418 _OrthancPluginService_ComputeSha1 = 25,
419 _OrthancPluginService_LookupDictionary = 26,
420 _OrthancPluginService_CallHttpClient2 = 27,
421 _OrthancPluginService_GenerateUuid = 28,
422 _OrthancPluginService_RegisterPrivateDictionaryTag = 29,
425 _OrthancPluginService_RegisterRestCallback = 1000,
426 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
427 _OrthancPluginService_RegisterStorageArea = 1002,
428 _OrthancPluginService_RegisterOnChangeCallback = 1003,
429 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
430 _OrthancPluginService_RegisterWorklistCallback = 1005,
431 _OrthancPluginService_RegisterDecodeImageCallback = 1006,
432 _OrthancPluginService_RegisterIncomingHttpRequestFilter = 1007,
433 _OrthancPluginService_RegisterFindCallback = 1008,
434 _OrthancPluginService_RegisterMoveCallback = 1009,
435 _OrthancPluginService_RegisterIncomingHttpRequestFilter2 = 1010,
438 _OrthancPluginService_AnswerBuffer = 2000,
439 _OrthancPluginService_CompressAndAnswerPngImage = 2001,
440 _OrthancPluginService_Redirect = 2002,
441 _OrthancPluginService_SendHttpStatusCode = 2003,
442 _OrthancPluginService_SendUnauthorized = 2004,
443 _OrthancPluginService_SendMethodNotAllowed = 2005,
444 _OrthancPluginService_SetCookie = 2006,
445 _OrthancPluginService_SetHttpHeader = 2007,
446 _OrthancPluginService_StartMultipartAnswer = 2008,
447 _OrthancPluginService_SendMultipartItem = 2009,
448 _OrthancPluginService_SendHttpStatus = 2010,
449 _OrthancPluginService_CompressAndAnswerImage = 2011,
450 _OrthancPluginService_SendMultipartItem2 = 2012,
453 _OrthancPluginService_GetDicomForInstance = 3000,
454 _OrthancPluginService_RestApiGet = 3001,
455 _OrthancPluginService_RestApiPost = 3002,
456 _OrthancPluginService_RestApiDelete = 3003,
457 _OrthancPluginService_RestApiPut = 3004,
458 _OrthancPluginService_LookupPatient = 3005,
459 _OrthancPluginService_LookupStudy = 3006,
460 _OrthancPluginService_LookupSeries = 3007,
461 _OrthancPluginService_LookupInstance = 3008,
462 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
463 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
464 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
465 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
466 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
467 _OrthancPluginService_ReconstructMainDicomTags = 3014,
468 _OrthancPluginService_RestApiGet2 = 3015,
471 _OrthancPluginService_GetInstanceRemoteAet = 4000,
472 _OrthancPluginService_GetInstanceSize = 4001,
473 _OrthancPluginService_GetInstanceData = 4002,
474 _OrthancPluginService_GetInstanceJson = 4003,
475 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
476 _OrthancPluginService_HasInstanceMetadata = 4005,
477 _OrthancPluginService_GetInstanceMetadata = 4006,
478 _OrthancPluginService_GetInstanceOrigin = 4007,
481 _OrthancPluginService_RegisterDatabaseBackend = 5000,
482 _OrthancPluginService_DatabaseAnswer = 5001,
483 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002,
484 _OrthancPluginService_StorageAreaCreate = 5003,
485 _OrthancPluginService_StorageAreaRead = 5004,
486 _OrthancPluginService_StorageAreaRemove = 5005,
489 _OrthancPluginService_GetImagePixelFormat = 6000,
490 _OrthancPluginService_GetImageWidth = 6001,
491 _OrthancPluginService_GetImageHeight = 6002,
492 _OrthancPluginService_GetImagePitch = 6003,
493 _OrthancPluginService_GetImageBuffer = 6004,
494 _OrthancPluginService_UncompressImage = 6005,
495 _OrthancPluginService_FreeImage = 6006,
496 _OrthancPluginService_CompressImage = 6007,
497 _OrthancPluginService_ConvertPixelFormat = 6008,
498 _OrthancPluginService_GetFontsCount = 6009,
499 _OrthancPluginService_GetFontInfo = 6010,
500 _OrthancPluginService_DrawText = 6011,
501 _OrthancPluginService_CreateImage = 6012,
502 _OrthancPluginService_CreateImageAccessor = 6013,
503 _OrthancPluginService_DecodeDicomImage = 6014,
506 _OrthancPluginService_WorklistAddAnswer = 7000,
507 _OrthancPluginService_WorklistMarkIncomplete = 7001,
508 _OrthancPluginService_WorklistIsMatch = 7002,
509 _OrthancPluginService_WorklistGetDicomQuery = 7003,
510 _OrthancPluginService_FindAddAnswer = 7004,
511 _OrthancPluginService_FindMarkIncomplete = 7005,
512 _OrthancPluginService_GetFindQuerySize = 7006,
513 _OrthancPluginService_GetFindQueryTag = 7007,
514 _OrthancPluginService_GetFindQueryTagName = 7008,
515 _OrthancPluginService_GetFindQueryValue = 7009,
516 _OrthancPluginService_CreateFindMatcher = 7010,
517 _OrthancPluginService_FreeFindMatcher = 7011,
518 _OrthancPluginService_FindMatcherIsMatch = 7012,
520 _OrthancPluginService_INTERNAL = 0x7fffffff
521 } _OrthancPluginService;
526 _OrthancPluginProperty_Description = 1,
527 _OrthancPluginProperty_RootUri = 2,
528 _OrthancPluginProperty_OrthancExplorer = 3,
530 _OrthancPluginProperty_INTERNAL = 0x7fffffff
531 } _OrthancPluginProperty;
615 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
629 _OrthancPluginContentType_INTERNAL = 0x7fffffff
645 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
671 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
686 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
700 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
738 _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff
753 _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff
764 OrthancPluginDicomToJsonFlags_None = 0,
772 _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff
783 OrthancPluginCreateDicomFlags_None = 0,
787 _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff
802 _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff
817 _OrthancPluginInstanceOrigin_INTERNAL = 0x7fffffff
932 const char* instanceId);
943 const char* resourceId);
955 uint32_t frameIndex);
1038 const char* issuerAet,
1039 const char* calledAet);
1066 uint32_t headersCount,
1067 const char*
const* headersKeys,
1068 const char*
const* headersValues);
1097 uint32_t headersCount,
1098 const char*
const* headersKeys,
1099 const char*
const* headersValues,
1100 uint32_t getArgumentsCount,
1101 const char*
const* getArgumentsKeys,
1102 const char*
const* getArgumentsValues);
1123 const char* issuerAet,
1124 const char* calledAet);
1163 typedef void* (*OrthancPluginMoveCallback) (
1165 const char* patientId,
1166 const char* accessionNumber,
1167 const char* studyInstanceUid,
1168 const char* seriesInstanceUid,
1169 const char* sopInstanceUid,
1170 const char* originatorAet,
1171 const char* sourceAet,
1172 const char* targetAet,
1173 uint16_t originatorId);
1221 typedef struct _OrthancPluginContext_t
1223 void* pluginsManager;
1224 const char* orthancVersion;
1227 _OrthancPluginService service,
1228 const void* params);
1282 int major, minor, revision;
1286 sizeof(int32_t) !=
sizeof(_OrthancPluginService) ||
1287 sizeof(int32_t) !=
sizeof(_OrthancPluginProperty) ||
1306 if (!strcmp(context->orthancVersion,
"mainline"))
1318 (context->orthancVersion,
"%4d.%4d.%4d", &major, &minor, &revision) != 3)
1325 if (major > ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
1330 if (major < ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
1337 if (minor > ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
1342 if (minor < ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
1349 if (revision >= ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER)
1372 context->Free(buffer->
data);
1386 const char* message)
1388 context->InvokeService(context, _OrthancPluginService_LogError, message);
1402 const char* message)
1404 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
1418 const char* message)
1420 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
1427 const char* pathRegularExpression;
1429 } _OrthancPluginRestCallback;
1449 const char* pathRegularExpression,
1452 _OrthancPluginRestCallback params;
1453 params.pathRegularExpression = pathRegularExpression;
1454 params.callback = callback;
1455 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
1483 const char* pathRegularExpression,
1486 _OrthancPluginRestCallback params;
1487 params.pathRegularExpression = pathRegularExpression;
1488 params.callback = callback;
1489 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms);
1497 } _OrthancPluginOnStoredInstanceCallback;
1513 _OrthancPluginOnStoredInstanceCallback params;
1514 params.callback = callback;
1516 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
1525 uint32_t answerSize;
1526 const char* mimeType;
1527 } _OrthancPluginAnswerBuffer;
1545 uint32_t answerSize,
1546 const char* mimeType)
1548 _OrthancPluginAnswerBuffer params;
1549 params.output = output;
1550 params.answer = answer;
1551 params.answerSize = answerSize;
1552 params.mimeType = mimeType;
1553 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms);
1565 } _OrthancPluginCompressAndAnswerPngImage;
1577 } _OrthancPluginCompressAndAnswerImage;
1607 _OrthancPluginCompressAndAnswerImage params;
1608 params.output = output;
1610 params.pixelFormat = format;
1611 params.width = width;
1612 params.height = height;
1613 params.pitch = pitch;
1614 params.buffer = buffer;
1616 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
1624 const char* instanceId;
1625 } _OrthancPluginGetDicomForInstance;
1642 const char* instanceId)
1644 _OrthancPluginGetDicomForInstance params;
1645 params.target = target;
1646 params.instanceId = instanceId;
1647 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
1656 } _OrthancPluginRestApiGet;
1677 _OrthancPluginRestApiGet params;
1678 params.target = target;
1680 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
1707 _OrthancPluginRestApiGet params;
1708 params.target = target;
1710 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms);
1721 } _OrthancPluginRestApiPostPut;
1746 _OrthancPluginRestApiPostPut params;
1747 params.target = target;
1750 params.bodySize = bodySize;
1751 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
1781 _OrthancPluginRestApiPostPut params;
1782 params.target = target;
1785 params.bodySize = bodySize;
1786 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms);
1807 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
1830 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
1858 _OrthancPluginRestApiPostPut params;
1859 params.target = target;
1862 params.bodySize = bodySize;
1863 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
1894 _OrthancPluginRestApiPostPut params;
1895 params.target = target;
1898 params.bodySize = bodySize;
1899 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms);
1907 const char* argument;
1908 } _OrthancPluginOutputPlusArgument;
1924 const char* redirection)
1926 _OrthancPluginOutputPlusArgument params;
1927 params.output = output;
1928 params.argument = redirection;
1929 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
1937 const char* argument;
1938 } _OrthancPluginRetrieveDynamicString;
1955 const char* patientID)
1959 _OrthancPluginRetrieveDynamicString params;
1960 params.result = &result;
1961 params.argument = patientID;
1990 const char* studyUID)
1994 _OrthancPluginRetrieveDynamicString params;
1995 params.result = &result;
1996 params.argument = studyUID;
2025 const char* accessionNumber)
2029 _OrthancPluginRetrieveDynamicString params;
2030 params.result = &result;
2031 params.argument = accessionNumber;
2060 const char* seriesUID)
2064 _OrthancPluginRetrieveDynamicString params;
2065 params.result = &result;
2066 params.argument = seriesUID;
2095 const char* sopInstanceUID)
2099 _OrthancPluginRetrieveDynamicString params;
2100 params.result = &result;
2101 params.argument = sopInstanceUID;
2120 } _OrthancPluginSendHttpStatusCode;
2143 _OrthancPluginSendHttpStatusCode params;
2144 params.output = output;
2145 params.status = status;
2146 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
2166 _OrthancPluginOutputPlusArgument params;
2167 params.output = output;
2168 params.argument = realm;
2169 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
2187 const char* allowedMethods)
2189 _OrthancPluginOutputPlusArgument params;
2190 params.output = output;
2191 params.argument = allowedMethods;
2192 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
2201 } _OrthancPluginSetHttpHeader;
2220 _OrthancPluginSetHttpHeader params;
2221 params.output = output;
2222 params.key = cookie;
2223 params.value = value;
2224 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
2245 _OrthancPluginSetHttpHeader params;
2246 params.output = output;
2248 params.value = value;
2249 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
2255 char** resultStringToFree;
2256 const char** resultString;
2257 int64_t* resultInt64;
2261 } _OrthancPluginAccessDicomInstance;
2281 _OrthancPluginAccessDicomInstance params;
2282 memset(¶ms, 0,
sizeof(params));
2283 params.resultString = &result;
2284 params.instance = instance;
2314 _OrthancPluginAccessDicomInstance params;
2315 memset(¶ms, 0,
sizeof(params));
2316 params.resultInt64 = &size;
2317 params.instance = instance;
2347 _OrthancPluginAccessDicomInstance params;
2348 memset(¶ms, 0,
sizeof(params));
2349 params.resultString = &result;
2350 params.instance = instance;
2383 _OrthancPluginAccessDicomInstance params;
2384 memset(¶ms, 0,
sizeof(params));
2385 params.resultStringToFree = &result;
2386 params.instance = instance;
2421 _OrthancPluginAccessDicomInstance params;
2422 memset(¶ms, 0,
sizeof(params));
2423 params.resultStringToFree = &result;
2424 params.instance = instance;
2457 const char* metadata)
2461 _OrthancPluginAccessDicomInstance params;
2462 memset(¶ms, 0,
sizeof(params));
2463 params.resultInt64 = &result;
2464 params.instance = instance;
2465 params.key = metadata;
2474 return (result != 0);
2495 const char* metadata)
2499 _OrthancPluginAccessDicomInstance params;
2500 memset(¶ms, 0,
sizeof(params));
2501 params.resultString = &result;
2502 params.instance = instance;
2503 params.key = metadata;
2524 } _OrthancPluginRegisterStorageArea;
2546 _OrthancPluginRegisterStorageArea params;
2547 params.create = create;
2549 params.remove =
remove;
2552 params.free = ::free;
2557 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
2576 _OrthancPluginRetrieveDynamicString params;
2577 params.result = &result;
2578 params.argument = NULL;
2606 _OrthancPluginRetrieveDynamicString params;
2607 params.result = &result;
2608 params.argument = NULL;
2641 _OrthancPluginRetrieveDynamicString params;
2642 params.result = &result;
2643 params.argument = NULL;
2661 } _OrthancPluginOnChangeCallback;
2683 _OrthancPluginOnChangeCallback params;
2684 params.callback = callback;
2686 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms);
2694 _OrthancPluginProperty property;
2696 } _OrthancPluginSetPluginProperty;
2714 _OrthancPluginSetPluginProperty params;
2715 params.plugin = OrthancPluginGetName();
2716 params.property = _OrthancPluginProperty_RootUri;
2719 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
2734 const char* description)
2736 _OrthancPluginSetPluginProperty params;
2737 params.plugin = OrthancPluginGetName();
2738 params.property = _OrthancPluginProperty_Description;
2739 params.value = description;
2741 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
2756 const char* javascript)
2758 _OrthancPluginSetPluginProperty params;
2759 params.plugin = OrthancPluginGetName();
2760 params.property = _OrthancPluginProperty_OrthancExplorer;
2761 params.value = javascript;
2763 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
2772 } _OrthancPluginGlobalProperty;
2791 const char* defaultValue)
2795 _OrthancPluginGlobalProperty params;
2796 params.result = &result;
2797 params.property = property;
2798 params.value = defaultValue;
2832 _OrthancPluginGlobalProperty params;
2833 params.result = NULL;
2834 params.property = property;
2835 params.value = value;
2837 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms);
2844 int32_t *resultInt32;
2845 uint32_t *resultUint32;
2846 int64_t *resultInt64;
2847 uint64_t *resultUint64;
2848 } _OrthancPluginReturnSingleValue;
2863 _OrthancPluginReturnSingleValue params;
2864 memset(¶ms, 0,
sizeof(params));
2865 params.resultUint32 = &count;
2898 _OrthancPluginGlobalProperty params;
2899 params.result = &result;
2900 params.property = (int32_t) argument;
2901 params.value = NULL;
2930 _OrthancPluginReturnSingleValue params;
2931 memset(¶ms, 0,
sizeof(params));
2932 params.resultUint32 = &count;
2962 _OrthancPluginRetrieveDynamicString params;
2963 params.result = &result;
2964 params.argument = NULL;
2982 const char* subType;
2983 const char* contentType;
2984 } _OrthancPluginStartMultipartAnswer;
3002 const char* subType,
3003 const char* contentType)
3005 _OrthancPluginStartMultipartAnswer params;
3006 params.output = output;
3007 params.subType = subType;
3008 params.contentType = contentType;
3009 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms);
3032 uint32_t answerSize)
3034 _OrthancPluginAnswerBuffer params;
3035 params.output = output;
3036 params.answer = answer;
3037 params.answerSize = answerSize;
3038 params.mimeType = NULL;
3039 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms);
3051 } _OrthancPluginBufferCompression;
3078 _OrthancPluginBufferCompression params;
3079 params.target = target;
3080 params.source = source;
3082 params.compression = compression;
3083 params.uncompress = uncompress;
3085 return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms);
3094 } _OrthancPluginReadFile;
3112 _OrthancPluginReadFile params;
3113 params.target = target;
3115 return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms);
3125 } _OrthancPluginWriteFile;
3144 _OrthancPluginWriteFile params;
3148 return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms);
3155 const char** target;
3157 } _OrthancPluginGetErrorDescription;
3173 const char* result = NULL;
3175 _OrthancPluginGetErrorDescription params;
3176 params.target = &result;
3177 params.error = error;
3182 return "Unknown error code";
3198 } _OrthancPluginSendHttpStatus;
3229 _OrthancPluginSendHttpStatus params;
3230 params.output = output;
3231 params.status = status;
3233 params.bodySize = bodySize;
3234 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms);
3242 uint32_t* resultUint32;
3244 void** resultBuffer;
3245 } _OrthancPluginGetImageInfo;
3264 _OrthancPluginGetImageInfo params;
3265 memset(¶ms, 0,
sizeof(params));
3266 params.image = image;
3267 params.resultPixelFormat = ⌖
3297 _OrthancPluginGetImageInfo params;
3298 memset(¶ms, 0,
sizeof(params));
3299 params.image = image;
3300 params.resultUint32 = &width;
3330 _OrthancPluginGetImageInfo params;
3331 memset(¶ms, 0,
sizeof(params));
3332 params.image = image;
3333 params.resultUint32 = &height;
3365 _OrthancPluginGetImageInfo params;
3366 memset(¶ms, 0,
sizeof(params));
3367 params.image = image;
3368 params.resultUint32 = &pitch;
3397 void* target = NULL;
3399 _OrthancPluginGetImageInfo params;
3400 memset(¶ms, 0,
sizeof(params));
3401 params.resultBuffer = ⌖
3402 params.image = image;
3421 } _OrthancPluginUncompressImage;
3444 _OrthancPluginUncompressImage params;
3445 memset(¶ms, 0,
sizeof(params));
3446 params.target = ⌖
3449 params.format = format;
3467 } _OrthancPluginFreeImage;
3482 _OrthancPluginFreeImage params;
3483 params.image = image;
3485 context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms);
3501 } _OrthancPluginCompressImage;
3532 _OrthancPluginCompressImage params;
3533 memset(¶ms, 0,
sizeof(params));
3534 params.target = target;
3536 params.pixelFormat = format;
3537 params.width = width;
3538 params.height = height;
3539 params.pitch = pitch;
3540 params.buffer = buffer;
3543 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
3578 _OrthancPluginCompressImage params;
3579 memset(¶ms, 0,
sizeof(params));
3580 params.target = target;
3582 params.pixelFormat = format;
3583 params.width = width;
3584 params.height = height;
3585 params.pitch = pitch;
3586 params.buffer = buffer;
3587 params.quality = quality;
3589 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
3625 _OrthancPluginCompressAndAnswerImage params;
3626 params.output = output;
3628 params.pixelFormat = format;
3629 params.width = width;
3630 params.height = height;
3631 params.pitch = pitch;
3632 params.buffer = buffer;
3633 params.quality = quality;
3634 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
3645 const char* username;
3646 const char* password;
3649 } _OrthancPluginCallHttpClient;
3671 const char* username,
3672 const char* password)
3674 _OrthancPluginCallHttpClient params;
3675 memset(¶ms, 0,
sizeof(params));
3677 params.target = target;
3680 params.username = username;
3681 params.password = password;
3683 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3710 const char* username,
3711 const char* password)
3713 _OrthancPluginCallHttpClient params;
3714 memset(¶ms, 0,
sizeof(params));
3716 params.target = target;
3720 params.bodySize = bodySize;
3721 params.username = username;
3722 params.password = password;
3724 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3751 const char* username,
3752 const char* password)
3754 _OrthancPluginCallHttpClient params;
3755 memset(¶ms, 0,
sizeof(params));
3757 params.target = target;
3761 params.bodySize = bodySize;
3762 params.username = username;
3763 params.password = password;
3765 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3785 const char* username,
3786 const char* password)
3788 _OrthancPluginCallHttpClient params;
3789 memset(¶ms, 0,
sizeof(params));
3793 params.username = username;
3794 params.password = password;
3796 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3806 } _OrthancPluginConvertPixelFormat;
3827 _OrthancPluginConvertPixelFormat params;
3828 params.target = ⌖
3829 params.source = source;
3830 params.targetFormat = targetFormat;
3860 _OrthancPluginReturnSingleValue params;
3861 memset(¶ms, 0,
sizeof(params));
3862 params.resultUint32 = &count;
3883 } _OrthancPluginGetFontInfo;
3899 const char* result = NULL;
3901 _OrthancPluginGetFontInfo params;
3902 memset(¶ms, 0,
sizeof(params));
3903 params.name = &result;
3904 params.fontIndex = fontIndex;
3933 _OrthancPluginGetFontInfo params;
3934 memset(¶ms, 0,
sizeof(params));
3935 params.size = &result;
3936 params.fontIndex = fontIndex;
3954 const char* utf8Text;
3960 } _OrthancPluginDrawText;
3984 const char* utf8Text,
3991 _OrthancPluginDrawText params;
3992 memset(¶ms, 0,
sizeof(params));
3993 params.image = image;
3994 params.fontIndex = fontIndex;
3995 params.utf8Text = utf8Text;
4002 return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms);
4011 const void* content;
4014 } _OrthancPluginStorageAreaCreate;
4036 const void* content,
4040 _OrthancPluginStorageAreaCreate params;
4041 params.storageArea = storageArea;
4043 params.content = content;
4047 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms);
4057 } _OrthancPluginStorageAreaRead;
4081 _OrthancPluginStorageAreaRead params;
4082 params.target = target;
4083 params.storageArea = storageArea;
4087 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms);
4096 } _OrthancPluginStorageAreaRemove;
4117 _OrthancPluginStorageAreaRemove params;
4118 params.storageArea = storageArea;
4122 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms);
4131 uint16_t httpStatus;
4132 const char* message;
4133 } _OrthancPluginRegisterErrorCode;
4153 uint16_t httpStatus,
4154 const char* message)
4158 _OrthancPluginRegisterErrorCode params;
4159 params.target = ⌖
4161 params.httpStatus = httpStatus;
4162 params.message = message;
4183 uint32_t minMultiplicity;
4184 uint32_t maxMultiplicity;
4185 } _OrthancPluginRegisterDictionaryTag;
4212 uint32_t minMultiplicity,
4213 uint32_t maxMultiplicity)
4215 _OrthancPluginRegisterDictionaryTag params;
4216 params.group = group;
4217 params.element = element;
4220 params.minMultiplicity = minMultiplicity;
4221 params.maxMultiplicity = maxMultiplicity;
4223 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, ¶ms);
4234 uint32_t minMultiplicity;
4235 uint32_t maxMultiplicity;
4236 const char* privateCreator;
4237 } _OrthancPluginRegisterPrivateDictionaryTag;
4265 uint32_t minMultiplicity,
4266 uint32_t maxMultiplicity,
4267 const char* privateCreator)
4269 _OrthancPluginRegisterPrivateDictionaryTag params;
4270 params.group = group;
4271 params.element = element;
4274 params.minMultiplicity = minMultiplicity;
4275 params.maxMultiplicity = maxMultiplicity;
4276 params.privateCreator = privateCreator;
4278 return context->InvokeService(context, _OrthancPluginService_RegisterPrivateDictionaryTag, ¶ms);
4287 } _OrthancPluginReconstructMainDicomTags;
4310 _OrthancPluginReconstructMainDicomTags params;
4311 params.level = level;
4312 params.storageArea = storageArea;
4314 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, ¶ms);
4321 const char* instanceId;
4326 uint32_t maxStringLength;
4327 } _OrthancPluginDicomToJson;
4355 uint32_t maxStringLength)
4359 _OrthancPluginDicomToJson params;
4360 memset(¶ms, 0,
sizeof(params));
4361 params.result = &result;
4362 params.buffer = buffer;
4364 params.format = format;
4365 params.flags = flags;
4366 params.maxStringLength = maxStringLength;
4400 const char* instanceId,
4403 uint32_t maxStringLength)
4407 _OrthancPluginDicomToJson params;
4408 memset(¶ms, 0,
sizeof(params));
4409 params.result = &result;
4410 params.instanceId = instanceId;
4411 params.format = format;
4412 params.flags = flags;
4413 params.maxStringLength = maxStringLength;
4431 uint32_t headersCount;
4432 const char*
const* headersKeys;
4433 const char*
const* headersValues;
4434 int32_t afterPlugins;
4435 } _OrthancPluginRestApiGet2;
4460 uint32_t headersCount,
4461 const char*
const* headersKeys,
4462 const char*
const* headersValues,
4463 int32_t afterPlugins)
4465 _OrthancPluginRestApiGet2 params;
4466 params.target = target;
4468 params.headersCount = headersCount;
4469 params.headersKeys = headersKeys;
4470 params.headersValues = headersValues;
4471 params.afterPlugins = afterPlugins;
4473 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, ¶ms);
4481 } _OrthancPluginWorklistCallback;
4498 _OrthancPluginWorklistCallback params;
4499 params.callback = callback;
4501 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, ¶ms);
4512 } _OrthancPluginWorklistAnswersOperation;
4537 _OrthancPluginWorklistAnswersOperation params;
4538 params.answers = answers;
4539 params.query = query;
4540 params.dicom = dicom;
4543 return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, ¶ms);
4564 _OrthancPluginWorklistAnswersOperation params;
4565 params.answers = answers;
4566 params.query = NULL;
4567 params.dicom = NULL;
4570 return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, ¶ms);
4581 } _OrthancPluginWorklistQueryOperation;
4604 int32_t isMatch = 0;
4606 _OrthancPluginWorklistQueryOperation params;
4607 params.query = query;
4608 params.dicom = dicom;
4610 params.isMatch = &isMatch;
4611 params.target = NULL;
4642 _OrthancPluginWorklistQueryOperation params;
4643 params.query = query;
4644 params.dicom = NULL;
4646 params.isMatch = NULL;
4647 params.target = target;
4649 return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, ¶ms);
4669 _OrthancPluginAccessDicomInstance params;
4670 memset(¶ms, 0,
sizeof(params));
4671 params.resultOrigin = &origin;
4672 params.instance = instance;
4692 } _OrthancPluginCreateDicom;
4719 _OrthancPluginCreateDicom params;
4720 params.target = target;
4722 params.pixelData = pixelData;
4723 params.flags = flags;
4725 return context->InvokeService(context, _OrthancPluginService_CreateDicom, ¶ms);
4732 } _OrthancPluginDecodeImageCallback;
4749 _OrthancPluginDecodeImageCallback params;
4750 params.callback = callback;
4752 return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, ¶ms);
4765 const void* constBuffer;
4766 uint32_t bufferSize;
4767 uint32_t frameIndex;
4768 } _OrthancPluginCreateImage;
4791 _OrthancPluginCreateImage params;
4792 memset(¶ms, 0,
sizeof(params));
4793 params.target = ⌖
4794 params.format = format;
4795 params.width = width;
4796 params.height = height;
4836 _OrthancPluginCreateImage params;
4837 memset(¶ms, 0,
sizeof(params));
4838 params.target = ⌖
4839 params.format = format;
4840 params.width = width;
4841 params.height = height;
4842 params.pitch = pitch;
4843 params.buffer = buffer;
4874 uint32_t bufferSize,
4875 uint32_t frameIndex)
4879 _OrthancPluginCreateImage params;
4880 memset(¶ms, 0,
sizeof(params));
4881 params.target = ⌖
4882 params.constBuffer = buffer;
4883 params.bufferSize = bufferSize;
4884 params.frameIndex = frameIndex;
4903 } _OrthancPluginComputeHash;
4924 _OrthancPluginComputeHash params;
4925 params.result = &result;
4926 params.buffer = buffer;
4960 _OrthancPluginComputeHash params;
4961 params.result = &result;
4962 params.buffer = buffer;
4982 } _OrthancPluginLookupDictionary;
5004 _OrthancPluginLookupDictionary params;
5005 params.target = target;
5007 return context->InvokeService(context, _OrthancPluginService_LookupDictionary, ¶ms);
5016 uint32_t answerSize;
5017 uint32_t headersCount;
5018 const char*
const* headersKeys;
5019 const char*
const* headersValues;
5020 } _OrthancPluginSendMultipartItem2;
5046 uint32_t answerSize,
5047 uint32_t headersCount,
5048 const char*
const* headersKeys,
5049 const char*
const* headersValues)
5051 _OrthancPluginSendMultipartItem2 params;
5052 params.output = output;
5053 params.answer = answer;
5054 params.answerSize = answerSize;
5055 params.headersCount = headersCount;
5056 params.headersKeys = headersKeys;
5057 params.headersValues = headersValues;
5059 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem2, ¶ms);
5066 } _OrthancPluginIncomingHttpRequestFilter;
5084 _OrthancPluginIncomingHttpRequestFilter params;
5085 params.callback = callback;
5087 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter, ¶ms);
5096 uint16_t* httpStatus;
5099 uint32_t headersCount;
5100 const char*
const* headersKeys;
5101 const char*
const* headersValues;
5104 const char* username;
5105 const char* password;
5107 const char* certificateFile;
5108 const char* certificateKeyFile;
5109 const char* certificateKeyPassword;
5111 } _OrthancPluginCallHttpClient2;
5156 uint16_t* httpStatus,
5159 uint32_t headersCount,
5160 const char*
const* headersKeys,
5161 const char*
const* headersValues,
5164 const char* username,
5165 const char* password,
5167 const char* certificateFile,
5168 const char* certificateKeyFile,
5169 const char* certificateKeyPassword,
5172 _OrthancPluginCallHttpClient2 params;
5173 memset(¶ms, 0,
sizeof(params));
5175 params.answerBody = answerBody;
5176 params.answerHeaders = answerHeaders;
5177 params.httpStatus = httpStatus;
5178 params.method = method;
5180 params.headersCount = headersCount;
5181 params.headersKeys = headersKeys;
5182 params.headersValues = headersValues;
5184 params.bodySize = bodySize;
5185 params.username = username;
5186 params.password = password;
5187 params.timeout = timeout;
5188 params.certificateFile = certificateFile;
5189 params.certificateKeyFile = certificateKeyFile;
5190 params.certificateKeyPassword = certificateKeyPassword;
5191 params.pkcs11 = pkcs11;
5193 return context->InvokeService(context, _OrthancPluginService_CallHttpClient2, ¶ms);
5212 _OrthancPluginRetrieveDynamicString params;
5213 params.result = &result;
5214 params.argument = NULL;
5233 } _OrthancPluginFindCallback;
5250 _OrthancPluginFindCallback params;
5251 params.callback = callback;
5253 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback, ¶ms);
5264 uint32_t *resultUint32;
5265 uint16_t *resultGroup;
5266 uint16_t *resultElement;
5267 char **resultString;
5268 } _OrthancPluginFindOperation;
5291 _OrthancPluginFindOperation params;
5292 memset(¶ms, 0,
sizeof(params));
5293 params.answers = answers;
5294 params.dicom = dicom;
5297 return context->InvokeService(context, _OrthancPluginService_FindAddAnswer, ¶ms);
5318 _OrthancPluginFindOperation params;
5319 memset(¶ms, 0,
sizeof(params));
5320 params.answers = answers;
5322 return context->InvokeService(context, _OrthancPluginService_FindMarkIncomplete, ¶ms);
5344 _OrthancPluginFindOperation params;
5345 memset(¶ms, 0,
sizeof(params));
5346 params.query = query;
5347 params.resultUint32 = &count;
5382 _OrthancPluginFindOperation params;
5383 memset(¶ms, 0,
sizeof(params));
5384 params.query = query;
5385 params.index = index;
5386 params.resultGroup = group;
5387 params.resultElement = element;
5389 return context->InvokeService(context, _OrthancPluginService_GetFindQueryTag, ¶ms);
5413 _OrthancPluginFindOperation params;
5414 memset(¶ms, 0,
sizeof(params));
5415 params.query = query;
5416 params.index = index;
5417 params.resultString = &result;
5451 _OrthancPluginFindOperation params;
5452 memset(¶ms, 0,
sizeof(params));
5453 params.query = query;
5454 params.index = index;
5455 params.resultString = &result;
5477 } _OrthancPluginMoveCallback;
5499 _OrthancPluginMoveCallback params;
5500 params.callback = callback;
5501 params.getMoveSize = getMoveSize;
5502 params.applyMove = applyMove;
5503 params.freeMove = freeMove;
5505 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback, ¶ms);
5515 } _OrthancPluginCreateFindMatcher;
5538 _OrthancPluginCreateFindMatcher params;
5539 memset(¶ms, 0,
sizeof(params));
5540 params.target = ⌖
5541 params.query = query;
5558 } _OrthancPluginFreeFindMatcher;
5573 _OrthancPluginFreeFindMatcher params;
5574 params.matcher = matcher;
5576 context->InvokeService(context, _OrthancPluginService_FreeFindMatcher, ¶ms);
5586 } _OrthancPluginFindMatcherIsMatch;
5608 int32_t isMatch = 0;
5610 _OrthancPluginFindMatcherIsMatch params;
5611 params.matcher = matcher;
5612 params.dicom = dicom;
5614 params.isMatch = &isMatch;
5631 } _OrthancPluginIncomingHttpRequestFilter2;
5648 _OrthancPluginIncomingHttpRequestFilter2 params;
5649 params.callback = callback;
5651 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter2, ¶ms);
Definition: OrthancCPlugin.h:697
const char * OrthancPluginGetInstanceRemoteAet(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the AET of a DICOM instance.
Definition: OrthancCPlugin.h:2275
int OrthancPluginHasInstanceMetadata(OrthancPluginContext *context, OrthancPluginDicomInstance *instance, const char *metadata)
Check whether a DICOM instance is associated with some metadata.
Definition: OrthancCPlugin.h:2454
OrthancPluginChangeType
Definition: OrthancCPlugin.h:654
void OrthancPluginSendHttpStatusCode(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status)
Send a HTTP status code.
Definition: OrthancCPlugin.h:2138
void OrthancPluginSetHttpHeader(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *key, const char *value)
Set some HTTP header.
Definition: OrthancCPlugin.h:2239
OrthancPluginErrorCode OrthancPluginRegisterDecodeImageCallback(OrthancPluginContext *context, OrthancPluginDecodeImageCallback callback)
Register a callback to handle the decoding of DICOM images.
Definition: OrthancCPlugin.h:4745
The parameters of a REST request.
Definition: OrthancCPlugin.h:326
void OrthancPluginRedirect(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *redirection)
Redirect a REST request.
Definition: OrthancCPlugin.h:1921
OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:1826
const char * OrthancPluginGetInstanceData(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the data of a DICOM file.
Definition: OrthancCPlugin.h:2341
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:3523
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:3615
int OrthancPluginCheckVersion(OrthancPluginContext *context)
Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
Definition: OrthancCPlugin.h:1279
int64_t OrthancPluginGetInstanceSize(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the size of a DICOM file.
Definition: OrthancCPlugin.h:2308
Graylevel, unsigned 16bpp image.
Definition: OrthancCPlugin.h:555
Definition: OrthancCPlugin.h:669
const char *const * headersValues
The values of the HTTP headers.
Definition: OrthancCPlugin.h:386
const char *const * headersKeys
The keys of the HTTP headers (always converted to low-case).
Definition: OrthancCPlugin.h:381
OrthancPluginPixelFormat
Definition: OrthancCPlugin.h:539
uint32_t getCount
For a GET request, the number of GET parameters.
Definition: OrthancCPlugin.h:346
Definition: OrthancCPlugin.h:581
void OrthancPluginRegisterStorageArea(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove)
Register a custom storage area.
Definition: OrthancCPlugin.h:2540
OrthancPluginErrorCode OrthancPluginGetDicomForInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *instanceId)
Retrieve a DICOM instance using its Orthanc identifier.
Definition: OrthancCPlugin.h:1639
OrthancPluginImageFormat
Definition: OrthancCPlugin.h:694
const char * OrthancPluginGetFontName(OrthancPluginContext *context, uint32_t fontIndex)
Return the name of a font.
Definition: OrthancCPlugin.h:3895
OrthancPluginImage * OrthancPluginConvertPixelFormat(OrthancPluginContext *context, const OrthancPluginImage *source, OrthancPluginPixelFormat targetFormat)
Change the pixel format of an image.
Definition: OrthancCPlugin.h:3820
Definition: OrthancCPlugin.h:663
OrthancPluginErrorCode OrthancPluginStorageAreaRead(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Read a file from the storage area.
Definition: OrthancCPlugin.h:4074
uint32_t OrthancPluginGetFontsCount(OrthancPluginContext *context)
Return the number of available fonts.
Definition: OrthancCPlugin.h:3855
void OrthancPluginRegisterOnChangeCallback(OrthancPluginContext *context, OrthancPluginOnChangeCallback callback)
Register a callback to monitor changes.
Definition: OrthancCPlugin.h:2679
Color image in RGBA32 format.
Definition: OrthancCPlugin.h:579
void OrthancPluginSendMethodNotAllowed(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *allowedMethods)
Signal that this URI does not support this HTTP method.
Definition: OrthancCPlugin.h:2184
Definition: OrthancCPlugin.h:681
void OrthancPluginAnswerBuffer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *answer, uint32_t answerSize, const char *mimeType)
Answer to a REST request.
Definition: OrthancCPlugin.h:1541
Definition: OrthancCPlugin.h:657
OrthancPluginImage * OrthancPluginDecodeDicomImage(OrthancPluginContext *context, const void *buffer, uint32_t bufferSize, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:4871
uint16_t group
Definition: OrthancCPlugin.h:1238
void * OrthancPluginGetImageBuffer(OrthancPluginContext *context, const OrthancPluginImage *image)
Return a pointer to the content of an image.
Definition: OrthancCPlugin.h:3393
uint32_t minMultiplicity
Definition: OrthancCPlugin.h:1241
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:2492
Definition: OrthancCPlugin.h:696
struct _OrthancPluginStorageArea_t OrthancPluginStorageArea
Opaque structure that represents the storage area that is actually used by Orthanc.
Definition: OrthancCPlugin.h:871
Definition: OrthancCPlugin.h:661
Color image in RGB48 format.
Definition: OrthancCPlugin.h:589
OrthancPluginErrorCode OrthancPluginRestApiPutAfterPlugins(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, const char *body, uint32_t bodySize)
Make a PUT call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:1887
uint32_t OrthancPluginGetExpectedDatabaseVersion(OrthancPluginContext *context)
Get the expected version of the database schema.
Definition: OrthancCPlugin.h:2925
Graylevel 8bpp image.
Definition: OrthancCPlugin.h:547
uint32_t OrthancPluginGetImageHeight(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the height of an image.
Definition: OrthancCPlugin.h:3324
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:3222
OrthancPluginImage * OrthancPluginUncompressImage(OrthancPluginContext *context, const void *data, uint32_t size, OrthancPluginImageFormat format)
Decode a compressed image.
Definition: OrthancCPlugin.h:3436
OrthancPluginErrorCode(* OrthancPluginRestCallback)(OrthancPluginRestOutput *output, const char *url, const OrthancPluginHttpRequest *request)
Signature of a callback function that answers to a REST request.
Definition: OrthancCPlugin.h:919
Definition: OrthancCPlugin.h:682
Definition: OrthancCPlugin.h:684
Color image in RGB24 format.
Definition: OrthancCPlugin.h:571
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter2(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter2 callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:5644
Graylevel, signed 16bpp image.
Definition: OrthancCPlugin.h:563
An entry in the dictionary of DICOM tags.
Definition: OrthancCPlugin.h:1236
Definition: OrthancCPlugin.h:656
OrthancPluginCompressionType
Definition: OrthancCPlugin.h:679
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:4456
OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pixel format of an image.
Definition: OrthancCPlugin.h:3258
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:3980
uint32_t OrthancPluginGetImagePitch(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pitch of an image.
Definition: OrthancCPlugin.h:3359
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:1598
uint32_t maxMultiplicity
Definition: OrthancCPlugin.h:1242
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:951
void OrthancPluginSendUnauthorized(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *realm)
Signal that a REST request is not authorized.
Definition: OrthancCPlugin.h:2161
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:833
uint32_t OrthancPluginGetFontSize(OrthancPluginContext *context, uint32_t fontIndex)
Return the size of a font.
Definition: OrthancCPlugin.h:3927
OrthancPluginErrorCode OrthancPluginRestApiGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:1672
uint32_t headersCount
The number of HTTP headers.
Definition: OrthancCPlugin.h:376
Definition: OrthancCPlugin.h:662
OrthancPluginErrorCode(* OrthancPluginStorageCreate)(const char *uuid, const void *content, int64_t size, OrthancPluginContentType type)
Callback for writing to the storage area.
Definition: OrthancCPlugin.h:978
OrthancPluginErrorCode OrthancPluginRestApiDelete(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:1803
OrthancPluginImage * OrthancPluginCreateImage(OrthancPluginContext *context, OrthancPluginPixelFormat format, uint32_t width, uint32_t height)
Create an image.
Definition: OrthancCPlugin.h:4783
char * OrthancPluginGetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *defaultValue)
Get the value of a global property.
Definition: OrthancCPlugin.h:2788
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:5042
OrthancPluginErrorCode(* OrthancPluginStorageRemove)(const char *uuid, OrthancPluginContentType type)
Callback for removing a file from the storage area.
Definition: OrthancCPlugin.h:1016
Definition: OrthancCPlugin.h:664
OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, OrthancPluginResourceType level)
Reconstruct the main DICOM tags.
Definition: OrthancCPlugin.h:4305
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:4826
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:5080
const char *const * getValues
For a GET request, the values of the GET parameters.
Definition: OrthancCPlugin.h:356
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:940
char * OrthancPluginGetInstanceSimplifiedJson(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file (with simplification).
Definition: OrthancCPlugin.h:2415
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:3070
Definition: OrthancCPlugin.h:698
const char * body
For a PUT or POST request, the content of the body.
Definition: OrthancCPlugin.h:361
void OrthancPluginRegisterRestCallbackNoLock(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback, without locking.
Definition: OrthancCPlugin.h:1481
Definition: OrthancCPlugin.h:667
struct _OrthancPluginImage_t OrthancPluginImage
Opaque structure that represents an image that is uncompressed in memory.
Definition: OrthancCPlugin.h:863
OrthancPluginErrorCode OrthancPluginRestApiPut(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, const char *body, uint32_t bodySize)
Make a PUT call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:1851
OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *subType, const char *contentType)
Start an HTTP multipart answer.
Definition: OrthancCPlugin.h:2999
OrthancPluginErrorCode OrthancPluginStorageAreaRemove(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Remove a file from the storage area.
Definition: OrthancCPlugin.h:4111
Definition: OrthancCPlugin.h:668
const char *const * getKeys
For a GET request, the keys of the GET parameters.
Definition: OrthancCPlugin.h:351
Definition: OrthancCPlugin.h:659
char * OrthancPluginLookupPatient(OrthancPluginContext *context, const char *patientID)
Look for a patient.
Definition: OrthancCPlugin.h:1953
OrthancPluginInstanceOrigin OrthancPluginGetInstanceOrigin(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the origin of a DICOM file.
Definition: OrthancCPlugin.h:4663
void OrthancPluginFreeImage(OrthancPluginContext *context, OrthancPluginImage *image)
Free an image.
Definition: OrthancCPlugin.h:3478
OrthancPluginValueRepresentation vr
Definition: OrthancCPlugin.h:1240
uint16_t element
Definition: OrthancCPlugin.h:1239
char * OrthancPluginLookupInstance(OrthancPluginContext *context, const char *sopInstanceUID)
Look for an instance.
Definition: OrthancCPlugin.h:2093
Definition: OrthancCPlugin.h:666
OrthancPluginErrorCode OrthancPluginSetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *value)
Set the value of a global property.
Definition: OrthancCPlugin.h:2827
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:3028
const char *const * groups
The matched values for the groups of the regular expression.
Definition: OrthancCPlugin.h:341
OrthancPluginErrorCode(* OrthancPluginStorageRead)(void **content, int64_t *size, const char *uuid, OrthancPluginContentType type)
Callback for reading from the storage area.
Definition: OrthancCPlugin.h:998
char * OrthancPluginLookupStudy(OrthancPluginContext *context, const char *studyUID)
Look for a study.
Definition: OrthancCPlugin.h:1988
uint32_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:838
Graylevel, floating-point 32bpp image.
Definition: OrthancCPlugin.h:605
uint32_t groupsCount
The number of groups of the regular expression.
Definition: OrthancCPlugin.h:336
uint32_t bodySize
For a PUT or POST request, the number of bytes of the body.
Definition: OrthancCPlugin.h:366
void OrthancPluginSetCookie(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *cookie, const char *value)
Set a cookie.
Definition: OrthancCPlugin.h:2214
Definition: OrthancCPlugin.h:658
char * OrthancPluginGetInstanceJson(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file.
Definition: OrthancCPlugin.h:2377
OrthancPluginErrorCode OrthancPluginRestApiPost(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, const char *body, uint32_t bodySize)
Make a POST call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:1739
void OrthancPluginRegisterOnStoredInstanceCallback(OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback)
Register a callback for received instances.
Definition: OrthancCPlugin.h:1509
Definition: OrthancCPlugin.h:660
Graylevel, unsigned 32bpp image.
Definition: OrthancCPlugin.h:597
void OrthancPluginRegisterRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback.
Definition: OrthancCPlugin.h:1447
char * OrthancPluginLookupStudyWithAccessionNumber(OrthancPluginContext *context, const char *accessionNumber)
Look for a study, using the accession number.
Definition: OrthancCPlugin.h:2023
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:1702
OrthancPluginErrorCode(* OrthancPluginOnStoredInstanceCallback)(OrthancPluginDicomInstance *instance, const char *instanceId)
Signature of a callback function that is triggered when Orthanc receives a DICOM instance.
Definition: OrthancCPlugin.h:930
OrthancPluginErrorCode OrthancPluginRestApiPostAfterPlugins(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, const char *body, uint32_t bodySize)
Make a POST call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:1774
Definition: OrthancCPlugin.h:665
Definition: OrthancCPlugin.h:683
OrthancPluginHttpMethod method
The HTTP method.
Definition: OrthancCPlugin.h:331
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:4032
A memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:828
Color image in BGRA32 format.
Definition: OrthancCPlugin.h:613
char * OrthancPluginLookupSeries(OrthancPluginContext *context, const char *seriesUID)
Look for a series.
Definition: OrthancCPlugin.h:2058
uint32_t OrthancPluginGetImageWidth(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the width of an image.
Definition: OrthancCPlugin.h:3291
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:3568