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 4 121 #define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 0 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 299 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
307 ORTHANC_PLUGINS_API
const char* OrthancPluginGetName();
320 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
396 _OrthancPluginService_LogInfo = 1,
397 _OrthancPluginService_LogWarning = 2,
398 _OrthancPluginService_LogError = 3,
399 _OrthancPluginService_GetOrthancPath = 4,
400 _OrthancPluginService_GetOrthancDirectory = 5,
401 _OrthancPluginService_GetConfigurationPath = 6,
402 _OrthancPluginService_SetPluginProperty = 7,
403 _OrthancPluginService_GetGlobalProperty = 8,
404 _OrthancPluginService_SetGlobalProperty = 9,
405 _OrthancPluginService_GetCommandLineArgumentsCount = 10,
406 _OrthancPluginService_GetCommandLineArgument = 11,
407 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
408 _OrthancPluginService_GetConfiguration = 13,
409 _OrthancPluginService_BufferCompression = 14,
410 _OrthancPluginService_ReadFile = 15,
411 _OrthancPluginService_WriteFile = 16,
412 _OrthancPluginService_GetErrorDescription = 17,
413 _OrthancPluginService_CallHttpClient = 18,
414 _OrthancPluginService_RegisterErrorCode = 19,
415 _OrthancPluginService_RegisterDictionaryTag = 20,
416 _OrthancPluginService_DicomBufferToJson = 21,
417 _OrthancPluginService_DicomInstanceToJson = 22,
418 _OrthancPluginService_CreateDicom = 23,
419 _OrthancPluginService_ComputeMd5 = 24,
420 _OrthancPluginService_ComputeSha1 = 25,
421 _OrthancPluginService_LookupDictionary = 26,
422 _OrthancPluginService_CallHttpClient2 = 27,
423 _OrthancPluginService_GenerateUuid = 28,
424 _OrthancPluginService_RegisterPrivateDictionaryTag = 29,
427 _OrthancPluginService_RegisterRestCallback = 1000,
428 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
429 _OrthancPluginService_RegisterStorageArea = 1002,
430 _OrthancPluginService_RegisterOnChangeCallback = 1003,
431 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
432 _OrthancPluginService_RegisterWorklistCallback = 1005,
433 _OrthancPluginService_RegisterDecodeImageCallback = 1006,
434 _OrthancPluginService_RegisterIncomingHttpRequestFilter = 1007,
435 _OrthancPluginService_RegisterFindCallback = 1008,
436 _OrthancPluginService_RegisterMoveCallback = 1009,
437 _OrthancPluginService_RegisterIncomingHttpRequestFilter2 = 1010,
440 _OrthancPluginService_AnswerBuffer = 2000,
441 _OrthancPluginService_CompressAndAnswerPngImage = 2001,
442 _OrthancPluginService_Redirect = 2002,
443 _OrthancPluginService_SendHttpStatusCode = 2003,
444 _OrthancPluginService_SendUnauthorized = 2004,
445 _OrthancPluginService_SendMethodNotAllowed = 2005,
446 _OrthancPluginService_SetCookie = 2006,
447 _OrthancPluginService_SetHttpHeader = 2007,
448 _OrthancPluginService_StartMultipartAnswer = 2008,
449 _OrthancPluginService_SendMultipartItem = 2009,
450 _OrthancPluginService_SendHttpStatus = 2010,
451 _OrthancPluginService_CompressAndAnswerImage = 2011,
452 _OrthancPluginService_SendMultipartItem2 = 2012,
455 _OrthancPluginService_GetDicomForInstance = 3000,
456 _OrthancPluginService_RestApiGet = 3001,
457 _OrthancPluginService_RestApiPost = 3002,
458 _OrthancPluginService_RestApiDelete = 3003,
459 _OrthancPluginService_RestApiPut = 3004,
460 _OrthancPluginService_LookupPatient = 3005,
461 _OrthancPluginService_LookupStudy = 3006,
462 _OrthancPluginService_LookupSeries = 3007,
463 _OrthancPluginService_LookupInstance = 3008,
464 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
465 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
466 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
467 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
468 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
469 _OrthancPluginService_ReconstructMainDicomTags = 3014,
470 _OrthancPluginService_RestApiGet2 = 3015,
473 _OrthancPluginService_GetInstanceRemoteAet = 4000,
474 _OrthancPluginService_GetInstanceSize = 4001,
475 _OrthancPluginService_GetInstanceData = 4002,
476 _OrthancPluginService_GetInstanceJson = 4003,
477 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
478 _OrthancPluginService_HasInstanceMetadata = 4005,
479 _OrthancPluginService_GetInstanceMetadata = 4006,
480 _OrthancPluginService_GetInstanceOrigin = 4007,
483 _OrthancPluginService_RegisterDatabaseBackend = 5000,
484 _OrthancPluginService_DatabaseAnswer = 5001,
485 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002,
486 _OrthancPluginService_StorageAreaCreate = 5003,
487 _OrthancPluginService_StorageAreaRead = 5004,
488 _OrthancPluginService_StorageAreaRemove = 5005,
491 _OrthancPluginService_GetImagePixelFormat = 6000,
492 _OrthancPluginService_GetImageWidth = 6001,
493 _OrthancPluginService_GetImageHeight = 6002,
494 _OrthancPluginService_GetImagePitch = 6003,
495 _OrthancPluginService_GetImageBuffer = 6004,
496 _OrthancPluginService_UncompressImage = 6005,
497 _OrthancPluginService_FreeImage = 6006,
498 _OrthancPluginService_CompressImage = 6007,
499 _OrthancPluginService_ConvertPixelFormat = 6008,
500 _OrthancPluginService_GetFontsCount = 6009,
501 _OrthancPluginService_GetFontInfo = 6010,
502 _OrthancPluginService_DrawText = 6011,
503 _OrthancPluginService_CreateImage = 6012,
504 _OrthancPluginService_CreateImageAccessor = 6013,
505 _OrthancPluginService_DecodeDicomImage = 6014,
508 _OrthancPluginService_WorklistAddAnswer = 7000,
509 _OrthancPluginService_WorklistMarkIncomplete = 7001,
510 _OrthancPluginService_WorklistIsMatch = 7002,
511 _OrthancPluginService_WorklistGetDicomQuery = 7003,
512 _OrthancPluginService_FindAddAnswer = 7004,
513 _OrthancPluginService_FindMarkIncomplete = 7005,
514 _OrthancPluginService_GetFindQuerySize = 7006,
515 _OrthancPluginService_GetFindQueryTag = 7007,
516 _OrthancPluginService_GetFindQueryTagName = 7008,
517 _OrthancPluginService_GetFindQueryValue = 7009,
518 _OrthancPluginService_CreateFindMatcher = 7010,
519 _OrthancPluginService_FreeFindMatcher = 7011,
520 _OrthancPluginService_FindMatcherIsMatch = 7012,
522 _OrthancPluginService_INTERNAL = 0x7fffffff
523 } _OrthancPluginService;
528 _OrthancPluginProperty_Description = 1,
529 _OrthancPluginProperty_RootUri = 2,
530 _OrthancPluginProperty_OrthancExplorer = 3,
532 _OrthancPluginProperty_INTERNAL = 0x7fffffff
533 } _OrthancPluginProperty;
625 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
639 _OrthancPluginContentType_INTERNAL = 0x7fffffff
655 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
681 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
696 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
710 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
748 _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff
763 _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff
774 OrthancPluginDicomToJsonFlags_None = 0,
782 _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff
793 OrthancPluginCreateDicomFlags_None = 0,
797 _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff
812 _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff
827 _OrthancPluginInstanceOrigin_INTERNAL = 0x7fffffff
942 const char* instanceId);
953 const char* resourceId);
965 uint32_t frameIndex);
1048 const char* issuerAet,
1049 const char* calledAet);
1076 uint32_t headersCount,
1077 const char*
const* headersKeys,
1078 const char*
const* headersValues);
1107 uint32_t headersCount,
1108 const char*
const* headersKeys,
1109 const char*
const* headersValues,
1110 uint32_t getArgumentsCount,
1111 const char*
const* getArgumentsKeys,
1112 const char*
const* getArgumentsValues);
1133 const char* issuerAet,
1134 const char* calledAet);
1173 typedef void* (*OrthancPluginMoveCallback) (
1175 const char* patientId,
1176 const char* accessionNumber,
1177 const char* studyInstanceUid,
1178 const char* seriesInstanceUid,
1179 const char* sopInstanceUid,
1180 const char* originatorAet,
1181 const char* sourceAet,
1182 const char* targetAet,
1183 uint16_t originatorId);
1231 typedef struct _OrthancPluginContext_t
1233 void* pluginsManager;
1234 const char* orthancVersion;
1237 _OrthancPluginService service,
1238 const void* params);
1296 int expectedRevision)
1298 int major, minor, revision;
1302 sizeof(int32_t) !=
sizeof(_OrthancPluginService) ||
1303 sizeof(int32_t) !=
sizeof(_OrthancPluginProperty) ||
1322 if (!strcmp(context->orthancVersion,
"mainline"))
1334 (context->orthancVersion,
"%4d.%4d.%4d", &major, &minor, &revision) != 3)
1341 if (major > expectedMajor)
1346 if (major < expectedMajor)
1353 if (minor > expectedMinor)
1358 if (minor < expectedMinor)
1365 if (revision >= expectedRevision)
1397 ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER,
1398 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER,
1399 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER);
1415 context->Free(buffer->
data);
1429 const char* message)
1431 context->InvokeService(context, _OrthancPluginService_LogError, message);
1445 const char* message)
1447 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
1461 const char* message)
1463 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
1470 const char* pathRegularExpression;
1472 } _OrthancPluginRestCallback;
1492 const char* pathRegularExpression,
1495 _OrthancPluginRestCallback params;
1496 params.pathRegularExpression = pathRegularExpression;
1497 params.callback = callback;
1498 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
1526 const char* pathRegularExpression,
1529 _OrthancPluginRestCallback params;
1530 params.pathRegularExpression = pathRegularExpression;
1531 params.callback = callback;
1532 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms);
1540 } _OrthancPluginOnStoredInstanceCallback;
1556 _OrthancPluginOnStoredInstanceCallback params;
1557 params.callback = callback;
1559 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
1568 uint32_t answerSize;
1569 const char* mimeType;
1570 } _OrthancPluginAnswerBuffer;
1588 uint32_t answerSize,
1589 const char* mimeType)
1591 _OrthancPluginAnswerBuffer params;
1592 params.output = output;
1593 params.answer = answer;
1594 params.answerSize = answerSize;
1595 params.mimeType = mimeType;
1596 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms);
1608 } _OrthancPluginCompressAndAnswerPngImage;
1620 } _OrthancPluginCompressAndAnswerImage;
1650 _OrthancPluginCompressAndAnswerImage params;
1651 params.output = output;
1653 params.pixelFormat = format;
1654 params.width = width;
1655 params.height = height;
1656 params.pitch = pitch;
1657 params.buffer = buffer;
1659 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
1667 const char* instanceId;
1668 } _OrthancPluginGetDicomForInstance;
1685 const char* instanceId)
1687 _OrthancPluginGetDicomForInstance params;
1688 params.target = target;
1689 params.instanceId = instanceId;
1690 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
1699 } _OrthancPluginRestApiGet;
1720 _OrthancPluginRestApiGet params;
1721 params.target = target;
1723 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
1750 _OrthancPluginRestApiGet params;
1751 params.target = target;
1753 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms);
1764 } _OrthancPluginRestApiPostPut;
1789 _OrthancPluginRestApiPostPut params;
1790 params.target = target;
1793 params.bodySize = bodySize;
1794 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
1824 _OrthancPluginRestApiPostPut params;
1825 params.target = target;
1828 params.bodySize = bodySize;
1829 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms);
1850 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
1873 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
1901 _OrthancPluginRestApiPostPut params;
1902 params.target = target;
1905 params.bodySize = bodySize;
1906 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
1937 _OrthancPluginRestApiPostPut params;
1938 params.target = target;
1941 params.bodySize = bodySize;
1942 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms);
1950 const char* argument;
1951 } _OrthancPluginOutputPlusArgument;
1967 const char* redirection)
1969 _OrthancPluginOutputPlusArgument params;
1970 params.output = output;
1971 params.argument = redirection;
1972 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
1980 const char* argument;
1981 } _OrthancPluginRetrieveDynamicString;
1998 const char* patientID)
2002 _OrthancPluginRetrieveDynamicString params;
2003 params.result = &result;
2004 params.argument = patientID;
2033 const char* studyUID)
2037 _OrthancPluginRetrieveDynamicString params;
2038 params.result = &result;
2039 params.argument = studyUID;
2068 const char* accessionNumber)
2072 _OrthancPluginRetrieveDynamicString params;
2073 params.result = &result;
2074 params.argument = accessionNumber;
2103 const char* seriesUID)
2107 _OrthancPluginRetrieveDynamicString params;
2108 params.result = &result;
2109 params.argument = seriesUID;
2138 const char* sopInstanceUID)
2142 _OrthancPluginRetrieveDynamicString params;
2143 params.result = &result;
2144 params.argument = sopInstanceUID;
2163 } _OrthancPluginSendHttpStatusCode;
2186 _OrthancPluginSendHttpStatusCode params;
2187 params.output = output;
2188 params.status = status;
2189 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
2209 _OrthancPluginOutputPlusArgument params;
2210 params.output = output;
2211 params.argument = realm;
2212 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
2230 const char* allowedMethods)
2232 _OrthancPluginOutputPlusArgument params;
2233 params.output = output;
2234 params.argument = allowedMethods;
2235 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
2244 } _OrthancPluginSetHttpHeader;
2263 _OrthancPluginSetHttpHeader params;
2264 params.output = output;
2265 params.key = cookie;
2266 params.value = value;
2267 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
2288 _OrthancPluginSetHttpHeader params;
2289 params.output = output;
2291 params.value = value;
2292 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
2298 char** resultStringToFree;
2299 const char** resultString;
2300 int64_t* resultInt64;
2304 } _OrthancPluginAccessDicomInstance;
2324 _OrthancPluginAccessDicomInstance params;
2325 memset(¶ms, 0,
sizeof(params));
2326 params.resultString = &result;
2327 params.instance = instance;
2357 _OrthancPluginAccessDicomInstance params;
2358 memset(¶ms, 0,
sizeof(params));
2359 params.resultInt64 = &size;
2360 params.instance = instance;
2390 _OrthancPluginAccessDicomInstance params;
2391 memset(¶ms, 0,
sizeof(params));
2392 params.resultString = &result;
2393 params.instance = instance;
2426 _OrthancPluginAccessDicomInstance params;
2427 memset(¶ms, 0,
sizeof(params));
2428 params.resultStringToFree = &result;
2429 params.instance = instance;
2464 _OrthancPluginAccessDicomInstance params;
2465 memset(¶ms, 0,
sizeof(params));
2466 params.resultStringToFree = &result;
2467 params.instance = instance;
2500 const char* metadata)
2504 _OrthancPluginAccessDicomInstance params;
2505 memset(¶ms, 0,
sizeof(params));
2506 params.resultInt64 = &result;
2507 params.instance = instance;
2508 params.key = metadata;
2517 return (result != 0);
2538 const char* metadata)
2542 _OrthancPluginAccessDicomInstance params;
2543 memset(¶ms, 0,
sizeof(params));
2544 params.resultString = &result;
2545 params.instance = instance;
2546 params.key = metadata;
2567 } _OrthancPluginRegisterStorageArea;
2589 _OrthancPluginRegisterStorageArea params;
2590 params.create = create;
2592 params.remove =
remove;
2595 params.free = ::free;
2600 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
2619 _OrthancPluginRetrieveDynamicString params;
2620 params.result = &result;
2621 params.argument = NULL;
2649 _OrthancPluginRetrieveDynamicString params;
2650 params.result = &result;
2651 params.argument = NULL;
2684 _OrthancPluginRetrieveDynamicString params;
2685 params.result = &result;
2686 params.argument = NULL;
2704 } _OrthancPluginOnChangeCallback;
2726 _OrthancPluginOnChangeCallback params;
2727 params.callback = callback;
2729 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms);
2737 _OrthancPluginProperty property;
2739 } _OrthancPluginSetPluginProperty;
2757 _OrthancPluginSetPluginProperty params;
2758 params.plugin = OrthancPluginGetName();
2759 params.property = _OrthancPluginProperty_RootUri;
2762 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
2777 const char* description)
2779 _OrthancPluginSetPluginProperty params;
2780 params.plugin = OrthancPluginGetName();
2781 params.property = _OrthancPluginProperty_Description;
2782 params.value = description;
2784 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
2799 const char* javascript)
2801 _OrthancPluginSetPluginProperty params;
2802 params.plugin = OrthancPluginGetName();
2803 params.property = _OrthancPluginProperty_OrthancExplorer;
2804 params.value = javascript;
2806 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
2815 } _OrthancPluginGlobalProperty;
2834 const char* defaultValue)
2838 _OrthancPluginGlobalProperty params;
2839 params.result = &result;
2840 params.property = property;
2841 params.value = defaultValue;
2875 _OrthancPluginGlobalProperty params;
2876 params.result = NULL;
2877 params.property = property;
2878 params.value = value;
2880 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms);
2887 int32_t *resultInt32;
2888 uint32_t *resultUint32;
2889 int64_t *resultInt64;
2890 uint64_t *resultUint64;
2891 } _OrthancPluginReturnSingleValue;
2906 _OrthancPluginReturnSingleValue params;
2907 memset(¶ms, 0,
sizeof(params));
2908 params.resultUint32 = &count;
2941 _OrthancPluginGlobalProperty params;
2942 params.result = &result;
2943 params.property = (int32_t) argument;
2944 params.value = NULL;
2972 _OrthancPluginReturnSingleValue params;
2973 memset(¶ms, 0,
sizeof(params));
2974 params.resultUint32 = &count;
3004 _OrthancPluginRetrieveDynamicString params;
3005 params.result = &result;
3006 params.argument = NULL;
3024 const char* subType;
3025 const char* contentType;
3026 } _OrthancPluginStartMultipartAnswer;
3044 const char* subType,
3045 const char* contentType)
3047 _OrthancPluginStartMultipartAnswer params;
3048 params.output = output;
3049 params.subType = subType;
3050 params.contentType = contentType;
3051 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms);
3074 uint32_t answerSize)
3076 _OrthancPluginAnswerBuffer params;
3077 params.output = output;
3078 params.answer = answer;
3079 params.answerSize = answerSize;
3080 params.mimeType = NULL;
3081 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms);
3093 } _OrthancPluginBufferCompression;
3120 _OrthancPluginBufferCompression params;
3121 params.target = target;
3122 params.source = source;
3124 params.compression = compression;
3125 params.uncompress = uncompress;
3127 return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms);
3136 } _OrthancPluginReadFile;
3154 _OrthancPluginReadFile params;
3155 params.target = target;
3157 return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms);
3167 } _OrthancPluginWriteFile;
3186 _OrthancPluginWriteFile params;
3190 return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms);
3197 const char** target;
3199 } _OrthancPluginGetErrorDescription;
3215 const char* result = NULL;
3217 _OrthancPluginGetErrorDescription params;
3218 params.target = &result;
3219 params.error = error;
3224 return "Unknown error code";
3240 } _OrthancPluginSendHttpStatus;
3271 _OrthancPluginSendHttpStatus params;
3272 params.output = output;
3273 params.status = status;
3275 params.bodySize = bodySize;
3276 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms);
3284 uint32_t* resultUint32;
3286 void** resultBuffer;
3287 } _OrthancPluginGetImageInfo;
3306 _OrthancPluginGetImageInfo params;
3307 memset(¶ms, 0,
sizeof(params));
3308 params.image = image;
3309 params.resultPixelFormat = ⌖
3339 _OrthancPluginGetImageInfo params;
3340 memset(¶ms, 0,
sizeof(params));
3341 params.image = image;
3342 params.resultUint32 = &width;
3372 _OrthancPluginGetImageInfo params;
3373 memset(¶ms, 0,
sizeof(params));
3374 params.image = image;
3375 params.resultUint32 = &height;
3407 _OrthancPluginGetImageInfo params;
3408 memset(¶ms, 0,
sizeof(params));
3409 params.image = image;
3410 params.resultUint32 = &pitch;
3439 void* target = NULL;
3441 _OrthancPluginGetImageInfo params;
3442 memset(¶ms, 0,
sizeof(params));
3443 params.resultBuffer = ⌖
3444 params.image = image;
3463 } _OrthancPluginUncompressImage;
3486 _OrthancPluginUncompressImage params;
3487 memset(¶ms, 0,
sizeof(params));
3488 params.target = ⌖
3491 params.format = format;
3509 } _OrthancPluginFreeImage;
3524 _OrthancPluginFreeImage params;
3525 params.image = image;
3527 context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms);
3543 } _OrthancPluginCompressImage;
3574 _OrthancPluginCompressImage params;
3575 memset(¶ms, 0,
sizeof(params));
3576 params.target = target;
3578 params.pixelFormat = format;
3579 params.width = width;
3580 params.height = height;
3581 params.pitch = pitch;
3582 params.buffer = buffer;
3585 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
3620 _OrthancPluginCompressImage params;
3621 memset(¶ms, 0,
sizeof(params));
3622 params.target = target;
3624 params.pixelFormat = format;
3625 params.width = width;
3626 params.height = height;
3627 params.pitch = pitch;
3628 params.buffer = buffer;
3629 params.quality = quality;
3631 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
3667 _OrthancPluginCompressAndAnswerImage params;
3668 params.output = output;
3670 params.pixelFormat = format;
3671 params.width = width;
3672 params.height = height;
3673 params.pitch = pitch;
3674 params.buffer = buffer;
3675 params.quality = quality;
3676 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
3687 const char* username;
3688 const char* password;
3691 } _OrthancPluginCallHttpClient;
3713 const char* username,
3714 const char* password)
3716 _OrthancPluginCallHttpClient params;
3717 memset(¶ms, 0,
sizeof(params));
3719 params.target = target;
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);
3793 const char* username,
3794 const char* password)
3796 _OrthancPluginCallHttpClient params;
3797 memset(¶ms, 0,
sizeof(params));
3799 params.target = target;
3803 params.bodySize = bodySize;
3804 params.username = username;
3805 params.password = password;
3807 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3827 const char* username,
3828 const char* password)
3830 _OrthancPluginCallHttpClient params;
3831 memset(¶ms, 0,
sizeof(params));
3835 params.username = username;
3836 params.password = password;
3838 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
3848 } _OrthancPluginConvertPixelFormat;
3869 _OrthancPluginConvertPixelFormat params;
3870 params.target = ⌖
3871 params.source = source;
3872 params.targetFormat = targetFormat;
3902 _OrthancPluginReturnSingleValue params;
3903 memset(¶ms, 0,
sizeof(params));
3904 params.resultUint32 = &count;
3925 } _OrthancPluginGetFontInfo;
3941 const char* result = NULL;
3943 _OrthancPluginGetFontInfo params;
3944 memset(¶ms, 0,
sizeof(params));
3945 params.name = &result;
3946 params.fontIndex = fontIndex;
3975 _OrthancPluginGetFontInfo params;
3976 memset(¶ms, 0,
sizeof(params));
3977 params.size = &result;
3978 params.fontIndex = fontIndex;
3996 const char* utf8Text;
4002 } _OrthancPluginDrawText;
4026 const char* utf8Text,
4033 _OrthancPluginDrawText params;
4034 memset(¶ms, 0,
sizeof(params));
4035 params.image = image;
4036 params.fontIndex = fontIndex;
4037 params.utf8Text = utf8Text;
4044 return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms);
4053 const void* content;
4056 } _OrthancPluginStorageAreaCreate;
4078 const void* content,
4082 _OrthancPluginStorageAreaCreate params;
4083 params.storageArea = storageArea;
4085 params.content = content;
4089 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms);
4099 } _OrthancPluginStorageAreaRead;
4123 _OrthancPluginStorageAreaRead params;
4124 params.target = target;
4125 params.storageArea = storageArea;
4129 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms);
4138 } _OrthancPluginStorageAreaRemove;
4159 _OrthancPluginStorageAreaRemove params;
4160 params.storageArea = storageArea;
4164 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms);
4173 uint16_t httpStatus;
4174 const char* message;
4175 } _OrthancPluginRegisterErrorCode;
4195 uint16_t httpStatus,
4196 const char* message)
4200 _OrthancPluginRegisterErrorCode params;
4201 params.target = ⌖
4203 params.httpStatus = httpStatus;
4204 params.message = message;
4225 uint32_t minMultiplicity;
4226 uint32_t maxMultiplicity;
4227 } _OrthancPluginRegisterDictionaryTag;
4254 uint32_t minMultiplicity,
4255 uint32_t maxMultiplicity)
4257 _OrthancPluginRegisterDictionaryTag params;
4258 params.group = group;
4259 params.element = element;
4262 params.minMultiplicity = minMultiplicity;
4263 params.maxMultiplicity = maxMultiplicity;
4265 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, ¶ms);
4276 uint32_t minMultiplicity;
4277 uint32_t maxMultiplicity;
4278 const char* privateCreator;
4279 } _OrthancPluginRegisterPrivateDictionaryTag;
4307 uint32_t minMultiplicity,
4308 uint32_t maxMultiplicity,
4309 const char* privateCreator)
4311 _OrthancPluginRegisterPrivateDictionaryTag params;
4312 params.group = group;
4313 params.element = element;
4316 params.minMultiplicity = minMultiplicity;
4317 params.maxMultiplicity = maxMultiplicity;
4318 params.privateCreator = privateCreator;
4320 return context->InvokeService(context, _OrthancPluginService_RegisterPrivateDictionaryTag, ¶ms);
4329 } _OrthancPluginReconstructMainDicomTags;
4350 _OrthancPluginReconstructMainDicomTags params;
4351 params.level = level;
4352 params.storageArea = storageArea;
4354 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, ¶ms);
4361 const char* instanceId;
4366 uint32_t maxStringLength;
4367 } _OrthancPluginDicomToJson;
4395 uint32_t maxStringLength)
4399 _OrthancPluginDicomToJson params;
4400 memset(¶ms, 0,
sizeof(params));
4401 params.result = &result;
4402 params.buffer = buffer;
4404 params.format = format;
4405 params.flags = flags;
4406 params.maxStringLength = maxStringLength;
4440 const char* instanceId,
4443 uint32_t maxStringLength)
4447 _OrthancPluginDicomToJson params;
4448 memset(¶ms, 0,
sizeof(params));
4449 params.result = &result;
4450 params.instanceId = instanceId;
4451 params.format = format;
4452 params.flags = flags;
4453 params.maxStringLength = maxStringLength;
4471 uint32_t headersCount;
4472 const char*
const* headersKeys;
4473 const char*
const* headersValues;
4474 int32_t afterPlugins;
4475 } _OrthancPluginRestApiGet2;
4500 uint32_t headersCount,
4501 const char*
const* headersKeys,
4502 const char*
const* headersValues,
4503 int32_t afterPlugins)
4505 _OrthancPluginRestApiGet2 params;
4506 params.target = target;
4508 params.headersCount = headersCount;
4509 params.headersKeys = headersKeys;
4510 params.headersValues = headersValues;
4511 params.afterPlugins = afterPlugins;
4513 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, ¶ms);
4521 } _OrthancPluginWorklistCallback;
4538 _OrthancPluginWorklistCallback params;
4539 params.callback = callback;
4541 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, ¶ms);
4552 } _OrthancPluginWorklistAnswersOperation;
4577 _OrthancPluginWorklistAnswersOperation params;
4578 params.answers = answers;
4579 params.query = query;
4580 params.dicom = dicom;
4583 return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, ¶ms);
4604 _OrthancPluginWorklistAnswersOperation params;
4605 params.answers = answers;
4606 params.query = NULL;
4607 params.dicom = NULL;
4610 return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, ¶ms);
4621 } _OrthancPluginWorklistQueryOperation;
4644 int32_t isMatch = 0;
4646 _OrthancPluginWorklistQueryOperation params;
4647 params.query = query;
4648 params.dicom = dicom;
4650 params.isMatch = &isMatch;
4651 params.target = NULL;
4682 _OrthancPluginWorklistQueryOperation params;
4683 params.query = query;
4684 params.dicom = NULL;
4686 params.isMatch = NULL;
4687 params.target = target;
4689 return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, ¶ms);
4709 _OrthancPluginAccessDicomInstance params;
4710 memset(¶ms, 0,
sizeof(params));
4711 params.resultOrigin = &origin;
4712 params.instance = instance;
4732 } _OrthancPluginCreateDicom;
4759 _OrthancPluginCreateDicom params;
4760 params.target = target;
4762 params.pixelData = pixelData;
4763 params.flags = flags;
4765 return context->InvokeService(context, _OrthancPluginService_CreateDicom, ¶ms);
4772 } _OrthancPluginDecodeImageCallback;
4789 _OrthancPluginDecodeImageCallback params;
4790 params.callback = callback;
4792 return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, ¶ms);
4805 const void* constBuffer;
4806 uint32_t bufferSize;
4807 uint32_t frameIndex;
4808 } _OrthancPluginCreateImage;
4831 _OrthancPluginCreateImage params;
4832 memset(¶ms, 0,
sizeof(params));
4833 params.target = ⌖
4834 params.format = format;
4835 params.width = width;
4836 params.height = height;
4876 _OrthancPluginCreateImage params;
4877 memset(¶ms, 0,
sizeof(params));
4878 params.target = ⌖
4879 params.format = format;
4880 params.width = width;
4881 params.height = height;
4882 params.pitch = pitch;
4883 params.buffer = buffer;
4914 uint32_t bufferSize,
4915 uint32_t frameIndex)
4919 _OrthancPluginCreateImage params;
4920 memset(¶ms, 0,
sizeof(params));
4921 params.target = ⌖
4922 params.constBuffer = buffer;
4923 params.bufferSize = bufferSize;
4924 params.frameIndex = frameIndex;
4943 } _OrthancPluginComputeHash;
4964 _OrthancPluginComputeHash params;
4965 params.result = &result;
4966 params.buffer = buffer;
5000 _OrthancPluginComputeHash params;
5001 params.result = &result;
5002 params.buffer = buffer;
5022 } _OrthancPluginLookupDictionary;
5044 _OrthancPluginLookupDictionary params;
5045 params.target = target;
5047 return context->InvokeService(context, _OrthancPluginService_LookupDictionary, ¶ms);
5056 uint32_t answerSize;
5057 uint32_t headersCount;
5058 const char*
const* headersKeys;
5059 const char*
const* headersValues;
5060 } _OrthancPluginSendMultipartItem2;
5086 uint32_t answerSize,
5087 uint32_t headersCount,
5088 const char*
const* headersKeys,
5089 const char*
const* headersValues)
5091 _OrthancPluginSendMultipartItem2 params;
5092 params.output = output;
5093 params.answer = answer;
5094 params.answerSize = answerSize;
5095 params.headersCount = headersCount;
5096 params.headersKeys = headersKeys;
5097 params.headersValues = headersValues;
5099 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem2, ¶ms);
5106 } _OrthancPluginIncomingHttpRequestFilter;
5124 _OrthancPluginIncomingHttpRequestFilter params;
5125 params.callback = callback;
5127 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter, ¶ms);
5136 uint16_t* httpStatus;
5139 uint32_t headersCount;
5140 const char*
const* headersKeys;
5141 const char*
const* headersValues;
5144 const char* username;
5145 const char* password;
5147 const char* certificateFile;
5148 const char* certificateKeyFile;
5149 const char* certificateKeyPassword;
5151 } _OrthancPluginCallHttpClient2;
5196 uint16_t* httpStatus,
5199 uint32_t headersCount,
5200 const char*
const* headersKeys,
5201 const char*
const* headersValues,
5204 const char* username,
5205 const char* password,
5207 const char* certificateFile,
5208 const char* certificateKeyFile,
5209 const char* certificateKeyPassword,
5212 _OrthancPluginCallHttpClient2 params;
5213 memset(¶ms, 0,
sizeof(params));
5215 params.answerBody = answerBody;
5216 params.answerHeaders = answerHeaders;
5217 params.httpStatus = httpStatus;
5218 params.method = method;
5220 params.headersCount = headersCount;
5221 params.headersKeys = headersKeys;
5222 params.headersValues = headersValues;
5224 params.bodySize = bodySize;
5225 params.username = username;
5226 params.password = password;
5227 params.timeout = timeout;
5228 params.certificateFile = certificateFile;
5229 params.certificateKeyFile = certificateKeyFile;
5230 params.certificateKeyPassword = certificateKeyPassword;
5231 params.pkcs11 = pkcs11;
5233 return context->InvokeService(context, _OrthancPluginService_CallHttpClient2, ¶ms);
5252 _OrthancPluginRetrieveDynamicString params;
5253 params.result = &result;
5254 params.argument = NULL;
5273 } _OrthancPluginFindCallback;
5290 _OrthancPluginFindCallback params;
5291 params.callback = callback;
5293 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback, ¶ms);
5304 uint32_t *resultUint32;
5305 uint16_t *resultGroup;
5306 uint16_t *resultElement;
5307 char **resultString;
5308 } _OrthancPluginFindOperation;
5331 _OrthancPluginFindOperation params;
5332 memset(¶ms, 0,
sizeof(params));
5333 params.answers = answers;
5334 params.dicom = dicom;
5337 return context->InvokeService(context, _OrthancPluginService_FindAddAnswer, ¶ms);
5358 _OrthancPluginFindOperation params;
5359 memset(¶ms, 0,
sizeof(params));
5360 params.answers = answers;
5362 return context->InvokeService(context, _OrthancPluginService_FindMarkIncomplete, ¶ms);
5384 _OrthancPluginFindOperation params;
5385 memset(¶ms, 0,
sizeof(params));
5386 params.query = query;
5387 params.resultUint32 = &count;
5422 _OrthancPluginFindOperation params;
5423 memset(¶ms, 0,
sizeof(params));
5424 params.query = query;
5425 params.index = index;
5426 params.resultGroup = group;
5427 params.resultElement = element;
5429 return context->InvokeService(context, _OrthancPluginService_GetFindQueryTag, ¶ms);
5453 _OrthancPluginFindOperation params;
5454 memset(¶ms, 0,
sizeof(params));
5455 params.query = query;
5456 params.index = index;
5457 params.resultString = &result;
5491 _OrthancPluginFindOperation params;
5492 memset(¶ms, 0,
sizeof(params));
5493 params.query = query;
5494 params.index = index;
5495 params.resultString = &result;
5517 } _OrthancPluginMoveCallback;
5539 _OrthancPluginMoveCallback params;
5540 params.callback = callback;
5541 params.getMoveSize = getMoveSize;
5542 params.applyMove = applyMove;
5543 params.freeMove = freeMove;
5545 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback, ¶ms);
5555 } _OrthancPluginCreateFindMatcher;
5578 _OrthancPluginCreateFindMatcher params;
5579 memset(¶ms, 0,
sizeof(params));
5580 params.target = ⌖
5581 params.query = query;
5598 } _OrthancPluginFreeFindMatcher;
5613 _OrthancPluginFreeFindMatcher params;
5614 params.matcher = matcher;
5616 context->InvokeService(context, _OrthancPluginService_FreeFindMatcher, ¶ms);
5626 } _OrthancPluginFindMatcherIsMatch;
5648 int32_t isMatch = 0;
5650 _OrthancPluginFindMatcherIsMatch params;
5651 params.matcher = matcher;
5652 params.dicom = dicom;
5654 params.isMatch = &isMatch;
5671 } _OrthancPluginIncomingHttpRequestFilter2;
5688 _OrthancPluginIncomingHttpRequestFilter2 params;
5689 params.callback = callback;
5691 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter2, ¶ms);
Definition: OrthancCPlugin.h:707
const char * OrthancPluginGetInstanceRemoteAet(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the AET of a DICOM instance.
Definition: OrthancCPlugin.h:2318
int OrthancPluginHasInstanceMetadata(OrthancPluginContext *context, OrthancPluginDicomInstance *instance, const char *metadata)
Check whether a DICOM instance is associated with some metadata.
Definition: OrthancCPlugin.h:2497
OrthancPluginChangeType
Definition: OrthancCPlugin.h:664
void OrthancPluginSendHttpStatusCode(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status)
Send a HTTP status code.
Definition: OrthancCPlugin.h:2181
OrthancPluginErrorCode OrthancPluginFindAddAnswer(OrthancPluginContext *context, OrthancPluginFindAnswers *answers, const void *dicom, uint32_t size)
Add one answer to some C-Find request.
Definition: OrthancCPlugin.h:5325
void OrthancPluginSetHttpHeader(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *key, const char *value)
Set some HTTP header.
Definition: OrthancCPlugin.h:2282
OrthancPluginErrorCode OrthancPluginRegisterDecodeImageCallback(OrthancPluginContext *context, OrthancPluginDecodeImageCallback callback)
Register a callback to handle the decoding of DICOM images.
Definition: OrthancCPlugin.h:4785
The parameters of a REST request.
Definition: OrthancCPlugin.h:328
void OrthancPluginRedirect(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *redirection)
Redirect a REST request.
Definition: OrthancCPlugin.h:1964
OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:1869
const char * OrthancPluginGetInstanceData(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the data of a DICOM file.
Definition: OrthancCPlugin.h:2384
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:3565
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:3657
int OrthancPluginCheckVersion(OrthancPluginContext *context)
Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
Definition: OrthancCPlugin.h:1392
int64_t OrthancPluginGetInstanceSize(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the size of a DICOM file.
Definition: OrthancCPlugin.h:2351
Graylevel, unsigned 16bpp image.
Definition: OrthancCPlugin.h:557
Definition: OrthancCPlugin.h:679
const char *const * headersValues
The values of the HTTP headers.
Definition: OrthancCPlugin.h:388
const char *const * headersKeys
The keys of the HTTP headers (always converted to low-case).
Definition: OrthancCPlugin.h:383
OrthancPluginPixelFormat
Definition: OrthancCPlugin.h:541
uint32_t getCount
For a GET request, the number of GET parameters.
Definition: OrthancCPlugin.h:348
Definition: OrthancCPlugin.h:583
void OrthancPluginRegisterStorageArea(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove)
Register a custom storage area.
Definition: OrthancCPlugin.h:2583
OrthancPluginErrorCode OrthancPluginGetDicomForInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *instanceId)
Retrieve a DICOM instance using its Orthanc identifier.
Definition: OrthancCPlugin.h:1682
OrthancPluginImageFormat
Definition: OrthancCPlugin.h:704
const char * OrthancPluginGetFontName(OrthancPluginContext *context, uint32_t fontIndex)
Return the name of a font.
Definition: OrthancCPlugin.h:3937
OrthancPluginImage * OrthancPluginConvertPixelFormat(OrthancPluginContext *context, const OrthancPluginImage *source, OrthancPluginPixelFormat targetFormat)
Change the pixel format of an image.
Definition: OrthancCPlugin.h:3862
OrthancPluginErrorCode(* OrthancPluginWorklistCallback)(OrthancPluginWorklistAnswers *answers, const OrthancPluginWorklistQuery *query, const char *issuerAet, const char *calledAet)
Callback to handle the C-Find SCP requests for worklists.
Definition: OrthancCPlugin.h:1045
Definition: OrthancCPlugin.h:673
OrthancPluginErrorCode OrthancPluginStorageAreaRead(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Read a file from the storage area.
Definition: OrthancCPlugin.h:4116
uint32_t OrthancPluginGetFontsCount(OrthancPluginContext *context)
Return the number of available fonts.
Definition: OrthancCPlugin.h:3897
OrthancPluginErrorCode OrthancPluginGetFindQueryTag(OrthancPluginContext *context, uint16_t *group, uint16_t *element, const OrthancPluginFindQuery *query, uint32_t index)
Get one tag in a C-Find query.
Definition: OrthancCPlugin.h:5415
void OrthancPluginRegisterOnChangeCallback(OrthancPluginContext *context, OrthancPluginOnChangeCallback callback)
Register a callback to monitor changes.
Definition: OrthancCPlugin.h:2722
Color image in RGBA32 format.
Definition: OrthancCPlugin.h:581
void OrthancPluginSendMethodNotAllowed(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *allowedMethods)
Signal that this URI does not support this HTTP method.
Definition: OrthancCPlugin.h:2227
Definition: OrthancCPlugin.h:691
void OrthancPluginAnswerBuffer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *answer, uint32_t answerSize, const char *mimeType)
Answer to a REST request.
Definition: OrthancCPlugin.h:1584
Definition: OrthancCPlugin.h:667
OrthancPluginImage * OrthancPluginDecodeDicomImage(OrthancPluginContext *context, const void *buffer, uint32_t bufferSize, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:4911
uint16_t group
Definition: OrthancCPlugin.h:1248
void * OrthancPluginGetImageBuffer(OrthancPluginContext *context, const OrthancPluginImage *image)
Return a pointer to the content of an image.
Definition: OrthancCPlugin.h:3435
uint32_t minMultiplicity
Definition: OrthancCPlugin.h:1251
OrthancPluginErrorCode OrthancPluginWorklistAddAnswer(OrthancPluginContext *context, OrthancPluginWorklistAnswers *answers, const OrthancPluginWorklistQuery *query, const void *dicom, uint32_t size)
Add one answer to some modality worklist request.
Definition: OrthancCPlugin.h:4570
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:2535
struct _OrthancPluginWorklistQuery_t OrthancPluginWorklistQuery
Opaque structure to an object that represents a C-Find query for worklists.
Definition: OrthancCPlugin.h:889
Definition: OrthancCPlugin.h:706
struct _OrthancPluginStorageArea_t OrthancPluginStorageArea
Opaque structure that represents the storage area that is actually used by Orthanc.
Definition: OrthancCPlugin.h:881
Definition: OrthancCPlugin.h:671
Color image in RGB48 format.
Definition: OrthancCPlugin.h:591
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:1930
uint32_t OrthancPluginGetExpectedDatabaseVersion(OrthancPluginContext *context)
Get the expected version of the database schema.
Definition: OrthancCPlugin.h:2967
Graylevel 8bpp image.
Definition: OrthancCPlugin.h:549
uint32_t OrthancPluginGetImageHeight(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the height of an image.
Definition: OrthancCPlugin.h:3366
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:3264
OrthancPluginImage * OrthancPluginUncompressImage(OrthancPluginContext *context, const void *data, uint32_t size, OrthancPluginImageFormat format)
Decode a compressed image.
Definition: OrthancCPlugin.h:3478
OrthancPluginErrorCode(* OrthancPluginRestCallback)(OrthancPluginRestOutput *output, const char *url, const OrthancPluginHttpRequest *request)
Signature of a callback function that answers to a REST request.
Definition: OrthancCPlugin.h:929
Definition: OrthancCPlugin.h:692
Definition: OrthancCPlugin.h:694
Color image in RGB24 format.
Definition: OrthancCPlugin.h:573
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter2(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter2 callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:5684
Graylevel, signed 16bpp image.
Definition: OrthancCPlugin.h:565
An entry in the dictionary of DICOM tags.
Definition: OrthancCPlugin.h:1246
Definition: OrthancCPlugin.h:666
OrthancPluginCompressionType
Definition: OrthancCPlugin.h:689
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:4496
OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pixel format of an image.
Definition: OrthancCPlugin.h:3300
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:4022
uint32_t OrthancPluginGetImagePitch(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pitch of an image.
Definition: OrthancCPlugin.h:3401
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:1641
uint32_t maxMultiplicity
Definition: OrthancCPlugin.h:1252
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:961
void OrthancPluginSendUnauthorized(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *realm)
Signal that a REST request is not authorized.
Definition: OrthancCPlugin.h:2204
Graylevel, unsigned 64bpp image.
Definition: OrthancCPlugin.h:623
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:843
uint32_t OrthancPluginGetFontSize(OrthancPluginContext *context, uint32_t fontIndex)
Return the size of a font.
Definition: OrthancCPlugin.h:3969
OrthancPluginErrorCode OrthancPluginRestApiGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:1715
uint32_t headersCount
The number of HTTP headers.
Definition: OrthancCPlugin.h:378
Definition: OrthancCPlugin.h:672
OrthancPluginErrorCode OrthancPluginRegisterWorklistCallback(OrthancPluginContext *context, OrthancPluginWorklistCallback callback)
Register a callback to handle modality worklists requests.
Definition: OrthancCPlugin.h:4534
OrthancPluginErrorCode(* OrthancPluginStorageCreate)(const char *uuid, const void *content, int64_t size, OrthancPluginContentType type)
Callback for writing to the storage area.
Definition: OrthancCPlugin.h:988
void *(* OrthancPluginMoveCallback)(OrthancPluginResourceType resourceType, const char *patientId, const char *accessionNumber, const char *studyInstanceUid, const char *seriesInstanceUid, const char *sopInstanceUid, const char *originatorAet, const char *sourceAet, const char *targetAet, uint16_t originatorId)
Callback to handle incoming C-Move SCP requests.
Definition: OrthancCPlugin.h:1173
OrthancPluginErrorCode OrthancPluginRestApiDelete(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:1846
struct _OrthancPluginFindAnswers_t OrthancPluginFindAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:913
OrthancPluginErrorCode OrthancPluginRegisterMoveCallback(OrthancPluginContext *context, OrthancPluginMoveCallback callback, OrthancPluginGetMoveSize getMoveSize, OrthancPluginApplyMove applyMove, OrthancPluginFreeMove freeMove)
Register a callback to handle C-Move requests.
Definition: OrthancCPlugin.h:5532
OrthancPluginImage * OrthancPluginCreateImage(OrthancPluginContext *context, OrthancPluginPixelFormat format, uint32_t width, uint32_t height)
Create an image.
Definition: OrthancCPlugin.h:4823
char * OrthancPluginGetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *defaultValue)
Get the value of a global property.
Definition: OrthancCPlugin.h:2831
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:5082
OrthancPluginErrorCode(* OrthancPluginStorageRemove)(const char *uuid, OrthancPluginContentType type)
Callback for removing a file from the storage area.
Definition: OrthancCPlugin.h:1026
Definition: OrthancCPlugin.h:674
OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, OrthancPluginResourceType level)
Reconstruct the main DICOM tags.
Definition: OrthancCPlugin.h:4345
char * OrthancPluginGetFindQueryTagName(OrthancPluginContext *context, const OrthancPluginFindQuery *query, uint32_t index)
Get the symbolic name of one tag in a C-Find query.
Definition: OrthancCPlugin.h:5446
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:4866
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:5120
const char *const * getValues
For a GET request, the values of the GET parameters.
Definition: OrthancCPlugin.h:358
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:950
char * OrthancPluginGetInstanceSimplifiedJson(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file (with simplification).
Definition: OrthancCPlugin.h:2458
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:3112
OrthancPluginErrorCode OrthancPluginWorklistMarkIncomplete(OrthancPluginContext *context, OrthancPluginWorklistAnswers *answers)
Mark the set of worklist answers as incomplete.
Definition: OrthancCPlugin.h:4600
Definition: OrthancCPlugin.h:708
const char * body
For a PUT or POST request, the content of the body.
Definition: OrthancCPlugin.h:363
void OrthancPluginRegisterRestCallbackNoLock(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback, without locking.
Definition: OrthancCPlugin.h:1524
OrthancPluginErrorCode(* OrthancPluginFindCallback)(OrthancPluginFindAnswers *answers, const OrthancPluginFindQuery *query, const char *issuerAet, const char *calledAet)
Callback to handle incoming C-Find SCP requests.
Definition: OrthancCPlugin.h:1130
Definition: OrthancCPlugin.h:677
OrthancPluginErrorCode OrthancPluginRegisterFindCallback(OrthancPluginContext *context, OrthancPluginFindCallback callback)
Register a callback to handle C-Find requests.
Definition: OrthancCPlugin.h:5286
struct _OrthancPluginImage_t OrthancPluginImage
Opaque structure that represents an image that is uncompressed in memory.
Definition: OrthancCPlugin.h:873
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:1894
OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *subType, const char *contentType)
Start an HTTP multipart answer.
Definition: OrthancCPlugin.h:3041
struct _OrthancPluginWorklistAnswers_t OrthancPluginWorklistAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:897
OrthancPluginErrorCode OrthancPluginStorageAreaRemove(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Remove a file from the storage area.
Definition: OrthancCPlugin.h:4153
Definition: OrthancCPlugin.h:678
const char *const * getKeys
For a GET request, the keys of the GET parameters.
Definition: OrthancCPlugin.h:353
Definition: OrthancCPlugin.h:669
char * OrthancPluginLookupPatient(OrthancPluginContext *context, const char *patientID)
Look for a patient.
Definition: OrthancCPlugin.h:1996
OrthancPluginInstanceOrigin OrthancPluginGetInstanceOrigin(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the origin of a DICOM file.
Definition: OrthancCPlugin.h:4703
void OrthancPluginFreeImage(OrthancPluginContext *context, OrthancPluginImage *image)
Free an image.
Definition: OrthancCPlugin.h:3520
OrthancPluginValueRepresentation vr
Definition: OrthancCPlugin.h:1250
uint16_t element
Definition: OrthancCPlugin.h:1249
char * OrthancPluginLookupInstance(OrthancPluginContext *context, const char *sopInstanceUID)
Look for an instance.
Definition: OrthancCPlugin.h:2136
Definition: OrthancCPlugin.h:676
OrthancPluginErrorCode OrthancPluginSetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *value)
Set the value of a global property.
Definition: OrthancCPlugin.h:2870
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:3070
const char *const * groups
The matched values for the groups of the regular expression.
Definition: OrthancCPlugin.h:343
OrthancPluginErrorCode(* OrthancPluginStorageRead)(void **content, int64_t *size, const char *uuid, OrthancPluginContentType type)
Callback for reading from the storage area.
Definition: OrthancCPlugin.h:1008
char * OrthancPluginLookupStudy(OrthancPluginContext *context, const char *studyUID)
Look for a study.
Definition: OrthancCPlugin.h:2031
uint32_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:848
Graylevel, floating-point 32bpp image.
Definition: OrthancCPlugin.h:607
uint32_t groupsCount
The number of groups of the regular expression.
Definition: OrthancCPlugin.h:338
int32_t OrthancPluginWorklistIsMatch(OrthancPluginContext *context, const OrthancPluginWorklistQuery *query, const void *dicom, uint32_t size)
Test whether a worklist matches the query.
Definition: OrthancCPlugin.h:4638
int OrthancPluginCheckVersionAdvanced(OrthancPluginContext *context, int expectedMajor, int expectedMinor, int expectedRevision)
Check that the version of the hosting Orthanc is above a given version.
Definition: OrthancCPlugin.h:1292
uint32_t bodySize
For a PUT or POST request, the number of bytes of the body.
Definition: OrthancCPlugin.h:368
OrthancPluginErrorCode OrthancPluginFindMarkIncomplete(OrthancPluginContext *context, OrthancPluginFindAnswers *answers)
Mark the set of C-Find answers as incomplete.
Definition: OrthancCPlugin.h:5354
void OrthancPluginSetCookie(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *cookie, const char *value)
Set a cookie.
Definition: OrthancCPlugin.h:2257
Definition: OrthancCPlugin.h:668
char * OrthancPluginGetInstanceJson(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file.
Definition: OrthancCPlugin.h:2420
uint32_t OrthancPluginGetFindQuerySize(OrthancPluginContext *context, const OrthancPluginFindQuery *query)
Get the number of tags in a C-Find query.
Definition: OrthancCPlugin.h:5378
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:1782
void OrthancPluginRegisterOnStoredInstanceCallback(OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback)
Register a callback for received instances.
Definition: OrthancCPlugin.h:1552
Definition: OrthancCPlugin.h:670
Graylevel, unsigned 32bpp image.
Definition: OrthancCPlugin.h:599
void OrthancPluginRegisterRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback.
Definition: OrthancCPlugin.h:1490
char * OrthancPluginLookupStudyWithAccessionNumber(OrthancPluginContext *context, const char *accessionNumber)
Look for a study, using the accession number.
Definition: OrthancCPlugin.h:2066
OrthancPluginErrorCode OrthancPluginWorklistGetDicomQuery(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginWorklistQuery *query)
Retrieve the worklist query as a DICOM file.
Definition: OrthancCPlugin.h:4677
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:1745
OrthancPluginErrorCode(* OrthancPluginOnStoredInstanceCallback)(OrthancPluginDicomInstance *instance, const char *instanceId)
Signature of a callback function that is triggered when Orthanc receives a DICOM instance.
Definition: OrthancCPlugin.h:940
struct _OrthancPluginFindQuery_t OrthancPluginFindQuery
Opaque structure to an object that represents a C-Find query.
Definition: OrthancCPlugin.h:905
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:1817
Definition: OrthancCPlugin.h:675
Definition: OrthancCPlugin.h:693
OrthancPluginHttpMethod method
The HTTP method.
Definition: OrthancCPlugin.h:333
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:4074
A memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:838
Color image in BGRA32 format.
Definition: OrthancCPlugin.h:615
char * OrthancPluginLookupSeries(OrthancPluginContext *context, const char *seriesUID)
Look for a series.
Definition: OrthancCPlugin.h:2101
uint32_t OrthancPluginGetImageWidth(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the width of an image.
Definition: OrthancCPlugin.h:3333
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:3610
char * OrthancPluginGetFindQueryValue(OrthancPluginContext *context, const OrthancPluginFindQuery *query, uint32_t index)
Get the value associated with one tag in a C-Find query.
Definition: OrthancCPlugin.h:5484