114 # define ORTHANC_PLUGINS_API __declspec(dllexport) 116 # define ORTHANC_PLUGINS_API __attribute__ ((visibility ("default"))) 118 # define ORTHANC_PLUGINS_API 121 #define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 1 122 #define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 12 123 #define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 0 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 311 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
319 ORTHANC_PLUGINS_API
const char* OrthancPluginGetName();
332 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
408 _OrthancPluginService_LogInfo = 1,
409 _OrthancPluginService_LogWarning = 2,
410 _OrthancPluginService_LogError = 3,
411 _OrthancPluginService_GetOrthancPath = 4,
412 _OrthancPluginService_GetOrthancDirectory = 5,
413 _OrthancPluginService_GetConfigurationPath = 6,
414 _OrthancPluginService_SetPluginProperty = 7,
415 _OrthancPluginService_GetGlobalProperty = 8,
416 _OrthancPluginService_SetGlobalProperty = 9,
417 _OrthancPluginService_GetCommandLineArgumentsCount = 10,
418 _OrthancPluginService_GetCommandLineArgument = 11,
419 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
420 _OrthancPluginService_GetConfiguration = 13,
421 _OrthancPluginService_BufferCompression = 14,
422 _OrthancPluginService_ReadFile = 15,
423 _OrthancPluginService_WriteFile = 16,
424 _OrthancPluginService_GetErrorDescription = 17,
425 _OrthancPluginService_CallHttpClient = 18,
426 _OrthancPluginService_RegisterErrorCode = 19,
427 _OrthancPluginService_RegisterDictionaryTag = 20,
428 _OrthancPluginService_DicomBufferToJson = 21,
429 _OrthancPluginService_DicomInstanceToJson = 22,
430 _OrthancPluginService_CreateDicom = 23,
431 _OrthancPluginService_ComputeMd5 = 24,
432 _OrthancPluginService_ComputeSha1 = 25,
433 _OrthancPluginService_LookupDictionary = 26,
434 _OrthancPluginService_CallHttpClient2 = 27,
435 _OrthancPluginService_GenerateUuid = 28,
436 _OrthancPluginService_RegisterPrivateDictionaryTag = 29,
437 _OrthancPluginService_AutodetectMimeType = 30,
438 _OrthancPluginService_SetMetricsValue = 31,
439 _OrthancPluginService_EncodeDicomWebJson = 32,
440 _OrthancPluginService_EncodeDicomWebXml = 33,
441 _OrthancPluginService_ChunkedHttpClient = 34,
442 _OrthancPluginService_GetTagName = 35,
443 _OrthancPluginService_EncodeDicomWebJson2 = 36,
444 _OrthancPluginService_EncodeDicomWebXml2 = 37,
445 _OrthancPluginService_CreateMemoryBuffer = 38,
446 _OrthancPluginService_GenerateRestApiAuthorizationToken = 39,
447 _OrthancPluginService_CreateMemoryBuffer64 = 40,
448 _OrthancPluginService_CreateDicom2 = 41,
449 _OrthancPluginService_GetDatabaseServerIdentifier = 42,
452 _OrthancPluginService_RegisterRestCallback = 1000,
453 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
454 _OrthancPluginService_RegisterStorageArea = 1002,
455 _OrthancPluginService_RegisterOnChangeCallback = 1003,
456 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
457 _OrthancPluginService_RegisterWorklistCallback = 1005,
458 _OrthancPluginService_RegisterDecodeImageCallback = 1006,
459 _OrthancPluginService_RegisterIncomingHttpRequestFilter = 1007,
460 _OrthancPluginService_RegisterFindCallback = 1008,
461 _OrthancPluginService_RegisterMoveCallback = 1009,
462 _OrthancPluginService_RegisterIncomingHttpRequestFilter2 = 1010,
463 _OrthancPluginService_RegisterRefreshMetricsCallback = 1011,
464 _OrthancPluginService_RegisterChunkedRestCallback = 1012,
465 _OrthancPluginService_RegisterStorageCommitmentScpCallback = 1013,
466 _OrthancPluginService_RegisterIncomingDicomInstanceFilter = 1014,
467 _OrthancPluginService_RegisterTranscoderCallback = 1015,
468 _OrthancPluginService_RegisterStorageArea2 = 1016,
469 _OrthancPluginService_RegisterIncomingCStoreInstanceFilter = 1017,
470 _OrthancPluginService_RegisterReceivedInstanceCallback = 1018,
471 _OrthancPluginService_RegisterWebDavCollection = 1019,
474 _OrthancPluginService_AnswerBuffer = 2000,
475 _OrthancPluginService_CompressAndAnswerPngImage = 2001,
476 _OrthancPluginService_Redirect = 2002,
477 _OrthancPluginService_SendHttpStatusCode = 2003,
478 _OrthancPluginService_SendUnauthorized = 2004,
479 _OrthancPluginService_SendMethodNotAllowed = 2005,
480 _OrthancPluginService_SetCookie = 2006,
481 _OrthancPluginService_SetHttpHeader = 2007,
482 _OrthancPluginService_StartMultipartAnswer = 2008,
483 _OrthancPluginService_SendMultipartItem = 2009,
484 _OrthancPluginService_SendHttpStatus = 2010,
485 _OrthancPluginService_CompressAndAnswerImage = 2011,
486 _OrthancPluginService_SendMultipartItem2 = 2012,
487 _OrthancPluginService_SetHttpErrorDetails = 2013,
490 _OrthancPluginService_GetDicomForInstance = 3000,
491 _OrthancPluginService_RestApiGet = 3001,
492 _OrthancPluginService_RestApiPost = 3002,
493 _OrthancPluginService_RestApiDelete = 3003,
494 _OrthancPluginService_RestApiPut = 3004,
495 _OrthancPluginService_LookupPatient = 3005,
496 _OrthancPluginService_LookupStudy = 3006,
497 _OrthancPluginService_LookupSeries = 3007,
498 _OrthancPluginService_LookupInstance = 3008,
499 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
500 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
501 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
502 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
503 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
504 _OrthancPluginService_ReconstructMainDicomTags = 3014,
505 _OrthancPluginService_RestApiGet2 = 3015,
506 _OrthancPluginService_CallRestApi = 3016,
509 _OrthancPluginService_GetInstanceRemoteAet = 4000,
510 _OrthancPluginService_GetInstanceSize = 4001,
511 _OrthancPluginService_GetInstanceData = 4002,
512 _OrthancPluginService_GetInstanceJson = 4003,
513 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
514 _OrthancPluginService_HasInstanceMetadata = 4005,
515 _OrthancPluginService_GetInstanceMetadata = 4006,
516 _OrthancPluginService_GetInstanceOrigin = 4007,
517 _OrthancPluginService_GetInstanceTransferSyntaxUid = 4008,
518 _OrthancPluginService_HasInstancePixelData = 4009,
519 _OrthancPluginService_CreateDicomInstance = 4010,
520 _OrthancPluginService_FreeDicomInstance = 4011,
521 _OrthancPluginService_GetInstanceFramesCount = 4012,
522 _OrthancPluginService_GetInstanceRawFrame = 4013,
523 _OrthancPluginService_GetInstanceDecodedFrame = 4014,
524 _OrthancPluginService_TranscodeDicomInstance = 4015,
525 _OrthancPluginService_SerializeDicomInstance = 4016,
526 _OrthancPluginService_GetInstanceAdvancedJson = 4017,
527 _OrthancPluginService_GetInstanceDicomWebJson = 4018,
528 _OrthancPluginService_GetInstanceDicomWebXml = 4019,
531 _OrthancPluginService_RegisterDatabaseBackend = 5000,
532 _OrthancPluginService_DatabaseAnswer = 5001,
533 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002,
534 _OrthancPluginService_StorageAreaCreate = 5003,
535 _OrthancPluginService_StorageAreaRead = 5004,
536 _OrthancPluginService_StorageAreaRemove = 5005,
537 _OrthancPluginService_RegisterDatabaseBackendV3 = 5006,
538 _OrthancPluginService_RegisterDatabaseBackendV4 = 5007,
541 _OrthancPluginService_GetImagePixelFormat = 6000,
542 _OrthancPluginService_GetImageWidth = 6001,
543 _OrthancPluginService_GetImageHeight = 6002,
544 _OrthancPluginService_GetImagePitch = 6003,
545 _OrthancPluginService_GetImageBuffer = 6004,
546 _OrthancPluginService_UncompressImage = 6005,
547 _OrthancPluginService_FreeImage = 6006,
548 _OrthancPluginService_CompressImage = 6007,
549 _OrthancPluginService_ConvertPixelFormat = 6008,
550 _OrthancPluginService_GetFontsCount = 6009,
551 _OrthancPluginService_GetFontInfo = 6010,
552 _OrthancPluginService_DrawText = 6011,
553 _OrthancPluginService_CreateImage = 6012,
554 _OrthancPluginService_CreateImageAccessor = 6013,
555 _OrthancPluginService_DecodeDicomImage = 6014,
558 _OrthancPluginService_WorklistAddAnswer = 7000,
559 _OrthancPluginService_WorklistMarkIncomplete = 7001,
560 _OrthancPluginService_WorklistIsMatch = 7002,
561 _OrthancPluginService_WorklistGetDicomQuery = 7003,
562 _OrthancPluginService_FindAddAnswer = 7004,
563 _OrthancPluginService_FindMarkIncomplete = 7005,
564 _OrthancPluginService_GetFindQuerySize = 7006,
565 _OrthancPluginService_GetFindQueryTag = 7007,
566 _OrthancPluginService_GetFindQueryTagName = 7008,
567 _OrthancPluginService_GetFindQueryValue = 7009,
568 _OrthancPluginService_CreateFindMatcher = 7010,
569 _OrthancPluginService_FreeFindMatcher = 7011,
570 _OrthancPluginService_FindMatcherIsMatch = 7012,
573 _OrthancPluginService_GetPeers = 8000,
574 _OrthancPluginService_FreePeers = 8001,
575 _OrthancPluginService_GetPeersCount = 8003,
576 _OrthancPluginService_GetPeerName = 8004,
577 _OrthancPluginService_GetPeerUrl = 8005,
578 _OrthancPluginService_CallPeerApi = 8006,
579 _OrthancPluginService_GetPeerUserProperty = 8007,
582 _OrthancPluginService_CreateJob = 9000,
583 _OrthancPluginService_FreeJob = 9001,
584 _OrthancPluginService_SubmitJob = 9002,
585 _OrthancPluginService_RegisterJobsUnserializer = 9003,
586 _OrthancPluginService_CreateJob2 = 9004,
588 _OrthancPluginService_INTERNAL = 0x7fffffff
589 } _OrthancPluginService;
594 _OrthancPluginProperty_Description = 1,
595 _OrthancPluginProperty_RootUri = 2,
596 _OrthancPluginProperty_OrthancExplorer = 3,
598 _OrthancPluginProperty_INTERNAL = 0x7fffffff
599 } _OrthancPluginProperty;
691 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
706 _OrthancPluginContentType_INTERNAL = 0x7fffffff
722 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
753 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
768 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
782 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
820 _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff
835 _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff
846 OrthancPluginDicomToJsonFlags_None = 0,
856 _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff
867 OrthancPluginCreateDicomFlags_None = 0,
871 _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff
887 _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff
903 _OrthancPluginConstraintType_INTERNAL = 0x7fffffff
919 _OrthancPluginInstanceOrigin_INTERNAL = 0x7fffffff
1022 _OrthancPluginReceivedInstanceAction_INTERNAL = 0x7fffffff
1185 const char* instanceId);
1196 const char* resourceId);
1207 const uint32_t size,
1208 uint32_t frameIndex);
1229 const char* bulkDataUri);
1247 const void* content,
1319 uint64_t rangeStart);
1355 const char* issuerAet,
1356 const char* calledAet);
1387 uint32_t headersCount,
1388 const char*
const* headersKeys,
1389 const char*
const* headersValues);
1422 uint32_t headersCount,
1423 const char*
const* headersKeys,
1424 const char*
const* headersValues,
1425 uint32_t getArgumentsCount,
1426 const char*
const* getArgumentsKeys,
1427 const char*
const* getArgumentsValues);
1448 const char* issuerAet,
1449 const char* calledAet);
1488 typedef void* (*OrthancPluginMoveCallback) (
1490 const char* patientId,
1491 const char* accessionNumber,
1492 const char* studyInstanceUid,
1493 const char* seriesInstanceUid,
1494 const char* sopInstanceUid,
1495 const char* originatorAet,
1496 const char* sourceAet,
1497 const char* targetAet,
1498 uint16_t originatorId);
1584 typedef const char* (*OrthancPluginJobGetContent) (
void* job);
1622 typedef const char* (*OrthancPluginJobGetSerialized) (
void* job);
1716 const char* serialized);
1764 uint32_t levelDepth,
1765 const uint16_t* levelTagGroup,
1766 const uint16_t* levelTagElement,
1767 const uint32_t* levelIndex,
1769 uint16_t tagElement,
1802 uint32_t levelDepth,
1803 const uint16_t* levelTagGroup,
1804 const uint16_t* levelTagElement,
1805 const uint32_t* levelIndex,
1807 uint16_t tagElement,
1816 typedef struct _OrthancPluginContext_t
1818 void* pluginsManager;
1819 const char* orthancVersion;
1822 _OrthancPluginService service,
1823 const void* params);
1884 int expectedRevision)
1886 int major, minor, revision;
1890 sizeof(int32_t) !=
sizeof(_OrthancPluginService) ||
1891 sizeof(int32_t) !=
sizeof(_OrthancPluginProperty) ||
1916 if (!strcmp(context->orthancVersion,
"mainline"))
1928 (context->orthancVersion,
"%4d.%4d.%4d", &major, &minor, &revision) != 3)
1935 if (major > expectedMajor)
1940 if (major < expectedMajor)
1947 if (minor > expectedMinor)
1952 if (minor < expectedMinor)
1959 if (revision >= expectedRevision)
1991 ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER,
1992 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER,
1993 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER);
2009 context->Free(buffer->
data);
2025 context->Free(buffer->
data);
2039 const char* message)
2041 context->InvokeService(context, _OrthancPluginService_LogError, message);
2055 const char* message)
2057 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
2071 const char* message)
2073 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
2080 const char* pathRegularExpression;
2082 } _OrthancPluginRestCallback;
2107 const char* pathRegularExpression,
2110 _OrthancPluginRestCallback params;
2111 params.pathRegularExpression = pathRegularExpression;
2112 params.callback = callback;
2113 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
2147 const char* pathRegularExpression,
2150 _OrthancPluginRestCallback params;
2151 params.pathRegularExpression = pathRegularExpression;
2152 params.callback = callback;
2153 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms);
2161 } _OrthancPluginOnStoredInstanceCallback;
2187 _OrthancPluginOnStoredInstanceCallback params;
2188 params.callback = callback;
2190 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
2199 uint32_t answerSize;
2200 const char* mimeType;
2201 } _OrthancPluginAnswerBuffer;
2219 uint32_t answerSize,
2220 const char* mimeType)
2222 _OrthancPluginAnswerBuffer params;
2223 params.output = output;
2224 params.answer = answer;
2225 params.answerSize = answerSize;
2226 params.mimeType = mimeType;
2227 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms);
2239 } _OrthancPluginCompressAndAnswerPngImage;
2251 } _OrthancPluginCompressAndAnswerImage;
2281 _OrthancPluginCompressAndAnswerImage params;
2282 params.output = output;
2284 params.pixelFormat = format;
2285 params.width = width;
2286 params.height = height;
2287 params.pitch = pitch;
2288 params.buffer = buffer;
2290 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
2298 const char* instanceId;
2299 } _OrthancPluginGetDicomForInstance;
2316 const char* instanceId)
2318 _OrthancPluginGetDicomForInstance params;
2319 params.target = target;
2320 params.instanceId = instanceId;
2321 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
2330 } _OrthancPluginRestApiGet;
2351 _OrthancPluginRestApiGet params;
2352 params.target = target;
2354 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
2381 _OrthancPluginRestApiGet params;
2382 params.target = target;
2384 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms);
2395 } _OrthancPluginRestApiPostPut;
2420 _OrthancPluginRestApiPostPut params;
2421 params.target = target;
2424 params.bodySize = bodySize;
2425 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
2455 _OrthancPluginRestApiPostPut params;
2456 params.target = target;
2459 params.bodySize = bodySize;
2460 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms);
2481 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
2504 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
2532 _OrthancPluginRestApiPostPut params;
2533 params.target = target;
2536 params.bodySize = bodySize;
2537 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
2568 _OrthancPluginRestApiPostPut params;
2569 params.target = target;
2572 params.bodySize = bodySize;
2573 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms);
2581 const char* argument;
2582 } _OrthancPluginOutputPlusArgument;
2598 const char* redirection)
2600 _OrthancPluginOutputPlusArgument params;
2601 params.output = output;
2602 params.argument = redirection;
2603 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
2611 const char* argument;
2612 } _OrthancPluginRetrieveDynamicString;
2629 const char* patientID)
2633 _OrthancPluginRetrieveDynamicString params;
2634 params.result = &result;
2635 params.argument = patientID;
2664 const char* studyUID)
2668 _OrthancPluginRetrieveDynamicString params;
2669 params.result = &result;
2670 params.argument = studyUID;
2699 const char* accessionNumber)
2703 _OrthancPluginRetrieveDynamicString params;
2704 params.result = &result;
2705 params.argument = accessionNumber;
2734 const char* seriesUID)
2738 _OrthancPluginRetrieveDynamicString params;
2739 params.result = &result;
2740 params.argument = seriesUID;
2769 const char* sopInstanceUID)
2773 _OrthancPluginRetrieveDynamicString params;
2774 params.result = &result;
2775 params.argument = sopInstanceUID;
2794 } _OrthancPluginSendHttpStatusCode;
2817 _OrthancPluginSendHttpStatusCode params;
2818 params.output = output;
2819 params.status = status;
2820 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
2840 _OrthancPluginOutputPlusArgument params;
2841 params.output = output;
2842 params.argument = realm;
2843 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
2861 const char* allowedMethods)
2863 _OrthancPluginOutputPlusArgument params;
2864 params.output = output;
2865 params.argument = allowedMethods;
2866 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
2875 } _OrthancPluginSetHttpHeader;
2894 _OrthancPluginSetHttpHeader params;
2895 params.output = output;
2896 params.key = cookie;
2897 params.value = value;
2898 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
2919 _OrthancPluginSetHttpHeader params;
2920 params.output = output;
2922 params.value = value;
2923 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
2929 char** resultStringToFree;
2930 const char** resultString;
2931 int64_t* resultInt64;
2935 } _OrthancPluginAccessDicomInstance;
2955 _OrthancPluginAccessDicomInstance params;
2956 memset(¶ms, 0,
sizeof(params));
2957 params.resultString = &result;
2958 params.instance = instance;
2988 _OrthancPluginAccessDicomInstance params;
2989 memset(¶ms, 0,
sizeof(params));
2990 params.resultInt64 = &size;
2991 params.instance = instance;
3021 _OrthancPluginAccessDicomInstance params;
3022 memset(¶ms, 0,
sizeof(params));
3023 params.resultString = &result;
3024 params.instance = instance;
3057 _OrthancPluginAccessDicomInstance params;
3058 memset(¶ms, 0,
sizeof(params));
3059 params.resultStringToFree = &result;
3060 params.instance = instance;
3095 _OrthancPluginAccessDicomInstance params;
3096 memset(¶ms, 0,
sizeof(params));
3097 params.resultStringToFree = &result;
3098 params.instance = instance;
3131 const char* metadata)
3135 _OrthancPluginAccessDicomInstance params;
3136 memset(¶ms, 0,
sizeof(params));
3137 params.resultInt64 = &result;
3138 params.instance = instance;
3139 params.key = metadata;
3148 return (result != 0);
3172 const char* metadata)
3176 _OrthancPluginAccessDicomInstance params;
3177 memset(¶ms, 0,
sizeof(params));
3178 params.resultString = &result;
3179 params.instance = instance;
3180 params.key = metadata;
3201 } _OrthancPluginRegisterStorageArea;
3224 _OrthancPluginRegisterStorageArea params;
3225 params.create = create;
3227 params.remove =
remove;
3230 params.free = ::free;
3235 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
3254 _OrthancPluginRetrieveDynamicString params;
3255 params.result = &result;
3256 params.argument = NULL;
3284 _OrthancPluginRetrieveDynamicString params;
3285 params.result = &result;
3286 params.argument = NULL;
3319 _OrthancPluginRetrieveDynamicString params;
3320 params.result = &result;
3321 params.argument = NULL;
3339 } _OrthancPluginOnChangeCallback;
3365 _OrthancPluginOnChangeCallback params;
3366 params.callback = callback;
3368 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms);
3376 _OrthancPluginProperty property;
3378 } _OrthancPluginSetPluginProperty;
3396 _OrthancPluginSetPluginProperty params;
3397 params.plugin = OrthancPluginGetName();
3398 params.property = _OrthancPluginProperty_RootUri;
3401 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3416 const char* description)
3418 _OrthancPluginSetPluginProperty params;
3419 params.plugin = OrthancPluginGetName();
3420 params.property = _OrthancPluginProperty_Description;
3421 params.value = description;
3423 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3438 const char* javascript)
3440 _OrthancPluginSetPluginProperty params;
3441 params.plugin = OrthancPluginGetName();
3442 params.property = _OrthancPluginProperty_OrthancExplorer;
3443 params.value = javascript;
3445 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3454 } _OrthancPluginGlobalProperty;
3473 const char* defaultValue)
3477 _OrthancPluginGlobalProperty params;
3478 params.result = &result;
3479 params.property = property;
3480 params.value = defaultValue;
3514 _OrthancPluginGlobalProperty params;
3515 params.result = NULL;
3516 params.property = property;
3517 params.value = value;
3519 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms);
3526 int32_t *resultInt32;
3527 uint32_t *resultUint32;
3528 int64_t *resultInt64;
3529 uint64_t *resultUint64;
3530 } _OrthancPluginReturnSingleValue;
3545 _OrthancPluginReturnSingleValue params;
3546 memset(¶ms, 0,
sizeof(params));
3547 params.resultUint32 = &count;
3580 _OrthancPluginGlobalProperty params;
3581 params.result = &result;
3582 params.property = (int32_t) argument;
3583 params.value = NULL;
3611 _OrthancPluginReturnSingleValue params;
3612 memset(¶ms, 0,
sizeof(params));
3613 params.resultUint32 = &count;
3643 _OrthancPluginRetrieveDynamicString params;
3644 params.result = &result;
3645 params.argument = NULL;
3663 const char* subType;
3664 const char* contentType;
3665 } _OrthancPluginStartMultipartAnswer;
3683 const char* subType,
3684 const char* contentType)
3686 _OrthancPluginStartMultipartAnswer params;
3687 params.output = output;
3688 params.subType = subType;
3689 params.contentType = contentType;
3690 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms);
3713 uint32_t answerSize)
3715 _OrthancPluginAnswerBuffer params;
3716 params.output = output;
3717 params.answer = answer;
3718 params.answerSize = answerSize;
3719 params.mimeType = NULL;
3720 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms);
3732 } _OrthancPluginBufferCompression;
3759 _OrthancPluginBufferCompression params;
3760 params.target = target;
3761 params.source = source;
3763 params.compression = compression;
3764 params.uncompress = uncompress;
3766 return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms);
3775 } _OrthancPluginReadFile;
3793 _OrthancPluginReadFile params;
3794 params.target = target;
3796 return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms);
3806 } _OrthancPluginWriteFile;
3825 _OrthancPluginWriteFile params;
3829 return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms);
3836 const char** target;
3838 } _OrthancPluginGetErrorDescription;
3854 const char* result = NULL;
3856 _OrthancPluginGetErrorDescription params;
3857 params.target = &result;
3858 params.error = error;
3863 return "Unknown error code";
3879 } _OrthancPluginSendHttpStatus;
3910 _OrthancPluginSendHttpStatus params;
3911 params.output = output;
3912 params.status = status;
3914 params.bodySize = bodySize;
3915 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms);
3923 uint32_t* resultUint32;
3925 void** resultBuffer;
3926 } _OrthancPluginGetImageInfo;
3945 _OrthancPluginGetImageInfo params;
3946 memset(¶ms, 0,
sizeof(params));
3947 params.image = image;
3948 params.resultPixelFormat = ⌖
3978 _OrthancPluginGetImageInfo params;
3979 memset(¶ms, 0,
sizeof(params));
3980 params.image = image;
3981 params.resultUint32 = &width;
4011 _OrthancPluginGetImageInfo params;
4012 memset(¶ms, 0,
sizeof(params));
4013 params.image = image;
4014 params.resultUint32 = &height;
4046 _OrthancPluginGetImageInfo params;
4047 memset(¶ms, 0,
sizeof(params));
4048 params.image = image;
4049 params.resultUint32 = &pitch;
4078 void* target = NULL;
4080 _OrthancPluginGetImageInfo params;
4081 memset(¶ms, 0,
sizeof(params));
4082 params.resultBuffer = ⌖
4083 params.image = image;
4102 } _OrthancPluginUncompressImage;
4125 _OrthancPluginUncompressImage params;
4126 memset(¶ms, 0,
sizeof(params));
4127 params.target = ⌖
4130 params.format = format;
4148 } _OrthancPluginFreeImage;
4163 _OrthancPluginFreeImage params;
4164 params.image = image;
4166 context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms);
4182 } _OrthancPluginCompressImage;
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;
4224 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4259 _OrthancPluginCompressImage params;
4260 memset(¶ms, 0,
sizeof(params));
4261 params.target = target;
4263 params.pixelFormat = format;
4264 params.width = width;
4265 params.height = height;
4266 params.pitch = pitch;
4267 params.buffer = buffer;
4268 params.quality = quality;
4270 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4306 _OrthancPluginCompressAndAnswerImage params;
4307 params.output = output;
4309 params.pixelFormat = format;
4310 params.width = width;
4311 params.height = height;
4312 params.pitch = pitch;
4313 params.buffer = buffer;
4314 params.quality = quality;
4315 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
4326 const char* username;
4327 const char* password;
4330 } _OrthancPluginCallHttpClient;
4353 const char* username,
4354 const char* password)
4356 _OrthancPluginCallHttpClient params;
4357 memset(¶ms, 0,
sizeof(params));
4359 params.target = target;
4362 params.username = username;
4363 params.password = password;
4365 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4393 const char* username,
4394 const char* password)
4396 _OrthancPluginCallHttpClient params;
4397 memset(¶ms, 0,
sizeof(params));
4399 params.target = target;
4403 params.bodySize = bodySize;
4404 params.username = username;
4405 params.password = password;
4407 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4435 const char* username,
4436 const char* password)
4438 _OrthancPluginCallHttpClient params;
4439 memset(¶ms, 0,
sizeof(params));
4441 params.target = target;
4445 params.bodySize = bodySize;
4446 params.username = username;
4447 params.password = password;
4449 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4470 const char* username,
4471 const char* password)
4473 _OrthancPluginCallHttpClient params;
4474 memset(¶ms, 0,
sizeof(params));
4478 params.username = username;
4479 params.password = password;
4481 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4491 } _OrthancPluginConvertPixelFormat;
4512 _OrthancPluginConvertPixelFormat params;
4513 params.target = ⌖
4514 params.source = source;
4515 params.targetFormat = targetFormat;
4545 _OrthancPluginReturnSingleValue params;
4546 memset(¶ms, 0,
sizeof(params));
4547 params.resultUint32 = &count;
4568 } _OrthancPluginGetFontInfo;
4584 const char* result = NULL;
4586 _OrthancPluginGetFontInfo params;
4587 memset(¶ms, 0,
sizeof(params));
4588 params.name = &result;
4589 params.fontIndex = fontIndex;
4618 _OrthancPluginGetFontInfo params;
4619 memset(¶ms, 0,
sizeof(params));
4620 params.size = &result;
4621 params.fontIndex = fontIndex;
4639 const char* utf8Text;
4645 } _OrthancPluginDrawText;
4669 const char* utf8Text,
4676 _OrthancPluginDrawText params;
4677 memset(¶ms, 0,
sizeof(params));
4678 params.image = image;
4679 params.fontIndex = fontIndex;
4680 params.utf8Text = utf8Text;
4687 return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms);
4696 const void* content;
4699 } _OrthancPluginStorageAreaCreate;
4723 const void* content,
4727 _OrthancPluginStorageAreaCreate params;
4728 params.storageArea = storageArea;
4730 params.content = content;
4734 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms);
4744 } _OrthancPluginStorageAreaRead;
4770 _OrthancPluginStorageAreaRead params;
4771 params.target = target;
4772 params.storageArea = storageArea;
4776 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms);
4785 } _OrthancPluginStorageAreaRemove;
4808 _OrthancPluginStorageAreaRemove params;
4809 params.storageArea = storageArea;
4813 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms);
4822 uint16_t httpStatus;
4823 const char* message;
4824 } _OrthancPluginRegisterErrorCode;
4844 uint16_t httpStatus,
4845 const char* message)
4849 _OrthancPluginRegisterErrorCode params;
4850 params.target = ⌖
4852 params.httpStatus = httpStatus;
4853 params.message = message;
4874 uint32_t minMultiplicity;
4875 uint32_t maxMultiplicity;
4876 } _OrthancPluginRegisterDictionaryTag;
4903 uint32_t minMultiplicity,
4904 uint32_t maxMultiplicity)
4906 _OrthancPluginRegisterDictionaryTag params;
4907 params.group = group;
4908 params.element = element;
4911 params.minMultiplicity = minMultiplicity;
4912 params.maxMultiplicity = maxMultiplicity;
4914 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, ¶ms);
4925 uint32_t minMultiplicity;
4926 uint32_t maxMultiplicity;
4927 const char* privateCreator;
4928 } _OrthancPluginRegisterPrivateDictionaryTag;
4956 uint32_t minMultiplicity,
4957 uint32_t maxMultiplicity,
4958 const char* privateCreator)
4960 _OrthancPluginRegisterPrivateDictionaryTag params;
4961 params.group = group;
4962 params.element = element;
4965 params.minMultiplicity = minMultiplicity;
4966 params.maxMultiplicity = maxMultiplicity;
4967 params.privateCreator = privateCreator;
4969 return context->InvokeService(context, _OrthancPluginService_RegisterPrivateDictionaryTag, ¶ms);
4978 } _OrthancPluginReconstructMainDicomTags;
4999 _OrthancPluginReconstructMainDicomTags params;
5000 params.level = level;
5001 params.storageArea = storageArea;
5003 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, ¶ms);
5010 const char* instanceId;
5015 uint32_t maxStringLength;
5016 } _OrthancPluginDicomToJson;
5044 uint32_t maxStringLength)
5048 _OrthancPluginDicomToJson params;
5049 memset(¶ms, 0,
sizeof(params));
5050 params.result = &result;
5051 params.buffer = buffer;
5053 params.format = format;
5054 params.flags = flags;
5055 params.maxStringLength = maxStringLength;
5089 const char* instanceId,
5092 uint32_t maxStringLength)
5096 _OrthancPluginDicomToJson params;
5097 memset(¶ms, 0,
sizeof(params));
5098 params.result = &result;
5099 params.instanceId = instanceId;
5100 params.format = format;
5101 params.flags = flags;
5102 params.maxStringLength = maxStringLength;
5120 uint32_t headersCount;
5121 const char*
const* headersKeys;
5122 const char*
const* headersValues;
5123 int32_t afterPlugins;
5124 } _OrthancPluginRestApiGet2;
5149 uint32_t headersCount,
5150 const char*
const* headersKeys,
5151 const char*
const* headersValues,
5152 int32_t afterPlugins)
5154 _OrthancPluginRestApiGet2 params;
5155 params.target = target;
5157 params.headersCount = headersCount;
5158 params.headersKeys = headersKeys;
5159 params.headersValues = headersValues;
5160 params.afterPlugins = afterPlugins;
5162 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, ¶ms);
5170 } _OrthancPluginWorklistCallback;
5187 _OrthancPluginWorklistCallback params;
5188 params.callback = callback;
5190 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, ¶ms);
5201 } _OrthancPluginWorklistAnswersOperation;
5226 _OrthancPluginWorklistAnswersOperation params;
5227 params.answers = answers;
5228 params.query = query;
5229 params.dicom = dicom;
5232 return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, ¶ms);
5253 _OrthancPluginWorklistAnswersOperation params;
5254 params.answers = answers;
5255 params.query = NULL;
5256 params.dicom = NULL;
5259 return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, ¶ms);
5270 } _OrthancPluginWorklistQueryOperation;
5293 int32_t isMatch = 0;
5295 _OrthancPluginWorklistQueryOperation params;
5296 params.query = query;
5297 params.dicom = dicom;
5299 params.isMatch = &isMatch;
5300 params.target = NULL;
5331 _OrthancPluginWorklistQueryOperation params;
5332 params.query = query;
5333 params.dicom = NULL;
5335 params.isMatch = NULL;
5336 params.target = target;
5338 return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, ¶ms);
5358 _OrthancPluginAccessDicomInstance params;
5359 memset(¶ms, 0,
sizeof(params));
5360 params.resultOrigin = &origin;
5361 params.instance = instance;
5381 } _OrthancPluginCreateDicom;
5415 _OrthancPluginCreateDicom params;
5416 params.target = target;
5418 params.pixelData = pixelData;
5419 params.flags = flags;
5421 return context->InvokeService(context, _OrthancPluginService_CreateDicom, ¶ms);
5428 } _OrthancPluginDecodeImageCallback;
5448 _OrthancPluginDecodeImageCallback params;
5449 params.callback = callback;
5451 return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, ¶ms);
5464 const void* constBuffer;
5465 uint32_t bufferSize;
5466 uint32_t frameIndex;
5467 } _OrthancPluginCreateImage;
5490 _OrthancPluginCreateImage params;
5491 memset(¶ms, 0,
sizeof(params));
5492 params.target = ⌖
5493 params.format = format;
5494 params.width = width;
5495 params.height = height;
5535 _OrthancPluginCreateImage params;
5536 memset(¶ms, 0,
sizeof(params));
5537 params.target = ⌖
5538 params.format = format;
5539 params.width = width;
5540 params.height = height;
5541 params.pitch = pitch;
5542 params.buffer = buffer;
5574 uint32_t bufferSize,
5575 uint32_t frameIndex)
5579 _OrthancPluginCreateImage params;
5580 memset(¶ms, 0,
sizeof(params));
5581 params.target = ⌖
5582 params.constBuffer = buffer;
5583 params.bufferSize = bufferSize;
5584 params.frameIndex = frameIndex;
5603 } _OrthancPluginComputeHash;
5624 _OrthancPluginComputeHash params;
5625 params.result = &result;
5626 params.buffer = buffer;
5660 _OrthancPluginComputeHash params;
5661 params.result = &result;
5662 params.buffer = buffer;
5682 } _OrthancPluginLookupDictionary;
5704 _OrthancPluginLookupDictionary params;
5705 params.target = target;
5707 return context->InvokeService(context, _OrthancPluginService_LookupDictionary, ¶ms);
5716 uint32_t answerSize;
5717 uint32_t headersCount;
5718 const char*
const* headersKeys;
5719 const char*
const* headersValues;
5720 } _OrthancPluginSendMultipartItem2;
5746 uint32_t answerSize,
5747 uint32_t headersCount,
5748 const char*
const* headersKeys,
5749 const char*
const* headersValues)
5751 _OrthancPluginSendMultipartItem2 params;
5752 params.output = output;
5753 params.answer = answer;
5754 params.answerSize = answerSize;
5755 params.headersCount = headersCount;
5756 params.headersKeys = headersKeys;
5757 params.headersValues = headersValues;
5759 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem2, ¶ms);
5766 } _OrthancPluginIncomingHttpRequestFilter;
5784 _OrthancPluginIncomingHttpRequestFilter params;
5785 params.callback = callback;
5787 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter, ¶ms);
5796 uint16_t* httpStatus;
5799 uint32_t headersCount;
5800 const char*
const* headersKeys;
5801 const char*
const* headersValues;
5804 const char* username;
5805 const char* password;
5807 const char* certificateFile;
5808 const char* certificateKeyFile;
5809 const char* certificateKeyPassword;
5811 } _OrthancPluginCallHttpClient2;
5859 uint16_t* httpStatus,
5862 uint32_t headersCount,
5863 const char*
const* headersKeys,
5864 const char*
const* headersValues,
5867 const char* username,
5868 const char* password,
5870 const char* certificateFile,
5871 const char* certificateKeyFile,
5872 const char* certificateKeyPassword,
5875 _OrthancPluginCallHttpClient2 params;
5876 memset(¶ms, 0,
sizeof(params));
5878 params.answerBody = answerBody;
5879 params.answerHeaders = answerHeaders;
5880 params.httpStatus = httpStatus;
5881 params.method = method;
5883 params.headersCount = headersCount;
5884 params.headersKeys = headersKeys;
5885 params.headersValues = headersValues;
5887 params.bodySize = bodySize;
5888 params.username = username;
5889 params.password = password;
5890 params.timeout = timeout;
5891 params.certificateFile = certificateFile;
5892 params.certificateKeyFile = certificateKeyFile;
5893 params.certificateKeyPassword = certificateKeyPassword;
5894 params.pkcs11 = pkcs11;
5896 return context->InvokeService(context, _OrthancPluginService_CallHttpClient2, ¶ms);
5915 _OrthancPluginRetrieveDynamicString params;
5916 params.result = &result;
5917 params.argument = NULL;
5936 } _OrthancPluginFindCallback;
5953 _OrthancPluginFindCallback params;
5954 params.callback = callback;
5956 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback, ¶ms);
5967 uint32_t *resultUint32;
5968 uint16_t *resultGroup;
5969 uint16_t *resultElement;
5970 char **resultString;
5971 } _OrthancPluginFindOperation;
5994 _OrthancPluginFindOperation params;
5995 memset(¶ms, 0,
sizeof(params));
5996 params.answers = answers;
5997 params.dicom = dicom;
6000 return context->InvokeService(context, _OrthancPluginService_FindAddAnswer, ¶ms);
6021 _OrthancPluginFindOperation params;
6022 memset(¶ms, 0,
sizeof(params));
6023 params.answers = answers;
6025 return context->InvokeService(context, _OrthancPluginService_FindMarkIncomplete, ¶ms);
6047 _OrthancPluginFindOperation params;
6048 memset(¶ms, 0,
sizeof(params));
6049 params.query = query;
6050 params.resultUint32 = &count;
6085 _OrthancPluginFindOperation params;
6086 memset(¶ms, 0,
sizeof(params));
6087 params.query = query;
6088 params.index = index;
6089 params.resultGroup = group;
6090 params.resultElement = element;
6092 return context->InvokeService(context, _OrthancPluginService_GetFindQueryTag, ¶ms);
6116 _OrthancPluginFindOperation params;
6117 memset(¶ms, 0,
sizeof(params));
6118 params.query = query;
6119 params.index = index;
6120 params.resultString = &result;
6154 _OrthancPluginFindOperation params;
6155 memset(¶ms, 0,
sizeof(params));
6156 params.query = query;
6157 params.index = index;
6158 params.resultString = &result;
6180 } _OrthancPluginMoveCallback;
6202 _OrthancPluginMoveCallback params;
6203 params.callback = callback;
6204 params.getMoveSize = getMoveSize;
6205 params.applyMove = applyMove;
6206 params.freeMove = freeMove;
6208 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback, ¶ms);
6218 } _OrthancPluginCreateFindMatcher;
6241 _OrthancPluginCreateFindMatcher params;
6242 memset(¶ms, 0,
sizeof(params));
6243 params.target = ⌖
6244 params.query = query;
6261 } _OrthancPluginFreeFindMatcher;
6276 _OrthancPluginFreeFindMatcher params;
6277 params.matcher = matcher;
6279 context->InvokeService(context, _OrthancPluginService_FreeFindMatcher, ¶ms);
6289 } _OrthancPluginFindMatcherIsMatch;
6311 int32_t isMatch = 0;
6313 _OrthancPluginFindMatcherIsMatch params;
6314 params.matcher = matcher;
6315 params.dicom = dicom;
6317 params.isMatch = &isMatch;
6334 } _OrthancPluginIncomingHttpRequestFilter2;
6351 _OrthancPluginIncomingHttpRequestFilter2 params;
6352 params.callback = callback;
6354 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter2, ¶ms);
6362 } _OrthancPluginGetPeers;
6380 _OrthancPluginGetPeers params;
6381 memset(¶ms, 0,
sizeof(params));
6382 params.peers = &peers;
6398 } _OrthancPluginFreePeers;
6413 _OrthancPluginFreePeers params;
6414 params.peers = peers;
6416 context->InvokeService(context, _OrthancPluginService_FreePeers, ¶ms);
6424 } _OrthancPluginGetPeersCount;
6443 uint32_t target = 0;
6445 _OrthancPluginGetPeersCount params;
6446 memset(¶ms, 0,
sizeof(params));
6447 params.target = ⌖
6448 params.peers = peers;
6464 const char** target;
6467 const char* userProperty;
6468 } _OrthancPluginGetPeerProperty;
6492 const char* target = NULL;
6494 _OrthancPluginGetPeerProperty params;
6495 memset(¶ms, 0,
sizeof(params));
6496 params.target = ⌖
6497 params.peers = peers;
6498 params.peerIndex = peerIndex;
6499 params.userProperty = NULL;
6533 const char* target = NULL;
6535 _OrthancPluginGetPeerProperty params;
6536 memset(¶ms, 0,
sizeof(params));
6537 params.target = ⌖
6538 params.peers = peers;
6539 params.peerIndex = peerIndex;
6540 params.userProperty = NULL;
6578 const char* userProperty)
6580 const char* target = NULL;
6582 _OrthancPluginGetPeerProperty params;
6583 memset(¶ms, 0,
sizeof(params));
6584 params.target = ⌖
6585 params.peers = peers;
6586 params.peerIndex = peerIndex;
6587 params.userProperty = userProperty;
6606 uint16_t* httpStatus;
6611 uint32_t additionalHeadersCount;
6612 const char*
const* additionalHeadersKeys;
6613 const char*
const* additionalHeadersValues;
6617 } _OrthancPluginCallPeerApi;
6659 uint16_t* httpStatus,
6664 uint32_t additionalHeadersCount,
6665 const char*
const* additionalHeadersKeys,
6666 const char*
const* additionalHeadersValues,
6671 _OrthancPluginCallPeerApi params;
6672 memset(¶ms, 0,
sizeof(params));
6674 params.answerBody = answerBody;
6675 params.answerHeaders = answerHeaders;
6676 params.httpStatus = httpStatus;
6677 params.peers = peers;
6678 params.peerIndex = peerIndex;
6679 params.method = method;
6681 params.additionalHeadersCount = additionalHeadersCount;
6682 params.additionalHeadersKeys = additionalHeadersKeys;
6683 params.additionalHeadersValues = additionalHeadersValues;
6685 params.bodySize = bodySize;
6686 params.timeout = timeout;
6688 return context->InvokeService(context, _OrthancPluginService_CallPeerApi, ¶ms);
6707 } _OrthancPluginCreateJob;
6755 _OrthancPluginCreateJob params;
6756 memset(¶ms, 0,
sizeof(params));
6758 params.target = ⌖
6760 params.finalize = finalize;
6762 params.getProgress = getProgress;
6763 params.getContent = getContent;
6764 params.getSerialized = getSerialized;
6767 params.reset = reset;
6794 } _OrthancPluginCreateJob2;
6841 _OrthancPluginCreateJob2 params;
6842 memset(¶ms, 0,
sizeof(params));
6844 params.target = ⌖
6846 params.finalize = finalize;
6848 params.getProgress = getProgress;
6849 params.getContent = getContent;
6850 params.getSerialized = getSerialized;
6853 params.reset = reset;
6871 } _OrthancPluginFreeJob;
6886 _OrthancPluginFreeJob params;
6889 context->InvokeService(context, _OrthancPluginService_FreeJob, ¶ms);
6899 } _OrthancPluginSubmitJob;
6919 char* resultId = NULL;
6921 _OrthancPluginSubmitJob params;
6922 memset(¶ms, 0,
sizeof(params));
6924 params.resultId = &resultId;
6926 params.priority = priority;
6945 } _OrthancPluginJobsUnserializer;
6963 _OrthancPluginJobsUnserializer params;
6964 params.unserializer = unserializer;
6966 context->InvokeService(context, _OrthancPluginService_RegisterJobsUnserializer, ¶ms);
6974 const char* details;
6976 } _OrthancPluginSetHttpErrorDetails;
6998 const char* details,
7001 _OrthancPluginSetHttpErrorDetails params;
7002 params.output = output;
7003 params.details = details;
7005 context->InvokeService(context, _OrthancPluginService_SetHttpErrorDetails, ¶ms);
7012 const char** result;
7013 const char* argument;
7014 } _OrthancPluginRetrieveStaticString;
7031 const char* result = NULL;
7033 _OrthancPluginRetrieveStaticString params;
7034 params.result = &result;
7035 params.argument = path;
7055 } _OrthancPluginSetMetricsValue;
7077 _OrthancPluginSetMetricsValue params;
7079 params.value = value;
7081 context->InvokeService(context, _OrthancPluginService_SetMetricsValue, ¶ms);
7089 } _OrthancPluginRegisterRefreshMetricsCallback;
7105 _OrthancPluginRegisterRefreshMetricsCallback params;
7106 params.callback = callback;
7107 context->InvokeService(context, _OrthancPluginService_RegisterRefreshMetricsCallback, ¶ms);
7119 } _OrthancPluginEncodeDicomWeb;
7143 char* target = NULL;
7145 _OrthancPluginEncodeDicomWeb params;
7146 params.target = ⌖
7147 params.dicom = dicom;
7148 params.dicomSize = dicomSize;
7149 params.callback = callback;
7185 char* target = NULL;
7187 _OrthancPluginEncodeDicomWeb params;
7188 params.target = ⌖
7189 params.dicom = dicom;
7190 params.dicomSize = dicomSize;
7191 params.callback = callback;
7213 } _OrthancPluginEncodeDicomWeb2;
7238 char* target = NULL;
7240 _OrthancPluginEncodeDicomWeb2 params;
7241 params.target = ⌖
7242 params.dicom = dicom;
7243 params.dicomSize = dicomSize;
7244 params.callback = callback;
7245 params.payload = payload;
7282 char* target = NULL;
7284 _OrthancPluginEncodeDicomWeb2 params;
7285 params.target = ⌖
7286 params.dicom = dicom;
7287 params.dicomSize = dicomSize;
7288 params.callback = callback;
7289 params.payload = payload;
7393 typedef const void* (*OrthancPluginChunkedClientRequestGetChunkData) (
void* request);
7417 uint16_t* httpStatus;
7420 uint32_t headersCount;
7421 const char*
const* headersKeys;
7422 const char*
const* headersValues;
7428 const char* username;
7429 const char* password;
7431 const char* certificateFile;
7432 const char* certificateKeyFile;
7433 const char* certificateKeyPassword;
7435 } _OrthancPluginChunkedHttpClient;
7493 uint16_t* httpStatus,
7496 uint32_t headersCount,
7497 const char*
const* headersKeys,
7498 const char*
const* headersValues,
7504 const char* username,
7505 const char* password,
7507 const char* certificateFile,
7508 const char* certificateKeyFile,
7509 const char* certificateKeyPassword,
7512 _OrthancPluginChunkedHttpClient params;
7513 memset(¶ms, 0,
sizeof(params));
7516 params.httpStatus = httpStatus;
7517 params.method = method;
7519 params.headersCount = headersCount;
7520 params.headersKeys = headersKeys;
7521 params.headersValues = headersValues;
7522 params.username = username;
7523 params.password = password;
7524 params.timeout = timeout;
7525 params.certificateFile = certificateFile;
7526 params.certificateKeyFile = certificateKeyFile;
7527 params.certificateKeyPassword = certificateKeyPassword;
7528 params.pkcs11 = pkcs11;
7531 params.answer = answer;
7532 params.answerAddChunk = answerAddChunk;
7533 params.answerAddHeader = answerAddHeader;
7534 params.request = request;
7535 params.requestIsDone = requestIsDone;
7536 params.requestChunkData = requestChunkData;
7537 params.requestChunkSize = requestChunkSize;
7538 params.requestNext = requestNext;
7540 return context->InvokeService(context, _OrthancPluginService_ChunkedHttpClient, ¶ms);
7630 const char* pathRegularExpression;
7638 } _OrthancPluginChunkedRestCallback;
7672 const char* pathRegularExpression,
7681 _OrthancPluginChunkedRestCallback params;
7682 params.pathRegularExpression = pathRegularExpression;
7683 params.getHandler = getHandler;
7684 params.postHandler = postHandler;
7685 params.deleteHandler = deleteHandler;
7686 params.putHandler = putHandler;
7687 params.addChunk = addChunk;
7688 params.execute = execute;
7689 params.finalize = finalize;
7691 context->InvokeService(context, _OrthancPluginService_RegisterChunkedRestCallback, ¶ms);
7703 const char* privateCreator;
7704 } _OrthancPluginGetTagName;
7725 const char* privateCreator)
7729 _OrthancPluginGetTagName params;
7730 params.result = &result;
7731 params.group = group;
7732 params.element = element;
7733 params.privateCreator = privateCreator;
7779 const char* transactionUid,
7780 const char*
const* sopClassUids,
7781 const char*
const* sopInstanceUids,
7782 uint32_t countInstances,
7783 const char* remoteAet,
7784 const char* calledAet);
7822 const char* sopClassUid,
7823 const char* sopInstanceUid);
7831 } _OrthancPluginRegisterStorageCommitmentScpCallback;
7852 _OrthancPluginRegisterStorageCommitmentScpCallback params;
7853 params.factory = factory;
7854 params.destructor = destructor;
7855 params.lookup = lookup;
7856 return context->InvokeService(context, _OrthancPluginService_RegisterStorageCommitmentScpCallback, ¶ms);
7893 } _OrthancPluginIncomingDicomInstanceFilter;
7911 _OrthancPluginIncomingDicomInstanceFilter params;
7912 params.callback = callback;
7914 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingDicomInstanceFilter, ¶ms);
7949 uint16_t* dimseStatus ,
7956 } _OrthancPluginIncomingCStoreInstanceFilter;
7974 _OrthancPluginIncomingCStoreInstanceFilter params;
7975 params.callback = callback;
7977 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingCStoreInstanceFilter, ¶ms);
8017 const void* receivedDicomBuffer,
8018 uint64_t receivedDicomBufferSize,
8025 } _OrthancPluginReceivedInstanceCallback;
8051 _OrthancPluginReceivedInstanceCallback params;
8052 params.callback = callback;
8054 return context->InvokeService(context, _OrthancPluginService_RegisterReceivedInstanceCallback, ¶ms);
8076 _OrthancPluginAccessDicomInstance params;
8077 memset(¶ms, 0,
sizeof(params));
8078 params.resultStringToFree = &result;
8079 params.instance = instance;
8109 int64_t hasPixelData;
8111 _OrthancPluginAccessDicomInstance params;
8112 memset(¶ms, 0,
sizeof(params));
8113 params.resultInt64 = &hasPixelData;
8114 params.instance = instance;
8125 return (hasPixelData != 0);
8139 const char* transferSyntax;
8140 } _OrthancPluginCreateDicomInstance;
8162 _OrthancPluginCreateDicomInstance params;
8163 params.target = ⌖
8164 params.buffer = buffer;
8181 } _OrthancPluginFreeDicomInstance;
8197 _OrthancPluginFreeDicomInstance params;
8198 params.dicom = dicom;
8200 context->InvokeService(context, _OrthancPluginService_FreeDicomInstance, ¶ms);
8206 uint32_t* targetUint32;
8209 char** targetStringToFree;
8211 uint32_t frameIndex;
8214 uint32_t maxStringLength;
8216 void* dicomWebPayload;
8217 } _OrthancPluginAccessDicomInstance2;
8236 _OrthancPluginAccessDicomInstance2 params;
8237 memset(¶ms, 0,
sizeof(params));
8238 params.targetUint32 = &count;
8239 params.instance = instance;
8274 uint32_t frameIndex)
8276 _OrthancPluginAccessDicomInstance2 params;
8277 memset(¶ms, 0,
sizeof(params));
8278 params.targetBuffer = target;
8279 params.instance = instance;
8280 params.frameIndex = frameIndex;
8282 return context->InvokeService(context, _OrthancPluginService_GetInstanceRawFrame, ¶ms);
8301 uint32_t frameIndex)
8305 _OrthancPluginAccessDicomInstance2 params;
8306 memset(¶ms, 0,
sizeof(params));
8307 params.targetImage = ⌖
8308 params.instance = instance;
8309 params.frameIndex = frameIndex;
8341 const char* transferSyntax)
8345 _OrthancPluginCreateDicomInstance params;
8346 params.target = ⌖
8347 params.buffer = buffer;
8349 params.transferSyntax = transferSyntax;
8380 _OrthancPluginAccessDicomInstance2 params;
8381 memset(¶ms, 0,
sizeof(params));
8382 params.targetBuffer = target;
8383 params.instance = instance;
8385 return context->InvokeService(context, _OrthancPluginService_SerializeDicomInstance, ¶ms);
8412 uint32_t maxStringLength)
8414 char* result = NULL;
8416 _OrthancPluginAccessDicomInstance2 params;
8417 memset(¶ms, 0,
sizeof(params));
8418 params.targetStringToFree = &result;
8419 params.instance = instance;
8420 params.format = format;
8421 params.flags = flags;
8422 params.maxStringLength = maxStringLength;
8456 char* target = NULL;
8458 _OrthancPluginAccessDicomInstance2 params;
8459 params.targetStringToFree = ⌖
8460 params.instance = instance;
8461 params.dicomWebCallback = callback;
8462 params.dicomWebPayload = payload;
8496 char* target = NULL;
8498 _OrthancPluginAccessDicomInstance2 params;
8499 params.targetStringToFree = ⌖
8500 params.instance = instance;
8501 params.dicomWebCallback = callback;
8502 params.dicomWebPayload = payload;
8539 const char*
const* allowedSyntaxes,
8540 uint32_t countSyntaxes,
8541 uint8_t allowNewSopInstanceUid);
8547 } _OrthancPluginTranscoderCallback;
8566 _OrthancPluginTranscoderCallback params;
8567 params.callback = callback;
8569 return context->InvokeService(context, _OrthancPluginService_RegisterTranscoderCallback, ¶ms);
8578 } _OrthancPluginCreateMemoryBuffer;
8602 _OrthancPluginCreateMemoryBuffer params;
8603 params.target = target;
8606 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer, ¶ms);
8640 _OrthancPluginRetrieveDynamicString params;
8641 params.result = &result;
8642 params.argument = NULL;
8644 if (context->InvokeService(context, _OrthancPluginService_GenerateRestApiAuthorizationToken,
8662 } _OrthancPluginCreateMemoryBuffer64;
8686 _OrthancPluginCreateMemoryBuffer64 params;
8687 params.target = target;
8690 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer64, ¶ms);
8700 } _OrthancPluginRegisterStorageArea2;
8725 _OrthancPluginRegisterStorageArea2 params;
8726 params.create = create;
8727 params.readWhole = readWhole;
8728 params.readRange = readRange;
8729 params.remove =
remove;
8730 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea2, ¶ms);
8737 _OrthancPluginCreateDicom createDicom;
8738 const char* privateCreator;
8739 } _OrthancPluginCreateDicom2;
8771 const char* privateCreator)
8773 _OrthancPluginCreateDicom2 params;
8774 params.createDicom.target = target;
8775 params.createDicom.json = json;
8776 params.createDicom.pixelData = pixelData;
8777 params.createDicom.flags = flags;
8778 params.privateCreator = privateCreator;
8780 return context->InvokeService(context, _OrthancPluginService_CreateDicom2, ¶ms);
8792 uint16_t* httpStatus;
8795 uint32_t headersCount;
8796 const char*
const* headersKeys;
8797 const char*
const* headersValues;
8800 uint8_t afterPlugins;
8801 } _OrthancPluginCallRestApi;
8837 uint16_t* httpStatus,
8840 uint32_t headersCount,
8841 const char*
const* headersKeys,
8842 const char*
const* headersValues,
8845 uint8_t afterPlugins)
8847 _OrthancPluginCallRestApi params;
8848 memset(¶ms, 0,
sizeof(params));
8850 params.answerBody = answerBody;
8851 params.answerHeaders = answerHeaders;
8852 params.httpStatus = httpStatus;
8853 params.method = method;
8855 params.headersCount = headersCount;
8856 params.headersKeys = headersKeys;
8857 params.headersValues = headersValues;
8859 params.bodySize = bodySize;
8860 params.afterPlugins = afterPlugins;
8862 return context->InvokeService(context, _OrthancPluginService_CallRestApi, ¶ms);
8894 const char* mimeType,
8895 const char* dateTime);
8914 const char* dateTime);
8942 const char* mimeType,
8943 const char* dateTime);
8960 uint8_t* isExisting,
8962 const char*
const* pathItems,
8985 uint8_t* isExisting,
8990 const char*
const* pathItems,
9014 const char*
const* pathItems,
9034 uint8_t* isReadOnly,
9036 const char*
const* pathItems,
9056 uint8_t* isReadOnly,
9058 const char*
const* pathItems,
9076 uint8_t* isReadOnly,
9078 const char*
const* pathItems,
9092 } _OrthancPluginRegisterWebDavCollection;
9125 _OrthancPluginRegisterWebDavCollection params;
9127 params.isExistingFolder = isExistingFolder;
9128 params.listFolder = listFolder;
9129 params.retrieveFile = retrieveFile;
9130 params.storeFile = storeFile;
9131 params.createFolder = createFolder;
9132 params.deleteItem = deleteItem;
9133 params.payload = payload;
9135 return context->InvokeService(context, _OrthancPluginService_RegisterWebDavCollection, ¶ms);
9152 _OrthancPluginRetrieveStaticString params;
9153 params.result = &result;
9154 params.argument = NULL;
9177 const void* request,
9178 uint64_t requestSize);
9190 uint32_t maxDatabaseRetries;
9193 } _OrthancPluginRegisterDatabaseBackendV4;
9215 uint32_t maxDatabaseRetries,
9219 _OrthancPluginRegisterDatabaseBackendV4 params;
9220 params.backend = backend;
9221 params.maxDatabaseRetries = maxDatabaseRetries;
9222 params.operations = operations;
9223 params.finalize = finalize;
9225 return context->InvokeService(context, _OrthancPluginService_RegisterDatabaseBackendV4, ¶ms);
char * OrthancPluginGetInstanceTransferSyntaxUid(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the transfer syntax of a DICOM file.
Definition: OrthancCPlugin.h:8070
Definition: OrthancCPlugin.h:779
OrthancPluginChangeType
Definition: OrthancCPlugin.h:731
void OrthancPluginSendHttpStatusCode(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status)
Send a HTTP status code.
Definition: OrthancCPlugin.h:2812
OrthancPluginErrorCode(* OrthancPluginWebDavCreateFolderCallback)(uint8_t *isReadOnly, uint32_t pathSize, const char *const *pathItems, void *payload)
Callback to create a folder.
Definition: OrthancCPlugin.h:9055
OrthancPluginErrorCode OrthancPluginFindAddAnswer(OrthancPluginContext *context, OrthancPluginFindAnswers *answers, const void *dicom, uint32_t size)
Add one answer to some C-Find request.
Definition: OrthancCPlugin.h:5988
void OrthancPluginSetHttpHeader(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *key, const char *value)
Set some HTTP header.
Definition: OrthancCPlugin.h:2913
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:8984
OrthancPluginImage * OrthancPluginGetInstanceDecodedFrame(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:8298
OrthancPluginErrorCode OrthancPluginRegisterDecodeImageCallback(OrthancPluginContext *context, OrthancPluginDecodeImageCallback callback)
Register a callback to handle the decoding of DICOM images.
Definition: OrthancCPlugin.h:5444
The parameters of a REST request.
Definition: OrthancCPlugin.h:340
void OrthancPluginRedirect(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *redirection)
Redirect a REST request.
Definition: OrthancCPlugin.h:2595
OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:2500
char * OrthancPluginGetInstanceDicomWebXml(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb XML.
Definition: OrthancCPlugin.h:8490
A 64-bit memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:1055
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:4204
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:4296
int OrthancPluginCheckVersion(OrthancPluginContext *context)
Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
Definition: OrthancCPlugin.h:1986
void OrthancPluginSetHttpErrorDetails(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *details, uint8_t log)
Provide a detailed description for an HTTP error.
Definition: OrthancCPlugin.h:6995
OrthancPluginErrorCode OrthancPluginSerializeDicomInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginDicomInstance *instance)
Writes a DICOM instance to a memory buffer.
Definition: OrthancCPlugin.h:8375
struct _OrthancPluginWebDavCollection_t OrthancPluginWebDavCollection
Opaque structure that represents a WebDAV collection.
Definition: OrthancCPlugin.h:8871
OrthancPluginDicomInstance * OrthancPluginTranscodeDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size, const char *transferSyntax)
Parse and transcode a DICOM instance.
Definition: OrthancCPlugin.h:8337
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:8407
char * OrthancPluginGetInstanceSimplifiedJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file (with simplification).
Definition: OrthancCPlugin.h:3089
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:2448
Graylevel, unsigned 16bpp image.
Definition: OrthancCPlugin.h:623
Definition: OrthancCPlugin.h:746
const char *const * headersValues
The values of the HTTP headers.
Definition: OrthancCPlugin.h:400
const char *const * headersKeys
The keys of the HTTP headers (always converted to low-case).
Definition: OrthancCPlugin.h:395
OrthancPluginPixelFormat
Definition: OrthancCPlugin.h:607
uint32_t getCount
For a GET request, the number of GET parameters.
Definition: OrthancCPlugin.h:360
Definition: OrthancCPlugin.h:649
void OrthancPluginRegisterStorageArea(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove)
Register a custom storage area.
Definition: OrthancCPlugin.h:3218
OrthancPluginErrorCode OrthancPluginGetDicomForInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *instanceId)
Retrieve a DICOM instance using its Orthanc identifier.
Definition: OrthancCPlugin.h:2313
OrthancPluginImageFormat
Definition: OrthancCPlugin.h:776
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:7846
OrthancPluginErrorCode(* OrthancPluginWebDavAddFolder)(OrthancPluginWebDavCollection *collection, const char *name, const char *dateTime)
Declare a subfolder while returning the content of a folder.
Definition: OrthancCPlugin.h:8911
const char * OrthancPluginGetFontName(OrthancPluginContext *context, uint32_t fontIndex)
Return the name of a font.
Definition: OrthancCPlugin.h:4580
OrthancPluginErrorCode OrthancPluginRegisterIncomingCStoreInstanceFilter(OrthancPluginContext *context, OrthancPluginIncomingCStoreInstanceFilter callback)
Register a callback to filter incoming DICOM instances received by Orthanc through C-STORE...
Definition: OrthancCPlugin.h:7970
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:5742
OrthancPluginImage * OrthancPluginConvertPixelFormat(OrthancPluginContext *context, const OrthancPluginImage *source, OrthancPluginPixelFormat targetFormat)
Change the pixel format of an image.
Definition: OrthancCPlugin.h:4505
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:1352
Definition: OrthancCPlugin.h:740
OrthancPluginErrorCode OrthancPluginStorageAreaRead(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Read a file from the storage area.
Definition: OrthancCPlugin.h:4763
OrthancPluginErrorCode OrthancPluginRegisterIncomingDicomInstanceFilter(OrthancPluginContext *context, OrthancPluginIncomingDicomInstanceFilter callback)
Register a callback to filter incoming DICOM instances.
Definition: OrthancCPlugin.h:7907
uint32_t OrthancPluginGetFontsCount(OrthancPluginContext *context)
Return the number of available fonts.
Definition: OrthancCPlugin.h:4540
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:6078
void OrthancPluginRegisterOnChangeCallback(OrthancPluginContext *context, OrthancPluginOnChangeCallback callback)
Register a callback to monitor changes.
Definition: OrthancCPlugin.h:3361
Color image in RGBA32 format.
Definition: OrthancCPlugin.h:647
void OrthancPluginSendMethodNotAllowed(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *allowedMethods)
Signal that this URI does not support this HTTP method.
Definition: OrthancCPlugin.h:2858
Definition: OrthancCPlugin.h:763
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:2525
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:1799
Definition: OrthancCPlugin.h:748
Definition: OrthancCPlugin.h:734
OrthancPluginImage * OrthancPluginDecodeDicomImage(OrthancPluginContext *context, const void *buffer, uint32_t bufferSize, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:5571
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:1383
uint16_t group
Definition: OrthancCPlugin.h:1833
void * OrthancPluginGetImageBuffer(OrthancPluginContext *context, const OrthancPluginImage *image)
Return a pointer to the content of an image.
Definition: OrthancCPlugin.h:4074
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:9114
uint32_t minMultiplicity
Definition: OrthancCPlugin.h:1836
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:5219
struct _OrthancPluginWorklistQuery_t OrthancPluginWorklistQuery
Opaque structure to an object that represents a C-Find query for worklists.
Definition: OrthancCPlugin.h:1107
Definition: OrthancCPlugin.h:778
struct _OrthancPluginStorageArea_t OrthancPluginStorageArea
Opaque structure that represents the storage area that is actually used by Orthanc.
Definition: OrthancCPlugin.h:1099
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:8959
char * OrthancPluginGetInstanceJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file.
Definition: OrthancCPlugin.h:3051
Definition: OrthancCPlugin.h:738
Color image in RGB48 format.
Definition: OrthancCPlugin.h:657
uint32_t OrthancPluginGetExpectedDatabaseVersion(OrthancPluginContext *context)
Get the expected version of the database schema.
Definition: OrthancCPlugin.h:3606
Graylevel 8bpp image.
Definition: OrthancCPlugin.h:615
Definition: OrthancCPlugin.h:750
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:1226
OrthancPluginDicomInstance * OrthancPluginCreateDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size)
Parse a DICOM instance.
Definition: OrthancCPlugin.h:8155
uint32_t OrthancPluginGetImageHeight(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the height of an image.
Definition: OrthancCPlugin.h:4005
OrthancPluginImage * OrthancPluginUncompressImage(OrthancPluginContext *context, const void *data, uint32_t size, OrthancPluginImageFormat format)
Decode a compressed image.
Definition: OrthancCPlugin.h:4117
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:8718
OrthancPluginErrorCode(* OrthancPluginRestCallback)(OrthancPluginRestOutput *output, const char *url, const OrthancPluginHttpRequest *request)
Signature of a callback function that answers to a REST request.
Definition: OrthancCPlugin.h:1172
Definition: OrthancCPlugin.h:764
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:8270
int32_t(* OrthancPluginIncomingCStoreInstanceFilter)(uint16_t *dimseStatus, const OrthancPluginDicomInstance *instance)
Callback to filter incoming DICOM instances received by Orthanc through C-STORE.
Definition: OrthancCPlugin.h:7948
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:8015
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:2413
Definition: OrthancCPlugin.h:766
Color image in RGB24 format.
Definition: OrthancCPlugin.h:639
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter2(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter2 callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:6347
char * OrthancPluginGenerateRestApiAuthorizationToken(OrthancPluginContext *context)
Generate a token to grant full access to the REST API of Orthanc.
Definition: OrthancCPlugin.h:8635
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:9010
Graylevel, signed 16bpp image.
Definition: OrthancCPlugin.h:631
An entry in the dictionary of DICOM tags.
Definition: OrthancCPlugin.h:1831
Definition: OrthancCPlugin.h:733
OrthancPluginCompressionType
Definition: OrthancCPlugin.h:761
void OrthancPluginSendHttpStatus(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status, const void *body, uint32_t bodySize)
Send a HTTP status, with a custom body.
Definition: OrthancCPlugin.h:3903
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:5145
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:8890
OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pixel format of an image.
Definition: OrthancCPlugin.h:3939
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:4665
uint32_t OrthancPluginGetImagePitch(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pitch of an image.
Definition: OrthancCPlugin.h:4040
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:2272
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:1060
uint32_t maxMultiplicity
Definition: OrthancCPlugin.h:1837
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:8833
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:1204
void(* OrthancPluginFree)(void *buffer)
Signature of a function to free dynamic memory.
Definition: OrthancCPlugin.h:1216
void OrthancPluginSendUnauthorized(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *realm)
Signal that a REST request is not authorized.
Definition: OrthancCPlugin.h:2835
Graylevel, unsigned 64bpp image.
Definition: OrthancCPlugin.h:689
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:1038
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:8047
uint32_t OrthancPluginGetFontSize(OrthancPluginContext *context, uint32_t fontIndex)
Return the size of a font.
Definition: OrthancCPlugin.h:4612
void(* OrthancPluginRefreshMetricsCallback)()
Callback executed to update the metrics of the plugin.
Definition: OrthancCPlugin.h:1733
OrthancPluginErrorCode OrthancPluginRestApiGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2346
uint32_t headersCount
The number of HTTP headers.
Definition: OrthancCPlugin.h:390
Definition: OrthancCPlugin.h:749
const void * OrthancPluginGetInstanceData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the data of a DICOM file.
Definition: OrthancCPlugin.h:3015
Definition: OrthancCPlugin.h:739
OrthancPluginErrorCode OrthancPluginRegisterWorklistCallback(OrthancPluginContext *context, OrthancPluginWorklistCallback callback)
Register a callback to handle modality worklists requests.
Definition: OrthancCPlugin.h:5183
OrthancPluginErrorCode(* OrthancPluginStorageCreate)(const char *uuid, const void *content, int64_t size, OrthancPluginContentType type)
Callback for writing to the storage area.
Definition: OrthancCPlugin.h:1245
int OrthancPluginHasInstanceMetadata(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, const char *metadata)
Check whether a DICOM instance is associated with some metadata.
Definition: OrthancCPlugin.h:3128
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:1488
OrthancPluginErrorCode OrthancPluginRestApiDelete(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2477
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:7819
struct _OrthancPluginFindAnswers_t OrthancPluginFindAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1131
OrthancPluginErrorCode OrthancPluginRegisterMoveCallback(OrthancPluginContext *context, OrthancPluginMoveCallback callback, OrthancPluginGetMoveSize getMoveSize, OrthancPluginApplyMove applyMove, OrthancPluginFreeMove freeMove)
Register a callback to handle C-Move requests.
Definition: OrthancCPlugin.h:6195
Definition: OrthancCPlugin.h:747
OrthancPluginImage * OrthancPluginCreateImage(OrthancPluginContext *context, OrthancPluginPixelFormat format, uint32_t width, uint32_t height)
Create an image.
Definition: OrthancCPlugin.h:5482
char * OrthancPluginGetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *defaultValue)
Get the value of a global property.
Definition: OrthancCPlugin.h:3470
OrthancPluginErrorCode(* OrthancPluginStorageRemove)(const char *uuid, OrthancPluginContentType type)
Callback for removing a file from the storage area.
Definition: OrthancCPlugin.h:1333
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:3169
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:9075
Definition: OrthancCPlugin.h:741
struct _OrthancPluginServerChunkedRequestReader_t OrthancPluginServerChunkedRequestReader
Opaque structure that reads the content of a HTTP request body during a chunked HTTP transfer...
Definition: OrthancCPlugin.h:7549
OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, OrthancPluginResourceType level)
Reconstruct the main DICOM tags.
Definition: OrthancCPlugin.h:4994
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:6109
void OrthancPluginRegisterJobsUnserializer(OrthancPluginContext *context, OrthancPluginJobsUnserializer unserializer)
Register an unserializer for custom jobs.
Definition: OrthancCPlugin.h:6959
void OrthancPluginFreeDicomInstance(OrthancPluginContext *context, OrthancPluginDicomInstance *dicom)
Free a DICOM instance.
Definition: OrthancCPlugin.h:8193
OrthancPluginErrorCode OrthancPluginRegisterDatabaseBackendV4(OrthancPluginContext *context, void *backend, uint32_t maxDatabaseRetries, OrthancPluginCallDatabaseBackendV4 operations, OrthancPluginFinalizeDatabaseBackendV4 finalize)
Definition: OrthancCPlugin.h:9212
int64_t OrthancPluginGetInstanceSize(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the size of a DICOM file.
Definition: OrthancCPlugin.h:2982
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:5525
char * OrthancPluginGetInstanceDicomWebJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb JSON.
Definition: OrthancCPlugin.h:8450
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:5780
OrthancPluginErrorCode(* OrthancPluginCallDatabaseBackendV4)(OrthancPluginMemoryBuffer64 *response, void *backend, const void *request, uint64_t requestSize)
Signature of a callback function that is triggered when the Orthanc core requests an operation from t...
Definition: OrthancCPlugin.h:9174
int32_t(* OrthancPluginIncomingDicomInstanceFilter)(const OrthancPluginDicomInstance *instance)
Callback to filter incoming DICOM instances received by Orthanc.
Definition: OrthancCPlugin.h:7886
const char *const * getValues
For a GET request, the values of the GET parameters.
Definition: OrthancCPlugin.h:370
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:1193
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:3751
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:8535
OrthancPluginErrorCode OrthancPluginWorklistMarkIncomplete(OrthancPluginContext *context, OrthancPluginWorklistAnswers *answers)
Mark the set of worklist answers as incomplete.
Definition: OrthancCPlugin.h:5249
Definition: OrthancCPlugin.h:780
void OrthancPluginRegisterRestCallbackNoLock(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback, without locking.
Definition: OrthancCPlugin.h:2145
OrthancPluginErrorCode(* OrthancPluginFindCallback)(OrthancPluginFindAnswers *answers, const OrthancPluginFindQuery *query, const char *issuerAet, const char *calledAet)
Callback to handle incoming C-Find SCP requests.
Definition: OrthancCPlugin.h:1445
Definition: OrthancCPlugin.h:744
void(* OrthancPluginFinalizeDatabaseBackendV4)(void *backend)
Signature of a callback function that is triggered when the database plugin must be finalized...
Definition: OrthancCPlugin.h:9185
OrthancPluginErrorCode OrthancPluginRegisterFindCallback(OrthancPluginContext *context, OrthancPluginFindCallback callback)
Register a callback to handle C-Find requests.
Definition: OrthancCPlugin.h:5949
struct _OrthancPluginImage_t OrthancPluginImage
Opaque structure that represents an image that is uncompressed in memory.
Definition: OrthancCPlugin.h:1091
OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *subType, const char *contentType)
Start an HTTP multipart answer.
Definition: OrthancCPlugin.h:3680
struct _OrthancPluginWorklistAnswers_t OrthancPluginWorklistAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1115
OrthancPluginInstanceOrigin OrthancPluginGetInstanceOrigin(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the origin of a DICOM file.
Definition: OrthancCPlugin.h:5352
Definition: OrthancCPlugin.h:751
void(* OrthancPluginFreeMove)(void *moveDriver)
Callback to free one C-Move driver.
Definition: OrthancCPlugin.h:1542
int32_t OrthancPluginHasInstancePixelData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Check whether the DICOM file has pixel data.
Definition: OrthancCPlugin.h:8105
OrthancPluginErrorCode OrthancPluginStorageAreaRemove(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Remove a file from the storage area.
Definition: OrthancCPlugin.h:4802
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:1183
Definition: OrthancCPlugin.h:745
const char *const * getKeys
For a GET request, the keys of the GET parameters.
Definition: OrthancCPlugin.h:365
Definition: OrthancCPlugin.h:736
char * OrthancPluginLookupPatient(OrthancPluginContext *context, const char *patientID)
Look for a patient.
Definition: OrthancCPlugin.h:2627
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:8938
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:1315
struct _OrthancPluginDicomInstance_t OrthancPluginDicomInstance
Opaque structure that represents a DICOM instance that is managed by the Orthanc core.
Definition: OrthancCPlugin.h:1083
void OrthancPluginFreeImage(OrthancPluginContext *context, OrthancPluginImage *image)
Free an image.
Definition: OrthancCPlugin.h:4159
OrthancPluginValueRepresentation vr
Definition: OrthancCPlugin.h:1835
uint16_t element
Definition: OrthancCPlugin.h:1834
char * OrthancPluginLookupInstance(OrthancPluginContext *context, const char *sopInstanceUID)
Look for an instance.
Definition: OrthancCPlugin.h:2767
Definition: OrthancCPlugin.h:743
OrthancPluginErrorCode OrthancPluginSetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *value)
Set the value of a global property.
Definition: OrthancCPlugin.h:3509
OrthancPluginErrorCode(* OrthancPluginApplyMove)(void *moveDriver)
Callback to apply one C-Move suboperation.
Definition: OrthancCPlugin.h:1528
const char *const * groups
The matched values for the groups of the regular expression.
Definition: OrthancCPlugin.h:355
OrthancPluginErrorCode(* OrthancPluginStorageRead)(void **content, int64_t *size, const char *uuid, OrthancPluginContentType type)
Callback for reading from the storage area.
Definition: OrthancCPlugin.h:1272
char * OrthancPluginLookupStudy(OrthancPluginContext *context, const char *studyUID)
Look for a study.
Definition: OrthancCPlugin.h:2662
uint32_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:1043
Graylevel, floating-point 32bpp image.
Definition: OrthancCPlugin.h:673
const char * OrthancPluginGetInstanceRemoteAet(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the AET of a DICOM instance.
Definition: OrthancCPlugin.h:2949
uint32_t groupsCount
The number of groups of the regular expression.
Definition: OrthancCPlugin.h:350
int32_t OrthancPluginWorklistIsMatch(OrthancPluginContext *context, const OrthancPluginWorklistQuery *query, const void *dicom, uint32_t size)
Test whether a worklist matches the query.
Definition: OrthancCPlugin.h:5287
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:1880
const void * body
For a PUT or POST request, the content of the body.
Definition: OrthancCPlugin.h:375
uint32_t bodySize
For a PUT or POST request, the number of bytes of the body.
Definition: OrthancCPlugin.h:380
OrthancPluginErrorCode OrthancPluginFindMarkIncomplete(OrthancPluginContext *context, OrthancPluginFindAnswers *answers)
Mark the set of C-Find answers as incomplete.
Definition: OrthancCPlugin.h:6017
OrthancPluginJob *(* OrthancPluginJobsUnserializer)(const char *jobType, const char *serialized)
Callback executed to unserialize a custom job.
Definition: OrthancCPlugin.h:1715
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:2561
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:3709
void OrthancPluginSetCookie(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *cookie, const char *value)
Set a cookie.
Definition: OrthancCPlugin.h:2888
Definition: OrthancCPlugin.h:735
uint32_t OrthancPluginGetFindQuerySize(OrthancPluginContext *context, const OrthancPluginFindQuery *query)
Get the number of tags in a C-Find query.
Definition: OrthancCPlugin.h:6041
struct _OrthancPluginRestOutput_t OrthancPluginRestOutput
Opaque structure that represents the HTTP connection to the client application.
Definition: OrthancCPlugin.h:1075
void OrthancPluginRegisterOnStoredInstanceCallback(OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback)
Register a callback for received instances.
Definition: OrthancCPlugin.h:2183
Definition: OrthancCPlugin.h:737
Graylevel, unsigned 32bpp image.
Definition: OrthancCPlugin.h:665
void OrthancPluginRegisterRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback.
Definition: OrthancCPlugin.h:2105
char * OrthancPluginLookupStudyWithAccessionNumber(OrthancPluginContext *context, const char *accessionNumber)
Look for a study, using the accession number.
Definition: OrthancCPlugin.h:2697
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:7670
OrthancPluginErrorCode OrthancPluginWorklistGetDicomQuery(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginWorklistQuery *query)
Retrieve the worklist query as a DICOM file.
Definition: OrthancCPlugin.h:5326
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:2376
struct _OrthancPluginFindQuery_t OrthancPluginFindQuery
Opaque structure to an object that represents a C-Find query.
Definition: OrthancCPlugin.h:1123
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:9033
Definition: OrthancCPlugin.h:742
Definition: OrthancCPlugin.h:765
void OrthancPluginRegisterRefreshMetricsCallback(OrthancPluginContext *context, OrthancPluginRefreshMetricsCallback callback)
Register a callback to refresh the metrics.
Definition: OrthancCPlugin.h:7101
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:1418
OrthancPluginHttpMethod method
The HTTP method.
Definition: OrthancCPlugin.h:345
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:4719
void OrthancPluginAnswerBuffer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const void *answer, uint32_t answerSize, const char *mimeType)
Answer to a REST request.
Definition: OrthancCPlugin.h:2215
A 32-bit memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:1033
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:7776
uint64_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:1065
OrthancPluginErrorCode(* OrthancPluginStorageReadWhole)(OrthancPluginMemoryBuffer64 *target, const char *uuid, OrthancPluginContentType type)
Callback for reading a whole file from the storage area.
Definition: OrthancCPlugin.h:1292
Color image in BGRA32 format.
Definition: OrthancCPlugin.h:681
uint32_t OrthancPluginGetInstanceFramesCount(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the number of frames in a DICOM instance.
Definition: OrthancCPlugin.h:8230
OrthancPluginErrorCode OrthancPluginRegisterTranscoderCallback(OrthancPluginContext *context, OrthancPluginTranscoderCallback callback)
Register a callback to handle the transcoding of DICOM images.
Definition: OrthancCPlugin.h:8562
void(* OrthancPluginStorageCommitmentDestructor)(void *handler)
Callback to free one storage commitment SCP handler.
Definition: OrthancCPlugin.h:7798
char * OrthancPluginLookupSeries(OrthancPluginContext *context, const char *seriesUID)
Look for a series.
Definition: OrthancCPlugin.h:2732
uint32_t(* OrthancPluginGetMoveSize)(void *moveDriver)
Callback to read the size of a C-Move driver.
Definition: OrthancCPlugin.h:1513
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:1761
uint32_t OrthancPluginGetImageWidth(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the width of an image.
Definition: OrthancCPlugin.h:3972
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:4249
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:6147