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 10 123 #define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 1 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 310 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
318 ORTHANC_PLUGINS_API
const char* OrthancPluginGetName();
331 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
407 _OrthancPluginService_LogInfo = 1,
408 _OrthancPluginService_LogWarning = 2,
409 _OrthancPluginService_LogError = 3,
410 _OrthancPluginService_GetOrthancPath = 4,
411 _OrthancPluginService_GetOrthancDirectory = 5,
412 _OrthancPluginService_GetConfigurationPath = 6,
413 _OrthancPluginService_SetPluginProperty = 7,
414 _OrthancPluginService_GetGlobalProperty = 8,
415 _OrthancPluginService_SetGlobalProperty = 9,
416 _OrthancPluginService_GetCommandLineArgumentsCount = 10,
417 _OrthancPluginService_GetCommandLineArgument = 11,
418 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
419 _OrthancPluginService_GetConfiguration = 13,
420 _OrthancPluginService_BufferCompression = 14,
421 _OrthancPluginService_ReadFile = 15,
422 _OrthancPluginService_WriteFile = 16,
423 _OrthancPluginService_GetErrorDescription = 17,
424 _OrthancPluginService_CallHttpClient = 18,
425 _OrthancPluginService_RegisterErrorCode = 19,
426 _OrthancPluginService_RegisterDictionaryTag = 20,
427 _OrthancPluginService_DicomBufferToJson = 21,
428 _OrthancPluginService_DicomInstanceToJson = 22,
429 _OrthancPluginService_CreateDicom = 23,
430 _OrthancPluginService_ComputeMd5 = 24,
431 _OrthancPluginService_ComputeSha1 = 25,
432 _OrthancPluginService_LookupDictionary = 26,
433 _OrthancPluginService_CallHttpClient2 = 27,
434 _OrthancPluginService_GenerateUuid = 28,
435 _OrthancPluginService_RegisterPrivateDictionaryTag = 29,
436 _OrthancPluginService_AutodetectMimeType = 30,
437 _OrthancPluginService_SetMetricsValue = 31,
438 _OrthancPluginService_EncodeDicomWebJson = 32,
439 _OrthancPluginService_EncodeDicomWebXml = 33,
440 _OrthancPluginService_ChunkedHttpClient = 34,
441 _OrthancPluginService_GetTagName = 35,
442 _OrthancPluginService_EncodeDicomWebJson2 = 36,
443 _OrthancPluginService_EncodeDicomWebXml2 = 37,
444 _OrthancPluginService_CreateMemoryBuffer = 38,
445 _OrthancPluginService_GenerateRestApiAuthorizationToken = 39,
446 _OrthancPluginService_CreateMemoryBuffer64 = 40,
447 _OrthancPluginService_CreateDicom2 = 41,
450 _OrthancPluginService_RegisterRestCallback = 1000,
451 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
452 _OrthancPluginService_RegisterStorageArea = 1002,
453 _OrthancPluginService_RegisterOnChangeCallback = 1003,
454 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
455 _OrthancPluginService_RegisterWorklistCallback = 1005,
456 _OrthancPluginService_RegisterDecodeImageCallback = 1006,
457 _OrthancPluginService_RegisterIncomingHttpRequestFilter = 1007,
458 _OrthancPluginService_RegisterFindCallback = 1008,
459 _OrthancPluginService_RegisterMoveCallback = 1009,
460 _OrthancPluginService_RegisterIncomingHttpRequestFilter2 = 1010,
461 _OrthancPluginService_RegisterRefreshMetricsCallback = 1011,
462 _OrthancPluginService_RegisterChunkedRestCallback = 1012,
463 _OrthancPluginService_RegisterStorageCommitmentScpCallback = 1013,
464 _OrthancPluginService_RegisterIncomingDicomInstanceFilter = 1014,
465 _OrthancPluginService_RegisterTranscoderCallback = 1015,
466 _OrthancPluginService_RegisterStorageArea2 = 1016,
467 _OrthancPluginService_RegisterIncomingCStoreInstanceFilter = 1017,
468 _OrthancPluginService_RegisterReceivedInstanceCallback = 1018,
469 _OrthancPluginService_RegisterWebDavCollection = 1019,
472 _OrthancPluginService_AnswerBuffer = 2000,
473 _OrthancPluginService_CompressAndAnswerPngImage = 2001,
474 _OrthancPluginService_Redirect = 2002,
475 _OrthancPluginService_SendHttpStatusCode = 2003,
476 _OrthancPluginService_SendUnauthorized = 2004,
477 _OrthancPluginService_SendMethodNotAllowed = 2005,
478 _OrthancPluginService_SetCookie = 2006,
479 _OrthancPluginService_SetHttpHeader = 2007,
480 _OrthancPluginService_StartMultipartAnswer = 2008,
481 _OrthancPluginService_SendMultipartItem = 2009,
482 _OrthancPluginService_SendHttpStatus = 2010,
483 _OrthancPluginService_CompressAndAnswerImage = 2011,
484 _OrthancPluginService_SendMultipartItem2 = 2012,
485 _OrthancPluginService_SetHttpErrorDetails = 2013,
488 _OrthancPluginService_GetDicomForInstance = 3000,
489 _OrthancPluginService_RestApiGet = 3001,
490 _OrthancPluginService_RestApiPost = 3002,
491 _OrthancPluginService_RestApiDelete = 3003,
492 _OrthancPluginService_RestApiPut = 3004,
493 _OrthancPluginService_LookupPatient = 3005,
494 _OrthancPluginService_LookupStudy = 3006,
495 _OrthancPluginService_LookupSeries = 3007,
496 _OrthancPluginService_LookupInstance = 3008,
497 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
498 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
499 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
500 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
501 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
502 _OrthancPluginService_ReconstructMainDicomTags = 3014,
503 _OrthancPluginService_RestApiGet2 = 3015,
504 _OrthancPluginService_CallRestApi = 3016,
507 _OrthancPluginService_GetInstanceRemoteAet = 4000,
508 _OrthancPluginService_GetInstanceSize = 4001,
509 _OrthancPluginService_GetInstanceData = 4002,
510 _OrthancPluginService_GetInstanceJson = 4003,
511 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
512 _OrthancPluginService_HasInstanceMetadata = 4005,
513 _OrthancPluginService_GetInstanceMetadata = 4006,
514 _OrthancPluginService_GetInstanceOrigin = 4007,
515 _OrthancPluginService_GetInstanceTransferSyntaxUid = 4008,
516 _OrthancPluginService_HasInstancePixelData = 4009,
517 _OrthancPluginService_CreateDicomInstance = 4010,
518 _OrthancPluginService_FreeDicomInstance = 4011,
519 _OrthancPluginService_GetInstanceFramesCount = 4012,
520 _OrthancPluginService_GetInstanceRawFrame = 4013,
521 _OrthancPluginService_GetInstanceDecodedFrame = 4014,
522 _OrthancPluginService_TranscodeDicomInstance = 4015,
523 _OrthancPluginService_SerializeDicomInstance = 4016,
524 _OrthancPluginService_GetInstanceAdvancedJson = 4017,
525 _OrthancPluginService_GetInstanceDicomWebJson = 4018,
526 _OrthancPluginService_GetInstanceDicomWebXml = 4019,
529 _OrthancPluginService_RegisterDatabaseBackend = 5000,
530 _OrthancPluginService_DatabaseAnswer = 5001,
531 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002,
532 _OrthancPluginService_StorageAreaCreate = 5003,
533 _OrthancPluginService_StorageAreaRead = 5004,
534 _OrthancPluginService_StorageAreaRemove = 5005,
535 _OrthancPluginService_RegisterDatabaseBackendV3 = 5006,
538 _OrthancPluginService_GetImagePixelFormat = 6000,
539 _OrthancPluginService_GetImageWidth = 6001,
540 _OrthancPluginService_GetImageHeight = 6002,
541 _OrthancPluginService_GetImagePitch = 6003,
542 _OrthancPluginService_GetImageBuffer = 6004,
543 _OrthancPluginService_UncompressImage = 6005,
544 _OrthancPluginService_FreeImage = 6006,
545 _OrthancPluginService_CompressImage = 6007,
546 _OrthancPluginService_ConvertPixelFormat = 6008,
547 _OrthancPluginService_GetFontsCount = 6009,
548 _OrthancPluginService_GetFontInfo = 6010,
549 _OrthancPluginService_DrawText = 6011,
550 _OrthancPluginService_CreateImage = 6012,
551 _OrthancPluginService_CreateImageAccessor = 6013,
552 _OrthancPluginService_DecodeDicomImage = 6014,
555 _OrthancPluginService_WorklistAddAnswer = 7000,
556 _OrthancPluginService_WorklistMarkIncomplete = 7001,
557 _OrthancPluginService_WorklistIsMatch = 7002,
558 _OrthancPluginService_WorklistGetDicomQuery = 7003,
559 _OrthancPluginService_FindAddAnswer = 7004,
560 _OrthancPluginService_FindMarkIncomplete = 7005,
561 _OrthancPluginService_GetFindQuerySize = 7006,
562 _OrthancPluginService_GetFindQueryTag = 7007,
563 _OrthancPluginService_GetFindQueryTagName = 7008,
564 _OrthancPluginService_GetFindQueryValue = 7009,
565 _OrthancPluginService_CreateFindMatcher = 7010,
566 _OrthancPluginService_FreeFindMatcher = 7011,
567 _OrthancPluginService_FindMatcherIsMatch = 7012,
570 _OrthancPluginService_GetPeers = 8000,
571 _OrthancPluginService_FreePeers = 8001,
572 _OrthancPluginService_GetPeersCount = 8003,
573 _OrthancPluginService_GetPeerName = 8004,
574 _OrthancPluginService_GetPeerUrl = 8005,
575 _OrthancPluginService_CallPeerApi = 8006,
576 _OrthancPluginService_GetPeerUserProperty = 8007,
579 _OrthancPluginService_CreateJob = 9000,
580 _OrthancPluginService_FreeJob = 9001,
581 _OrthancPluginService_SubmitJob = 9002,
582 _OrthancPluginService_RegisterJobsUnserializer = 9003,
584 _OrthancPluginService_INTERNAL = 0x7fffffff
585 } _OrthancPluginService;
590 _OrthancPluginProperty_Description = 1,
591 _OrthancPluginProperty_RootUri = 2,
592 _OrthancPluginProperty_OrthancExplorer = 3,
594 _OrthancPluginProperty_INTERNAL = 0x7fffffff
595 } _OrthancPluginProperty;
687 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
702 _OrthancPluginContentType_INTERNAL = 0x7fffffff
718 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
749 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
764 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
778 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
816 _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff
831 _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff
842 OrthancPluginDicomToJsonFlags_None = 0,
852 _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff
863 OrthancPluginCreateDicomFlags_None = 0,
867 _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff
883 _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff
899 _OrthancPluginConstraintType_INTERNAL = 0x7fffffff
915 _OrthancPluginInstanceOrigin_INTERNAL = 0x7fffffff
1018 _OrthancPluginReceivedInstanceAction_INTERNAL = 0x7fffffff
1181 const char* instanceId);
1192 const char* resourceId);
1203 const uint32_t size,
1204 uint32_t frameIndex);
1225 const char* bulkDataUri);
1243 const void* content,
1315 uint64_t rangeStart);
1351 const char* issuerAet,
1352 const char* calledAet);
1383 uint32_t headersCount,
1384 const char*
const* headersKeys,
1385 const char*
const* headersValues);
1418 uint32_t headersCount,
1419 const char*
const* headersKeys,
1420 const char*
const* headersValues,
1421 uint32_t getArgumentsCount,
1422 const char*
const* getArgumentsKeys,
1423 const char*
const* getArgumentsValues);
1444 const char* issuerAet,
1445 const char* calledAet);
1484 typedef void* (*OrthancPluginMoveCallback) (
1486 const char* patientId,
1487 const char* accessionNumber,
1488 const char* studyInstanceUid,
1489 const char* seriesInstanceUid,
1490 const char* sopInstanceUid,
1491 const char* originatorAet,
1492 const char* sourceAet,
1493 const char* targetAet,
1494 uint16_t originatorId);
1579 typedef const char* (*OrthancPluginJobGetContent) (
void* job);
1597 typedef const char* (*OrthancPluginJobGetSerialized) (
void* job);
1670 const char* serialized);
1718 uint32_t levelDepth,
1719 const uint16_t* levelTagGroup,
1720 const uint16_t* levelTagElement,
1721 const uint32_t* levelIndex,
1723 uint16_t tagElement,
1756 uint32_t levelDepth,
1757 const uint16_t* levelTagGroup,
1758 const uint16_t* levelTagElement,
1759 const uint32_t* levelIndex,
1761 uint16_t tagElement,
1770 typedef struct _OrthancPluginContext_t
1772 void* pluginsManager;
1773 const char* orthancVersion;
1776 _OrthancPluginService service,
1777 const void* params);
1838 int expectedRevision)
1840 int major, minor, revision;
1844 sizeof(int32_t) !=
sizeof(_OrthancPluginService) ||
1845 sizeof(int32_t) !=
sizeof(_OrthancPluginProperty) ||
1870 if (!strcmp(context->orthancVersion,
"mainline"))
1882 (context->orthancVersion,
"%4d.%4d.%4d", &major, &minor, &revision) != 3)
1889 if (major > expectedMajor)
1894 if (major < expectedMajor)
1901 if (minor > expectedMinor)
1906 if (minor < expectedMinor)
1913 if (revision >= expectedRevision)
1945 ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER,
1946 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER,
1947 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER);
1963 context->Free(buffer->
data);
1979 context->Free(buffer->
data);
1993 const char* message)
1995 context->InvokeService(context, _OrthancPluginService_LogError, message);
2009 const char* message)
2011 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
2025 const char* message)
2027 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
2034 const char* pathRegularExpression;
2036 } _OrthancPluginRestCallback;
2061 const char* pathRegularExpression,
2064 _OrthancPluginRestCallback params;
2065 params.pathRegularExpression = pathRegularExpression;
2066 params.callback = callback;
2067 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
2101 const char* pathRegularExpression,
2104 _OrthancPluginRestCallback params;
2105 params.pathRegularExpression = pathRegularExpression;
2106 params.callback = callback;
2107 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms);
2115 } _OrthancPluginOnStoredInstanceCallback;
2141 _OrthancPluginOnStoredInstanceCallback params;
2142 params.callback = callback;
2144 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
2153 uint32_t answerSize;
2154 const char* mimeType;
2155 } _OrthancPluginAnswerBuffer;
2173 uint32_t answerSize,
2174 const char* mimeType)
2176 _OrthancPluginAnswerBuffer params;
2177 params.output = output;
2178 params.answer = answer;
2179 params.answerSize = answerSize;
2180 params.mimeType = mimeType;
2181 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms);
2193 } _OrthancPluginCompressAndAnswerPngImage;
2205 } _OrthancPluginCompressAndAnswerImage;
2235 _OrthancPluginCompressAndAnswerImage params;
2236 params.output = output;
2238 params.pixelFormat = format;
2239 params.width = width;
2240 params.height = height;
2241 params.pitch = pitch;
2242 params.buffer = buffer;
2244 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
2252 const char* instanceId;
2253 } _OrthancPluginGetDicomForInstance;
2270 const char* instanceId)
2272 _OrthancPluginGetDicomForInstance params;
2273 params.target = target;
2274 params.instanceId = instanceId;
2275 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
2284 } _OrthancPluginRestApiGet;
2305 _OrthancPluginRestApiGet params;
2306 params.target = target;
2308 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
2335 _OrthancPluginRestApiGet params;
2336 params.target = target;
2338 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms);
2349 } _OrthancPluginRestApiPostPut;
2374 _OrthancPluginRestApiPostPut params;
2375 params.target = target;
2378 params.bodySize = bodySize;
2379 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
2409 _OrthancPluginRestApiPostPut params;
2410 params.target = target;
2413 params.bodySize = bodySize;
2414 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms);
2435 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
2458 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
2486 _OrthancPluginRestApiPostPut params;
2487 params.target = target;
2490 params.bodySize = bodySize;
2491 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
2522 _OrthancPluginRestApiPostPut params;
2523 params.target = target;
2526 params.bodySize = bodySize;
2527 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms);
2535 const char* argument;
2536 } _OrthancPluginOutputPlusArgument;
2552 const char* redirection)
2554 _OrthancPluginOutputPlusArgument params;
2555 params.output = output;
2556 params.argument = redirection;
2557 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
2565 const char* argument;
2566 } _OrthancPluginRetrieveDynamicString;
2583 const char* patientID)
2587 _OrthancPluginRetrieveDynamicString params;
2588 params.result = &result;
2589 params.argument = patientID;
2618 const char* studyUID)
2622 _OrthancPluginRetrieveDynamicString params;
2623 params.result = &result;
2624 params.argument = studyUID;
2653 const char* accessionNumber)
2657 _OrthancPluginRetrieveDynamicString params;
2658 params.result = &result;
2659 params.argument = accessionNumber;
2688 const char* seriesUID)
2692 _OrthancPluginRetrieveDynamicString params;
2693 params.result = &result;
2694 params.argument = seriesUID;
2723 const char* sopInstanceUID)
2727 _OrthancPluginRetrieveDynamicString params;
2728 params.result = &result;
2729 params.argument = sopInstanceUID;
2748 } _OrthancPluginSendHttpStatusCode;
2771 _OrthancPluginSendHttpStatusCode params;
2772 params.output = output;
2773 params.status = status;
2774 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
2794 _OrthancPluginOutputPlusArgument params;
2795 params.output = output;
2796 params.argument = realm;
2797 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
2815 const char* allowedMethods)
2817 _OrthancPluginOutputPlusArgument params;
2818 params.output = output;
2819 params.argument = allowedMethods;
2820 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
2829 } _OrthancPluginSetHttpHeader;
2848 _OrthancPluginSetHttpHeader params;
2849 params.output = output;
2850 params.key = cookie;
2851 params.value = value;
2852 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
2873 _OrthancPluginSetHttpHeader params;
2874 params.output = output;
2876 params.value = value;
2877 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
2883 char** resultStringToFree;
2884 const char** resultString;
2885 int64_t* resultInt64;
2889 } _OrthancPluginAccessDicomInstance;
2909 _OrthancPluginAccessDicomInstance params;
2910 memset(¶ms, 0,
sizeof(params));
2911 params.resultString = &result;
2912 params.instance = instance;
2942 _OrthancPluginAccessDicomInstance params;
2943 memset(¶ms, 0,
sizeof(params));
2944 params.resultInt64 = &size;
2945 params.instance = instance;
2975 _OrthancPluginAccessDicomInstance params;
2976 memset(¶ms, 0,
sizeof(params));
2977 params.resultString = &result;
2978 params.instance = instance;
3011 _OrthancPluginAccessDicomInstance params;
3012 memset(¶ms, 0,
sizeof(params));
3013 params.resultStringToFree = &result;
3014 params.instance = instance;
3049 _OrthancPluginAccessDicomInstance params;
3050 memset(¶ms, 0,
sizeof(params));
3051 params.resultStringToFree = &result;
3052 params.instance = instance;
3085 const char* metadata)
3089 _OrthancPluginAccessDicomInstance params;
3090 memset(¶ms, 0,
sizeof(params));
3091 params.resultInt64 = &result;
3092 params.instance = instance;
3093 params.key = metadata;
3102 return (result != 0);
3126 const char* metadata)
3130 _OrthancPluginAccessDicomInstance params;
3131 memset(¶ms, 0,
sizeof(params));
3132 params.resultString = &result;
3133 params.instance = instance;
3134 params.key = metadata;
3155 } _OrthancPluginRegisterStorageArea;
3178 _OrthancPluginRegisterStorageArea params;
3179 params.create = create;
3181 params.remove =
remove;
3184 params.free = ::free;
3189 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
3208 _OrthancPluginRetrieveDynamicString params;
3209 params.result = &result;
3210 params.argument = NULL;
3238 _OrthancPluginRetrieveDynamicString params;
3239 params.result = &result;
3240 params.argument = NULL;
3273 _OrthancPluginRetrieveDynamicString params;
3274 params.result = &result;
3275 params.argument = NULL;
3293 } _OrthancPluginOnChangeCallback;
3319 _OrthancPluginOnChangeCallback params;
3320 params.callback = callback;
3322 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms);
3330 _OrthancPluginProperty property;
3332 } _OrthancPluginSetPluginProperty;
3350 _OrthancPluginSetPluginProperty params;
3351 params.plugin = OrthancPluginGetName();
3352 params.property = _OrthancPluginProperty_RootUri;
3355 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3370 const char* description)
3372 _OrthancPluginSetPluginProperty params;
3373 params.plugin = OrthancPluginGetName();
3374 params.property = _OrthancPluginProperty_Description;
3375 params.value = description;
3377 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3392 const char* javascript)
3394 _OrthancPluginSetPluginProperty params;
3395 params.plugin = OrthancPluginGetName();
3396 params.property = _OrthancPluginProperty_OrthancExplorer;
3397 params.value = javascript;
3399 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3408 } _OrthancPluginGlobalProperty;
3427 const char* defaultValue)
3431 _OrthancPluginGlobalProperty params;
3432 params.result = &result;
3433 params.property = property;
3434 params.value = defaultValue;
3468 _OrthancPluginGlobalProperty params;
3469 params.result = NULL;
3470 params.property = property;
3471 params.value = value;
3473 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms);
3480 int32_t *resultInt32;
3481 uint32_t *resultUint32;
3482 int64_t *resultInt64;
3483 uint64_t *resultUint64;
3484 } _OrthancPluginReturnSingleValue;
3499 _OrthancPluginReturnSingleValue params;
3500 memset(¶ms, 0,
sizeof(params));
3501 params.resultUint32 = &count;
3534 _OrthancPluginGlobalProperty params;
3535 params.result = &result;
3536 params.property = (int32_t) argument;
3537 params.value = NULL;
3565 _OrthancPluginReturnSingleValue params;
3566 memset(¶ms, 0,
sizeof(params));
3567 params.resultUint32 = &count;
3597 _OrthancPluginRetrieveDynamicString params;
3598 params.result = &result;
3599 params.argument = NULL;
3617 const char* subType;
3618 const char* contentType;
3619 } _OrthancPluginStartMultipartAnswer;
3637 const char* subType,
3638 const char* contentType)
3640 _OrthancPluginStartMultipartAnswer params;
3641 params.output = output;
3642 params.subType = subType;
3643 params.contentType = contentType;
3644 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms);
3667 uint32_t answerSize)
3669 _OrthancPluginAnswerBuffer params;
3670 params.output = output;
3671 params.answer = answer;
3672 params.answerSize = answerSize;
3673 params.mimeType = NULL;
3674 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms);
3686 } _OrthancPluginBufferCompression;
3713 _OrthancPluginBufferCompression params;
3714 params.target = target;
3715 params.source = source;
3717 params.compression = compression;
3718 params.uncompress = uncompress;
3720 return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms);
3729 } _OrthancPluginReadFile;
3747 _OrthancPluginReadFile params;
3748 params.target = target;
3750 return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms);
3760 } _OrthancPluginWriteFile;
3779 _OrthancPluginWriteFile params;
3783 return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms);
3790 const char** target;
3792 } _OrthancPluginGetErrorDescription;
3808 const char* result = NULL;
3810 _OrthancPluginGetErrorDescription params;
3811 params.target = &result;
3812 params.error = error;
3817 return "Unknown error code";
3833 } _OrthancPluginSendHttpStatus;
3864 _OrthancPluginSendHttpStatus params;
3865 params.output = output;
3866 params.status = status;
3868 params.bodySize = bodySize;
3869 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms);
3877 uint32_t* resultUint32;
3879 void** resultBuffer;
3880 } _OrthancPluginGetImageInfo;
3899 _OrthancPluginGetImageInfo params;
3900 memset(¶ms, 0,
sizeof(params));
3901 params.image = image;
3902 params.resultPixelFormat = ⌖
3932 _OrthancPluginGetImageInfo params;
3933 memset(¶ms, 0,
sizeof(params));
3934 params.image = image;
3935 params.resultUint32 = &width;
3965 _OrthancPluginGetImageInfo params;
3966 memset(¶ms, 0,
sizeof(params));
3967 params.image = image;
3968 params.resultUint32 = &height;
4000 _OrthancPluginGetImageInfo params;
4001 memset(¶ms, 0,
sizeof(params));
4002 params.image = image;
4003 params.resultUint32 = &pitch;
4032 void* target = NULL;
4034 _OrthancPluginGetImageInfo params;
4035 memset(¶ms, 0,
sizeof(params));
4036 params.resultBuffer = ⌖
4037 params.image = image;
4056 } _OrthancPluginUncompressImage;
4079 _OrthancPluginUncompressImage params;
4080 memset(¶ms, 0,
sizeof(params));
4081 params.target = ⌖
4084 params.format = format;
4102 } _OrthancPluginFreeImage;
4117 _OrthancPluginFreeImage params;
4118 params.image = image;
4120 context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms);
4136 } _OrthancPluginCompressImage;
4167 _OrthancPluginCompressImage params;
4168 memset(¶ms, 0,
sizeof(params));
4169 params.target = target;
4171 params.pixelFormat = format;
4172 params.width = width;
4173 params.height = height;
4174 params.pitch = pitch;
4175 params.buffer = buffer;
4178 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4213 _OrthancPluginCompressImage params;
4214 memset(¶ms, 0,
sizeof(params));
4215 params.target = target;
4217 params.pixelFormat = format;
4218 params.width = width;
4219 params.height = height;
4220 params.pitch = pitch;
4221 params.buffer = buffer;
4222 params.quality = quality;
4224 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4260 _OrthancPluginCompressAndAnswerImage params;
4261 params.output = output;
4263 params.pixelFormat = format;
4264 params.width = width;
4265 params.height = height;
4266 params.pitch = pitch;
4267 params.buffer = buffer;
4268 params.quality = quality;
4269 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
4280 const char* username;
4281 const char* password;
4284 } _OrthancPluginCallHttpClient;
4307 const char* username,
4308 const char* password)
4310 _OrthancPluginCallHttpClient params;
4311 memset(¶ms, 0,
sizeof(params));
4313 params.target = target;
4316 params.username = username;
4317 params.password = password;
4319 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4347 const char* username,
4348 const char* password)
4350 _OrthancPluginCallHttpClient params;
4351 memset(¶ms, 0,
sizeof(params));
4353 params.target = target;
4357 params.bodySize = bodySize;
4358 params.username = username;
4359 params.password = password;
4361 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4389 const char* username,
4390 const char* password)
4392 _OrthancPluginCallHttpClient params;
4393 memset(¶ms, 0,
sizeof(params));
4395 params.target = target;
4399 params.bodySize = bodySize;
4400 params.username = username;
4401 params.password = password;
4403 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4424 const char* username,
4425 const char* password)
4427 _OrthancPluginCallHttpClient params;
4428 memset(¶ms, 0,
sizeof(params));
4432 params.username = username;
4433 params.password = password;
4435 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4445 } _OrthancPluginConvertPixelFormat;
4466 _OrthancPluginConvertPixelFormat params;
4467 params.target = ⌖
4468 params.source = source;
4469 params.targetFormat = targetFormat;
4499 _OrthancPluginReturnSingleValue params;
4500 memset(¶ms, 0,
sizeof(params));
4501 params.resultUint32 = &count;
4522 } _OrthancPluginGetFontInfo;
4538 const char* result = NULL;
4540 _OrthancPluginGetFontInfo params;
4541 memset(¶ms, 0,
sizeof(params));
4542 params.name = &result;
4543 params.fontIndex = fontIndex;
4572 _OrthancPluginGetFontInfo params;
4573 memset(¶ms, 0,
sizeof(params));
4574 params.size = &result;
4575 params.fontIndex = fontIndex;
4593 const char* utf8Text;
4599 } _OrthancPluginDrawText;
4623 const char* utf8Text,
4630 _OrthancPluginDrawText params;
4631 memset(¶ms, 0,
sizeof(params));
4632 params.image = image;
4633 params.fontIndex = fontIndex;
4634 params.utf8Text = utf8Text;
4641 return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms);
4650 const void* content;
4653 } _OrthancPluginStorageAreaCreate;
4677 const void* content,
4681 _OrthancPluginStorageAreaCreate params;
4682 params.storageArea = storageArea;
4684 params.content = content;
4688 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms);
4698 } _OrthancPluginStorageAreaRead;
4724 _OrthancPluginStorageAreaRead params;
4725 params.target = target;
4726 params.storageArea = storageArea;
4730 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms);
4739 } _OrthancPluginStorageAreaRemove;
4762 _OrthancPluginStorageAreaRemove params;
4763 params.storageArea = storageArea;
4767 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms);
4776 uint16_t httpStatus;
4777 const char* message;
4778 } _OrthancPluginRegisterErrorCode;
4798 uint16_t httpStatus,
4799 const char* message)
4803 _OrthancPluginRegisterErrorCode params;
4804 params.target = ⌖
4806 params.httpStatus = httpStatus;
4807 params.message = message;
4828 uint32_t minMultiplicity;
4829 uint32_t maxMultiplicity;
4830 } _OrthancPluginRegisterDictionaryTag;
4857 uint32_t minMultiplicity,
4858 uint32_t maxMultiplicity)
4860 _OrthancPluginRegisterDictionaryTag params;
4861 params.group = group;
4862 params.element = element;
4865 params.minMultiplicity = minMultiplicity;
4866 params.maxMultiplicity = maxMultiplicity;
4868 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, ¶ms);
4879 uint32_t minMultiplicity;
4880 uint32_t maxMultiplicity;
4881 const char* privateCreator;
4882 } _OrthancPluginRegisterPrivateDictionaryTag;
4910 uint32_t minMultiplicity,
4911 uint32_t maxMultiplicity,
4912 const char* privateCreator)
4914 _OrthancPluginRegisterPrivateDictionaryTag params;
4915 params.group = group;
4916 params.element = element;
4919 params.minMultiplicity = minMultiplicity;
4920 params.maxMultiplicity = maxMultiplicity;
4921 params.privateCreator = privateCreator;
4923 return context->InvokeService(context, _OrthancPluginService_RegisterPrivateDictionaryTag, ¶ms);
4932 } _OrthancPluginReconstructMainDicomTags;
4953 _OrthancPluginReconstructMainDicomTags params;
4954 params.level = level;
4955 params.storageArea = storageArea;
4957 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, ¶ms);
4964 const char* instanceId;
4969 uint32_t maxStringLength;
4970 } _OrthancPluginDicomToJson;
4998 uint32_t maxStringLength)
5002 _OrthancPluginDicomToJson params;
5003 memset(¶ms, 0,
sizeof(params));
5004 params.result = &result;
5005 params.buffer = buffer;
5007 params.format = format;
5008 params.flags = flags;
5009 params.maxStringLength = maxStringLength;
5043 const char* instanceId,
5046 uint32_t maxStringLength)
5050 _OrthancPluginDicomToJson params;
5051 memset(¶ms, 0,
sizeof(params));
5052 params.result = &result;
5053 params.instanceId = instanceId;
5054 params.format = format;
5055 params.flags = flags;
5056 params.maxStringLength = maxStringLength;
5074 uint32_t headersCount;
5075 const char*
const* headersKeys;
5076 const char*
const* headersValues;
5077 int32_t afterPlugins;
5078 } _OrthancPluginRestApiGet2;
5103 uint32_t headersCount,
5104 const char*
const* headersKeys,
5105 const char*
const* headersValues,
5106 int32_t afterPlugins)
5108 _OrthancPluginRestApiGet2 params;
5109 params.target = target;
5111 params.headersCount = headersCount;
5112 params.headersKeys = headersKeys;
5113 params.headersValues = headersValues;
5114 params.afterPlugins = afterPlugins;
5116 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, ¶ms);
5124 } _OrthancPluginWorklistCallback;
5141 _OrthancPluginWorklistCallback params;
5142 params.callback = callback;
5144 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, ¶ms);
5155 } _OrthancPluginWorklistAnswersOperation;
5180 _OrthancPluginWorklistAnswersOperation params;
5181 params.answers = answers;
5182 params.query = query;
5183 params.dicom = dicom;
5186 return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, ¶ms);
5207 _OrthancPluginWorklistAnswersOperation params;
5208 params.answers = answers;
5209 params.query = NULL;
5210 params.dicom = NULL;
5213 return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, ¶ms);
5224 } _OrthancPluginWorklistQueryOperation;
5247 int32_t isMatch = 0;
5249 _OrthancPluginWorklistQueryOperation params;
5250 params.query = query;
5251 params.dicom = dicom;
5253 params.isMatch = &isMatch;
5254 params.target = NULL;
5285 _OrthancPluginWorklistQueryOperation params;
5286 params.query = query;
5287 params.dicom = NULL;
5289 params.isMatch = NULL;
5290 params.target = target;
5292 return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, ¶ms);
5312 _OrthancPluginAccessDicomInstance params;
5313 memset(¶ms, 0,
sizeof(params));
5314 params.resultOrigin = &origin;
5315 params.instance = instance;
5335 } _OrthancPluginCreateDicom;
5369 _OrthancPluginCreateDicom params;
5370 params.target = target;
5372 params.pixelData = pixelData;
5373 params.flags = flags;
5375 return context->InvokeService(context, _OrthancPluginService_CreateDicom, ¶ms);
5382 } _OrthancPluginDecodeImageCallback;
5402 _OrthancPluginDecodeImageCallback params;
5403 params.callback = callback;
5405 return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, ¶ms);
5418 const void* constBuffer;
5419 uint32_t bufferSize;
5420 uint32_t frameIndex;
5421 } _OrthancPluginCreateImage;
5444 _OrthancPluginCreateImage params;
5445 memset(¶ms, 0,
sizeof(params));
5446 params.target = ⌖
5447 params.format = format;
5448 params.width = width;
5449 params.height = height;
5489 _OrthancPluginCreateImage params;
5490 memset(¶ms, 0,
sizeof(params));
5491 params.target = ⌖
5492 params.format = format;
5493 params.width = width;
5494 params.height = height;
5495 params.pitch = pitch;
5496 params.buffer = buffer;
5528 uint32_t bufferSize,
5529 uint32_t frameIndex)
5533 _OrthancPluginCreateImage params;
5534 memset(¶ms, 0,
sizeof(params));
5535 params.target = ⌖
5536 params.constBuffer = buffer;
5537 params.bufferSize = bufferSize;
5538 params.frameIndex = frameIndex;
5557 } _OrthancPluginComputeHash;
5578 _OrthancPluginComputeHash params;
5579 params.result = &result;
5580 params.buffer = buffer;
5614 _OrthancPluginComputeHash params;
5615 params.result = &result;
5616 params.buffer = buffer;
5636 } _OrthancPluginLookupDictionary;
5658 _OrthancPluginLookupDictionary params;
5659 params.target = target;
5661 return context->InvokeService(context, _OrthancPluginService_LookupDictionary, ¶ms);
5670 uint32_t answerSize;
5671 uint32_t headersCount;
5672 const char*
const* headersKeys;
5673 const char*
const* headersValues;
5674 } _OrthancPluginSendMultipartItem2;
5700 uint32_t answerSize,
5701 uint32_t headersCount,
5702 const char*
const* headersKeys,
5703 const char*
const* headersValues)
5705 _OrthancPluginSendMultipartItem2 params;
5706 params.output = output;
5707 params.answer = answer;
5708 params.answerSize = answerSize;
5709 params.headersCount = headersCount;
5710 params.headersKeys = headersKeys;
5711 params.headersValues = headersValues;
5713 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem2, ¶ms);
5720 } _OrthancPluginIncomingHttpRequestFilter;
5738 _OrthancPluginIncomingHttpRequestFilter params;
5739 params.callback = callback;
5741 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter, ¶ms);
5750 uint16_t* httpStatus;
5753 uint32_t headersCount;
5754 const char*
const* headersKeys;
5755 const char*
const* headersValues;
5758 const char* username;
5759 const char* password;
5761 const char* certificateFile;
5762 const char* certificateKeyFile;
5763 const char* certificateKeyPassword;
5765 } _OrthancPluginCallHttpClient2;
5813 uint16_t* httpStatus,
5816 uint32_t headersCount,
5817 const char*
const* headersKeys,
5818 const char*
const* headersValues,
5821 const char* username,
5822 const char* password,
5824 const char* certificateFile,
5825 const char* certificateKeyFile,
5826 const char* certificateKeyPassword,
5829 _OrthancPluginCallHttpClient2 params;
5830 memset(¶ms, 0,
sizeof(params));
5832 params.answerBody = answerBody;
5833 params.answerHeaders = answerHeaders;
5834 params.httpStatus = httpStatus;
5835 params.method = method;
5837 params.headersCount = headersCount;
5838 params.headersKeys = headersKeys;
5839 params.headersValues = headersValues;
5841 params.bodySize = bodySize;
5842 params.username = username;
5843 params.password = password;
5844 params.timeout = timeout;
5845 params.certificateFile = certificateFile;
5846 params.certificateKeyFile = certificateKeyFile;
5847 params.certificateKeyPassword = certificateKeyPassword;
5848 params.pkcs11 = pkcs11;
5850 return context->InvokeService(context, _OrthancPluginService_CallHttpClient2, ¶ms);
5869 _OrthancPluginRetrieveDynamicString params;
5870 params.result = &result;
5871 params.argument = NULL;
5890 } _OrthancPluginFindCallback;
5907 _OrthancPluginFindCallback params;
5908 params.callback = callback;
5910 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback, ¶ms);
5921 uint32_t *resultUint32;
5922 uint16_t *resultGroup;
5923 uint16_t *resultElement;
5924 char **resultString;
5925 } _OrthancPluginFindOperation;
5948 _OrthancPluginFindOperation params;
5949 memset(¶ms, 0,
sizeof(params));
5950 params.answers = answers;
5951 params.dicom = dicom;
5954 return context->InvokeService(context, _OrthancPluginService_FindAddAnswer, ¶ms);
5975 _OrthancPluginFindOperation params;
5976 memset(¶ms, 0,
sizeof(params));
5977 params.answers = answers;
5979 return context->InvokeService(context, _OrthancPluginService_FindMarkIncomplete, ¶ms);
6001 _OrthancPluginFindOperation params;
6002 memset(¶ms, 0,
sizeof(params));
6003 params.query = query;
6004 params.resultUint32 = &count;
6039 _OrthancPluginFindOperation params;
6040 memset(¶ms, 0,
sizeof(params));
6041 params.query = query;
6042 params.index = index;
6043 params.resultGroup = group;
6044 params.resultElement = element;
6046 return context->InvokeService(context, _OrthancPluginService_GetFindQueryTag, ¶ms);
6070 _OrthancPluginFindOperation params;
6071 memset(¶ms, 0,
sizeof(params));
6072 params.query = query;
6073 params.index = index;
6074 params.resultString = &result;
6108 _OrthancPluginFindOperation params;
6109 memset(¶ms, 0,
sizeof(params));
6110 params.query = query;
6111 params.index = index;
6112 params.resultString = &result;
6134 } _OrthancPluginMoveCallback;
6156 _OrthancPluginMoveCallback params;
6157 params.callback = callback;
6158 params.getMoveSize = getMoveSize;
6159 params.applyMove = applyMove;
6160 params.freeMove = freeMove;
6162 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback, ¶ms);
6172 } _OrthancPluginCreateFindMatcher;
6195 _OrthancPluginCreateFindMatcher params;
6196 memset(¶ms, 0,
sizeof(params));
6197 params.target = ⌖
6198 params.query = query;
6215 } _OrthancPluginFreeFindMatcher;
6230 _OrthancPluginFreeFindMatcher params;
6231 params.matcher = matcher;
6233 context->InvokeService(context, _OrthancPluginService_FreeFindMatcher, ¶ms);
6243 } _OrthancPluginFindMatcherIsMatch;
6265 int32_t isMatch = 0;
6267 _OrthancPluginFindMatcherIsMatch params;
6268 params.matcher = matcher;
6269 params.dicom = dicom;
6271 params.isMatch = &isMatch;
6288 } _OrthancPluginIncomingHttpRequestFilter2;
6305 _OrthancPluginIncomingHttpRequestFilter2 params;
6306 params.callback = callback;
6308 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter2, ¶ms);
6316 } _OrthancPluginGetPeers;
6334 _OrthancPluginGetPeers params;
6335 memset(¶ms, 0,
sizeof(params));
6336 params.peers = &peers;
6352 } _OrthancPluginFreePeers;
6367 _OrthancPluginFreePeers params;
6368 params.peers = peers;
6370 context->InvokeService(context, _OrthancPluginService_FreePeers, ¶ms);
6378 } _OrthancPluginGetPeersCount;
6397 uint32_t target = 0;
6399 _OrthancPluginGetPeersCount params;
6400 memset(¶ms, 0,
sizeof(params));
6401 params.target = ⌖
6402 params.peers = peers;
6418 const char** target;
6421 const char* userProperty;
6422 } _OrthancPluginGetPeerProperty;
6446 const char* target = NULL;
6448 _OrthancPluginGetPeerProperty params;
6449 memset(¶ms, 0,
sizeof(params));
6450 params.target = ⌖
6451 params.peers = peers;
6452 params.peerIndex = peerIndex;
6453 params.userProperty = NULL;
6487 const char* target = NULL;
6489 _OrthancPluginGetPeerProperty params;
6490 memset(¶ms, 0,
sizeof(params));
6491 params.target = ⌖
6492 params.peers = peers;
6493 params.peerIndex = peerIndex;
6494 params.userProperty = NULL;
6532 const char* userProperty)
6534 const char* target = NULL;
6536 _OrthancPluginGetPeerProperty params;
6537 memset(¶ms, 0,
sizeof(params));
6538 params.target = ⌖
6539 params.peers = peers;
6540 params.peerIndex = peerIndex;
6541 params.userProperty = userProperty;
6560 uint16_t* httpStatus;
6565 uint32_t additionalHeadersCount;
6566 const char*
const* additionalHeadersKeys;
6567 const char*
const* additionalHeadersValues;
6571 } _OrthancPluginCallPeerApi;
6613 uint16_t* httpStatus,
6618 uint32_t additionalHeadersCount,
6619 const char*
const* additionalHeadersKeys,
6620 const char*
const* additionalHeadersValues,
6625 _OrthancPluginCallPeerApi params;
6626 memset(¶ms, 0,
sizeof(params));
6628 params.answerBody = answerBody;
6629 params.answerHeaders = answerHeaders;
6630 params.httpStatus = httpStatus;
6631 params.peers = peers;
6632 params.peerIndex = peerIndex;
6633 params.method = method;
6635 params.additionalHeadersCount = additionalHeadersCount;
6636 params.additionalHeadersKeys = additionalHeadersKeys;
6637 params.additionalHeadersValues = additionalHeadersValues;
6639 params.bodySize = bodySize;
6640 params.timeout = timeout;
6642 return context->InvokeService(context, _OrthancPluginService_CallPeerApi, ¶ms);
6661 } _OrthancPluginCreateJob;
6708 _OrthancPluginCreateJob params;
6709 memset(¶ms, 0,
sizeof(params));
6711 params.target = ⌖
6713 params.finalize = finalize;
6715 params.getProgress = getProgress;
6716 params.getContent = getContent;
6717 params.getSerialized = getSerialized;
6720 params.reset = reset;
6738 } _OrthancPluginFreeJob;
6753 _OrthancPluginFreeJob params;
6756 context->InvokeService(context, _OrthancPluginService_FreeJob, ¶ms);
6766 } _OrthancPluginSubmitJob;
6786 char* resultId = NULL;
6788 _OrthancPluginSubmitJob params;
6789 memset(¶ms, 0,
sizeof(params));
6791 params.resultId = &resultId;
6793 params.priority = priority;
6812 } _OrthancPluginJobsUnserializer;
6830 _OrthancPluginJobsUnserializer params;
6831 params.unserializer = unserializer;
6833 context->InvokeService(context, _OrthancPluginService_RegisterJobsUnserializer, ¶ms);
6841 const char* details;
6843 } _OrthancPluginSetHttpErrorDetails;
6865 const char* details,
6868 _OrthancPluginSetHttpErrorDetails params;
6869 params.output = output;
6870 params.details = details;
6872 context->InvokeService(context, _OrthancPluginService_SetHttpErrorDetails, ¶ms);
6879 const char** result;
6880 const char* argument;
6881 } _OrthancPluginRetrieveStaticString;
6898 const char* result = NULL;
6900 _OrthancPluginRetrieveStaticString params;
6901 params.result = &result;
6902 params.argument = path;
6922 } _OrthancPluginSetMetricsValue;
6944 _OrthancPluginSetMetricsValue params;
6946 params.value = value;
6948 context->InvokeService(context, _OrthancPluginService_SetMetricsValue, ¶ms);
6956 } _OrthancPluginRegisterRefreshMetricsCallback;
6972 _OrthancPluginRegisterRefreshMetricsCallback params;
6973 params.callback = callback;
6974 context->InvokeService(context, _OrthancPluginService_RegisterRefreshMetricsCallback, ¶ms);
6986 } _OrthancPluginEncodeDicomWeb;
7010 char* target = NULL;
7012 _OrthancPluginEncodeDicomWeb params;
7013 params.target = ⌖
7014 params.dicom = dicom;
7015 params.dicomSize = dicomSize;
7016 params.callback = callback;
7052 char* target = NULL;
7054 _OrthancPluginEncodeDicomWeb params;
7055 params.target = ⌖
7056 params.dicom = dicom;
7057 params.dicomSize = dicomSize;
7058 params.callback = callback;
7080 } _OrthancPluginEncodeDicomWeb2;
7105 char* target = NULL;
7107 _OrthancPluginEncodeDicomWeb2 params;
7108 params.target = ⌖
7109 params.dicom = dicom;
7110 params.dicomSize = dicomSize;
7111 params.callback = callback;
7112 params.payload = payload;
7149 char* target = NULL;
7151 _OrthancPluginEncodeDicomWeb2 params;
7152 params.target = ⌖
7153 params.dicom = dicom;
7154 params.dicomSize = dicomSize;
7155 params.callback = callback;
7156 params.payload = payload;
7260 typedef const void* (*OrthancPluginChunkedClientRequestGetChunkData) (
void* request);
7284 uint16_t* httpStatus;
7287 uint32_t headersCount;
7288 const char*
const* headersKeys;
7289 const char*
const* headersValues;
7295 const char* username;
7296 const char* password;
7298 const char* certificateFile;
7299 const char* certificateKeyFile;
7300 const char* certificateKeyPassword;
7302 } _OrthancPluginChunkedHttpClient;
7360 uint16_t* httpStatus,
7363 uint32_t headersCount,
7364 const char*
const* headersKeys,
7365 const char*
const* headersValues,
7371 const char* username,
7372 const char* password,
7374 const char* certificateFile,
7375 const char* certificateKeyFile,
7376 const char* certificateKeyPassword,
7379 _OrthancPluginChunkedHttpClient params;
7380 memset(¶ms, 0,
sizeof(params));
7383 params.httpStatus = httpStatus;
7384 params.method = method;
7386 params.headersCount = headersCount;
7387 params.headersKeys = headersKeys;
7388 params.headersValues = headersValues;
7389 params.username = username;
7390 params.password = password;
7391 params.timeout = timeout;
7392 params.certificateFile = certificateFile;
7393 params.certificateKeyFile = certificateKeyFile;
7394 params.certificateKeyPassword = certificateKeyPassword;
7395 params.pkcs11 = pkcs11;
7398 params.answer = answer;
7399 params.answerAddChunk = answerAddChunk;
7400 params.answerAddHeader = answerAddHeader;
7401 params.request = request;
7402 params.requestIsDone = requestIsDone;
7403 params.requestChunkData = requestChunkData;
7404 params.requestChunkSize = requestChunkSize;
7405 params.requestNext = requestNext;
7407 return context->InvokeService(context, _OrthancPluginService_ChunkedHttpClient, ¶ms);
7497 const char* pathRegularExpression;
7505 } _OrthancPluginChunkedRestCallback;
7539 const char* pathRegularExpression,
7548 _OrthancPluginChunkedRestCallback params;
7549 params.pathRegularExpression = pathRegularExpression;
7550 params.getHandler = getHandler;
7551 params.postHandler = postHandler;
7552 params.deleteHandler = deleteHandler;
7553 params.putHandler = putHandler;
7554 params.addChunk = addChunk;
7555 params.execute = execute;
7556 params.finalize = finalize;
7558 context->InvokeService(context, _OrthancPluginService_RegisterChunkedRestCallback, ¶ms);
7570 const char* privateCreator;
7571 } _OrthancPluginGetTagName;
7592 const char* privateCreator)
7596 _OrthancPluginGetTagName params;
7597 params.result = &result;
7598 params.group = group;
7599 params.element = element;
7600 params.privateCreator = privateCreator;
7646 const char* transactionUid,
7647 const char*
const* sopClassUids,
7648 const char*
const* sopInstanceUids,
7649 uint32_t countInstances,
7650 const char* remoteAet,
7651 const char* calledAet);
7689 const char* sopClassUid,
7690 const char* sopInstanceUid);
7698 } _OrthancPluginRegisterStorageCommitmentScpCallback;
7719 _OrthancPluginRegisterStorageCommitmentScpCallback params;
7720 params.factory = factory;
7721 params.destructor = destructor;
7722 params.lookup = lookup;
7723 return context->InvokeService(context, _OrthancPluginService_RegisterStorageCommitmentScpCallback, ¶ms);
7760 } _OrthancPluginIncomingDicomInstanceFilter;
7778 _OrthancPluginIncomingDicomInstanceFilter params;
7779 params.callback = callback;
7781 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingDicomInstanceFilter, ¶ms);
7816 uint16_t* dimseStatus ,
7823 } _OrthancPluginIncomingCStoreInstanceFilter;
7841 _OrthancPluginIncomingCStoreInstanceFilter params;
7842 params.callback = callback;
7844 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingCStoreInstanceFilter, ¶ms);
7884 const void* receivedDicomBuffer,
7885 uint64_t receivedDicomBufferSize,
7892 } _OrthancPluginReceivedInstanceCallback;
7918 _OrthancPluginReceivedInstanceCallback params;
7919 params.callback = callback;
7921 return context->InvokeService(context, _OrthancPluginService_RegisterReceivedInstanceCallback, ¶ms);
7943 _OrthancPluginAccessDicomInstance params;
7944 memset(¶ms, 0,
sizeof(params));
7945 params.resultStringToFree = &result;
7946 params.instance = instance;
7976 int64_t hasPixelData;
7978 _OrthancPluginAccessDicomInstance params;
7979 memset(¶ms, 0,
sizeof(params));
7980 params.resultInt64 = &hasPixelData;
7981 params.instance = instance;
7992 return (hasPixelData != 0);
8006 const char* transferSyntax;
8007 } _OrthancPluginCreateDicomInstance;
8029 _OrthancPluginCreateDicomInstance params;
8030 params.target = ⌖
8031 params.buffer = buffer;
8048 } _OrthancPluginFreeDicomInstance;
8064 _OrthancPluginFreeDicomInstance params;
8065 params.dicom = dicom;
8067 context->InvokeService(context, _OrthancPluginService_FreeDicomInstance, ¶ms);
8073 uint32_t* targetUint32;
8076 char** targetStringToFree;
8078 uint32_t frameIndex;
8081 uint32_t maxStringLength;
8083 void* dicomWebPayload;
8084 } _OrthancPluginAccessDicomInstance2;
8103 _OrthancPluginAccessDicomInstance2 params;
8104 memset(¶ms, 0,
sizeof(params));
8105 params.targetUint32 = &count;
8106 params.instance = instance;
8141 uint32_t frameIndex)
8143 _OrthancPluginAccessDicomInstance2 params;
8144 memset(¶ms, 0,
sizeof(params));
8145 params.targetBuffer = target;
8146 params.instance = instance;
8147 params.frameIndex = frameIndex;
8149 return context->InvokeService(context, _OrthancPluginService_GetInstanceRawFrame, ¶ms);
8168 uint32_t frameIndex)
8172 _OrthancPluginAccessDicomInstance2 params;
8173 memset(¶ms, 0,
sizeof(params));
8174 params.targetImage = ⌖
8175 params.instance = instance;
8176 params.frameIndex = frameIndex;
8208 const char* transferSyntax)
8212 _OrthancPluginCreateDicomInstance params;
8213 params.target = ⌖
8214 params.buffer = buffer;
8216 params.transferSyntax = transferSyntax;
8247 _OrthancPluginAccessDicomInstance2 params;
8248 memset(¶ms, 0,
sizeof(params));
8249 params.targetBuffer = target;
8250 params.instance = instance;
8252 return context->InvokeService(context, _OrthancPluginService_SerializeDicomInstance, ¶ms);
8279 uint32_t maxStringLength)
8281 char* result = NULL;
8283 _OrthancPluginAccessDicomInstance2 params;
8284 memset(¶ms, 0,
sizeof(params));
8285 params.targetStringToFree = &result;
8286 params.instance = instance;
8287 params.format = format;
8288 params.flags = flags;
8289 params.maxStringLength = maxStringLength;
8323 char* target = NULL;
8325 _OrthancPluginAccessDicomInstance2 params;
8326 params.targetStringToFree = ⌖
8327 params.instance = instance;
8328 params.dicomWebCallback = callback;
8329 params.dicomWebPayload = payload;
8363 char* target = NULL;
8365 _OrthancPluginAccessDicomInstance2 params;
8366 params.targetStringToFree = ⌖
8367 params.instance = instance;
8368 params.dicomWebCallback = callback;
8369 params.dicomWebPayload = payload;
8406 const char*
const* allowedSyntaxes,
8407 uint32_t countSyntaxes,
8408 uint8_t allowNewSopInstanceUid);
8414 } _OrthancPluginTranscoderCallback;
8433 _OrthancPluginTranscoderCallback params;
8434 params.callback = callback;
8436 return context->InvokeService(context, _OrthancPluginService_RegisterTranscoderCallback, ¶ms);
8445 } _OrthancPluginCreateMemoryBuffer;
8469 _OrthancPluginCreateMemoryBuffer params;
8470 params.target = target;
8473 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer, ¶ms);
8507 _OrthancPluginRetrieveDynamicString params;
8508 params.result = &result;
8509 params.argument = NULL;
8511 if (context->InvokeService(context, _OrthancPluginService_GenerateRestApiAuthorizationToken,
8529 } _OrthancPluginCreateMemoryBuffer64;
8553 _OrthancPluginCreateMemoryBuffer64 params;
8554 params.target = target;
8557 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer64, ¶ms);
8567 } _OrthancPluginRegisterStorageArea2;
8592 _OrthancPluginRegisterStorageArea2 params;
8593 params.create = create;
8594 params.readWhole = readWhole;
8595 params.readRange = readRange;
8596 params.remove =
remove;
8597 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea2, ¶ms);
8604 _OrthancPluginCreateDicom createDicom;
8605 const char* privateCreator;
8606 } _OrthancPluginCreateDicom2;
8638 const char* privateCreator)
8640 _OrthancPluginCreateDicom2 params;
8641 params.createDicom.target = target;
8642 params.createDicom.json = json;
8643 params.createDicom.pixelData = pixelData;
8644 params.createDicom.flags = flags;
8645 params.privateCreator = privateCreator;
8647 return context->InvokeService(context, _OrthancPluginService_CreateDicom2, ¶ms);
8659 uint16_t* httpStatus;
8662 uint32_t headersCount;
8663 const char*
const* headersKeys;
8664 const char*
const* headersValues;
8667 uint8_t afterPlugins;
8668 } _OrthancPluginCallRestApi;
8704 uint16_t* httpStatus,
8707 uint32_t headersCount,
8708 const char*
const* headersKeys,
8709 const char*
const* headersValues,
8712 uint8_t afterPlugins)
8714 _OrthancPluginCallRestApi params;
8715 memset(¶ms, 0,
sizeof(params));
8717 params.answerBody = answerBody;
8718 params.answerHeaders = answerHeaders;
8719 params.httpStatus = httpStatus;
8720 params.method = method;
8722 params.headersCount = headersCount;
8723 params.headersKeys = headersKeys;
8724 params.headersValues = headersValues;
8726 params.bodySize = bodySize;
8727 params.afterPlugins = afterPlugins;
8729 return context->InvokeService(context, _OrthancPluginService_CallRestApi, ¶ms);
8761 const char* mimeType,
8762 const char* dateTime);
8781 const char* dateTime);
8809 const char* mimeType,
8810 const char* dateTime);
8827 uint8_t* isExisting,
8829 const char*
const* pathItems,
8852 uint8_t* isExisting,
8857 const char*
const* pathItems,
8881 const char*
const* pathItems,
8901 uint8_t* isReadOnly,
8903 const char*
const* pathItems,
8923 uint8_t* isReadOnly,
8925 const char*
const* pathItems,
8943 uint8_t* isReadOnly,
8945 const char*
const* pathItems,
8959 } _OrthancPluginRegisterWebDavCollection;
8992 _OrthancPluginRegisterWebDavCollection params;
8994 params.isExistingFolder = isExistingFolder;
8995 params.listFolder = listFolder;
8996 params.retrieveFile = retrieveFile;
8997 params.storeFile = storeFile;
8998 params.createFolder = createFolder;
8999 params.deleteItem = deleteItem;
9000 params.payload = payload;
9002 return context->InvokeService(context, _OrthancPluginService_RegisterWebDavCollection, ¶ms);
char * OrthancPluginGetInstanceTransferSyntaxUid(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the transfer syntax of a DICOM file.
Definition: OrthancCPlugin.h:7937
Definition: OrthancCPlugin.h:775
OrthancPluginChangeType
Definition: OrthancCPlugin.h:727
void OrthancPluginSendHttpStatusCode(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status)
Send a HTTP status code.
Definition: OrthancCPlugin.h:2766
OrthancPluginErrorCode(* OrthancPluginWebDavCreateFolderCallback)(uint8_t *isReadOnly, uint32_t pathSize, const char *const *pathItems, void *payload)
Callback to create a folder.
Definition: OrthancCPlugin.h:8922
OrthancPluginErrorCode OrthancPluginFindAddAnswer(OrthancPluginContext *context, OrthancPluginFindAnswers *answers, const void *dicom, uint32_t size)
Add one answer to some C-Find request.
Definition: OrthancCPlugin.h:5942
void OrthancPluginSetHttpHeader(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *key, const char *value)
Set some HTTP header.
Definition: OrthancCPlugin.h:2867
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:8851
OrthancPluginImage * OrthancPluginGetInstanceDecodedFrame(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:8165
OrthancPluginErrorCode OrthancPluginRegisterDecodeImageCallback(OrthancPluginContext *context, OrthancPluginDecodeImageCallback callback)
Register a callback to handle the decoding of DICOM images.
Definition: OrthancCPlugin.h:5398
The parameters of a REST request.
Definition: OrthancCPlugin.h:339
void OrthancPluginRedirect(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *redirection)
Redirect a REST request.
Definition: OrthancCPlugin.h:2549
OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:2454
char * OrthancPluginGetInstanceDicomWebXml(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb XML.
Definition: OrthancCPlugin.h:8357
A 64-bit memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:1051
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:4158
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:4250
int OrthancPluginCheckVersion(OrthancPluginContext *context)
Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
Definition: OrthancCPlugin.h:1940
void OrthancPluginSetHttpErrorDetails(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *details, uint8_t log)
Provide a detailed description for an HTTP error.
Definition: OrthancCPlugin.h:6862
OrthancPluginErrorCode OrthancPluginSerializeDicomInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginDicomInstance *instance)
Writes a DICOM instance to a memory buffer.
Definition: OrthancCPlugin.h:8242
struct _OrthancPluginWebDavCollection_t OrthancPluginWebDavCollection
Opaque structure that represents a WebDAV collection.
Definition: OrthancCPlugin.h:8738
OrthancPluginDicomInstance * OrthancPluginTranscodeDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size, const char *transferSyntax)
Parse and transcode a DICOM instance.
Definition: OrthancCPlugin.h:8204
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:8274
char * OrthancPluginGetInstanceSimplifiedJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file (with simplification).
Definition: OrthancCPlugin.h:3043
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:2402
Graylevel, unsigned 16bpp image.
Definition: OrthancCPlugin.h:619
Definition: OrthancCPlugin.h:742
const char *const * headersValues
The values of the HTTP headers.
Definition: OrthancCPlugin.h:399
const char *const * headersKeys
The keys of the HTTP headers (always converted to low-case).
Definition: OrthancCPlugin.h:394
OrthancPluginPixelFormat
Definition: OrthancCPlugin.h:603
uint32_t getCount
For a GET request, the number of GET parameters.
Definition: OrthancCPlugin.h:359
Definition: OrthancCPlugin.h:645
void OrthancPluginRegisterStorageArea(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove)
Register a custom storage area.
Definition: OrthancCPlugin.h:3172
OrthancPluginErrorCode OrthancPluginGetDicomForInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *instanceId)
Retrieve a DICOM instance using its Orthanc identifier.
Definition: OrthancCPlugin.h:2267
OrthancPluginImageFormat
Definition: OrthancCPlugin.h:772
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:7713
OrthancPluginErrorCode(* OrthancPluginWebDavAddFolder)(OrthancPluginWebDavCollection *collection, const char *name, const char *dateTime)
Declare a subfolder while returning the content of a folder.
Definition: OrthancCPlugin.h:8778
const char * OrthancPluginGetFontName(OrthancPluginContext *context, uint32_t fontIndex)
Return the name of a font.
Definition: OrthancCPlugin.h:4534
OrthancPluginErrorCode OrthancPluginRegisterIncomingCStoreInstanceFilter(OrthancPluginContext *context, OrthancPluginIncomingCStoreInstanceFilter callback)
Register a callback to filter incoming DICOM instances received by Orthanc through C-STORE...
Definition: OrthancCPlugin.h:7837
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:5696
OrthancPluginImage * OrthancPluginConvertPixelFormat(OrthancPluginContext *context, const OrthancPluginImage *source, OrthancPluginPixelFormat targetFormat)
Change the pixel format of an image.
Definition: OrthancCPlugin.h:4459
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:1348
Definition: OrthancCPlugin.h:736
OrthancPluginErrorCode OrthancPluginStorageAreaRead(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Read a file from the storage area.
Definition: OrthancCPlugin.h:4717
OrthancPluginErrorCode OrthancPluginRegisterIncomingDicomInstanceFilter(OrthancPluginContext *context, OrthancPluginIncomingDicomInstanceFilter callback)
Register a callback to filter incoming DICOM instances.
Definition: OrthancCPlugin.h:7774
uint32_t OrthancPluginGetFontsCount(OrthancPluginContext *context)
Return the number of available fonts.
Definition: OrthancCPlugin.h:4494
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:6032
void OrthancPluginRegisterOnChangeCallback(OrthancPluginContext *context, OrthancPluginOnChangeCallback callback)
Register a callback to monitor changes.
Definition: OrthancCPlugin.h:3315
Color image in RGBA32 format.
Definition: OrthancCPlugin.h:643
void OrthancPluginSendMethodNotAllowed(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *allowedMethods)
Signal that this URI does not support this HTTP method.
Definition: OrthancCPlugin.h:2812
Definition: OrthancCPlugin.h:759
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:2479
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:1753
Definition: OrthancCPlugin.h:744
Definition: OrthancCPlugin.h:730
OrthancPluginImage * OrthancPluginDecodeDicomImage(OrthancPluginContext *context, const void *buffer, uint32_t bufferSize, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:5525
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:1379
uint16_t group
Definition: OrthancCPlugin.h:1787
void * OrthancPluginGetImageBuffer(OrthancPluginContext *context, const OrthancPluginImage *image)
Return a pointer to the content of an image.
Definition: OrthancCPlugin.h:4028
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:8981
uint32_t minMultiplicity
Definition: OrthancCPlugin.h:1790
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:5173
struct _OrthancPluginWorklistQuery_t OrthancPluginWorklistQuery
Opaque structure to an object that represents a C-Find query for worklists.
Definition: OrthancCPlugin.h:1103
Definition: OrthancCPlugin.h:774
struct _OrthancPluginStorageArea_t OrthancPluginStorageArea
Opaque structure that represents the storage area that is actually used by Orthanc.
Definition: OrthancCPlugin.h:1095
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:8826
char * OrthancPluginGetInstanceJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file.
Definition: OrthancCPlugin.h:3005
Definition: OrthancCPlugin.h:734
Color image in RGB48 format.
Definition: OrthancCPlugin.h:653
uint32_t OrthancPluginGetExpectedDatabaseVersion(OrthancPluginContext *context)
Get the expected version of the database schema.
Definition: OrthancCPlugin.h:3560
Graylevel 8bpp image.
Definition: OrthancCPlugin.h:611
Definition: OrthancCPlugin.h:746
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:1222
OrthancPluginDicomInstance * OrthancPluginCreateDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size)
Parse a DICOM instance.
Definition: OrthancCPlugin.h:8022
uint32_t OrthancPluginGetImageHeight(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the height of an image.
Definition: OrthancCPlugin.h:3959
void OrthancPluginSendHttpStatus(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status, const char *body, uint32_t bodySize)
Send a HTTP status, with a custom body.
Definition: OrthancCPlugin.h:3857
OrthancPluginImage * OrthancPluginUncompressImage(OrthancPluginContext *context, const void *data, uint32_t size, OrthancPluginImageFormat format)
Decode a compressed image.
Definition: OrthancCPlugin.h:4071
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:8585
OrthancPluginErrorCode(* OrthancPluginRestCallback)(OrthancPluginRestOutput *output, const char *url, const OrthancPluginHttpRequest *request)
Signature of a callback function that answers to a REST request.
Definition: OrthancCPlugin.h:1168
Definition: OrthancCPlugin.h:760
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:8137
int32_t(* OrthancPluginIncomingCStoreInstanceFilter)(uint16_t *dimseStatus, const OrthancPluginDicomInstance *instance)
Callback to filter incoming DICOM instances received by Orthanc through C-STORE.
Definition: OrthancCPlugin.h:7815
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:7882
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:2367
Definition: OrthancCPlugin.h:762
Color image in RGB24 format.
Definition: OrthancCPlugin.h:635
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter2(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter2 callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:6301
char * OrthancPluginGenerateRestApiAuthorizationToken(OrthancPluginContext *context)
Generate a token to grant full access to the REST API of Orthanc.
Definition: OrthancCPlugin.h:8502
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:8877
Graylevel, signed 16bpp image.
Definition: OrthancCPlugin.h:627
An entry in the dictionary of DICOM tags.
Definition: OrthancCPlugin.h:1785
Definition: OrthancCPlugin.h:729
OrthancPluginCompressionType
Definition: OrthancCPlugin.h:757
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:5099
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:8757
OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pixel format of an image.
Definition: OrthancCPlugin.h:3893
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:4619
uint32_t OrthancPluginGetImagePitch(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pitch of an image.
Definition: OrthancCPlugin.h:3994
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:2226
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:1056
uint32_t maxMultiplicity
Definition: OrthancCPlugin.h:1791
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:8700
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:1200
void(* OrthancPluginFree)(void *buffer)
Signature of a function to free dynamic memory.
Definition: OrthancCPlugin.h:1212
void OrthancPluginSendUnauthorized(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *realm)
Signal that a REST request is not authorized.
Definition: OrthancCPlugin.h:2789
Graylevel, unsigned 64bpp image.
Definition: OrthancCPlugin.h:685
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:1034
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:7914
uint32_t OrthancPluginGetFontSize(OrthancPluginContext *context, uint32_t fontIndex)
Return the size of a font.
Definition: OrthancCPlugin.h:4566
void(* OrthancPluginRefreshMetricsCallback)()
Callback executed to update the metrics of the plugin.
Definition: OrthancCPlugin.h:1687
OrthancPluginErrorCode OrthancPluginRestApiGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2300
uint32_t headersCount
The number of HTTP headers.
Definition: OrthancCPlugin.h:389
Definition: OrthancCPlugin.h:745
const void * OrthancPluginGetInstanceData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the data of a DICOM file.
Definition: OrthancCPlugin.h:2969
Definition: OrthancCPlugin.h:735
OrthancPluginErrorCode OrthancPluginRegisterWorklistCallback(OrthancPluginContext *context, OrthancPluginWorklistCallback callback)
Register a callback to handle modality worklists requests.
Definition: OrthancCPlugin.h:5137
OrthancPluginErrorCode(* OrthancPluginStorageCreate)(const char *uuid, const void *content, int64_t size, OrthancPluginContentType type)
Callback for writing to the storage area.
Definition: OrthancCPlugin.h:1241
int OrthancPluginHasInstanceMetadata(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, const char *metadata)
Check whether a DICOM instance is associated with some metadata.
Definition: OrthancCPlugin.h:3082
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:1484
OrthancPluginErrorCode OrthancPluginRestApiDelete(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2431
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:7686
struct _OrthancPluginFindAnswers_t OrthancPluginFindAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1127
OrthancPluginErrorCode OrthancPluginRegisterMoveCallback(OrthancPluginContext *context, OrthancPluginMoveCallback callback, OrthancPluginGetMoveSize getMoveSize, OrthancPluginApplyMove applyMove, OrthancPluginFreeMove freeMove)
Register a callback to handle C-Move requests.
Definition: OrthancCPlugin.h:6149
Definition: OrthancCPlugin.h:743
OrthancPluginImage * OrthancPluginCreateImage(OrthancPluginContext *context, OrthancPluginPixelFormat format, uint32_t width, uint32_t height)
Create an image.
Definition: OrthancCPlugin.h:5436
char * OrthancPluginGetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *defaultValue)
Get the value of a global property.
Definition: OrthancCPlugin.h:3424
OrthancPluginErrorCode(* OrthancPluginStorageRemove)(const char *uuid, OrthancPluginContentType type)
Callback for removing a file from the storage area.
Definition: OrthancCPlugin.h:1329
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:3123
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:8942
Definition: OrthancCPlugin.h:737
struct _OrthancPluginServerChunkedRequestReader_t OrthancPluginServerChunkedRequestReader
Opaque structure that reads the content of a HTTP request body during a chunked HTTP transfer...
Definition: OrthancCPlugin.h:7416
OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, OrthancPluginResourceType level)
Reconstruct the main DICOM tags.
Definition: OrthancCPlugin.h:4948
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:6063
void OrthancPluginRegisterJobsUnserializer(OrthancPluginContext *context, OrthancPluginJobsUnserializer unserializer)
Register an unserializer for custom jobs.
Definition: OrthancCPlugin.h:6826
void OrthancPluginFreeDicomInstance(OrthancPluginContext *context, OrthancPluginDicomInstance *dicom)
Free a DICOM instance.
Definition: OrthancCPlugin.h:8060
int64_t OrthancPluginGetInstanceSize(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the size of a DICOM file.
Definition: OrthancCPlugin.h:2936
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:5479
char * OrthancPluginGetInstanceDicomWebJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb JSON.
Definition: OrthancCPlugin.h:8317
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:5734
int32_t(* OrthancPluginIncomingDicomInstanceFilter)(const OrthancPluginDicomInstance *instance)
Callback to filter incoming DICOM instances received by Orthanc.
Definition: OrthancCPlugin.h:7753
const char *const * getValues
For a GET request, the values of the GET parameters.
Definition: OrthancCPlugin.h:369
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:1189
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:3705
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:8402
OrthancPluginErrorCode OrthancPluginWorklistMarkIncomplete(OrthancPluginContext *context, OrthancPluginWorklistAnswers *answers)
Mark the set of worklist answers as incomplete.
Definition: OrthancCPlugin.h:5203
Definition: OrthancCPlugin.h:776
void OrthancPluginRegisterRestCallbackNoLock(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback, without locking.
Definition: OrthancCPlugin.h:2099
OrthancPluginErrorCode(* OrthancPluginFindCallback)(OrthancPluginFindAnswers *answers, const OrthancPluginFindQuery *query, const char *issuerAet, const char *calledAet)
Callback to handle incoming C-Find SCP requests.
Definition: OrthancCPlugin.h:1441
Definition: OrthancCPlugin.h:740
OrthancPluginErrorCode OrthancPluginRegisterFindCallback(OrthancPluginContext *context, OrthancPluginFindCallback callback)
Register a callback to handle C-Find requests.
Definition: OrthancCPlugin.h:5903
struct _OrthancPluginImage_t OrthancPluginImage
Opaque structure that represents an image that is uncompressed in memory.
Definition: OrthancCPlugin.h:1087
OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *subType, const char *contentType)
Start an HTTP multipart answer.
Definition: OrthancCPlugin.h:3634
struct _OrthancPluginWorklistAnswers_t OrthancPluginWorklistAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1111
OrthancPluginInstanceOrigin OrthancPluginGetInstanceOrigin(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the origin of a DICOM file.
Definition: OrthancCPlugin.h:5306
Definition: OrthancCPlugin.h:747
void(* OrthancPluginFreeMove)(void *moveDriver)
Callback to free one C-Move driver.
Definition: OrthancCPlugin.h:1538
int32_t OrthancPluginHasInstancePixelData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Check whether the DICOM file has pixel data.
Definition: OrthancCPlugin.h:7972
OrthancPluginErrorCode OrthancPluginStorageAreaRemove(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Remove a file from the storage area.
Definition: OrthancCPlugin.h:4756
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:1179
Definition: OrthancCPlugin.h:741
const char *const * getKeys
For a GET request, the keys of the GET parameters.
Definition: OrthancCPlugin.h:364
Definition: OrthancCPlugin.h:732
char * OrthancPluginLookupPatient(OrthancPluginContext *context, const char *patientID)
Look for a patient.
Definition: OrthancCPlugin.h:2581
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:8805
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:1311
struct _OrthancPluginDicomInstance_t OrthancPluginDicomInstance
Opaque structure that represents a DICOM instance that is managed by the Orthanc core.
Definition: OrthancCPlugin.h:1079
void OrthancPluginFreeImage(OrthancPluginContext *context, OrthancPluginImage *image)
Free an image.
Definition: OrthancCPlugin.h:4113
OrthancPluginValueRepresentation vr
Definition: OrthancCPlugin.h:1789
uint16_t element
Definition: OrthancCPlugin.h:1788
char * OrthancPluginLookupInstance(OrthancPluginContext *context, const char *sopInstanceUID)
Look for an instance.
Definition: OrthancCPlugin.h:2721
Definition: OrthancCPlugin.h:739
OrthancPluginErrorCode OrthancPluginSetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *value)
Set the value of a global property.
Definition: OrthancCPlugin.h:3463
OrthancPluginErrorCode(* OrthancPluginApplyMove)(void *moveDriver)
Callback to apply one C-Move suboperation.
Definition: OrthancCPlugin.h:1524
const char *const * groups
The matched values for the groups of the regular expression.
Definition: OrthancCPlugin.h:354
OrthancPluginErrorCode(* OrthancPluginStorageRead)(void **content, int64_t *size, const char *uuid, OrthancPluginContentType type)
Callback for reading from the storage area.
Definition: OrthancCPlugin.h:1268
char * OrthancPluginLookupStudy(OrthancPluginContext *context, const char *studyUID)
Look for a study.
Definition: OrthancCPlugin.h:2616
uint32_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:1039
Graylevel, floating-point 32bpp image.
Definition: OrthancCPlugin.h:669
const char * OrthancPluginGetInstanceRemoteAet(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the AET of a DICOM instance.
Definition: OrthancCPlugin.h:2903
uint32_t groupsCount
The number of groups of the regular expression.
Definition: OrthancCPlugin.h:349
int32_t OrthancPluginWorklistIsMatch(OrthancPluginContext *context, const OrthancPluginWorklistQuery *query, const void *dicom, uint32_t size)
Test whether a worklist matches the query.
Definition: OrthancCPlugin.h:5241
int OrthancPluginCheckVersionAdvanced(OrthancPluginContext *context, int expectedMajor, int expectedMinor, int expectedRevision)
Check that the version of the hosting Orthanc is above a given version.
Definition: OrthancCPlugin.h:1834
const void * body
For a PUT or POST request, the content of the body.
Definition: OrthancCPlugin.h:374
uint32_t bodySize
For a PUT or POST request, the number of bytes of the body.
Definition: OrthancCPlugin.h:379
OrthancPluginErrorCode OrthancPluginFindMarkIncomplete(OrthancPluginContext *context, OrthancPluginFindAnswers *answers)
Mark the set of C-Find answers as incomplete.
Definition: OrthancCPlugin.h:5971
OrthancPluginJob *(* OrthancPluginJobsUnserializer)(const char *jobType, const char *serialized)
Callback executed to unserialize a custom job.
Definition: OrthancCPlugin.h:1669
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:2515
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:3663
void OrthancPluginSetCookie(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *cookie, const char *value)
Set a cookie.
Definition: OrthancCPlugin.h:2842
Definition: OrthancCPlugin.h:731
uint32_t OrthancPluginGetFindQuerySize(OrthancPluginContext *context, const OrthancPluginFindQuery *query)
Get the number of tags in a C-Find query.
Definition: OrthancCPlugin.h:5995
struct _OrthancPluginRestOutput_t OrthancPluginRestOutput
Opaque structure that represents the HTTP connection to the client application.
Definition: OrthancCPlugin.h:1071
void OrthancPluginRegisterOnStoredInstanceCallback(OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback)
Register a callback for received instances.
Definition: OrthancCPlugin.h:2137
Definition: OrthancCPlugin.h:733
Graylevel, unsigned 32bpp image.
Definition: OrthancCPlugin.h:661
void OrthancPluginRegisterRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback.
Definition: OrthancCPlugin.h:2059
char * OrthancPluginLookupStudyWithAccessionNumber(OrthancPluginContext *context, const char *accessionNumber)
Look for a study, using the accession number.
Definition: OrthancCPlugin.h:2651
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:7537
OrthancPluginErrorCode OrthancPluginWorklistGetDicomQuery(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginWorklistQuery *query)
Retrieve the worklist query as a DICOM file.
Definition: OrthancCPlugin.h:5280
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:2330
struct _OrthancPluginFindQuery_t OrthancPluginFindQuery
Opaque structure to an object that represents a C-Find query.
Definition: OrthancCPlugin.h:1119
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:8900
Definition: OrthancCPlugin.h:738
Definition: OrthancCPlugin.h:761
void OrthancPluginRegisterRefreshMetricsCallback(OrthancPluginContext *context, OrthancPluginRefreshMetricsCallback callback)
Register a callback to refresh the metrics.
Definition: OrthancCPlugin.h:6968
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:1414
OrthancPluginHttpMethod method
The HTTP method.
Definition: OrthancCPlugin.h:344
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:4673
void OrthancPluginAnswerBuffer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const void *answer, uint32_t answerSize, const char *mimeType)
Answer to a REST request.
Definition: OrthancCPlugin.h:2169
A 32-bit memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:1029
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:7643
uint64_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:1061
OrthancPluginErrorCode(* OrthancPluginStorageReadWhole)(OrthancPluginMemoryBuffer64 *target, const char *uuid, OrthancPluginContentType type)
Callback for reading a whole file from the storage area.
Definition: OrthancCPlugin.h:1288
Color image in BGRA32 format.
Definition: OrthancCPlugin.h:677
uint32_t OrthancPluginGetInstanceFramesCount(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the number of frames in a DICOM instance.
Definition: OrthancCPlugin.h:8097
OrthancPluginErrorCode OrthancPluginRegisterTranscoderCallback(OrthancPluginContext *context, OrthancPluginTranscoderCallback callback)
Register a callback to handle the transcoding of DICOM images.
Definition: OrthancCPlugin.h:8429
void(* OrthancPluginStorageCommitmentDestructor)(void *handler)
Callback to free one storage commitment SCP handler.
Definition: OrthancCPlugin.h:7665
char * OrthancPluginLookupSeries(OrthancPluginContext *context, const char *seriesUID)
Look for a series.
Definition: OrthancCPlugin.h:2686
uint32_t(* OrthancPluginGetMoveSize)(void *moveDriver)
Callback to read the size of a C-Move driver.
Definition: OrthancCPlugin.h:1509
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:1715
uint32_t OrthancPluginGetImageWidth(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the width of an image.
Definition: OrthancCPlugin.h:3926
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:4203
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:6101