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 2 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 298 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
306 ORTHANC_PLUGINS_API
const char* OrthancPluginGetName();
319 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
395 _OrthancPluginService_LogInfo = 1,
396 _OrthancPluginService_LogWarning = 2,
397 _OrthancPluginService_LogError = 3,
398 _OrthancPluginService_GetOrthancPath = 4,
399 _OrthancPluginService_GetOrthancDirectory = 5,
400 _OrthancPluginService_GetConfigurationPath = 6,
401 _OrthancPluginService_SetPluginProperty = 7,
402 _OrthancPluginService_GetGlobalProperty = 8,
403 _OrthancPluginService_SetGlobalProperty = 9,
404 _OrthancPluginService_GetCommandLineArgumentsCount = 10,
405 _OrthancPluginService_GetCommandLineArgument = 11,
406 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
407 _OrthancPluginService_GetConfiguration = 13,
408 _OrthancPluginService_BufferCompression = 14,
409 _OrthancPluginService_ReadFile = 15,
410 _OrthancPluginService_WriteFile = 16,
411 _OrthancPluginService_GetErrorDescription = 17,
412 _OrthancPluginService_CallHttpClient = 18,
413 _OrthancPluginService_RegisterErrorCode = 19,
414 _OrthancPluginService_RegisterDictionaryTag = 20,
415 _OrthancPluginService_DicomBufferToJson = 21,
416 _OrthancPluginService_DicomInstanceToJson = 22,
417 _OrthancPluginService_CreateDicom = 23,
418 _OrthancPluginService_ComputeMd5 = 24,
419 _OrthancPluginService_ComputeSha1 = 25,
420 _OrthancPluginService_LookupDictionary = 26,
421 _OrthancPluginService_CallHttpClient2 = 27,
422 _OrthancPluginService_GenerateUuid = 28,
423 _OrthancPluginService_RegisterPrivateDictionaryTag = 29,
426 _OrthancPluginService_RegisterRestCallback = 1000,
427 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
428 _OrthancPluginService_RegisterStorageArea = 1002,
429 _OrthancPluginService_RegisterOnChangeCallback = 1003,
430 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
431 _OrthancPluginService_RegisterWorklistCallback = 1005,
432 _OrthancPluginService_RegisterDecodeImageCallback = 1006,
433 _OrthancPluginService_RegisterIncomingHttpRequestFilter = 1007,
434 _OrthancPluginService_RegisterFindCallback = 1008,
435 _OrthancPluginService_RegisterMoveCallback = 1009,
436 _OrthancPluginService_RegisterIncomingHttpRequestFilter2 = 1010,
439 _OrthancPluginService_AnswerBuffer = 2000,
440 _OrthancPluginService_CompressAndAnswerPngImage = 2001,
441 _OrthancPluginService_Redirect = 2002,
442 _OrthancPluginService_SendHttpStatusCode = 2003,
443 _OrthancPluginService_SendUnauthorized = 2004,
444 _OrthancPluginService_SendMethodNotAllowed = 2005,
445 _OrthancPluginService_SetCookie = 2006,
446 _OrthancPluginService_SetHttpHeader = 2007,
447 _OrthancPluginService_StartMultipartAnswer = 2008,
448 _OrthancPluginService_SendMultipartItem = 2009,
449 _OrthancPluginService_SendHttpStatus = 2010,
450 _OrthancPluginService_CompressAndAnswerImage = 2011,
451 _OrthancPluginService_SendMultipartItem2 = 2012,
454 _OrthancPluginService_GetDicomForInstance = 3000,
455 _OrthancPluginService_RestApiGet = 3001,
456 _OrthancPluginService_RestApiPost = 3002,
457 _OrthancPluginService_RestApiDelete = 3003,
458 _OrthancPluginService_RestApiPut = 3004,
459 _OrthancPluginService_LookupPatient = 3005,
460 _OrthancPluginService_LookupStudy = 3006,
461 _OrthancPluginService_LookupSeries = 3007,
462 _OrthancPluginService_LookupInstance = 3008,
463 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
464 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
465 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
466 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
467 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
468 _OrthancPluginService_ReconstructMainDicomTags = 3014,
469 _OrthancPluginService_RestApiGet2 = 3015,
472 _OrthancPluginService_GetInstanceRemoteAet = 4000,
473 _OrthancPluginService_GetInstanceSize = 4001,
474 _OrthancPluginService_GetInstanceData = 4002,
475 _OrthancPluginService_GetInstanceJson = 4003,
476 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
477 _OrthancPluginService_HasInstanceMetadata = 4005,
478 _OrthancPluginService_GetInstanceMetadata = 4006,
479 _OrthancPluginService_GetInstanceOrigin = 4007,
482 _OrthancPluginService_RegisterDatabaseBackend = 5000,
483 _OrthancPluginService_DatabaseAnswer = 5001,
484 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002,
485 _OrthancPluginService_StorageAreaCreate = 5003,
486 _OrthancPluginService_StorageAreaRead = 5004,
487 _OrthancPluginService_StorageAreaRemove = 5005,
490 _OrthancPluginService_GetImagePixelFormat = 6000,
491 _OrthancPluginService_GetImageWidth = 6001,
492 _OrthancPluginService_GetImageHeight = 6002,
493 _OrthancPluginService_GetImagePitch = 6003,
494 _OrthancPluginService_GetImageBuffer = 6004,
495 _OrthancPluginService_UncompressImage = 6005,
496 _OrthancPluginService_FreeImage = 6006,
497 _OrthancPluginService_CompressImage = 6007,
498 _OrthancPluginService_ConvertPixelFormat = 6008,
499 _OrthancPluginService_GetFontsCount = 6009,
500 _OrthancPluginService_GetFontInfo = 6010,
501 _OrthancPluginService_DrawText = 6011,
502 _OrthancPluginService_CreateImage = 6012,
503 _OrthancPluginService_CreateImageAccessor = 6013,
504 _OrthancPluginService_DecodeDicomImage = 6014,
507 _OrthancPluginService_WorklistAddAnswer = 7000,
508 _OrthancPluginService_WorklistMarkIncomplete = 7001,
509 _OrthancPluginService_WorklistIsMatch = 7002,
510 _OrthancPluginService_WorklistGetDicomQuery = 7003,
511 _OrthancPluginService_FindAddAnswer = 7004,
512 _OrthancPluginService_FindMarkIncomplete = 7005,
513 _OrthancPluginService_GetFindQuerySize = 7006,
514 _OrthancPluginService_GetFindQueryTag = 7007,
515 _OrthancPluginService_GetFindQueryTagName = 7008,
516 _OrthancPluginService_GetFindQueryValue = 7009,
517 _OrthancPluginService_CreateFindMatcher = 7010,
518 _OrthancPluginService_FreeFindMatcher = 7011,
519 _OrthancPluginService_FindMatcherIsMatch = 7012,
521 _OrthancPluginService_INTERNAL = 0x7fffffff
522 } _OrthancPluginService;
527 _OrthancPluginProperty_Description = 1,
528 _OrthancPluginProperty_RootUri = 2,
529 _OrthancPluginProperty_OrthancExplorer = 3,
531 _OrthancPluginProperty_INTERNAL = 0x7fffffff
532 } _OrthancPluginProperty;
616 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
630 _OrthancPluginContentType_INTERNAL = 0x7fffffff
646 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
672 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
687 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
701 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
739 _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff
754 _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff
765 OrthancPluginDicomToJsonFlags_None = 0,
773 _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff
784 OrthancPluginCreateDicomFlags_None = 0,
788 _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff
803 _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff
818 _OrthancPluginInstanceOrigin_INTERNAL = 0x7fffffff
933 const char* instanceId);
944 const char* resourceId);
956 uint32_t frameIndex);
1039 const char* issuerAet,
1040 const char* calledAet);
1067 uint32_t headersCount,
1068 const char*
const* headersKeys,
1069 const char*
const* headersValues);
1098 uint32_t headersCount,
1099 const char*
const* headersKeys,
1100 const char*
const* headersValues,
1101 uint32_t getArgumentsCount,
1102 const char*
const* getArgumentsKeys,
1103 const char*
const* getArgumentsValues);
1124 const char* issuerAet,
1125 const char* calledAet);
1164 typedef void* (*OrthancPluginMoveCallback) (
1166 const char* patientId,
1167 const char* accessionNumber,
1168 const char* studyInstanceUid,
1169 const char* seriesInstanceUid,
1170 const char* sopInstanceUid,
1171 const char* originatorAet,
1172 const char* sourceAet,
1173 const char* targetAet,
1174 uint16_t originatorId);
1222 typedef struct _OrthancPluginContext_t
1224 void* pluginsManager;
1225 const char* orthancVersion;
1228 _OrthancPluginService service,
1229 const void* params);
1283 int major, minor, revision;
1287 sizeof(int32_t) !=
sizeof(_OrthancPluginService) ||
1288 sizeof(int32_t) !=
sizeof(_OrthancPluginProperty) ||
1307 if (!strcmp(context->orthancVersion,
"mainline"))
1319 (context->orthancVersion,
"%4d.%4d.%4d", &major, &minor, &revision) != 3)
1326 if (major > ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
1331 if (major < ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
1338 if (minor > ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
1343 if (minor < ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
1350 if (revision >= ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER)
1373 context->Free(buffer->
data);
1387 const char* message)
1389 context->InvokeService(context, _OrthancPluginService_LogError, message);
1403 const char* message)
1405 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
1419 const char* message)
1421 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
1428 const char* pathRegularExpression;
1430 } _OrthancPluginRestCallback;
1450 const char* pathRegularExpression,
1453 _OrthancPluginRestCallback params;
1454 params.pathRegularExpression = pathRegularExpression;
1455 params.callback = callback;
1456 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
1484 const char* pathRegularExpression,
1487 _OrthancPluginRestCallback params;
1488 params.pathRegularExpression = pathRegularExpression;
1489 params.callback = callback;
1490 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms);
1498 } _OrthancPluginOnStoredInstanceCallback;
1514 _OrthancPluginOnStoredInstanceCallback params;
1515 params.callback = callback;
1517 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
1526 uint32_t answerSize;
1527 const char* mimeType;
1528 } _OrthancPluginAnswerBuffer;
1546 uint32_t answerSize,
1547 const char* mimeType)
1549 _OrthancPluginAnswerBuffer params;
1550 params.output = output;
1551 params.answer = answer;
1552 params.answerSize = answerSize;
1553 params.mimeType = mimeType;
1554 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms);
1566 } _OrthancPluginCompressAndAnswerPngImage;
1578 } _OrthancPluginCompressAndAnswerImage;
1608 _OrthancPluginCompressAndAnswerImage params;
1609 params.output = output;
1611 params.pixelFormat = format;
1612 params.width = width;
1613 params.height = height;
1614 params.pitch = pitch;
1615 params.buffer = buffer;
1617 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
1625 const char* instanceId;
1626 } _OrthancPluginGetDicomForInstance;
1643 const char* instanceId)
1645 _OrthancPluginGetDicomForInstance params;
1646 params.target = target;
1647 params.instanceId = instanceId;
1648 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
1657 } _OrthancPluginRestApiGet;
1678 _OrthancPluginRestApiGet params;
1679 params.target = target;
1681 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
1708 _OrthancPluginRestApiGet params;
1709 params.target = target;
1711 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms);
1722 } _OrthancPluginRestApiPostPut;
1747 _OrthancPluginRestApiPostPut params;
1748 params.target = target;
1751 params.bodySize = bodySize;
1752 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
1782 _OrthancPluginRestApiPostPut params;
1783 params.target = target;
1786 params.bodySize = bodySize;
1787 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms);
1808 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
1831 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
1859 _OrthancPluginRestApiPostPut params;
1860 params.target = target;
1863 params.bodySize = bodySize;
1864 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
1895 _OrthancPluginRestApiPostPut params;
1896 params.target = target;
1899 params.bodySize = bodySize;
1900 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms);
1908 const char* argument;
1909 } _OrthancPluginOutputPlusArgument;
1925 const char* redirection)
1927 _OrthancPluginOutputPlusArgument params;
1928 params.output = output;
1929 params.argument = redirection;
1930 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
1938 const char* argument;
1939 } _OrthancPluginRetrieveDynamicString;
1956 const char* patientID)
1960 _OrthancPluginRetrieveDynamicString params;
1961 params.result = &result;
1962 params.argument = patientID;
1991 const char* studyUID)
1995 _OrthancPluginRetrieveDynamicString params;
1996 params.result = &result;
1997 params.argument = studyUID;
2026 const char* accessionNumber)
2030 _OrthancPluginRetrieveDynamicString params;
2031 params.result = &result;
2032 params.argument = accessionNumber;
2061 const char* seriesUID)
2065 _OrthancPluginRetrieveDynamicString params;
2066 params.result = &result;
2067 params.argument = seriesUID;
2096 const char* sopInstanceUID)
2100 _OrthancPluginRetrieveDynamicString params;
2101 params.result = &result;
2102 params.argument = sopInstanceUID;
2121 } _OrthancPluginSendHttpStatusCode;
2144 _OrthancPluginSendHttpStatusCode params;
2145 params.output = output;
2146 params.status = status;
2147 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
2167 _OrthancPluginOutputPlusArgument params;
2168 params.output = output;
2169 params.argument = realm;
2170 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
2188 const char* allowedMethods)
2190 _OrthancPluginOutputPlusArgument params;
2191 params.output = output;
2192 params.argument = allowedMethods;
2193 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
2202 } _OrthancPluginSetHttpHeader;
2221 _OrthancPluginSetHttpHeader params;
2222 params.output = output;
2223 params.key = cookie;
2224 params.value = value;
2225 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
2246 _OrthancPluginSetHttpHeader params;
2247 params.output = output;
2249 params.value = value;
2250 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
2256 char** resultStringToFree;
2257 const char** resultString;
2258 int64_t* resultInt64;
2262 } _OrthancPluginAccessDicomInstance;
2282 _OrthancPluginAccessDicomInstance params;
2283 memset(¶ms, 0,
sizeof(params));
2284 params.resultString = &result;
2285 params.instance = instance;
2315 _OrthancPluginAccessDicomInstance params;
2316 memset(¶ms, 0,
sizeof(params));
2317 params.resultInt64 = &size;
2318 params.instance = instance;
2348 _OrthancPluginAccessDicomInstance params;
2349 memset(¶ms, 0,
sizeof(params));
2350 params.resultString = &result;
2351 params.instance = instance;
2384 _OrthancPluginAccessDicomInstance params;
2385 memset(¶ms, 0,
sizeof(params));
2386 params.resultStringToFree = &result;
2387 params.instance = instance;
2422 _OrthancPluginAccessDicomInstance params;
2423 memset(¶ms, 0,
sizeof(params));
2424 params.resultStringToFree = &result;
2425 params.instance = instance;
2458 const char* metadata)
2462 _OrthancPluginAccessDicomInstance params;
2463 memset(¶ms, 0,
sizeof(params));
2464 params.resultInt64 = &result;
2465 params.instance = instance;
2466 params.key = metadata;
2475 return (result != 0);
2496 const char* metadata)
2500 _OrthancPluginAccessDicomInstance params;
2501 memset(¶ms, 0,
sizeof(params));
2502 params.resultString = &result;
2503 params.instance = instance;
2504 params.key = metadata;
2525 } _OrthancPluginRegisterStorageArea;
2547 _OrthancPluginRegisterStorageArea params;
2548 params.create = create;
2550 params.remove =
remove;
2553 params.free = ::free;
2558 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
2577 _OrthancPluginRetrieveDynamicString params;
2578 params.result = &result;
2579 params.argument = NULL;
2607 _OrthancPluginRetrieveDynamicString params;
2608 params.result = &result;
2609 params.argument = NULL;
2642 _OrthancPluginRetrieveDynamicString params;
2643 params.result = &result;
2644 params.argument = NULL;
2662 } _OrthancPluginOnChangeCallback;
2684 _OrthancPluginOnChangeCallback params;
2685 params.callback = callback;
2687 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms);
2695 _OrthancPluginProperty property;
2697 } _OrthancPluginSetPluginProperty;
2715 _OrthancPluginSetPluginProperty params;
2716 params.plugin = OrthancPluginGetName();
2717 params.property = _OrthancPluginProperty_RootUri;
2720 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
2735 const char* description)
2737 _OrthancPluginSetPluginProperty params;
2738 params.plugin = OrthancPluginGetName();
2739 params.property = _OrthancPluginProperty_Description;
2740 params.value = description;
2742 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
2757 const char* javascript)
2759 _OrthancPluginSetPluginProperty params;
2760 params.plugin = OrthancPluginGetName();
2761 params.property = _OrthancPluginProperty_OrthancExplorer;
2762 params.value = javascript;
2764 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
2773 } _OrthancPluginGlobalProperty;
2792 const char* defaultValue)
2796 _OrthancPluginGlobalProperty params;
2797 params.result = &result;
2798 params.property = property;
2799 params.value = defaultValue;
2833 _OrthancPluginGlobalProperty params;
2834 params.result = NULL;
2835 params.property = property;
2836 params.value = value;
2838 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms);
2845 int32_t *resultInt32;
2846 uint32_t *resultUint32;
2847 int64_t *resultInt64;
2848 uint64_t *resultUint64;
2849 } _OrthancPluginReturnSingleValue;
2864 _OrthancPluginReturnSingleValue params;
2865 memset(¶ms, 0,
sizeof(params));
2866 params.resultUint32 = &count;
2899 _OrthancPluginGlobalProperty params;
2900 params.result = &result;
2901 params.property = (int32_t) argument;
2902 params.value = NULL;
2931 _OrthancPluginReturnSingleValue params;
2932 memset(¶ms, 0,
sizeof(params));
2933 params.resultUint32 = &count;
2963 _OrthancPluginRetrieveDynamicString params;
2964 params.result = &result;
2965 params.argument = NULL;
2983 const char* subType;
2984 const char* contentType;
2985 } _OrthancPluginStartMultipartAnswer;
3003 const char* subType,
3004 const char* contentType)
3006 _OrthancPluginStartMultipartAnswer params;
3007 params.output = output;
3008 params.subType = subType;
3009 params.contentType = contentType;
3010 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms);
3033 uint32_t answerSize)
3035 _OrthancPluginAnswerBuffer params;
3036 params.output = output;
3037 params.answer = answer;
3038 params.answerSize = answerSize;
3039 params.mimeType = NULL;
3040 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms);
3052 } _OrthancPluginBufferCompression;
3079 _OrthancPluginBufferCompression params;
3080 params.target = target;
3081 params.source = source;
3083 params.compression = compression;
3084 params.uncompress = uncompress;
3086 return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms);
3095 } _OrthancPluginReadFile;
3113 _OrthancPluginReadFile params;
3114 params.target = target;
3116 return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms);
3126 } _OrthancPluginWriteFile;
3145 _OrthancPluginWriteFile params;
3149 return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms);
3156 const char** target;
3158 } _OrthancPluginGetErrorDescription;
3174 const char* result = NULL;
3176 _OrthancPluginGetErrorDescription params;
3177 params.target = &result;
3178 params.error = error;
3183 return "Unknown error code";
3199 } _OrthancPluginSendHttpStatus;
3230 _OrthancPluginSendHttpStatus params;
3231 params.output = output;
3232 params.status = status;
3234 params.bodySize = bodySize;
3235 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms);
3243 uint32_t* resultUint32;
3245 void** resultBuffer;
3246 } _OrthancPluginGetImageInfo;
3265 _OrthancPluginGetImageInfo params;
3266 memset(¶ms, 0,
sizeof(params));
3267 params.image = image;
3268 params.resultPixelFormat = ⌖
3298 _OrthancPluginGetImageInfo params;
3299 memset(¶ms, 0,
sizeof(params));
3300 params.image = image;
3301 params.resultUint32 = &width;
3331 _OrthancPluginGetImageInfo params;
3332 memset(¶ms, 0,
sizeof(params));
3333 params.image = image;
3334 params.resultUint32 = &height;
3366 _OrthancPluginGetImageInfo params;
3367 memset(¶ms, 0,
sizeof(params));
3368 params.image = image;
3369 params.resultUint32 = &pitch;
3398 void* target = NULL;
3400 _OrthancPluginGetImageInfo params;
3401 memset(¶ms, 0,
sizeof(params));
3402 params.resultBuffer = ⌖
3403 params.image = image;
3422 } _OrthancPluginUncompressImage;
3445 _OrthancPluginUncompressImage params;
3446 memset(¶ms, 0,
sizeof(params));
3447 params.target = ⌖
3450 params.format = format;
3468 } _OrthancPluginFreeImage;
3483 _OrthancPluginFreeImage params;
3484 params.image = image;
3486 context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms);
3502 } _OrthancPluginCompressImage;
3533 _OrthancPluginCompressImage params;
3534 memset(¶ms, 0,
sizeof(params));
3535 params.target = target;
3537 params.pixelFormat = format;
3538 params.width = width;
3539 params.height = height;
3540 params.pitch = pitch;
3541 params.buffer = buffer;
3544 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
3579 _OrthancPluginCompressImage params;
3580 memset(¶ms, 0,
sizeof(params));
3581 params.target = target;
3583 params.pixelFormat = format;
3584 params.width = width;
3585 params.height = height;
3586 params.pitch = pitch;
3587 params.buffer = buffer;
3588 params.quality = quality;
3590 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
3626 _OrthancPluginCompressAndAnswerImage params;
3627 params.output = output;
3629 params.pixelFormat = format;
3630 params.width = width;
3631 params.height = height;
3632 params.pitch = pitch;
3633 params.buffer = buffer;
3634 params.quality = quality;
3635 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
3646 const char* username;
3647 const char* password;
3650 } _OrthancPluginCallHttpClient;
3672 const char* username,
3673 const char* password)
3675 _OrthancPluginCallHttpClient params;
3676 memset(¶ms, 0,
sizeof(params));
3678 params.target = target;
3681 params.username = username;
3682 params.password = password;
3684 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3711 const char* username,
3712 const char* password)
3714 _OrthancPluginCallHttpClient params;
3715 memset(¶ms, 0,
sizeof(params));
3717 params.target = target;
3721 params.bodySize = bodySize;
3722 params.username = username;
3723 params.password = password;
3725 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3752 const char* username,
3753 const char* password)
3755 _OrthancPluginCallHttpClient params;
3756 memset(¶ms, 0,
sizeof(params));
3758 params.target = target;
3762 params.bodySize = bodySize;
3763 params.username = username;
3764 params.password = password;
3766 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3786 const char* username,
3787 const char* password)
3789 _OrthancPluginCallHttpClient params;
3790 memset(¶ms, 0,
sizeof(params));
3794 params.username = username;
3795 params.password = password;
3797 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3807 } _OrthancPluginConvertPixelFormat;
3828 _OrthancPluginConvertPixelFormat params;
3829 params.target = ⌖
3830 params.source = source;
3831 params.targetFormat = targetFormat;
3861 _OrthancPluginReturnSingleValue params;
3862 memset(¶ms, 0,
sizeof(params));
3863 params.resultUint32 = &count;
3884 } _OrthancPluginGetFontInfo;
3900 const char* result = NULL;
3902 _OrthancPluginGetFontInfo params;
3903 memset(¶ms, 0,
sizeof(params));
3904 params.name = &result;
3905 params.fontIndex = fontIndex;
3934 _OrthancPluginGetFontInfo params;
3935 memset(¶ms, 0,
sizeof(params));
3936 params.size = &result;
3937 params.fontIndex = fontIndex;
3955 const char* utf8Text;
3961 } _OrthancPluginDrawText;
3985 const char* utf8Text,
3992 _OrthancPluginDrawText params;
3993 memset(¶ms, 0,
sizeof(params));
3994 params.image = image;
3995 params.fontIndex = fontIndex;
3996 params.utf8Text = utf8Text;
4003 return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms);
4012 const void* content;
4015 } _OrthancPluginStorageAreaCreate;
4037 const void* content,
4041 _OrthancPluginStorageAreaCreate params;
4042 params.storageArea = storageArea;
4044 params.content = content;
4048 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms);
4058 } _OrthancPluginStorageAreaRead;
4082 _OrthancPluginStorageAreaRead params;
4083 params.target = target;
4084 params.storageArea = storageArea;
4088 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms);
4097 } _OrthancPluginStorageAreaRemove;
4118 _OrthancPluginStorageAreaRemove params;
4119 params.storageArea = storageArea;
4123 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms);
4132 uint16_t httpStatus;
4133 const char* message;
4134 } _OrthancPluginRegisterErrorCode;
4154 uint16_t httpStatus,
4155 const char* message)
4159 _OrthancPluginRegisterErrorCode params;
4160 params.target = ⌖
4162 params.httpStatus = httpStatus;
4163 params.message = message;
4184 uint32_t minMultiplicity;
4185 uint32_t maxMultiplicity;
4186 } _OrthancPluginRegisterDictionaryTag;
4213 uint32_t minMultiplicity,
4214 uint32_t maxMultiplicity)
4216 _OrthancPluginRegisterDictionaryTag params;
4217 params.group = group;
4218 params.element = element;
4221 params.minMultiplicity = minMultiplicity;
4222 params.maxMultiplicity = maxMultiplicity;
4224 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, ¶ms);
4235 uint32_t minMultiplicity;
4236 uint32_t maxMultiplicity;
4237 const char* privateCreator;
4238 } _OrthancPluginRegisterPrivateDictionaryTag;
4266 uint32_t minMultiplicity,
4267 uint32_t maxMultiplicity,
4268 const char* privateCreator)
4270 _OrthancPluginRegisterPrivateDictionaryTag params;
4271 params.group = group;
4272 params.element = element;
4275 params.minMultiplicity = minMultiplicity;
4276 params.maxMultiplicity = maxMultiplicity;
4277 params.privateCreator = privateCreator;
4279 return context->InvokeService(context, _OrthancPluginService_RegisterPrivateDictionaryTag, ¶ms);
4288 } _OrthancPluginReconstructMainDicomTags;
4311 _OrthancPluginReconstructMainDicomTags params;
4312 params.level = level;
4313 params.storageArea = storageArea;
4315 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, ¶ms);
4322 const char* instanceId;
4327 uint32_t maxStringLength;
4328 } _OrthancPluginDicomToJson;
4356 uint32_t maxStringLength)
4360 _OrthancPluginDicomToJson params;
4361 memset(¶ms, 0,
sizeof(params));
4362 params.result = &result;
4363 params.buffer = buffer;
4365 params.format = format;
4366 params.flags = flags;
4367 params.maxStringLength = maxStringLength;
4401 const char* instanceId,
4404 uint32_t maxStringLength)
4408 _OrthancPluginDicomToJson params;
4409 memset(¶ms, 0,
sizeof(params));
4410 params.result = &result;
4411 params.instanceId = instanceId;
4412 params.format = format;
4413 params.flags = flags;
4414 params.maxStringLength = maxStringLength;
4432 uint32_t headersCount;
4433 const char*
const* headersKeys;
4434 const char*
const* headersValues;
4435 int32_t afterPlugins;
4436 } _OrthancPluginRestApiGet2;
4461 uint32_t headersCount,
4462 const char*
const* headersKeys,
4463 const char*
const* headersValues,
4464 int32_t afterPlugins)
4466 _OrthancPluginRestApiGet2 params;
4467 params.target = target;
4469 params.headersCount = headersCount;
4470 params.headersKeys = headersKeys;
4471 params.headersValues = headersValues;
4472 params.afterPlugins = afterPlugins;
4474 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, ¶ms);
4482 } _OrthancPluginWorklistCallback;
4499 _OrthancPluginWorklistCallback params;
4500 params.callback = callback;
4502 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, ¶ms);
4513 } _OrthancPluginWorklistAnswersOperation;
4538 _OrthancPluginWorklistAnswersOperation params;
4539 params.answers = answers;
4540 params.query = query;
4541 params.dicom = dicom;
4544 return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, ¶ms);
4565 _OrthancPluginWorklistAnswersOperation params;
4566 params.answers = answers;
4567 params.query = NULL;
4568 params.dicom = NULL;
4571 return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, ¶ms);
4582 } _OrthancPluginWorklistQueryOperation;
4605 int32_t isMatch = 0;
4607 _OrthancPluginWorklistQueryOperation params;
4608 params.query = query;
4609 params.dicom = dicom;
4611 params.isMatch = &isMatch;
4612 params.target = NULL;
4643 _OrthancPluginWorklistQueryOperation params;
4644 params.query = query;
4645 params.dicom = NULL;
4647 params.isMatch = NULL;
4648 params.target = target;
4650 return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, ¶ms);
4670 _OrthancPluginAccessDicomInstance params;
4671 memset(¶ms, 0,
sizeof(params));
4672 params.resultOrigin = &origin;
4673 params.instance = instance;
4693 } _OrthancPluginCreateDicom;
4720 _OrthancPluginCreateDicom params;
4721 params.target = target;
4723 params.pixelData = pixelData;
4724 params.flags = flags;
4726 return context->InvokeService(context, _OrthancPluginService_CreateDicom, ¶ms);
4733 } _OrthancPluginDecodeImageCallback;
4750 _OrthancPluginDecodeImageCallback params;
4751 params.callback = callback;
4753 return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, ¶ms);
4766 const void* constBuffer;
4767 uint32_t bufferSize;
4768 uint32_t frameIndex;
4769 } _OrthancPluginCreateImage;
4792 _OrthancPluginCreateImage params;
4793 memset(¶ms, 0,
sizeof(params));
4794 params.target = ⌖
4795 params.format = format;
4796 params.width = width;
4797 params.height = height;
4837 _OrthancPluginCreateImage params;
4838 memset(¶ms, 0,
sizeof(params));
4839 params.target = ⌖
4840 params.format = format;
4841 params.width = width;
4842 params.height = height;
4843 params.pitch = pitch;
4844 params.buffer = buffer;
4875 uint32_t bufferSize,
4876 uint32_t frameIndex)
4880 _OrthancPluginCreateImage params;
4881 memset(¶ms, 0,
sizeof(params));
4882 params.target = ⌖
4883 params.constBuffer = buffer;
4884 params.bufferSize = bufferSize;
4885 params.frameIndex = frameIndex;
4904 } _OrthancPluginComputeHash;
4925 _OrthancPluginComputeHash params;
4926 params.result = &result;
4927 params.buffer = buffer;
4961 _OrthancPluginComputeHash params;
4962 params.result = &result;
4963 params.buffer = buffer;
4983 } _OrthancPluginLookupDictionary;
5005 _OrthancPluginLookupDictionary params;
5006 params.target = target;
5008 return context->InvokeService(context, _OrthancPluginService_LookupDictionary, ¶ms);
5017 uint32_t answerSize;
5018 uint32_t headersCount;
5019 const char*
const* headersKeys;
5020 const char*
const* headersValues;
5021 } _OrthancPluginSendMultipartItem2;
5047 uint32_t answerSize,
5048 uint32_t headersCount,
5049 const char*
const* headersKeys,
5050 const char*
const* headersValues)
5052 _OrthancPluginSendMultipartItem2 params;
5053 params.output = output;
5054 params.answer = answer;
5055 params.answerSize = answerSize;
5056 params.headersCount = headersCount;
5057 params.headersKeys = headersKeys;
5058 params.headersValues = headersValues;
5060 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem2, ¶ms);
5067 } _OrthancPluginIncomingHttpRequestFilter;
5085 _OrthancPluginIncomingHttpRequestFilter params;
5086 params.callback = callback;
5088 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter, ¶ms);
5097 uint16_t* httpStatus;
5100 uint32_t headersCount;
5101 const char*
const* headersKeys;
5102 const char*
const* headersValues;
5105 const char* username;
5106 const char* password;
5108 const char* certificateFile;
5109 const char* certificateKeyFile;
5110 const char* certificateKeyPassword;
5112 } _OrthancPluginCallHttpClient2;
5157 uint16_t* httpStatus,
5160 uint32_t headersCount,
5161 const char*
const* headersKeys,
5162 const char*
const* headersValues,
5165 const char* username,
5166 const char* password,
5168 const char* certificateFile,
5169 const char* certificateKeyFile,
5170 const char* certificateKeyPassword,
5173 _OrthancPluginCallHttpClient2 params;
5174 memset(¶ms, 0,
sizeof(params));
5176 params.answerBody = answerBody;
5177 params.answerHeaders = answerHeaders;
5178 params.httpStatus = httpStatus;
5179 params.method = method;
5181 params.headersCount = headersCount;
5182 params.headersKeys = headersKeys;
5183 params.headersValues = headersValues;
5185 params.bodySize = bodySize;
5186 params.username = username;
5187 params.password = password;
5188 params.timeout = timeout;
5189 params.certificateFile = certificateFile;
5190 params.certificateKeyFile = certificateKeyFile;
5191 params.certificateKeyPassword = certificateKeyPassword;
5192 params.pkcs11 = pkcs11;
5194 return context->InvokeService(context, _OrthancPluginService_CallHttpClient2, ¶ms);
5213 _OrthancPluginRetrieveDynamicString params;
5214 params.result = &result;
5215 params.argument = NULL;
5234 } _OrthancPluginFindCallback;
5251 _OrthancPluginFindCallback params;
5252 params.callback = callback;
5254 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback, ¶ms);
5265 uint32_t *resultUint32;
5266 uint16_t *resultGroup;
5267 uint16_t *resultElement;
5268 char **resultString;
5269 } _OrthancPluginFindOperation;
5292 _OrthancPluginFindOperation params;
5293 memset(¶ms, 0,
sizeof(params));
5294 params.answers = answers;
5295 params.dicom = dicom;
5298 return context->InvokeService(context, _OrthancPluginService_FindAddAnswer, ¶ms);
5319 _OrthancPluginFindOperation params;
5320 memset(¶ms, 0,
sizeof(params));
5321 params.answers = answers;
5323 return context->InvokeService(context, _OrthancPluginService_FindMarkIncomplete, ¶ms);
5345 _OrthancPluginFindOperation params;
5346 memset(¶ms, 0,
sizeof(params));
5347 params.query = query;
5348 params.resultUint32 = &count;
5383 _OrthancPluginFindOperation params;
5384 memset(¶ms, 0,
sizeof(params));
5385 params.query = query;
5386 params.index = index;
5387 params.resultGroup = group;
5388 params.resultElement = element;
5390 return context->InvokeService(context, _OrthancPluginService_GetFindQueryTag, ¶ms);
5414 _OrthancPluginFindOperation params;
5415 memset(¶ms, 0,
sizeof(params));
5416 params.query = query;
5417 params.index = index;
5418 params.resultString = &result;
5452 _OrthancPluginFindOperation params;
5453 memset(¶ms, 0,
sizeof(params));
5454 params.query = query;
5455 params.index = index;
5456 params.resultString = &result;
5478 } _OrthancPluginMoveCallback;
5500 _OrthancPluginMoveCallback params;
5501 params.callback = callback;
5502 params.getMoveSize = getMoveSize;
5503 params.applyMove = applyMove;
5504 params.freeMove = freeMove;
5506 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback, ¶ms);
5516 } _OrthancPluginCreateFindMatcher;
5539 _OrthancPluginCreateFindMatcher params;
5540 memset(¶ms, 0,
sizeof(params));
5541 params.target = ⌖
5542 params.query = query;
5559 } _OrthancPluginFreeFindMatcher;
5574 _OrthancPluginFreeFindMatcher params;
5575 params.matcher = matcher;
5577 context->InvokeService(context, _OrthancPluginService_FreeFindMatcher, ¶ms);
5587 } _OrthancPluginFindMatcherIsMatch;
5609 int32_t isMatch = 0;
5611 _OrthancPluginFindMatcherIsMatch params;
5612 params.matcher = matcher;
5613 params.dicom = dicom;
5615 params.isMatch = &isMatch;
5632 } _OrthancPluginIncomingHttpRequestFilter2;
5649 _OrthancPluginIncomingHttpRequestFilter2 params;
5650 params.callback = callback;
5652 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter2, ¶ms);
Definition: OrthancCPlugin.h:698
const char * OrthancPluginGetInstanceRemoteAet(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the AET of a DICOM instance.
Definition: OrthancCPlugin.h:2276
int OrthancPluginHasInstanceMetadata(OrthancPluginContext *context, OrthancPluginDicomInstance *instance, const char *metadata)
Check whether a DICOM instance is associated with some metadata.
Definition: OrthancCPlugin.h:2455
OrthancPluginChangeType
Definition: OrthancCPlugin.h:655
void OrthancPluginSendHttpStatusCode(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status)
Send a HTTP status code.
Definition: OrthancCPlugin.h:2139
void OrthancPluginSetHttpHeader(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *key, const char *value)
Set some HTTP header.
Definition: OrthancCPlugin.h:2240
OrthancPluginErrorCode OrthancPluginRegisterDecodeImageCallback(OrthancPluginContext *context, OrthancPluginDecodeImageCallback callback)
Register a callback to handle the decoding of DICOM images.
Definition: OrthancCPlugin.h:4746
The parameters of a REST request.
Definition: OrthancCPlugin.h:327
void OrthancPluginRedirect(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *redirection)
Redirect a REST request.
Definition: OrthancCPlugin.h:1922
OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:1827
const char * OrthancPluginGetInstanceData(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the data of a DICOM file.
Definition: OrthancCPlugin.h:2342
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:3524
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:3616
int OrthancPluginCheckVersion(OrthancPluginContext *context)
Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
Definition: OrthancCPlugin.h:1280
int64_t OrthancPluginGetInstanceSize(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the size of a DICOM file.
Definition: OrthancCPlugin.h:2309
Graylevel, unsigned 16bpp image.
Definition: OrthancCPlugin.h:556
Definition: OrthancCPlugin.h:670
const char *const * headersValues
The values of the HTTP headers.
Definition: OrthancCPlugin.h:387
const char *const * headersKeys
The keys of the HTTP headers (always converted to low-case).
Definition: OrthancCPlugin.h:382
OrthancPluginPixelFormat
Definition: OrthancCPlugin.h:540
uint32_t getCount
For a GET request, the number of GET parameters.
Definition: OrthancCPlugin.h:347
Definition: OrthancCPlugin.h:582
void OrthancPluginRegisterStorageArea(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove)
Register a custom storage area.
Definition: OrthancCPlugin.h:2541
OrthancPluginErrorCode OrthancPluginGetDicomForInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *instanceId)
Retrieve a DICOM instance using its Orthanc identifier.
Definition: OrthancCPlugin.h:1640
OrthancPluginImageFormat
Definition: OrthancCPlugin.h:695
const char * OrthancPluginGetFontName(OrthancPluginContext *context, uint32_t fontIndex)
Return the name of a font.
Definition: OrthancCPlugin.h:3896
OrthancPluginImage * OrthancPluginConvertPixelFormat(OrthancPluginContext *context, const OrthancPluginImage *source, OrthancPluginPixelFormat targetFormat)
Change the pixel format of an image.
Definition: OrthancCPlugin.h:3821
Definition: OrthancCPlugin.h:664
OrthancPluginErrorCode OrthancPluginStorageAreaRead(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Read a file from the storage area.
Definition: OrthancCPlugin.h:4075
uint32_t OrthancPluginGetFontsCount(OrthancPluginContext *context)
Return the number of available fonts.
Definition: OrthancCPlugin.h:3856
void OrthancPluginRegisterOnChangeCallback(OrthancPluginContext *context, OrthancPluginOnChangeCallback callback)
Register a callback to monitor changes.
Definition: OrthancCPlugin.h:2680
Color image in RGBA32 format.
Definition: OrthancCPlugin.h:580
void OrthancPluginSendMethodNotAllowed(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *allowedMethods)
Signal that this URI does not support this HTTP method.
Definition: OrthancCPlugin.h:2185
Definition: OrthancCPlugin.h:682
void OrthancPluginAnswerBuffer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *answer, uint32_t answerSize, const char *mimeType)
Answer to a REST request.
Definition: OrthancCPlugin.h:1542
Definition: OrthancCPlugin.h:658
OrthancPluginImage * OrthancPluginDecodeDicomImage(OrthancPluginContext *context, const void *buffer, uint32_t bufferSize, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:4872
uint16_t group
Definition: OrthancCPlugin.h:1239
void * OrthancPluginGetImageBuffer(OrthancPluginContext *context, const OrthancPluginImage *image)
Return a pointer to the content of an image.
Definition: OrthancCPlugin.h:3394
uint32_t minMultiplicity
Definition: OrthancCPlugin.h:1242
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:2493
Definition: OrthancCPlugin.h:697
struct _OrthancPluginStorageArea_t OrthancPluginStorageArea
Opaque structure that represents the storage area that is actually used by Orthanc.
Definition: OrthancCPlugin.h:872
Definition: OrthancCPlugin.h:662
Color image in RGB48 format.
Definition: OrthancCPlugin.h:590
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:1888
uint32_t OrthancPluginGetExpectedDatabaseVersion(OrthancPluginContext *context)
Get the expected version of the database schema.
Definition: OrthancCPlugin.h:2926
Graylevel 8bpp image.
Definition: OrthancCPlugin.h:548
uint32_t OrthancPluginGetImageHeight(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the height of an image.
Definition: OrthancCPlugin.h:3325
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:3223
OrthancPluginImage * OrthancPluginUncompressImage(OrthancPluginContext *context, const void *data, uint32_t size, OrthancPluginImageFormat format)
Decode a compressed image.
Definition: OrthancCPlugin.h:3437
OrthancPluginErrorCode(* OrthancPluginRestCallback)(OrthancPluginRestOutput *output, const char *url, const OrthancPluginHttpRequest *request)
Signature of a callback function that answers to a REST request.
Definition: OrthancCPlugin.h:920
Definition: OrthancCPlugin.h:683
Definition: OrthancCPlugin.h:685
Color image in RGB24 format.
Definition: OrthancCPlugin.h:572
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter2(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter2 callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:5645
Graylevel, signed 16bpp image.
Definition: OrthancCPlugin.h:564
An entry in the dictionary of DICOM tags.
Definition: OrthancCPlugin.h:1237
Definition: OrthancCPlugin.h:657
OrthancPluginCompressionType
Definition: OrthancCPlugin.h:680
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:4457
OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pixel format of an image.
Definition: OrthancCPlugin.h:3259
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:3981
uint32_t OrthancPluginGetImagePitch(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pitch of an image.
Definition: OrthancCPlugin.h:3360
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:1599
uint32_t maxMultiplicity
Definition: OrthancCPlugin.h:1243
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:952
void OrthancPluginSendUnauthorized(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *realm)
Signal that a REST request is not authorized.
Definition: OrthancCPlugin.h:2162
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:834
uint32_t OrthancPluginGetFontSize(OrthancPluginContext *context, uint32_t fontIndex)
Return the size of a font.
Definition: OrthancCPlugin.h:3928
OrthancPluginErrorCode OrthancPluginRestApiGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:1673
uint32_t headersCount
The number of HTTP headers.
Definition: OrthancCPlugin.h:377
Definition: OrthancCPlugin.h:663
OrthancPluginErrorCode(* OrthancPluginStorageCreate)(const char *uuid, const void *content, int64_t size, OrthancPluginContentType type)
Callback for writing to the storage area.
Definition: OrthancCPlugin.h:979
OrthancPluginErrorCode OrthancPluginRestApiDelete(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:1804
OrthancPluginImage * OrthancPluginCreateImage(OrthancPluginContext *context, OrthancPluginPixelFormat format, uint32_t width, uint32_t height)
Create an image.
Definition: OrthancCPlugin.h:4784
char * OrthancPluginGetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *defaultValue)
Get the value of a global property.
Definition: OrthancCPlugin.h:2789
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:5043
OrthancPluginErrorCode(* OrthancPluginStorageRemove)(const char *uuid, OrthancPluginContentType type)
Callback for removing a file from the storage area.
Definition: OrthancCPlugin.h:1017
Definition: OrthancCPlugin.h:665
OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, OrthancPluginResourceType level)
Reconstruct the main DICOM tags.
Definition: OrthancCPlugin.h:4306
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:4827
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:5081
const char *const * getValues
For a GET request, the values of the GET parameters.
Definition: OrthancCPlugin.h:357
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:941
char * OrthancPluginGetInstanceSimplifiedJson(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file (with simplification).
Definition: OrthancCPlugin.h:2416
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:3071
Definition: OrthancCPlugin.h:699
const char * body
For a PUT or POST request, the content of the body.
Definition: OrthancCPlugin.h:362
void OrthancPluginRegisterRestCallbackNoLock(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback, without locking.
Definition: OrthancCPlugin.h:1482
Definition: OrthancCPlugin.h:668
struct _OrthancPluginImage_t OrthancPluginImage
Opaque structure that represents an image that is uncompressed in memory.
Definition: OrthancCPlugin.h:864
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:1852
OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *subType, const char *contentType)
Start an HTTP multipart answer.
Definition: OrthancCPlugin.h:3000
OrthancPluginErrorCode OrthancPluginStorageAreaRemove(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Remove a file from the storage area.
Definition: OrthancCPlugin.h:4112
Definition: OrthancCPlugin.h:669
const char *const * getKeys
For a GET request, the keys of the GET parameters.
Definition: OrthancCPlugin.h:352
Definition: OrthancCPlugin.h:660
char * OrthancPluginLookupPatient(OrthancPluginContext *context, const char *patientID)
Look for a patient.
Definition: OrthancCPlugin.h:1954
OrthancPluginInstanceOrigin OrthancPluginGetInstanceOrigin(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the origin of a DICOM file.
Definition: OrthancCPlugin.h:4664
void OrthancPluginFreeImage(OrthancPluginContext *context, OrthancPluginImage *image)
Free an image.
Definition: OrthancCPlugin.h:3479
OrthancPluginValueRepresentation vr
Definition: OrthancCPlugin.h:1241
uint16_t element
Definition: OrthancCPlugin.h:1240
char * OrthancPluginLookupInstance(OrthancPluginContext *context, const char *sopInstanceUID)
Look for an instance.
Definition: OrthancCPlugin.h:2094
Definition: OrthancCPlugin.h:667
OrthancPluginErrorCode OrthancPluginSetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *value)
Set the value of a global property.
Definition: OrthancCPlugin.h:2828
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:3029
const char *const * groups
The matched values for the groups of the regular expression.
Definition: OrthancCPlugin.h:342
OrthancPluginErrorCode(* OrthancPluginStorageRead)(void **content, int64_t *size, const char *uuid, OrthancPluginContentType type)
Callback for reading from the storage area.
Definition: OrthancCPlugin.h:999
char * OrthancPluginLookupStudy(OrthancPluginContext *context, const char *studyUID)
Look for a study.
Definition: OrthancCPlugin.h:1989
uint32_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:839
Graylevel, floating-point 32bpp image.
Definition: OrthancCPlugin.h:606
uint32_t groupsCount
The number of groups of the regular expression.
Definition: OrthancCPlugin.h:337
uint32_t bodySize
For a PUT or POST request, the number of bytes of the body.
Definition: OrthancCPlugin.h:367
void OrthancPluginSetCookie(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *cookie, const char *value)
Set a cookie.
Definition: OrthancCPlugin.h:2215
Definition: OrthancCPlugin.h:659
char * OrthancPluginGetInstanceJson(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file.
Definition: OrthancCPlugin.h:2378
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:1740
void OrthancPluginRegisterOnStoredInstanceCallback(OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback)
Register a callback for received instances.
Definition: OrthancCPlugin.h:1510
Definition: OrthancCPlugin.h:661
Graylevel, unsigned 32bpp image.
Definition: OrthancCPlugin.h:598
void OrthancPluginRegisterRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback.
Definition: OrthancCPlugin.h:1448
char * OrthancPluginLookupStudyWithAccessionNumber(OrthancPluginContext *context, const char *accessionNumber)
Look for a study, using the accession number.
Definition: OrthancCPlugin.h:2024
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:1703
OrthancPluginErrorCode(* OrthancPluginOnStoredInstanceCallback)(OrthancPluginDicomInstance *instance, const char *instanceId)
Signature of a callback function that is triggered when Orthanc receives a DICOM instance.
Definition: OrthancCPlugin.h:931
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:1775
Definition: OrthancCPlugin.h:666
Definition: OrthancCPlugin.h:684
OrthancPluginHttpMethod method
The HTTP method.
Definition: OrthancCPlugin.h:332
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:4033
A memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:829
Color image in BGRA32 format.
Definition: OrthancCPlugin.h:614
char * OrthancPluginLookupSeries(OrthancPluginContext *context, const char *seriesUID)
Look for a series.
Definition: OrthancCPlugin.h:2059
uint32_t OrthancPluginGetImageWidth(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the width of an image.
Definition: OrthancCPlugin.h:3292
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:3569