114 # define ORTHANC_PLUGINS_API __declspec(dllexport)
116 # define ORTHANC_PLUGINS_API __attribute__ ((visibility ("default")))
118 # define ORTHANC_PLUGINS_API
121 #define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 1
122 #define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 12
123 #define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 3
126 #if !defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE)
127 #define ORTHANC_PLUGINS_VERSION_IS_ABOVE(major, minor, revision) \
128 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER > major || \
129 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER == major && \
130 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER > minor || \
131 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER == minor && \
132 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER >= revision))))
151 #ifndef ORTHANC_PLUGIN_INLINE
152 # if __STDC_VERSION__ >= 199901L
154 # define ORTHANC_PLUGIN_INLINE static inline
155 # elif defined(__cplusplus)
157 # define ORTHANC_PLUGIN_INLINE static inline
158 # elif defined(__GNUC__)
160 # define ORTHANC_PLUGIN_INLINE static __inline
161 # elif defined(_MSC_VER)
163 # define ORTHANC_PLUGIN_INLINE static __inline
165 # error Your compiler is not known to support the "inline" keyword
313 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
321 ORTHANC_PLUGINS_API
const char* OrthancPluginGetName();
334 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
410 _OrthancPluginService_LogInfo = 1,
411 _OrthancPluginService_LogWarning = 2,
412 _OrthancPluginService_LogError = 3,
413 _OrthancPluginService_GetOrthancPath = 4,
414 _OrthancPluginService_GetOrthancDirectory = 5,
415 _OrthancPluginService_GetConfigurationPath = 6,
416 _OrthancPluginService_SetPluginProperty = 7,
417 _OrthancPluginService_GetGlobalProperty = 8,
418 _OrthancPluginService_SetGlobalProperty = 9,
419 _OrthancPluginService_GetCommandLineArgumentsCount = 10,
420 _OrthancPluginService_GetCommandLineArgument = 11,
421 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
422 _OrthancPluginService_GetConfiguration = 13,
423 _OrthancPluginService_BufferCompression = 14,
424 _OrthancPluginService_ReadFile = 15,
425 _OrthancPluginService_WriteFile = 16,
426 _OrthancPluginService_GetErrorDescription = 17,
427 _OrthancPluginService_CallHttpClient = 18,
428 _OrthancPluginService_RegisterErrorCode = 19,
429 _OrthancPluginService_RegisterDictionaryTag = 20,
430 _OrthancPluginService_DicomBufferToJson = 21,
431 _OrthancPluginService_DicomInstanceToJson = 22,
432 _OrthancPluginService_CreateDicom = 23,
433 _OrthancPluginService_ComputeMd5 = 24,
434 _OrthancPluginService_ComputeSha1 = 25,
435 _OrthancPluginService_LookupDictionary = 26,
436 _OrthancPluginService_CallHttpClient2 = 27,
437 _OrthancPluginService_GenerateUuid = 28,
438 _OrthancPluginService_RegisterPrivateDictionaryTag = 29,
439 _OrthancPluginService_AutodetectMimeType = 30,
440 _OrthancPluginService_SetMetricsValue = 31,
441 _OrthancPluginService_EncodeDicomWebJson = 32,
442 _OrthancPluginService_EncodeDicomWebXml = 33,
443 _OrthancPluginService_ChunkedHttpClient = 34,
444 _OrthancPluginService_GetTagName = 35,
445 _OrthancPluginService_EncodeDicomWebJson2 = 36,
446 _OrthancPluginService_EncodeDicomWebXml2 = 37,
447 _OrthancPluginService_CreateMemoryBuffer = 38,
448 _OrthancPluginService_GenerateRestApiAuthorizationToken = 39,
449 _OrthancPluginService_CreateMemoryBuffer64 = 40,
450 _OrthancPluginService_CreateDicom2 = 41,
451 _OrthancPluginService_GetDatabaseServerIdentifier = 42,
452 _OrthancPluginService_SetMetricsIntegerValue = 43,
453 _OrthancPluginService_SetCurrentThreadName = 44,
457 _OrthancPluginService_RegisterRestCallback = 1000,
458 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
459 _OrthancPluginService_RegisterStorageArea = 1002,
460 _OrthancPluginService_RegisterOnChangeCallback = 1003,
461 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
462 _OrthancPluginService_RegisterWorklistCallback = 1005,
463 _OrthancPluginService_RegisterDecodeImageCallback = 1006,
464 _OrthancPluginService_RegisterIncomingHttpRequestFilter = 1007,
465 _OrthancPluginService_RegisterFindCallback = 1008,
466 _OrthancPluginService_RegisterMoveCallback = 1009,
467 _OrthancPluginService_RegisterIncomingHttpRequestFilter2 = 1010,
468 _OrthancPluginService_RegisterRefreshMetricsCallback = 1011,
469 _OrthancPluginService_RegisterChunkedRestCallback = 1012,
470 _OrthancPluginService_RegisterStorageCommitmentScpCallback = 1013,
471 _OrthancPluginService_RegisterIncomingDicomInstanceFilter = 1014,
472 _OrthancPluginService_RegisterTranscoderCallback = 1015,
473 _OrthancPluginService_RegisterStorageArea2 = 1016,
474 _OrthancPluginService_RegisterIncomingCStoreInstanceFilter = 1017,
475 _OrthancPluginService_RegisterReceivedInstanceCallback = 1018,
476 _OrthancPluginService_RegisterWebDavCollection = 1019,
479 _OrthancPluginService_AnswerBuffer = 2000,
480 _OrthancPluginService_CompressAndAnswerPngImage = 2001,
481 _OrthancPluginService_Redirect = 2002,
482 _OrthancPluginService_SendHttpStatusCode = 2003,
483 _OrthancPluginService_SendUnauthorized = 2004,
484 _OrthancPluginService_SendMethodNotAllowed = 2005,
485 _OrthancPluginService_SetCookie = 2006,
486 _OrthancPluginService_SetHttpHeader = 2007,
487 _OrthancPluginService_StartMultipartAnswer = 2008,
488 _OrthancPluginService_SendMultipartItem = 2009,
489 _OrthancPluginService_SendHttpStatus = 2010,
490 _OrthancPluginService_CompressAndAnswerImage = 2011,
491 _OrthancPluginService_SendMultipartItem2 = 2012,
492 _OrthancPluginService_SetHttpErrorDetails = 2013,
495 _OrthancPluginService_GetDicomForInstance = 3000,
496 _OrthancPluginService_RestApiGet = 3001,
497 _OrthancPluginService_RestApiPost = 3002,
498 _OrthancPluginService_RestApiDelete = 3003,
499 _OrthancPluginService_RestApiPut = 3004,
500 _OrthancPluginService_LookupPatient = 3005,
501 _OrthancPluginService_LookupStudy = 3006,
502 _OrthancPluginService_LookupSeries = 3007,
503 _OrthancPluginService_LookupInstance = 3008,
504 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
505 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
506 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
507 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
508 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
509 _OrthancPluginService_ReconstructMainDicomTags = 3014,
510 _OrthancPluginService_RestApiGet2 = 3015,
511 _OrthancPluginService_CallRestApi = 3016,
514 _OrthancPluginService_GetInstanceRemoteAet = 4000,
515 _OrthancPluginService_GetInstanceSize = 4001,
516 _OrthancPluginService_GetInstanceData = 4002,
517 _OrthancPluginService_GetInstanceJson = 4003,
518 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
519 _OrthancPluginService_HasInstanceMetadata = 4005,
520 _OrthancPluginService_GetInstanceMetadata = 4006,
521 _OrthancPluginService_GetInstanceOrigin = 4007,
522 _OrthancPluginService_GetInstanceTransferSyntaxUid = 4008,
523 _OrthancPluginService_HasInstancePixelData = 4009,
524 _OrthancPluginService_CreateDicomInstance = 4010,
525 _OrthancPluginService_FreeDicomInstance = 4011,
526 _OrthancPluginService_GetInstanceFramesCount = 4012,
527 _OrthancPluginService_GetInstanceRawFrame = 4013,
528 _OrthancPluginService_GetInstanceDecodedFrame = 4014,
529 _OrthancPluginService_TranscodeDicomInstance = 4015,
530 _OrthancPluginService_SerializeDicomInstance = 4016,
531 _OrthancPluginService_GetInstanceAdvancedJson = 4017,
532 _OrthancPluginService_GetInstanceDicomWebJson = 4018,
533 _OrthancPluginService_GetInstanceDicomWebXml = 4019,
534 _OrthancPluginService_LoadDicomInstance = 4020,
537 _OrthancPluginService_RegisterDatabaseBackend = 5000,
538 _OrthancPluginService_DatabaseAnswer = 5001,
539 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002,
540 _OrthancPluginService_StorageAreaCreate = 5003,
541 _OrthancPluginService_StorageAreaRead = 5004,
542 _OrthancPluginService_StorageAreaRemove = 5005,
543 _OrthancPluginService_RegisterDatabaseBackendV3 = 5006,
544 _OrthancPluginService_RegisterDatabaseBackendV4 = 5007,
547 _OrthancPluginService_GetImagePixelFormat = 6000,
548 _OrthancPluginService_GetImageWidth = 6001,
549 _OrthancPluginService_GetImageHeight = 6002,
550 _OrthancPluginService_GetImagePitch = 6003,
551 _OrthancPluginService_GetImageBuffer = 6004,
552 _OrthancPluginService_UncompressImage = 6005,
553 _OrthancPluginService_FreeImage = 6006,
554 _OrthancPluginService_CompressImage = 6007,
555 _OrthancPluginService_ConvertPixelFormat = 6008,
556 _OrthancPluginService_GetFontsCount = 6009,
557 _OrthancPluginService_GetFontInfo = 6010,
558 _OrthancPluginService_DrawText = 6011,
559 _OrthancPluginService_CreateImage = 6012,
560 _OrthancPluginService_CreateImageAccessor = 6013,
561 _OrthancPluginService_DecodeDicomImage = 6014,
564 _OrthancPluginService_WorklistAddAnswer = 7000,
565 _OrthancPluginService_WorklistMarkIncomplete = 7001,
566 _OrthancPluginService_WorklistIsMatch = 7002,
567 _OrthancPluginService_WorklistGetDicomQuery = 7003,
568 _OrthancPluginService_FindAddAnswer = 7004,
569 _OrthancPluginService_FindMarkIncomplete = 7005,
570 _OrthancPluginService_GetFindQuerySize = 7006,
571 _OrthancPluginService_GetFindQueryTag = 7007,
572 _OrthancPluginService_GetFindQueryTagName = 7008,
573 _OrthancPluginService_GetFindQueryValue = 7009,
574 _OrthancPluginService_CreateFindMatcher = 7010,
575 _OrthancPluginService_FreeFindMatcher = 7011,
576 _OrthancPluginService_FindMatcherIsMatch = 7012,
579 _OrthancPluginService_GetPeers = 8000,
580 _OrthancPluginService_FreePeers = 8001,
581 _OrthancPluginService_GetPeersCount = 8003,
582 _OrthancPluginService_GetPeerName = 8004,
583 _OrthancPluginService_GetPeerUrl = 8005,
584 _OrthancPluginService_CallPeerApi = 8006,
585 _OrthancPluginService_GetPeerUserProperty = 8007,
588 _OrthancPluginService_CreateJob = 9000,
589 _OrthancPluginService_FreeJob = 9001,
590 _OrthancPluginService_SubmitJob = 9002,
591 _OrthancPluginService_RegisterJobsUnserializer = 9003,
592 _OrthancPluginService_CreateJob2 = 9004,
594 _OrthancPluginService_INTERNAL = 0x7fffffff
595 } _OrthancPluginService;
600 _OrthancPluginProperty_Description = 1,
601 _OrthancPluginProperty_RootUri = 2,
602 _OrthancPluginProperty_OrthancExplorer = 3,
604 _OrthancPluginProperty_INTERNAL = 0x7fffffff
605 } _OrthancPluginProperty;
697 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
712 _OrthancPluginContentType_INTERNAL = 0x7fffffff
728 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
759 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
774 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
788 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
826 _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff
841 _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff
862 _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff
877 _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff
893 _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff
909 _OrthancPluginConstraintType_INTERNAL = 0x7fffffff
925 _OrthancPluginInstanceOrigin_INTERNAL = 0x7fffffff
1042 _OrthancPluginReceivedInstanceAction_INTERNAL = 0x7fffffff
1070 _OrthancPluginLoadDicomInstanceMode_INTERNAL = 0x7fffffff
1233 const char* instanceId);
1244 const char* resourceId);
1255 const uint32_t size,
1256 uint32_t frameIndex);
1277 const char* bulkDataUri);
1295 const void* content,
1367 uint64_t rangeStart);
1403 const char* issuerAet,
1404 const char* calledAet);
1435 uint32_t headersCount,
1436 const char*
const* headersKeys,
1437 const char*
const* headersValues);
1470 uint32_t headersCount,
1471 const char*
const* headersKeys,
1472 const char*
const* headersValues,
1473 uint32_t getArgumentsCount,
1474 const char*
const* getArgumentsKeys,
1475 const char*
const* getArgumentsValues);
1496 const char* issuerAet,
1497 const char* calledAet);
1536 typedef void* (*OrthancPluginMoveCallback) (
1538 const char* patientId,
1539 const char* accessionNumber,
1540 const char* studyInstanceUid,
1541 const char* seriesInstanceUid,
1542 const char* sopInstanceUid,
1543 const char* originatorAet,
1544 const char* sourceAet,
1545 const char* targetAet,
1546 uint16_t originatorId);
1632 typedef const char* (*OrthancPluginJobGetContent) (
void* job);
1670 typedef const char* (*OrthancPluginJobGetSerialized) (
void* job);
1764 const char* serialized);
1813 uint32_t levelDepth,
1814 const uint16_t* levelTagGroup,
1815 const uint16_t* levelTagElement,
1816 const uint32_t* levelIndex,
1818 uint16_t tagElement,
1851 uint32_t levelDepth,
1852 const uint16_t* levelTagGroup,
1853 const uint16_t* levelTagElement,
1854 const uint32_t* levelIndex,
1856 uint16_t tagElement,
1865 typedef struct _OrthancPluginContext_t
1867 void* pluginsManager;
1868 const char* orthancVersion;
1871 _OrthancPluginService service,
1872 const void* params);
1931 int32_t expectedMajor,
1932 int32_t expectedMinor,
1933 int32_t expectedRevision)
1935 int32_t major, minor, revision;
1937 if (
sizeof(
int) !=
sizeof(int32_t) ||
1940 sizeof(int32_t) !=
sizeof(_OrthancPluginService) ||
1941 sizeof(int32_t) !=
sizeof(_OrthancPluginProperty) ||
1966 if (!strcmp(context->orthancVersion,
"mainline"))
1978 (context->orthancVersion,
"%4d.%4d.%4d", &major, &minor, &revision) != 3)
1985 if (major > expectedMajor)
1990 if (major < expectedMajor)
1997 if (minor > expectedMinor)
2002 if (minor < expectedMinor)
2009 if (revision >= expectedRevision)
2041 ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER,
2042 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER,
2043 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER);
2059 context->Free(buffer->
data);
2075 context->Free(buffer->
data);
2089 const char* message)
2091 context->InvokeService(context, _OrthancPluginService_LogError, message);
2105 const char* message)
2107 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
2121 const char* message)
2123 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
2130 const char* pathRegularExpression;
2132 } _OrthancPluginRestCallback;
2157 const char* pathRegularExpression,
2160 _OrthancPluginRestCallback params;
2161 params.pathRegularExpression = pathRegularExpression;
2162 params.callback = callback;
2163 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
2197 const char* pathRegularExpression,
2200 _OrthancPluginRestCallback params;
2201 params.pathRegularExpression = pathRegularExpression;
2202 params.callback = callback;
2203 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms);
2211 } _OrthancPluginOnStoredInstanceCallback;
2237 _OrthancPluginOnStoredInstanceCallback params;
2238 params.callback = callback;
2240 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
2249 uint32_t answerSize;
2250 const char* mimeType;
2251 } _OrthancPluginAnswerBuffer;
2269 uint32_t answerSize,
2270 const char* mimeType)
2272 _OrthancPluginAnswerBuffer params;
2273 params.output = output;
2274 params.answer = answer;
2275 params.answerSize = answerSize;
2276 params.mimeType = mimeType;
2277 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms);
2289 } _OrthancPluginCompressAndAnswerPngImage;
2301 } _OrthancPluginCompressAndAnswerImage;
2331 _OrthancPluginCompressAndAnswerImage params;
2332 params.output = output;
2334 params.pixelFormat = format;
2335 params.width = width;
2336 params.height = height;
2337 params.pitch = pitch;
2338 params.buffer = buffer;
2340 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
2348 const char* instanceId;
2349 } _OrthancPluginGetDicomForInstance;
2366 const char* instanceId)
2368 _OrthancPluginGetDicomForInstance params;
2369 params.target = target;
2370 params.instanceId = instanceId;
2371 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
2380 } _OrthancPluginRestApiGet;
2401 _OrthancPluginRestApiGet params;
2402 params.target = target;
2404 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
2431 _OrthancPluginRestApiGet params;
2432 params.target = target;
2434 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms);
2445 } _OrthancPluginRestApiPostPut;
2470 _OrthancPluginRestApiPostPut params;
2471 params.target = target;
2474 params.bodySize = bodySize;
2475 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
2505 _OrthancPluginRestApiPostPut params;
2506 params.target = target;
2509 params.bodySize = bodySize;
2510 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms);
2531 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
2554 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
2582 _OrthancPluginRestApiPostPut params;
2583 params.target = target;
2586 params.bodySize = bodySize;
2587 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
2618 _OrthancPluginRestApiPostPut params;
2619 params.target = target;
2622 params.bodySize = bodySize;
2623 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms);
2631 const char* argument;
2632 } _OrthancPluginOutputPlusArgument;
2648 const char* redirection)
2650 _OrthancPluginOutputPlusArgument params;
2651 params.output = output;
2652 params.argument = redirection;
2653 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
2661 const char* argument;
2662 } _OrthancPluginRetrieveDynamicString;
2679 const char* patientID)
2683 _OrthancPluginRetrieveDynamicString params;
2684 params.result = &result;
2685 params.argument = patientID;
2714 const char* studyUID)
2718 _OrthancPluginRetrieveDynamicString params;
2719 params.result = &result;
2720 params.argument = studyUID;
2749 const char* accessionNumber)
2753 _OrthancPluginRetrieveDynamicString params;
2754 params.result = &result;
2755 params.argument = accessionNumber;
2784 const char* seriesUID)
2788 _OrthancPluginRetrieveDynamicString params;
2789 params.result = &result;
2790 params.argument = seriesUID;
2819 const char* sopInstanceUID)
2823 _OrthancPluginRetrieveDynamicString params;
2824 params.result = &result;
2825 params.argument = sopInstanceUID;
2844 } _OrthancPluginSendHttpStatusCode;
2867 _OrthancPluginSendHttpStatusCode params;
2868 params.output = output;
2869 params.status = status;
2870 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
2890 _OrthancPluginOutputPlusArgument params;
2891 params.output = output;
2892 params.argument = realm;
2893 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
2911 const char* allowedMethods)
2913 _OrthancPluginOutputPlusArgument params;
2914 params.output = output;
2915 params.argument = allowedMethods;
2916 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
2925 } _OrthancPluginSetHttpHeader;
2944 _OrthancPluginSetHttpHeader params;
2945 params.output = output;
2946 params.key = cookie;
2947 params.value = value;
2948 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
2969 _OrthancPluginSetHttpHeader params;
2970 params.output = output;
2972 params.value = value;
2973 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
2979 char** resultStringToFree;
2980 const char** resultString;
2981 int64_t* resultInt64;
2985 } _OrthancPluginAccessDicomInstance;
3005 _OrthancPluginAccessDicomInstance params;
3006 memset(¶ms, 0,
sizeof(params));
3007 params.resultString = &result;
3008 params.instance = instance;
3038 _OrthancPluginAccessDicomInstance params;
3039 memset(¶ms, 0,
sizeof(params));
3040 params.resultInt64 = &size;
3041 params.instance = instance;
3071 _OrthancPluginAccessDicomInstance params;
3072 memset(¶ms, 0,
sizeof(params));
3073 params.resultString = &result;
3074 params.instance = instance;
3107 _OrthancPluginAccessDicomInstance params;
3108 memset(¶ms, 0,
sizeof(params));
3109 params.resultStringToFree = &result;
3110 params.instance = instance;
3145 _OrthancPluginAccessDicomInstance params;
3146 memset(¶ms, 0,
sizeof(params));
3147 params.resultStringToFree = &result;
3148 params.instance = instance;
3181 const char* metadata)
3185 _OrthancPluginAccessDicomInstance params;
3186 memset(¶ms, 0,
sizeof(params));
3187 params.resultInt64 = &result;
3188 params.instance = instance;
3189 params.key = metadata;
3198 return (result != 0);
3222 const char* metadata)
3226 _OrthancPluginAccessDicomInstance params;
3227 memset(¶ms, 0,
sizeof(params));
3228 params.resultString = &result;
3229 params.instance = instance;
3230 params.key = metadata;
3251 } _OrthancPluginRegisterStorageArea;
3274 _OrthancPluginRegisterStorageArea params;
3275 params.create = create;
3277 params.remove = remove;
3280 params.free = ::free;
3285 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
3304 _OrthancPluginRetrieveDynamicString params;
3305 params.result = &result;
3306 params.argument = NULL;
3334 _OrthancPluginRetrieveDynamicString params;
3335 params.result = &result;
3336 params.argument = NULL;
3369 _OrthancPluginRetrieveDynamicString params;
3370 params.result = &result;
3371 params.argument = NULL;
3389 } _OrthancPluginOnChangeCallback;
3415 _OrthancPluginOnChangeCallback params;
3416 params.callback = callback;
3418 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms);
3426 _OrthancPluginProperty property;
3428 } _OrthancPluginSetPluginProperty;
3446 _OrthancPluginSetPluginProperty params;
3447 params.plugin = OrthancPluginGetName();
3448 params.property = _OrthancPluginProperty_RootUri;
3451 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3466 const char* description)
3468 _OrthancPluginSetPluginProperty params;
3469 params.plugin = OrthancPluginGetName();
3470 params.property = _OrthancPluginProperty_Description;
3471 params.value = description;
3473 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3488 const char* javascript)
3490 _OrthancPluginSetPluginProperty params;
3491 params.plugin = OrthancPluginGetName();
3492 params.property = _OrthancPluginProperty_OrthancExplorer;
3493 params.value = javascript;
3495 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3504 } _OrthancPluginGlobalProperty;
3523 const char* defaultValue)
3527 _OrthancPluginGlobalProperty params;
3528 params.result = &result;
3529 params.property = property;
3530 params.value = defaultValue;
3564 _OrthancPluginGlobalProperty params;
3565 params.result = NULL;
3566 params.property = property;
3567 params.value = value;
3569 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms);
3576 int32_t *resultInt32;
3577 uint32_t *resultUint32;
3578 int64_t *resultInt64;
3579 uint64_t *resultUint64;
3580 } _OrthancPluginReturnSingleValue;
3595 _OrthancPluginReturnSingleValue params;
3596 memset(¶ms, 0,
sizeof(params));
3597 params.resultUint32 = &count;
3630 _OrthancPluginGlobalProperty params;
3631 params.result = &result;
3632 params.property = (int32_t) argument;
3633 params.value = NULL;
3661 _OrthancPluginReturnSingleValue params;
3662 memset(¶ms, 0,
sizeof(params));
3663 params.resultUint32 = &count;
3693 _OrthancPluginRetrieveDynamicString params;
3694 params.result = &result;
3695 params.argument = NULL;
3713 const char* subType;
3714 const char* contentType;
3715 } _OrthancPluginStartMultipartAnswer;
3733 const char* subType,
3734 const char* contentType)
3736 _OrthancPluginStartMultipartAnswer params;
3737 params.output = output;
3738 params.subType = subType;
3739 params.contentType = contentType;
3740 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms);
3763 uint32_t answerSize)
3765 _OrthancPluginAnswerBuffer params;
3766 params.output = output;
3767 params.answer = answer;
3768 params.answerSize = answerSize;
3769 params.mimeType = NULL;
3770 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms);
3782 } _OrthancPluginBufferCompression;
3809 _OrthancPluginBufferCompression params;
3810 params.target = target;
3811 params.source = source;
3813 params.compression = compression;
3814 params.uncompress = uncompress;
3816 return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms);
3825 } _OrthancPluginReadFile;
3843 _OrthancPluginReadFile params;
3844 params.target = target;
3846 return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms);
3856 } _OrthancPluginWriteFile;
3875 _OrthancPluginWriteFile params;
3879 return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms);
3886 const char** target;
3888 } _OrthancPluginGetErrorDescription;
3904 const char* result = NULL;
3906 _OrthancPluginGetErrorDescription params;
3907 params.target = &result;
3908 params.error = error;
3913 return "Unknown error code";
3929 } _OrthancPluginSendHttpStatus;
3960 _OrthancPluginSendHttpStatus params;
3961 params.output = output;
3962 params.status = status;
3964 params.bodySize = bodySize;
3965 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms);
3973 uint32_t* resultUint32;
3975 void** resultBuffer;
3976 } _OrthancPluginGetImageInfo;
3995 _OrthancPluginGetImageInfo params;
3996 memset(¶ms, 0,
sizeof(params));
3997 params.image = image;
3998 params.resultPixelFormat = ⌖
4028 _OrthancPluginGetImageInfo params;
4029 memset(¶ms, 0,
sizeof(params));
4030 params.image = image;
4031 params.resultUint32 = &width;
4061 _OrthancPluginGetImageInfo params;
4062 memset(¶ms, 0,
sizeof(params));
4063 params.image = image;
4064 params.resultUint32 = &height;
4096 _OrthancPluginGetImageInfo params;
4097 memset(¶ms, 0,
sizeof(params));
4098 params.image = image;
4099 params.resultUint32 = &pitch;
4128 void* target = NULL;
4130 _OrthancPluginGetImageInfo params;
4131 memset(¶ms, 0,
sizeof(params));
4132 params.resultBuffer = ⌖
4133 params.image = image;
4152 } _OrthancPluginUncompressImage;
4175 _OrthancPluginUncompressImage params;
4176 memset(¶ms, 0,
sizeof(params));
4177 params.target = ⌖
4180 params.format = format;
4198 } _OrthancPluginFreeImage;
4213 _OrthancPluginFreeImage params;
4214 params.image = image;
4216 context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms);
4232 } _OrthancPluginCompressImage;
4263 _OrthancPluginCompressImage params;
4264 memset(¶ms, 0,
sizeof(params));
4265 params.target = target;
4267 params.pixelFormat = format;
4268 params.width = width;
4269 params.height = height;
4270 params.pitch = pitch;
4271 params.buffer = buffer;
4274 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4309 _OrthancPluginCompressImage params;
4310 memset(¶ms, 0,
sizeof(params));
4311 params.target = target;
4313 params.pixelFormat = format;
4314 params.width = width;
4315 params.height = height;
4316 params.pitch = pitch;
4317 params.buffer = buffer;
4318 params.quality = quality;
4320 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4356 _OrthancPluginCompressAndAnswerImage params;
4357 params.output = output;
4359 params.pixelFormat = format;
4360 params.width = width;
4361 params.height = height;
4362 params.pitch = pitch;
4363 params.buffer = buffer;
4364 params.quality = quality;
4365 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
4376 const char* username;
4377 const char* password;
4380 } _OrthancPluginCallHttpClient;
4403 const char* username,
4404 const char* password)
4406 _OrthancPluginCallHttpClient params;
4407 memset(¶ms, 0,
sizeof(params));
4409 params.target = target;
4412 params.username = username;
4413 params.password = password;
4415 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4443 const char* username,
4444 const char* password)
4446 _OrthancPluginCallHttpClient params;
4447 memset(¶ms, 0,
sizeof(params));
4449 params.target = target;
4453 params.bodySize = bodySize;
4454 params.username = username;
4455 params.password = password;
4457 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4485 const char* username,
4486 const char* password)
4488 _OrthancPluginCallHttpClient params;
4489 memset(¶ms, 0,
sizeof(params));
4491 params.target = target;
4495 params.bodySize = bodySize;
4496 params.username = username;
4497 params.password = password;
4499 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4520 const char* username,
4521 const char* password)
4523 _OrthancPluginCallHttpClient params;
4524 memset(¶ms, 0,
sizeof(params));
4528 params.username = username;
4529 params.password = password;
4531 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4541 } _OrthancPluginConvertPixelFormat;
4562 _OrthancPluginConvertPixelFormat params;
4563 params.target = ⌖
4564 params.source = source;
4565 params.targetFormat = targetFormat;
4595 _OrthancPluginReturnSingleValue params;
4596 memset(¶ms, 0,
sizeof(params));
4597 params.resultUint32 = &count;
4618 } _OrthancPluginGetFontInfo;
4634 const char* result = NULL;
4636 _OrthancPluginGetFontInfo params;
4637 memset(¶ms, 0,
sizeof(params));
4638 params.name = &result;
4639 params.fontIndex = fontIndex;
4668 _OrthancPluginGetFontInfo params;
4669 memset(¶ms, 0,
sizeof(params));
4670 params.size = &result;
4671 params.fontIndex = fontIndex;
4689 const char* utf8Text;
4695 } _OrthancPluginDrawText;
4719 const char* utf8Text,
4726 _OrthancPluginDrawText params;
4727 memset(¶ms, 0,
sizeof(params));
4728 params.image = image;
4729 params.fontIndex = fontIndex;
4730 params.utf8Text = utf8Text;
4737 return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms);
4746 const void* content;
4749 } _OrthancPluginStorageAreaCreate;
4773 const void* content,
4777 _OrthancPluginStorageAreaCreate params;
4778 params.storageArea = storageArea;
4780 params.content = content;
4784 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms);
4794 } _OrthancPluginStorageAreaRead;
4820 _OrthancPluginStorageAreaRead params;
4821 params.target = target;
4822 params.storageArea = storageArea;
4826 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms);
4835 } _OrthancPluginStorageAreaRemove;
4858 _OrthancPluginStorageAreaRemove params;
4859 params.storageArea = storageArea;
4863 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms);
4872 uint16_t httpStatus;
4873 const char* message;
4874 } _OrthancPluginRegisterErrorCode;
4894 uint16_t httpStatus,
4895 const char* message)
4899 _OrthancPluginRegisterErrorCode params;
4900 params.target = ⌖
4902 params.httpStatus = httpStatus;
4903 params.message = message;
4924 uint32_t minMultiplicity;
4925 uint32_t maxMultiplicity;
4926 } _OrthancPluginRegisterDictionaryTag;
4953 uint32_t minMultiplicity,
4954 uint32_t maxMultiplicity)
4956 _OrthancPluginRegisterDictionaryTag params;
4957 params.group = group;
4958 params.element = element;
4961 params.minMultiplicity = minMultiplicity;
4962 params.maxMultiplicity = maxMultiplicity;
4964 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, ¶ms);
4975 uint32_t minMultiplicity;
4976 uint32_t maxMultiplicity;
4977 const char* privateCreator;
4978 } _OrthancPluginRegisterPrivateDictionaryTag;
5006 uint32_t minMultiplicity,
5007 uint32_t maxMultiplicity,
5008 const char* privateCreator)
5010 _OrthancPluginRegisterPrivateDictionaryTag params;
5011 params.group = group;
5012 params.element = element;
5015 params.minMultiplicity = minMultiplicity;
5016 params.maxMultiplicity = maxMultiplicity;
5017 params.privateCreator = privateCreator;
5019 return context->InvokeService(context, _OrthancPluginService_RegisterPrivateDictionaryTag, ¶ms);
5028 } _OrthancPluginReconstructMainDicomTags;
5049 _OrthancPluginReconstructMainDicomTags params;
5050 params.level = level;
5051 params.storageArea = storageArea;
5053 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, ¶ms);
5060 const char* instanceId;
5065 uint32_t maxStringLength;
5066 } _OrthancPluginDicomToJson;
5094 uint32_t maxStringLength)
5098 _OrthancPluginDicomToJson params;
5099 memset(¶ms, 0,
sizeof(params));
5100 params.result = &result;
5101 params.buffer = buffer;
5103 params.format = format;
5104 params.flags = flags;
5105 params.maxStringLength = maxStringLength;
5139 const char* instanceId,
5142 uint32_t maxStringLength)
5146 _OrthancPluginDicomToJson params;
5147 memset(¶ms, 0,
sizeof(params));
5148 params.result = &result;
5149 params.instanceId = instanceId;
5150 params.format = format;
5151 params.flags = flags;
5152 params.maxStringLength = maxStringLength;
5170 uint32_t headersCount;
5171 const char*
const* headersKeys;
5172 const char*
const* headersValues;
5173 int32_t afterPlugins;
5174 } _OrthancPluginRestApiGet2;
5199 uint32_t headersCount,
5200 const char*
const* headersKeys,
5201 const char*
const* headersValues,
5202 int32_t afterPlugins)
5204 _OrthancPluginRestApiGet2 params;
5205 params.target = target;
5207 params.headersCount = headersCount;
5208 params.headersKeys = headersKeys;
5209 params.headersValues = headersValues;
5210 params.afterPlugins = afterPlugins;
5212 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, ¶ms);
5220 } _OrthancPluginWorklistCallback;
5237 _OrthancPluginWorklistCallback params;
5238 params.callback = callback;
5240 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, ¶ms);
5251 } _OrthancPluginWorklistAnswersOperation;
5276 _OrthancPluginWorklistAnswersOperation params;
5277 params.answers = answers;
5278 params.query = query;
5279 params.dicom = dicom;
5282 return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, ¶ms);
5303 _OrthancPluginWorklistAnswersOperation params;
5304 params.answers = answers;
5305 params.query = NULL;
5306 params.dicom = NULL;
5309 return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, ¶ms);
5320 } _OrthancPluginWorklistQueryOperation;
5343 int32_t isMatch = 0;
5345 _OrthancPluginWorklistQueryOperation params;
5346 params.query = query;
5347 params.dicom = dicom;
5349 params.isMatch = &isMatch;
5350 params.target = NULL;
5381 _OrthancPluginWorklistQueryOperation params;
5382 params.query = query;
5383 params.dicom = NULL;
5385 params.isMatch = NULL;
5386 params.target = target;
5388 return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, ¶ms);
5408 _OrthancPluginAccessDicomInstance params;
5409 memset(¶ms, 0,
sizeof(params));
5410 params.resultOrigin = &origin;
5411 params.instance = instance;
5431 } _OrthancPluginCreateDicom;
5465 _OrthancPluginCreateDicom params;
5466 params.target = target;
5468 params.pixelData = pixelData;
5469 params.flags = flags;
5471 return context->InvokeService(context, _OrthancPluginService_CreateDicom, ¶ms);
5478 } _OrthancPluginDecodeImageCallback;
5498 _OrthancPluginDecodeImageCallback params;
5499 params.callback = callback;
5501 return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, ¶ms);
5514 const void* constBuffer;
5515 uint32_t bufferSize;
5516 uint32_t frameIndex;
5517 } _OrthancPluginCreateImage;
5540 _OrthancPluginCreateImage params;
5541 memset(¶ms, 0,
sizeof(params));
5542 params.target = ⌖
5543 params.format = format;
5544 params.width = width;
5545 params.height = height;
5585 _OrthancPluginCreateImage params;
5586 memset(¶ms, 0,
sizeof(params));
5587 params.target = ⌖
5588 params.format = format;
5589 params.width = width;
5590 params.height = height;
5591 params.pitch = pitch;
5592 params.buffer = buffer;
5624 uint32_t bufferSize,
5625 uint32_t frameIndex)
5629 _OrthancPluginCreateImage params;
5630 memset(¶ms, 0,
sizeof(params));
5631 params.target = ⌖
5632 params.constBuffer = buffer;
5633 params.bufferSize = bufferSize;
5634 params.frameIndex = frameIndex;
5653 } _OrthancPluginComputeHash;
5674 _OrthancPluginComputeHash params;
5675 params.result = &result;
5676 params.buffer = buffer;
5710 _OrthancPluginComputeHash params;
5711 params.result = &result;
5712 params.buffer = buffer;
5732 } _OrthancPluginLookupDictionary;
5754 _OrthancPluginLookupDictionary params;
5755 params.target = target;
5757 return context->InvokeService(context, _OrthancPluginService_LookupDictionary, ¶ms);
5766 uint32_t answerSize;
5767 uint32_t headersCount;
5768 const char*
const* headersKeys;
5769 const char*
const* headersValues;
5770 } _OrthancPluginSendMultipartItem2;
5796 uint32_t answerSize,
5797 uint32_t headersCount,
5798 const char*
const* headersKeys,
5799 const char*
const* headersValues)
5801 _OrthancPluginSendMultipartItem2 params;
5802 params.output = output;
5803 params.answer = answer;
5804 params.answerSize = answerSize;
5805 params.headersCount = headersCount;
5806 params.headersKeys = headersKeys;
5807 params.headersValues = headersValues;
5809 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem2, ¶ms);
5816 } _OrthancPluginIncomingHttpRequestFilter;
5834 _OrthancPluginIncomingHttpRequestFilter params;
5835 params.callback = callback;
5837 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter, ¶ms);
5846 uint16_t* httpStatus;
5849 uint32_t headersCount;
5850 const char*
const* headersKeys;
5851 const char*
const* headersValues;
5854 const char* username;
5855 const char* password;
5857 const char* certificateFile;
5858 const char* certificateKeyFile;
5859 const char* certificateKeyPassword;
5861 } _OrthancPluginCallHttpClient2;
5909 uint16_t* httpStatus,
5912 uint32_t headersCount,
5913 const char*
const* headersKeys,
5914 const char*
const* headersValues,
5917 const char* username,
5918 const char* password,
5920 const char* certificateFile,
5921 const char* certificateKeyFile,
5922 const char* certificateKeyPassword,
5925 _OrthancPluginCallHttpClient2 params;
5926 memset(¶ms, 0,
sizeof(params));
5928 params.answerBody = answerBody;
5929 params.answerHeaders = answerHeaders;
5930 params.httpStatus = httpStatus;
5931 params.method = method;
5933 params.headersCount = headersCount;
5934 params.headersKeys = headersKeys;
5935 params.headersValues = headersValues;
5937 params.bodySize = bodySize;
5938 params.username = username;
5939 params.password = password;
5940 params.timeout = timeout;
5941 params.certificateFile = certificateFile;
5942 params.certificateKeyFile = certificateKeyFile;
5943 params.certificateKeyPassword = certificateKeyPassword;
5944 params.pkcs11 = pkcs11;
5946 return context->InvokeService(context, _OrthancPluginService_CallHttpClient2, ¶ms);
5965 _OrthancPluginRetrieveDynamicString params;
5966 params.result = &result;
5967 params.argument = NULL;
5986 } _OrthancPluginFindCallback;
6003 _OrthancPluginFindCallback params;
6004 params.callback = callback;
6006 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback, ¶ms);
6017 uint32_t *resultUint32;
6018 uint16_t *resultGroup;
6019 uint16_t *resultElement;
6020 char **resultString;
6021 } _OrthancPluginFindOperation;
6044 _OrthancPluginFindOperation params;
6045 memset(¶ms, 0,
sizeof(params));
6046 params.answers = answers;
6047 params.dicom = dicom;
6050 return context->InvokeService(context, _OrthancPluginService_FindAddAnswer, ¶ms);
6071 _OrthancPluginFindOperation params;
6072 memset(¶ms, 0,
sizeof(params));
6073 params.answers = answers;
6075 return context->InvokeService(context, _OrthancPluginService_FindMarkIncomplete, ¶ms);
6097 _OrthancPluginFindOperation params;
6098 memset(¶ms, 0,
sizeof(params));
6099 params.query = query;
6100 params.resultUint32 = &count;
6135 _OrthancPluginFindOperation params;
6136 memset(¶ms, 0,
sizeof(params));
6137 params.query = query;
6138 params.index = index;
6139 params.resultGroup = group;
6140 params.resultElement = element;
6142 return context->InvokeService(context, _OrthancPluginService_GetFindQueryTag, ¶ms);
6166 _OrthancPluginFindOperation params;
6167 memset(¶ms, 0,
sizeof(params));
6168 params.query = query;
6169 params.index = index;
6170 params.resultString = &result;
6204 _OrthancPluginFindOperation params;
6205 memset(¶ms, 0,
sizeof(params));
6206 params.query = query;
6207 params.index = index;
6208 params.resultString = &result;
6230 } _OrthancPluginMoveCallback;
6252 _OrthancPluginMoveCallback params;
6253 params.callback = callback;
6254 params.getMoveSize = getMoveSize;
6255 params.applyMove = applyMove;
6256 params.freeMove = freeMove;
6258 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback, ¶ms);
6268 } _OrthancPluginCreateFindMatcher;
6291 _OrthancPluginCreateFindMatcher params;
6292 memset(¶ms, 0,
sizeof(params));
6293 params.target = ⌖
6294 params.query = query;
6311 } _OrthancPluginFreeFindMatcher;
6326 _OrthancPluginFreeFindMatcher params;
6327 params.matcher = matcher;
6329 context->InvokeService(context, _OrthancPluginService_FreeFindMatcher, ¶ms);
6339 } _OrthancPluginFindMatcherIsMatch;
6361 int32_t isMatch = 0;
6363 _OrthancPluginFindMatcherIsMatch params;
6364 params.matcher = matcher;
6365 params.dicom = dicom;
6367 params.isMatch = &isMatch;
6384 } _OrthancPluginIncomingHttpRequestFilter2;
6401 _OrthancPluginIncomingHttpRequestFilter2 params;
6402 params.callback = callback;
6404 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter2, ¶ms);
6412 } _OrthancPluginGetPeers;
6430 _OrthancPluginGetPeers params;
6431 memset(¶ms, 0,
sizeof(params));
6432 params.peers = &peers;
6448 } _OrthancPluginFreePeers;
6463 _OrthancPluginFreePeers params;
6464 params.peers = peers;
6466 context->InvokeService(context, _OrthancPluginService_FreePeers, ¶ms);
6474 } _OrthancPluginGetPeersCount;
6493 uint32_t target = 0;
6495 _OrthancPluginGetPeersCount params;
6496 memset(¶ms, 0,
sizeof(params));
6497 params.target = ⌖
6498 params.peers = peers;
6514 const char** target;
6517 const char* userProperty;
6518 } _OrthancPluginGetPeerProperty;
6542 const char* target = NULL;
6544 _OrthancPluginGetPeerProperty params;
6545 memset(¶ms, 0,
sizeof(params));
6546 params.target = ⌖
6547 params.peers = peers;
6548 params.peerIndex = peerIndex;
6549 params.userProperty = NULL;
6583 const char* target = NULL;
6585 _OrthancPluginGetPeerProperty params;
6586 memset(¶ms, 0,
sizeof(params));
6587 params.target = ⌖
6588 params.peers = peers;
6589 params.peerIndex = peerIndex;
6590 params.userProperty = NULL;
6628 const char* userProperty)
6630 const char* target = NULL;
6632 _OrthancPluginGetPeerProperty params;
6633 memset(¶ms, 0,
sizeof(params));
6634 params.target = ⌖
6635 params.peers = peers;
6636 params.peerIndex = peerIndex;
6637 params.userProperty = userProperty;
6656 uint16_t* httpStatus;
6661 uint32_t additionalHeadersCount;
6662 const char*
const* additionalHeadersKeys;
6663 const char*
const* additionalHeadersValues;
6667 } _OrthancPluginCallPeerApi;
6709 uint16_t* httpStatus,
6714 uint32_t additionalHeadersCount,
6715 const char*
const* additionalHeadersKeys,
6716 const char*
const* additionalHeadersValues,
6721 _OrthancPluginCallPeerApi params;
6722 memset(¶ms, 0,
sizeof(params));
6724 params.answerBody = answerBody;
6725 params.answerHeaders = answerHeaders;
6726 params.httpStatus = httpStatus;
6727 params.peers = peers;
6728 params.peerIndex = peerIndex;
6729 params.method = method;
6731 params.additionalHeadersCount = additionalHeadersCount;
6732 params.additionalHeadersKeys = additionalHeadersKeys;
6733 params.additionalHeadersValues = additionalHeadersValues;
6735 params.bodySize = bodySize;
6736 params.timeout = timeout;
6738 return context->InvokeService(context, _OrthancPluginService_CallPeerApi, ¶ms);
6757 } _OrthancPluginCreateJob;
6805 _OrthancPluginCreateJob params;
6806 memset(¶ms, 0,
sizeof(params));
6808 params.target = ⌖
6810 params.finalize = finalize;
6812 params.getProgress = getProgress;
6813 params.getContent = getContent;
6814 params.getSerialized = getSerialized;
6817 params.reset = reset;
6844 } _OrthancPluginCreateJob2;
6891 _OrthancPluginCreateJob2 params;
6892 memset(¶ms, 0,
sizeof(params));
6894 params.target = ⌖
6896 params.finalize = finalize;
6898 params.getProgress = getProgress;
6899 params.getContent = getContent;
6900 params.getSerialized = getSerialized;
6903 params.reset = reset;
6921 } _OrthancPluginFreeJob;
6936 _OrthancPluginFreeJob params;
6939 context->InvokeService(context, _OrthancPluginService_FreeJob, ¶ms);
6949 } _OrthancPluginSubmitJob;
6969 char* resultId = NULL;
6971 _OrthancPluginSubmitJob params;
6972 memset(¶ms, 0,
sizeof(params));
6974 params.resultId = &resultId;
6976 params.priority = priority;
6995 } _OrthancPluginJobsUnserializer;
7013 _OrthancPluginJobsUnserializer params;
7014 params.unserializer = unserializer;
7016 context->InvokeService(context, _OrthancPluginService_RegisterJobsUnserializer, ¶ms);
7024 const char* details;
7026 } _OrthancPluginSetHttpErrorDetails;
7048 const char* details,
7051 _OrthancPluginSetHttpErrorDetails params;
7052 params.output = output;
7053 params.details = details;
7055 context->InvokeService(context, _OrthancPluginService_SetHttpErrorDetails, ¶ms);
7062 const char** result;
7063 const char* argument;
7064 } _OrthancPluginRetrieveStaticString;
7081 const char* result = NULL;
7083 _OrthancPluginRetrieveStaticString params;
7084 params.result = &result;
7085 params.argument = path;
7105 } _OrthancPluginSetMetricsValue;
7129 _OrthancPluginSetMetricsValue params;
7131 params.value = value;
7133 context->InvokeService(context, _OrthancPluginService_SetMetricsValue, ¶ms);
7141 } _OrthancPluginRegisterRefreshMetricsCallback;
7158 _OrthancPluginRegisterRefreshMetricsCallback params;
7159 params.callback = callback;
7160 context->InvokeService(context, _OrthancPluginService_RegisterRefreshMetricsCallback, ¶ms);
7172 } _OrthancPluginEncodeDicomWeb;
7196 char* target = NULL;
7198 _OrthancPluginEncodeDicomWeb params;
7199 params.target = ⌖
7200 params.dicom = dicom;
7201 params.dicomSize = dicomSize;
7202 params.callback = callback;
7238 char* target = NULL;
7240 _OrthancPluginEncodeDicomWeb params;
7241 params.target = ⌖
7242 params.dicom = dicom;
7243 params.dicomSize = dicomSize;
7244 params.callback = callback;
7266 } _OrthancPluginEncodeDicomWeb2;
7291 char* target = NULL;
7293 _OrthancPluginEncodeDicomWeb2 params;
7294 params.target = ⌖
7295 params.dicom = dicom;
7296 params.dicomSize = dicomSize;
7297 params.callback = callback;
7298 params.payload = payload;
7335 char* target = NULL;
7337 _OrthancPluginEncodeDicomWeb2 params;
7338 params.target = ⌖
7339 params.dicom = dicom;
7340 params.dicomSize = dicomSize;
7341 params.callback = callback;
7342 params.payload = payload;
7446 typedef const void* (*OrthancPluginChunkedClientRequestGetChunkData) (
void* request);
7470 uint16_t* httpStatus;
7473 uint32_t headersCount;
7474 const char*
const* headersKeys;
7475 const char*
const* headersValues;
7481 const char* username;
7482 const char* password;
7484 const char* certificateFile;
7485 const char* certificateKeyFile;
7486 const char* certificateKeyPassword;
7488 } _OrthancPluginChunkedHttpClient;
7546 uint16_t* httpStatus,
7549 uint32_t headersCount,
7550 const char*
const* headersKeys,
7551 const char*
const* headersValues,
7557 const char* username,
7558 const char* password,
7560 const char* certificateFile,
7561 const char* certificateKeyFile,
7562 const char* certificateKeyPassword,
7565 _OrthancPluginChunkedHttpClient params;
7566 memset(¶ms, 0,
sizeof(params));
7569 params.httpStatus = httpStatus;
7570 params.method = method;
7572 params.headersCount = headersCount;
7573 params.headersKeys = headersKeys;
7574 params.headersValues = headersValues;
7575 params.username = username;
7576 params.password = password;
7577 params.timeout = timeout;
7578 params.certificateFile = certificateFile;
7579 params.certificateKeyFile = certificateKeyFile;
7580 params.certificateKeyPassword = certificateKeyPassword;
7581 params.pkcs11 = pkcs11;
7584 params.answer = answer;
7585 params.answerAddChunk = answerAddChunk;
7586 params.answerAddHeader = answerAddHeader;
7587 params.request = request;
7588 params.requestIsDone = requestIsDone;
7589 params.requestChunkData = requestChunkData;
7590 params.requestChunkSize = requestChunkSize;
7591 params.requestNext = requestNext;
7593 return context->InvokeService(context, _OrthancPluginService_ChunkedHttpClient, ¶ms);
7683 const char* pathRegularExpression;
7691 } _OrthancPluginChunkedRestCallback;
7725 const char* pathRegularExpression,
7734 _OrthancPluginChunkedRestCallback params;
7735 params.pathRegularExpression = pathRegularExpression;
7736 params.getHandler = getHandler;
7737 params.postHandler = postHandler;
7738 params.deleteHandler = deleteHandler;
7739 params.putHandler = putHandler;
7740 params.addChunk = addChunk;
7741 params.execute = execute;
7742 params.finalize = finalize;
7744 context->InvokeService(context, _OrthancPluginService_RegisterChunkedRestCallback, ¶ms);
7756 const char* privateCreator;
7757 } _OrthancPluginGetTagName;
7778 const char* privateCreator)
7782 _OrthancPluginGetTagName params;
7783 params.result = &result;
7784 params.group = group;
7785 params.element = element;
7786 params.privateCreator = privateCreator;
7832 const char* transactionUid,
7833 const char*
const* sopClassUids,
7834 const char*
const* sopInstanceUids,
7835 uint32_t countInstances,
7836 const char* remoteAet,
7837 const char* calledAet);
7875 const char* sopClassUid,
7876 const char* sopInstanceUid);
7884 } _OrthancPluginRegisterStorageCommitmentScpCallback;
7905 _OrthancPluginRegisterStorageCommitmentScpCallback params;
7906 params.factory = factory;
7907 params.destructor = destructor;
7908 params.lookup = lookup;
7909 return context->InvokeService(context, _OrthancPluginService_RegisterStorageCommitmentScpCallback, ¶ms);
7946 } _OrthancPluginIncomingDicomInstanceFilter;
7964 _OrthancPluginIncomingDicomInstanceFilter params;
7965 params.callback = callback;
7967 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingDicomInstanceFilter, ¶ms);
8002 uint16_t* dimseStatus ,
8009 } _OrthancPluginIncomingCStoreInstanceFilter;
8027 _OrthancPluginIncomingCStoreInstanceFilter params;
8028 params.callback = callback;
8030 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingCStoreInstanceFilter, ¶ms);
8070 const void* receivedDicomBuffer,
8071 uint64_t receivedDicomBufferSize,
8078 } _OrthancPluginReceivedInstanceCallback;
8104 _OrthancPluginReceivedInstanceCallback params;
8105 params.callback = callback;
8107 return context->InvokeService(context, _OrthancPluginService_RegisterReceivedInstanceCallback, ¶ms);
8129 _OrthancPluginAccessDicomInstance params;
8130 memset(¶ms, 0,
sizeof(params));
8131 params.resultStringToFree = &result;
8132 params.instance = instance;
8162 int64_t hasPixelData;
8164 _OrthancPluginAccessDicomInstance params;
8165 memset(¶ms, 0,
sizeof(params));
8166 params.resultInt64 = &hasPixelData;
8167 params.instance = instance;
8178 return (hasPixelData != 0);
8192 const char* transferSyntax;
8193 } _OrthancPluginCreateDicomInstance;
8215 _OrthancPluginCreateDicomInstance params;
8216 params.target = ⌖
8217 params.buffer = buffer;
8234 } _OrthancPluginFreeDicomInstance;
8250 _OrthancPluginFreeDicomInstance params;
8251 params.dicom = dicom;
8253 context->InvokeService(context, _OrthancPluginService_FreeDicomInstance, ¶ms);
8259 uint32_t* targetUint32;
8262 char** targetStringToFree;
8264 uint32_t frameIndex;
8267 uint32_t maxStringLength;
8269 void* dicomWebPayload;
8270 } _OrthancPluginAccessDicomInstance2;
8289 _OrthancPluginAccessDicomInstance2 params;
8290 memset(¶ms, 0,
sizeof(params));
8291 params.targetUint32 = &count;
8292 params.instance = instance;
8327 uint32_t frameIndex)
8329 _OrthancPluginAccessDicomInstance2 params;
8330 memset(¶ms, 0,
sizeof(params));
8331 params.targetBuffer = target;
8332 params.instance = instance;
8333 params.frameIndex = frameIndex;
8335 return context->InvokeService(context, _OrthancPluginService_GetInstanceRawFrame, ¶ms);
8354 uint32_t frameIndex)
8358 _OrthancPluginAccessDicomInstance2 params;
8359 memset(¶ms, 0,
sizeof(params));
8360 params.targetImage = ⌖
8361 params.instance = instance;
8362 params.frameIndex = frameIndex;
8394 const char* transferSyntax)
8398 _OrthancPluginCreateDicomInstance params;
8399 params.target = ⌖
8400 params.buffer = buffer;
8402 params.transferSyntax = transferSyntax;
8433 _OrthancPluginAccessDicomInstance2 params;
8434 memset(¶ms, 0,
sizeof(params));
8435 params.targetBuffer = target;
8436 params.instance = instance;
8438 return context->InvokeService(context, _OrthancPluginService_SerializeDicomInstance, ¶ms);
8465 uint32_t maxStringLength)
8467 char* result = NULL;
8469 _OrthancPluginAccessDicomInstance2 params;
8470 memset(¶ms, 0,
sizeof(params));
8471 params.targetStringToFree = &result;
8472 params.instance = instance;
8473 params.format = format;
8474 params.flags = flags;
8475 params.maxStringLength = maxStringLength;
8509 char* target = NULL;
8511 _OrthancPluginAccessDicomInstance2 params;
8512 params.targetStringToFree = ⌖
8513 params.instance = instance;
8514 params.dicomWebCallback = callback;
8515 params.dicomWebPayload = payload;
8549 char* target = NULL;
8551 _OrthancPluginAccessDicomInstance2 params;
8552 params.targetStringToFree = ⌖
8553 params.instance = instance;
8554 params.dicomWebCallback = callback;
8555 params.dicomWebPayload = payload;
8592 const char*
const* allowedSyntaxes,
8593 uint32_t countSyntaxes,
8594 uint8_t allowNewSopInstanceUid);
8600 } _OrthancPluginTranscoderCallback;
8619 _OrthancPluginTranscoderCallback params;
8620 params.callback = callback;
8622 return context->InvokeService(context, _OrthancPluginService_RegisterTranscoderCallback, ¶ms);
8631 } _OrthancPluginCreateMemoryBuffer;
8655 _OrthancPluginCreateMemoryBuffer params;
8656 params.target = target;
8659 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer, ¶ms);
8693 _OrthancPluginRetrieveDynamicString params;
8694 params.result = &result;
8695 params.argument = NULL;
8697 if (context->InvokeService(context, _OrthancPluginService_GenerateRestApiAuthorizationToken,
8715 } _OrthancPluginCreateMemoryBuffer64;
8739 _OrthancPluginCreateMemoryBuffer64 params;
8740 params.target = target;
8743 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer64, ¶ms);
8753 } _OrthancPluginRegisterStorageArea2;
8778 _OrthancPluginRegisterStorageArea2 params;
8779 params.create = create;
8780 params.readWhole = readWhole;
8781 params.readRange = readRange;
8782 params.remove = remove;
8783 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea2, ¶ms);
8790 _OrthancPluginCreateDicom createDicom;
8791 const char* privateCreator;
8792 } _OrthancPluginCreateDicom2;
8824 const char* privateCreator)
8826 _OrthancPluginCreateDicom2 params;
8827 params.createDicom.target = target;
8828 params.createDicom.json = json;
8829 params.createDicom.pixelData = pixelData;
8830 params.createDicom.flags = flags;
8831 params.privateCreator = privateCreator;
8833 return context->InvokeService(context, _OrthancPluginService_CreateDicom2, ¶ms);
8845 uint16_t* httpStatus;
8848 uint32_t headersCount;
8849 const char*
const* headersKeys;
8850 const char*
const* headersValues;
8853 uint8_t afterPlugins;
8854 } _OrthancPluginCallRestApi;
8890 uint16_t* httpStatus,
8893 uint32_t headersCount,
8894 const char*
const* headersKeys,
8895 const char*
const* headersValues,
8898 uint8_t afterPlugins)
8900 _OrthancPluginCallRestApi params;
8901 memset(¶ms, 0,
sizeof(params));
8903 params.answerBody = answerBody;
8904 params.answerHeaders = answerHeaders;
8905 params.httpStatus = httpStatus;
8906 params.method = method;
8908 params.headersCount = headersCount;
8909 params.headersKeys = headersKeys;
8910 params.headersValues = headersValues;
8912 params.bodySize = bodySize;
8913 params.afterPlugins = afterPlugins;
8915 return context->InvokeService(context, _OrthancPluginService_CallRestApi, ¶ms);
8947 const char* mimeType,
8948 const char* dateTime);
8967 const char* dateTime);
8995 const char* mimeType,
8996 const char* dateTime);
9013 uint8_t* isExisting,
9015 const char*
const* pathItems,
9038 uint8_t* isExisting,
9043 const char*
const* pathItems,
9067 const char*
const* pathItems,
9087 uint8_t* isReadOnly,
9089 const char*
const* pathItems,
9109 uint8_t* isReadOnly,
9111 const char*
const* pathItems,
9129 uint8_t* isReadOnly,
9131 const char*
const* pathItems,
9145 } _OrthancPluginRegisterWebDavCollection;
9178 _OrthancPluginRegisterWebDavCollection params;
9180 params.isExistingFolder = isExistingFolder;
9181 params.listFolder = listFolder;
9182 params.retrieveFile = retrieveFile;
9183 params.storeFile = storeFile;
9184 params.createFolder = createFolder;
9185 params.deleteItem = deleteItem;
9186 params.payload = payload;
9188 return context->InvokeService(context, _OrthancPluginService_RegisterWebDavCollection, ¶ms);
9205 _OrthancPluginRetrieveStaticString params;
9206 params.result = &result;
9207 params.argument = NULL;
9230 const void* request,
9231 uint64_t requestSize);
9243 uint32_t maxDatabaseRetries;
9246 } _OrthancPluginRegisterDatabaseBackendV4;
9268 uint32_t maxDatabaseRetries,
9272 _OrthancPluginRegisterDatabaseBackendV4 params;
9273 params.backend = backend;
9274 params.maxDatabaseRetries = maxDatabaseRetries;
9275 params.operations = operations;
9276 params.finalize = finalize;
9278 return context->InvokeService(context, _OrthancPluginService_RegisterDatabaseBackendV4, ¶ms);
9285 const char* instanceId;
9287 } _OrthancPluginLoadDicomInstance;
9304 const char* instanceId,
9309 _OrthancPluginLoadDicomInstance params;
9310 params.target = ⌖
9311 params.instanceId = instanceId;
9331 } _OrthancPluginSetMetricsIntegerValue;
9354 _OrthancPluginSetMetricsIntegerValue params;
9356 params.value = value;
9358 context->InvokeService(context, _OrthancPluginService_SetMetricsIntegerValue, ¶ms);
9377 const char* threadName)
9379 return context->InvokeService(context, _OrthancPluginService_SetCurrentThreadName, threadName);
OrthancPluginErrorCode OrthancPluginRegisterDatabaseBackendV4(OrthancPluginContext *context, void *backend, uint32_t maxDatabaseRetries, OrthancPluginCallDatabaseBackendV4 operations, OrthancPluginFinalizeDatabaseBackendV4 finalize)
Register a custom database back-end.
Definition: OrthancCPlugin.h:9265
OrthancPluginErrorCode(* OrthancPluginCallDatabaseBackendV4)(OrthancPluginMemoryBuffer64 *response, void *backend, const void *request, uint64_t requestSize)
Signature of a callback function that is triggered when the Orthanc core requests an operation from t...
Definition: OrthancCPlugin.h:9227
OrthancPluginReceivedInstanceAction(* OrthancPluginReceivedInstanceCallback)(OrthancPluginMemoryBuffer64 *modifiedDicomBuffer, const void *receivedDicomBuffer, uint64_t receivedDicomBufferSize, OrthancPluginInstanceOrigin origin)
Callback to keep/discard/modify a DICOM instance received by Orthanc from any source (C-STORE or REST...
Definition: OrthancCPlugin.h:8068
OrthancPluginErrorCode(* OrthancPluginWebDavAddFile)(OrthancPluginWebDavCollection *collection, const char *name, uint64_t size, const char *mimeType, const char *dateTime)
Declare a file while returning the content of a folder.
Definition: OrthancCPlugin.h:8943
void OrthancPluginRegisterStorageArea(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove)
Register a custom storage area.
Definition: OrthancCPlugin.h:3268
void OrthancPluginRegisterOnStoredInstanceCallback(OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback)
Register a callback for received instances.
Definition: OrthancCPlugin.h:2233
void(* OrthancPluginDicomWebSetBinaryNode)(OrthancPluginDicomWebNode *node, OrthancPluginDicomWebBinaryMode mode, const char *bulkDataUri)
Signature of a function to set the content of a node encoding a binary DICOM tag, into a JSON or XML ...
Definition: OrthancCPlugin.h:1274
OrthancPluginErrorCode OrthancPluginRegisterDecodeImageCallback(OrthancPluginContext *context, OrthancPluginDecodeImageCallback callback)
Register a callback to handle the decoding of DICOM images.
Definition: OrthancCPlugin.h:5494
OrthancPluginChangeType
Definition: OrthancCPlugin.h:738
OrthancPluginErrorCode(* OrthancPluginStorageReadWhole)(OrthancPluginMemoryBuffer64 *target, const char *uuid, OrthancPluginContentType type)
Callback for reading a whole file from the storage area.
Definition: OrthancCPlugin.h:1340
OrthancPluginErrorCode OrthancPluginRegisterIncomingCStoreInstanceFilter(OrthancPluginContext *context, OrthancPluginIncomingCStoreInstanceFilter callback)
Register a callback to filter incoming DICOM instances received by Orthanc through C-STORE.
Definition: OrthancCPlugin.h:8023
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:1252
void OrthancPluginRegisterRefreshMetricsCallback(OrthancPluginContext *context, OrthancPluginRefreshMetricsCallback callback)
Register a callback to refresh the metrics.
Definition: OrthancCPlugin.h:7154
OrthancPluginErrorCode(* OrthancPluginWebDavCreateFolderCallback)(uint8_t *isReadOnly, uint32_t pathSize, const char *const *pathItems, void *payload)
Callback to create a folder.
Definition: OrthancCPlugin.h:9108
struct _OrthancPluginWebDavCollection_t OrthancPluginWebDavCollection
Opaque structure that represents a WebDAV collection.
Definition: OrthancCPlugin.h:8924
void(* OrthancPluginDicomWebBinaryCallback)(OrthancPluginDicomWebNode *node, OrthancPluginDicomWebSetBinaryNode setter, uint32_t levelDepth, const uint16_t *levelTagGroup, const uint16_t *levelTagElement, const uint32_t *levelIndex, uint16_t tagGroup, uint16_t tagElement, OrthancPluginValueRepresentation vr)
Callback executed to encode a binary tag in DICOMweb.
Definition: OrthancCPlugin.h:1810
OrthancPluginErrorCode(* OrthancPluginWebDavRetrieveFileCallback)(OrthancPluginWebDavCollection *collection, OrthancPluginWebDavRetrieveFile retrieveFile, uint32_t pathSize, const char *const *pathItems, void *payload)
Callback for retrieving the content of a file.
Definition: OrthancCPlugin.h:9063
int32_t(* OrthancPluginIncomingDicomInstanceFilter)(const OrthancPluginDicomInstance *instance)
Callback to filter incoming DICOM instances received by Orthanc.
Definition: OrthancCPlugin.h:7939
OrthancPluginErrorCode OrthancPluginStorageAreaRemove(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Remove a file from the storage area.
Definition: OrthancCPlugin.h:4852
OrthancPluginErrorCode(* OrthancPluginTranscoderCallback)(OrthancPluginMemoryBuffer *transcoded, const void *buffer, uint64_t size, const char *const *allowedSyntaxes, uint32_t countSyntaxes, uint8_t allowNewSopInstanceUid)
Signature of a callback function to transcode a DICOM instance.
Definition: OrthancCPlugin.h:8588
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter2(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter2 callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:6397
OrthancPluginErrorCode(* OrthancPluginWebDavRetrieveFile)(OrthancPluginWebDavCollection *collection, const void *data, uint64_t size, const char *mimeType, const char *dateTime)
Retrieve the content of a file.
Definition: OrthancCPlugin.h:8991
OrthancPluginErrorCode(* OrthancPluginStorageRead)(void **content, int64_t *size, const char *uuid, OrthancPluginContentType type)
Callback for reading from the storage area.
Definition: OrthancCPlugin.h:1320
void OrthancPluginRegisterRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback.
Definition: OrthancCPlugin.h:2155
uint32_t OrthancPluginGetExpectedDatabaseVersion(OrthancPluginContext *context)
Get the expected version of the database schema.
Definition: OrthancCPlugin.h:3656
OrthancPluginErrorCode OrthancPluginRegisterReceivedInstanceCallback(OrthancPluginContext *context, OrthancPluginReceivedInstanceCallback callback)
Register a callback to keep/discard/modify a DICOM instance received by Orthanc from any source (C-ST...
Definition: OrthancCPlugin.h:8100
int32_t OrthancPluginCheckVersion(OrthancPluginContext *context)
Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
Definition: OrthancCPlugin.h:2036
OrthancPluginErrorCode(* OrthancPluginWebDavListFolderCallback)(uint8_t *isExisting, OrthancPluginWebDavCollection *collection, OrthancPluginWebDavAddFile addFile, OrthancPluginWebDavAddFolder addFolder, uint32_t pathSize, const char *const *pathItems, void *payload)
Callback for listing the content of a folder.
Definition: OrthancCPlugin.h:9037
struct _OrthancPluginRestOutput_t OrthancPluginRestOutput
Opaque structure that represents the HTTP connection to the client application.
Definition: OrthancCPlugin.h:1123
void OrthancPluginRegisterOnChangeCallback(OrthancPluginContext *context, OrthancPluginOnChangeCallback callback)
Register a callback to monitor changes.
Definition: OrthancCPlugin.h:3411
void OrthancPluginRegisterStorageArea2(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageReadWhole readWhole, OrthancPluginStorageReadRange readRange, OrthancPluginStorageRemove remove)
Register a custom storage area, with support for range request.
Definition: OrthancCPlugin.h:8771
OrthancPluginErrorCode(* OrthancPluginWebDavAddFolder)(OrthancPluginWebDavCollection *collection, const char *name, const char *dateTime)
Declare a subfolder while returning the content of a folder.
Definition: OrthancCPlugin.h:8964
OrthancPluginErrorCode OrthancPluginRegisterWebDavCollection(OrthancPluginContext *context, const char *uri, OrthancPluginWebDavIsExistingFolderCallback isExistingFolder, OrthancPluginWebDavListFolderCallback listFolder, OrthancPluginWebDavRetrieveFileCallback retrieveFile, OrthancPluginWebDavStoreFileCallback storeFile, OrthancPluginWebDavCreateFolderCallback createFolder, OrthancPluginWebDavDeleteItemCallback deleteItem, void *payload)
Register a WebDAV virtual filesystem.
Definition: OrthancCPlugin.h:9167
int32_t(* OrthancPluginIncomingHttpRequestFilter2)(OrthancPluginHttpMethod method, const char *uri, const char *ip, uint32_t headersCount, const char *const *headersKeys, const char *const *headersValues, uint32_t getArgumentsCount, const char *const *getArgumentsKeys, const char *const *getArgumentsValues)
Callback to filter incoming HTTP requests received by Orthanc.
Definition: OrthancCPlugin.h:1466
OrthancPluginErrorCode(* OrthancPluginRestCallback)(OrthancPluginRestOutput *output, const char *url, const OrthancPluginHttpRequest *request)
Signature of a callback function that answers to a REST request.
Definition: OrthancCPlugin.h:1220
void(* OrthancPluginRefreshMetricsCallback)()
Callback executed to update the metrics of the plugin.
Definition: OrthancCPlugin.h:1782
OrthancPluginErrorCode OrthancPluginRegisterTranscoderCallback(OrthancPluginContext *context, OrthancPluginTranscoderCallback callback)
Register a callback to handle the transcoding of DICOM images.
Definition: OrthancCPlugin.h:8615
OrthancPluginErrorCode(* OrthancPluginOnStoredInstanceCallback)(const OrthancPluginDicomInstance *instance, const char *instanceId)
Signature of a callback function that is triggered when Orthanc stores a new DICOM instance.
Definition: OrthancCPlugin.h:1231
OrthancPluginErrorCode(* OrthancPluginWebDavStoreFileCallback)(uint8_t *isReadOnly, uint32_t pathSize, const char *const *pathItems, const void *data, uint64_t size, void *payload)
Callback to store a file.
Definition: OrthancCPlugin.h:9086
OrthancPluginErrorCode(* OrthancPluginWebDavDeleteItemCallback)(uint8_t *isReadOnly, uint32_t pathSize, const char *const *pathItems, void *payload)
Callback to remove a file or a folder.
Definition: OrthancCPlugin.h:9128
OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, OrthancPluginResourceType level)
Reconstruct the main DICOM tags.
Definition: OrthancCPlugin.h:5044
OrthancPluginErrorCode(* OrthancPluginStorageRemove)(const char *uuid, OrthancPluginContentType type)
Callback for removing a file from the storage area.
Definition: OrthancCPlugin.h:1381
OrthancPluginErrorCode(* OrthancPluginStorageCreate)(const char *uuid, const void *content, int64_t size, OrthancPluginContentType type)
Callback for writing to the storage area.
Definition: OrthancCPlugin.h:1293
void(* OrthancPluginDicomWebBinaryCallback2)(OrthancPluginDicomWebNode *node, OrthancPluginDicomWebSetBinaryNode setter, uint32_t levelDepth, const uint16_t *levelTagGroup, const uint16_t *levelTagElement, const uint32_t *levelIndex, uint16_t tagGroup, uint16_t tagElement, OrthancPluginValueRepresentation vr, void *payload)
Callback executed to encode a binary tag in DICOMweb.
Definition: OrthancCPlugin.h:1848
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:1241
void(* OrthancPluginFinalizeDatabaseBackendV4)(void *backend)
Signature of a callback function that is triggered when the database plugin must be finalized.
Definition: OrthancCPlugin.h:9238
struct _OrthancPluginServerChunkedRequestReader_t OrthancPluginServerChunkedRequestReader
Opaque structure that reads the content of a HTTP request body during a chunked HTTP transfer.
Definition: OrthancCPlugin.h:7602
OrthancPluginErrorCode(* OrthancPluginWebDavIsExistingFolderCallback)(uint8_t *isExisting, uint32_t pathSize, const char *const *pathItems, void *payload)
Callback for testing the existence of a folder.
Definition: OrthancCPlugin.h:9012
int32_t(* OrthancPluginIncomingHttpRequestFilter)(OrthancPluginHttpMethod method, const char *uri, const char *ip, uint32_t headersCount, const char *const *headersKeys, const char *const *headersValues)
Callback to filter incoming HTTP requests received by Orthanc.
Definition: OrthancCPlugin.h:1431
OrthancPluginJob *(* OrthancPluginJobsUnserializer)(const char *jobType, const char *serialized)
Callback executed to unserialize a custom job.
Definition: OrthancCPlugin.h:1763
void OrthancPluginRegisterJobsUnserializer(OrthancPluginContext *context, OrthancPluginJobsUnserializer unserializer)
Register an unserializer for custom jobs.
Definition: OrthancCPlugin.h:7009
void(* OrthancPluginFree)(void *buffer)
Signature of a function to free dynamic memory.
Definition: OrthancCPlugin.h:1264
void OrthancPluginRegisterRestCallbackNoLock(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback, without locking.
Definition: OrthancCPlugin.h:2195
OrthancPluginErrorCode OrthancPluginStorageAreaRead(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Read a file from the storage area.
Definition: OrthancCPlugin.h:4813
int32_t OrthancPluginCheckVersionAdvanced(OrthancPluginContext *context, int32_t expectedMajor, int32_t expectedMinor, int32_t expectedRevision)
Check that the version of the hosting Orthanc is above a given version.
Definition: OrthancCPlugin.h:1929
OrthancPluginErrorCode(* OrthancPluginStorageReadRange)(OrthancPluginMemoryBuffer64 *target, const char *uuid, OrthancPluginContentType type, uint64_t rangeStart)
Callback for reading a range of a file from the storage area.
Definition: OrthancCPlugin.h:1363
void OrthancPluginRegisterChunkedRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback getHandler, OrthancPluginServerChunkedRequestReaderFactory postHandler, OrthancPluginRestCallback deleteHandler, OrthancPluginServerChunkedRequestReaderFactory putHandler, OrthancPluginServerChunkedRequestReaderAddChunk addChunk, OrthancPluginServerChunkedRequestReaderExecute execute, OrthancPluginServerChunkedRequestReaderFinalize finalize)
Register a REST callback to handle chunked HTTP transfers.
Definition: OrthancCPlugin.h:7723
int32_t(* OrthancPluginIncomingCStoreInstanceFilter)(uint16_t *dimseStatus, const OrthancPluginDicomInstance *instance)
Callback to filter incoming DICOM instances received by Orthanc through C-STORE.
Definition: OrthancCPlugin.h:8001
OrthancPluginErrorCode OrthancPluginRegisterIncomingDicomInstanceFilter(OrthancPluginContext *context, OrthancPluginIncomingDicomInstanceFilter callback)
Register a callback to filter incoming DICOM instances.
Definition: OrthancCPlugin.h:7960
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:5830
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:4769
@ OrthancPluginChangeType_OrthancStopped
Definition: OrthancCPlugin.h:750
@ OrthancPluginChangeType_OrthancStarted
Definition: OrthancCPlugin.h:749
@ OrthancPluginChangeType_Deleted
Definition: OrthancCPlugin.h:740
@ OrthancPluginChangeType_JobFailure
Definition: OrthancCPlugin.h:757
@ OrthancPluginChangeType_NewInstance
Definition: OrthancCPlugin.h:742
@ OrthancPluginChangeType_NewPatient
Definition: OrthancCPlugin.h:743
@ OrthancPluginChangeType_JobSubmitted
Definition: OrthancCPlugin.h:755
@ OrthancPluginChangeType_NewSeries
Definition: OrthancCPlugin.h:744
@ OrthancPluginChangeType_StablePatient
Definition: OrthancCPlugin.h:746
@ OrthancPluginChangeType_UpdatedPeers
Definition: OrthancCPlugin.h:753
@ OrthancPluginChangeType_StableStudy
Definition: OrthancCPlugin.h:748
@ OrthancPluginChangeType_CompletedSeries
Definition: OrthancCPlugin.h:739
@ OrthancPluginChangeType_NewChildInstance
Definition: OrthancCPlugin.h:741
@ OrthancPluginChangeType_UpdatedAttachment
Definition: OrthancCPlugin.h:751
@ OrthancPluginChangeType_UpdatedMetadata
Definition: OrthancCPlugin.h:752
@ OrthancPluginChangeType_StableSeries
Definition: OrthancCPlugin.h:747
@ OrthancPluginChangeType_UpdatedModalities
Definition: OrthancCPlugin.h:754
@ OrthancPluginChangeType_JobSuccess
Definition: OrthancCPlugin.h:756
@ OrthancPluginChangeType_NewStudy
Definition: OrthancCPlugin.h:745
uint32_t OrthancPluginGetFindQuerySize(OrthancPluginContext *context, const OrthancPluginFindQuery *query)
Get the number of tags in a C-Find query.
Definition: OrthancCPlugin.h:6091
struct _OrthancPluginFindQuery_t OrthancPluginFindQuery
Opaque structure to an object that represents a C-Find query.
Definition: OrthancCPlugin.h:1171
OrthancPluginErrorCode(* OrthancPluginApplyMove)(void *moveDriver)
Callback to apply one C-Move suboperation.
Definition: OrthancCPlugin.h:1576
OrthancPluginErrorCode OrthancPluginFindMarkIncomplete(OrthancPluginContext *context, OrthancPluginFindAnswers *answers)
Mark the set of C-Find answers as incomplete.
Definition: OrthancCPlugin.h:6067
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:6159
void(* OrthancPluginStorageCommitmentDestructor)(void *handler)
Callback to free one storage commitment SCP handler.
Definition: OrthancCPlugin.h:7851
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:1400
OrthancPluginErrorCode OrthancPluginRegisterMoveCallback(OrthancPluginContext *context, OrthancPluginMoveCallback callback, OrthancPluginGetMoveSize getMoveSize, OrthancPluginApplyMove applyMove, OrthancPluginFreeMove freeMove)
Register a callback to handle C-Move requests.
Definition: OrthancCPlugin.h:6245
OrthancPluginErrorCode(* OrthancPluginStorageCommitmentFactory)(void **handler, const char *jobId, const char *transactionUid, const char *const *sopClassUids, const char *const *sopInstanceUids, uint32_t countInstances, const char *remoteAet, const char *calledAet)
Callback executed by the storage commitment SCP.
Definition: OrthancCPlugin.h:7829
OrthancPluginErrorCode OrthancPluginRegisterFindCallback(OrthancPluginContext *context, OrthancPluginFindCallback callback)
Register a callback to handle C-Find requests.
Definition: OrthancCPlugin.h:5999
OrthancPluginErrorCode OrthancPluginWorklistGetDicomQuery(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginWorklistQuery *query)
Retrieve the worklist query as a DICOM file.
Definition: OrthancCPlugin.h:5376
OrthancPluginErrorCode(* OrthancPluginStorageCommitmentLookup)(OrthancPluginStorageCommitmentFailureReason *target, void *handler, const char *sopClassUid, const char *sopInstanceUid)
Callback to get the status of one DICOM instance in the storage commitment SCP.
Definition: OrthancCPlugin.h:7872
int32_t OrthancPluginWorklistIsMatch(OrthancPluginContext *context, const OrthancPluginWorklistQuery *query, const void *dicom, uint32_t size)
Test whether a worklist matches the query.
Definition: OrthancCPlugin.h:5337
OrthancPluginErrorCode OrthancPluginFindAddAnswer(OrthancPluginContext *context, OrthancPluginFindAnswers *answers, const void *dicom, uint32_t size)
Add one answer to some C-Find request.
Definition: OrthancCPlugin.h:6038
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:1536
OrthancPluginErrorCode OrthancPluginRegisterStorageCommitmentScpCallback(OrthancPluginContext *context, OrthancPluginStorageCommitmentFactory factory, OrthancPluginStorageCommitmentDestructor destructor, OrthancPluginStorageCommitmentLookup lookup)
Register a callback to handle incoming requests to the storage commitment SCP.
Definition: OrthancCPlugin.h:7899
struct _OrthancPluginFindAnswers_t OrthancPluginFindAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1179
struct _OrthancPluginWorklistAnswers_t OrthancPluginWorklistAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1163
OrthancPluginErrorCode(* OrthancPluginFindCallback)(OrthancPluginFindAnswers *answers, const OrthancPluginFindQuery *query, const char *issuerAet, const char *calledAet)
Callback to handle incoming C-Find SCP requests.
Definition: OrthancCPlugin.h:1493
uint32_t(* OrthancPluginGetMoveSize)(void *moveDriver)
Callback to read the size of a C-Move driver.
Definition: OrthancCPlugin.h:1561
OrthancPluginErrorCode OrthancPluginRegisterWorklistCallback(OrthancPluginContext *context, OrthancPluginWorklistCallback callback)
Register a callback to handle modality worklists requests.
Definition: OrthancCPlugin.h:5233
OrthancPluginErrorCode OrthancPluginWorklistMarkIncomplete(OrthancPluginContext *context, OrthancPluginWorklistAnswers *answers)
Mark the set of worklist answers as incomplete.
Definition: OrthancCPlugin.h:5299
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:6197
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:6128
void(* OrthancPluginFreeMove)(void *moveDriver)
Callback to free one C-Move driver.
Definition: OrthancCPlugin.h:1590
struct _OrthancPluginWorklistQuery_t OrthancPluginWorklistQuery
Opaque structure to an object that represents a C-Find query for worklists.
Definition: OrthancCPlugin.h:1155
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:5269
int32_t OrthancPluginHasInstancePixelData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Check whether the DICOM file has pixel data.
Definition: OrthancCPlugin.h:8158
char * OrthancPluginGetInstanceDicomWebXml(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb XML.
Definition: OrthancCPlugin.h:8543
struct _OrthancPluginDicomInstance_t OrthancPluginDicomInstance
Opaque structure that represents a DICOM instance that is managed by the Orthanc core.
Definition: OrthancCPlugin.h:1131
char * OrthancPluginGetInstanceTransferSyntaxUid(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the transfer syntax of a DICOM file.
Definition: OrthancCPlugin.h:8123
OrthancPluginErrorCode OrthancPluginGetInstanceRawFrame(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginDicomInstance *instance, uint32_t frameIndex)
Get the raw content of a frame in a DICOM instance.
Definition: OrthancCPlugin.h:8323
char * OrthancPluginGetInstanceAdvancedJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomToJsonFormat format, OrthancPluginDicomToJsonFlags flags, uint32_t maxStringLength)
Format a DICOM memory buffer as a JSON string.
Definition: OrthancCPlugin.h:8460
const void * OrthancPluginGetInstanceData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the data of a DICOM file.
Definition: OrthancCPlugin.h:3065
OrthancPluginDicomInstance * OrthancPluginCreateDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size)
Parse a DICOM instance.
Definition: OrthancCPlugin.h:8208
int32_t OrthancPluginHasInstanceMetadata(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, const char *metadata)
Check whether a DICOM instance is associated with some metadata.
Definition: OrthancCPlugin.h:3178
uint32_t OrthancPluginGetInstanceFramesCount(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the number of frames in a DICOM instance.
Definition: OrthancCPlugin.h:8283
OrthancPluginImage * OrthancPluginGetInstanceDecodedFrame(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:8351
OrthancPluginDicomInstance * OrthancPluginLoadDicomInstance(OrthancPluginContext *context, const char *instanceId, OrthancPluginLoadDicomInstanceMode mode)
Load a DICOM instance from the Orthanc server.
Definition: OrthancCPlugin.h:9302
OrthancPluginInstanceOrigin OrthancPluginGetInstanceOrigin(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the origin of a DICOM file.
Definition: OrthancCPlugin.h:5402
int64_t OrthancPluginGetInstanceSize(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the size of a DICOM file.
Definition: OrthancCPlugin.h:3032
char * OrthancPluginGetInstanceDicomWebJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb JSON.
Definition: OrthancCPlugin.h:8503
char * OrthancPluginGetInstanceSimplifiedJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file (with simplification).
Definition: OrthancCPlugin.h:3139
char * OrthancPluginGetInstanceJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file.
Definition: OrthancCPlugin.h:3101
const char * OrthancPluginGetInstanceMetadata(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, const char *metadata)
Get the value of some metadata associated with a given DICOM instance.
Definition: OrthancCPlugin.h:3219
void OrthancPluginFreeDicomInstance(OrthancPluginContext *context, OrthancPluginDicomInstance *dicom)
Free a DICOM instance.
Definition: OrthancCPlugin.h:8246
OrthancPluginErrorCode OrthancPluginSerializeDicomInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginDicomInstance *instance)
Writes a DICOM instance to a memory buffer.
Definition: OrthancCPlugin.h:8428
OrthancPluginDicomInstance * OrthancPluginTranscodeDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size, const char *transferSyntax)
Parse and transcode a DICOM instance.
Definition: OrthancCPlugin.h:8390
const char * OrthancPluginGetInstanceRemoteAet(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the AET of a DICOM instance.
Definition: OrthancCPlugin.h:2999
OrthancPluginPixelFormat
Definition: OrthancCPlugin.h:614
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:4715
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:4299
uint32_t OrthancPluginGetImagePitch(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pitch of an image.
Definition: OrthancCPlugin.h:4090
OrthancPluginImage * OrthancPluginConvertPixelFormat(OrthancPluginContext *context, const OrthancPluginImage *source, OrthancPluginPixelFormat targetFormat)
Change the pixel format of an image.
Definition: OrthancCPlugin.h:4555
OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pixel format of an image.
Definition: OrthancCPlugin.h:3989
uint32_t OrthancPluginGetFontsCount(OrthancPluginContext *context)
Return the number of available fonts.
Definition: OrthancCPlugin.h:4590
uint32_t OrthancPluginGetImageHeight(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the height of an image.
Definition: OrthancCPlugin.h:4055
void OrthancPluginFreeImage(OrthancPluginContext *context, OrthancPluginImage *image)
Free an image.
Definition: OrthancCPlugin.h:4209
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:4254
OrthancPluginImage * OrthancPluginCreateImage(OrthancPluginContext *context, OrthancPluginPixelFormat format, uint32_t width, uint32_t height)
Create an image.
Definition: OrthancCPlugin.h:5532
OrthancPluginImage * OrthancPluginUncompressImage(OrthancPluginContext *context, const void *data, uint32_t size, OrthancPluginImageFormat format)
Decode a compressed image.
Definition: OrthancCPlugin.h:4167
const char * OrthancPluginGetFontName(OrthancPluginContext *context, uint32_t fontIndex)
Return the name of a font.
Definition: OrthancCPlugin.h:4630
void * OrthancPluginGetImageBuffer(OrthancPluginContext *context, const OrthancPluginImage *image)
Return a pointer to the content of an image.
Definition: OrthancCPlugin.h:4124
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:5575
OrthancPluginImageFormat
Definition: OrthancCPlugin.h:783
struct _OrthancPluginStorageArea_t OrthancPluginStorageArea
Opaque structure that represents the storage area that is actually used by Orthanc.
Definition: OrthancCPlugin.h:1147
OrthancPluginCompressionType
Definition: OrthancCPlugin.h:768
uint32_t OrthancPluginGetImageWidth(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the width of an image.
Definition: OrthancCPlugin.h:4022
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:3801
OrthancPluginImage * OrthancPluginDecodeDicomImage(OrthancPluginContext *context, const void *buffer, uint32_t bufferSize, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:5621
uint32_t OrthancPluginGetFontSize(OrthancPluginContext *context, uint32_t fontIndex)
Return the size of a font.
Definition: OrthancCPlugin.h:4662
struct _OrthancPluginImage_t OrthancPluginImage
Opaque structure that represents an image that is uncompressed in memory.
Definition: OrthancCPlugin.h:1139
@ OrthancPluginPixelFormat_RGBA32
Color image in RGBA32 format.
Definition: OrthancCPlugin.h:653
@ OrthancPluginPixelFormat_RGB48
Color image in RGB48 format.
Definition: OrthancCPlugin.h:663
@ OrthancPluginPixelFormat_Grayscale8
Graylevel 8bpp image.
Definition: OrthancCPlugin.h:621
@ OrthancPluginPixelFormat_SignedGrayscale16
Graylevel, signed 16bpp image.
Definition: OrthancCPlugin.h:637
@ OrthancPluginPixelFormat_Float32
Graylevel, floating-point 32bpp image.
Definition: OrthancCPlugin.h:679
@ OrthancPluginPixelFormat_RGB24
Color image in RGB24 format.
Definition: OrthancCPlugin.h:645
@ OrthancPluginPixelFormat_BGRA32
Color image in BGRA32 format.
Definition: OrthancCPlugin.h:687
@ OrthancPluginPixelFormat_Unknown
Definition: OrthancCPlugin.h:655
@ OrthancPluginPixelFormat_Grayscale64
Graylevel, unsigned 64bpp image.
Definition: OrthancCPlugin.h:695
@ OrthancPluginPixelFormat_Grayscale32
Graylevel, unsigned 32bpp image.
Definition: OrthancCPlugin.h:671
@ OrthancPluginPixelFormat_Grayscale16
Graylevel, unsigned 16bpp image.
Definition: OrthancCPlugin.h:629
@ OrthancPluginImageFormat_Png
Definition: OrthancCPlugin.h:784
@ OrthancPluginImageFormat_Jpeg
Definition: OrthancCPlugin.h:785
@ OrthancPluginImageFormat_Dicom
Definition: OrthancCPlugin.h:786
@ OrthancPluginCompressionType_Gzip
Definition: OrthancCPlugin.h:771
@ OrthancPluginCompressionType_ZlibWithSize
Definition: OrthancCPlugin.h:770
@ OrthancPluginCompressionType_Zlib
Definition: OrthancCPlugin.h:769
@ OrthancPluginCompressionType_GzipWithSize
Definition: OrthancCPlugin.h:772
OrthancPluginErrorCode OrthancPluginRestApiPost(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, const void *body, uint32_t bodySize)
Make a POST call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2463
OrthancPluginErrorCode OrthancPluginRestApiPostAfterPlugins(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, const void *body, uint32_t bodySize)
Make a POST call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:2498
OrthancPluginErrorCode OrthancPluginRestApiPutAfterPlugins(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, const void *body, uint32_t bodySize)
Make a PUT call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:2611
char * OrthancPluginLookupStudy(OrthancPluginContext *context, const char *studyUID)
Look for a study.
Definition: OrthancCPlugin.h:2712
OrthancPluginErrorCode OrthancPluginSetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *value)
Set the value of a global property.
Definition: OrthancCPlugin.h:3559
char * OrthancPluginGetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *defaultValue)
Get the value of a global property.
Definition: OrthancCPlugin.h:3520
OrthancPluginErrorCode OrthancPluginRestApiPut(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, const void *body, uint32_t bodySize)
Make a PUT call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2575
char * OrthancPluginLookupSeries(OrthancPluginContext *context, const char *seriesUID)
Look for a series.
Definition: OrthancCPlugin.h:2782
char * OrthancPluginLookupStudyWithAccessionNumber(OrthancPluginContext *context, const char *accessionNumber)
Look for a study, using the accession number.
Definition: OrthancCPlugin.h:2747
char * OrthancPluginGenerateRestApiAuthorizationToken(OrthancPluginContext *context)
Generate a token to grant full access to the REST API of Orthanc.
Definition: OrthancCPlugin.h:8688
OrthancPluginErrorCode OrthancPluginRestApiGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2396
char * OrthancPluginLookupInstance(OrthancPluginContext *context, const char *sopInstanceUID)
Look for an instance.
Definition: OrthancCPlugin.h:2817
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:2426
char * OrthancPluginLookupPatient(OrthancPluginContext *context, const char *patientID)
Look for a patient.
Definition: OrthancCPlugin.h:2677
OrthancPluginErrorCode OrthancPluginRestApiDelete(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2527
OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:2550
OrthancPluginErrorCode OrthancPluginCallRestApi(OrthancPluginContext *context, OrthancPluginMemoryBuffer *answerBody, OrthancPluginMemoryBuffer *answerHeaders, uint16_t *httpStatus, OrthancPluginHttpMethod method, const char *uri, uint32_t headersCount, const char *const *headersKeys, const char *const *headersValues, const void *body, uint32_t bodySize, uint8_t afterPlugins)
Call the REST API of Orthanc with full flexibility.
Definition: OrthancCPlugin.h:8886
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:5195
OrthancPluginErrorCode OrthancPluginGetDicomForInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *instanceId)
Retrieve a DICOM instance using its Orthanc identifier.
Definition: OrthancCPlugin.h:2363
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:2322
void OrthancPluginSendUnauthorized(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *realm)
Signal that a REST request is not authorized.
Definition: OrthancCPlugin.h:2885
void OrthancPluginSetHttpErrorDetails(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *details, uint8_t log)
Provide a detailed description for an HTTP error.
Definition: OrthancCPlugin.h:7045
void OrthancPluginSendMethodNotAllowed(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *allowedMethods)
Signal that this URI does not support this HTTP method.
Definition: OrthancCPlugin.h:2908
void OrthancPluginAnswerBuffer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const void *answer, uint32_t answerSize, const char *mimeType)
Answer to a REST request.
Definition: OrthancCPlugin.h:2265
void OrthancPluginSendHttpStatusCode(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status)
Send a HTTP status code.
Definition: OrthancCPlugin.h:2862
void OrthancPluginSetHttpHeader(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *key, const char *value)
Set some HTTP header.
Definition: OrthancCPlugin.h:2963
void OrthancPluginSetCookie(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *cookie, const char *value)
Set a cookie.
Definition: OrthancCPlugin.h:2938
void OrthancPluginRedirect(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *redirection)
Redirect a REST request.
Definition: OrthancCPlugin.h:2645
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:4346
OrthancPluginErrorCode OrthancPluginSendMultipartItem(OrthancPluginContext *context, OrthancPluginRestOutput *output, const void *answer, uint32_t answerSize)
Send an item as a part of some HTTP multipart answer.
Definition: OrthancCPlugin.h:3759
OrthancPluginErrorCode OrthancPluginSendMultipartItem2(OrthancPluginContext *context, OrthancPluginRestOutput *output, const void *answer, uint32_t answerSize, uint32_t headersCount, const char *const *headersKeys, const char *const *headersValues)
Send an item as a part of some HTTP multipart answer, with custom headers.
Definition: OrthancCPlugin.h:5792
void OrthancPluginSendHttpStatus(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status, const void *body, uint32_t bodySize)
Send a HTTP status, with a custom body.
Definition: OrthancCPlugin.h:3953
OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *subType, const char *contentType)
Start an HTTP multipart answer.
Definition: OrthancCPlugin.h:3730
An entry in the dictionary of DICOM tags.
Definition: OrthancCPlugin.h:1881
uint32_t minMultiplicity
Definition: OrthancCPlugin.h:1885
uint32_t maxMultiplicity
Definition: OrthancCPlugin.h:1886
OrthancPluginValueRepresentation vr
Definition: OrthancCPlugin.h:1884
uint16_t element
Definition: OrthancCPlugin.h:1883
uint16_t group
Definition: OrthancCPlugin.h:1882
The parameters of a REST request.
Definition: OrthancCPlugin.h:343
const char *const * getValues
For a GET request, the values of the GET parameters.
Definition: OrthancCPlugin.h:372
const char *const * groups
The matched values for the groups of the regular expression.
Definition: OrthancCPlugin.h:357
uint32_t bodySize
For a PUT or POST request, the number of bytes of the body.
Definition: OrthancCPlugin.h:382
uint32_t groupsCount
The number of groups of the regular expression.
Definition: OrthancCPlugin.h:352
const char *const * headersKeys
The keys of the HTTP headers (always converted to low-case).
Definition: OrthancCPlugin.h:397
const void * body
For a PUT or POST request, the content of the body.
Definition: OrthancCPlugin.h:377
const char *const * getKeys
For a GET request, the keys of the GET parameters.
Definition: OrthancCPlugin.h:367
uint32_t headersCount
The number of HTTP headers.
Definition: OrthancCPlugin.h:392
OrthancPluginHttpMethod method
The HTTP method.
Definition: OrthancCPlugin.h:347
uint32_t getCount
For a GET request, the number of GET parameters.
Definition: OrthancCPlugin.h:362
const char *const * headersValues
The values of the HTTP headers.
Definition: OrthancCPlugin.h:402
A 64-bit memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:1104
uint64_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:1113
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:1108
A 32-bit memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:1082
uint32_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:1091
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:1086