111 # define ORTHANC_PLUGINS_API __declspec(dllexport)
113 # define ORTHANC_PLUGINS_API __attribute__ ((visibility ("default")))
115 # define ORTHANC_PLUGINS_API
118 #define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 1
119 #define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 9
120 #define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 0
123 #if !defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE)
124 #define ORTHANC_PLUGINS_VERSION_IS_ABOVE(major, minor, revision) \
125 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER > major || \
126 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER == major && \
127 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER > minor || \
128 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER == minor && \
129 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER >= revision))))
148 #ifndef ORTHANC_PLUGIN_INLINE
149 # if __STDC_VERSION__ >= 199901L
151 # define ORTHANC_PLUGIN_INLINE static inline
152 # elif defined(__cplusplus)
154 # define ORTHANC_PLUGIN_INLINE static inline
155 # elif defined(__GNUC__)
157 # define ORTHANC_PLUGIN_INLINE static __inline
158 # elif defined(_MSC_VER)
160 # define ORTHANC_PLUGIN_INLINE static __inline
162 # error Your compiler is not known to support the "inline" keyword
305 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
313 ORTHANC_PLUGINS_API
const char* OrthancPluginGetName();
326 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
402 _OrthancPluginService_LogInfo = 1,
403 _OrthancPluginService_LogWarning = 2,
404 _OrthancPluginService_LogError = 3,
405 _OrthancPluginService_GetOrthancPath = 4,
406 _OrthancPluginService_GetOrthancDirectory = 5,
407 _OrthancPluginService_GetConfigurationPath = 6,
408 _OrthancPluginService_SetPluginProperty = 7,
409 _OrthancPluginService_GetGlobalProperty = 8,
410 _OrthancPluginService_SetGlobalProperty = 9,
411 _OrthancPluginService_GetCommandLineArgumentsCount = 10,
412 _OrthancPluginService_GetCommandLineArgument = 11,
413 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
414 _OrthancPluginService_GetConfiguration = 13,
415 _OrthancPluginService_BufferCompression = 14,
416 _OrthancPluginService_ReadFile = 15,
417 _OrthancPluginService_WriteFile = 16,
418 _OrthancPluginService_GetErrorDescription = 17,
419 _OrthancPluginService_CallHttpClient = 18,
420 _OrthancPluginService_RegisterErrorCode = 19,
421 _OrthancPluginService_RegisterDictionaryTag = 20,
422 _OrthancPluginService_DicomBufferToJson = 21,
423 _OrthancPluginService_DicomInstanceToJson = 22,
424 _OrthancPluginService_CreateDicom = 23,
425 _OrthancPluginService_ComputeMd5 = 24,
426 _OrthancPluginService_ComputeSha1 = 25,
427 _OrthancPluginService_LookupDictionary = 26,
428 _OrthancPluginService_CallHttpClient2 = 27,
429 _OrthancPluginService_GenerateUuid = 28,
430 _OrthancPluginService_RegisterPrivateDictionaryTag = 29,
431 _OrthancPluginService_AutodetectMimeType = 30,
432 _OrthancPluginService_SetMetricsValue = 31,
433 _OrthancPluginService_EncodeDicomWebJson = 32,
434 _OrthancPluginService_EncodeDicomWebXml = 33,
435 _OrthancPluginService_ChunkedHttpClient = 34,
436 _OrthancPluginService_GetTagName = 35,
437 _OrthancPluginService_EncodeDicomWebJson2 = 36,
438 _OrthancPluginService_EncodeDicomWebXml2 = 37,
439 _OrthancPluginService_CreateMemoryBuffer = 38,
440 _OrthancPluginService_GenerateRestApiAuthorizationToken = 39,
441 _OrthancPluginService_CreateMemoryBuffer64 = 40,
442 _OrthancPluginService_CreateDicom2 = 41,
445 _OrthancPluginService_RegisterRestCallback = 1000,
446 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
447 _OrthancPluginService_RegisterStorageArea = 1002,
448 _OrthancPluginService_RegisterOnChangeCallback = 1003,
449 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
450 _OrthancPluginService_RegisterWorklistCallback = 1005,
451 _OrthancPluginService_RegisterDecodeImageCallback = 1006,
452 _OrthancPluginService_RegisterIncomingHttpRequestFilter = 1007,
453 _OrthancPluginService_RegisterFindCallback = 1008,
454 _OrthancPluginService_RegisterMoveCallback = 1009,
455 _OrthancPluginService_RegisterIncomingHttpRequestFilter2 = 1010,
456 _OrthancPluginService_RegisterRefreshMetricsCallback = 1011,
457 _OrthancPluginService_RegisterChunkedRestCallback = 1012,
458 _OrthancPluginService_RegisterStorageCommitmentScpCallback = 1013,
459 _OrthancPluginService_RegisterIncomingDicomInstanceFilter = 1014,
460 _OrthancPluginService_RegisterTranscoderCallback = 1015,
461 _OrthancPluginService_RegisterStorageArea2 = 1016,
464 _OrthancPluginService_AnswerBuffer = 2000,
465 _OrthancPluginService_CompressAndAnswerPngImage = 2001,
466 _OrthancPluginService_Redirect = 2002,
467 _OrthancPluginService_SendHttpStatusCode = 2003,
468 _OrthancPluginService_SendUnauthorized = 2004,
469 _OrthancPluginService_SendMethodNotAllowed = 2005,
470 _OrthancPluginService_SetCookie = 2006,
471 _OrthancPluginService_SetHttpHeader = 2007,
472 _OrthancPluginService_StartMultipartAnswer = 2008,
473 _OrthancPluginService_SendMultipartItem = 2009,
474 _OrthancPluginService_SendHttpStatus = 2010,
475 _OrthancPluginService_CompressAndAnswerImage = 2011,
476 _OrthancPluginService_SendMultipartItem2 = 2012,
477 _OrthancPluginService_SetHttpErrorDetails = 2013,
480 _OrthancPluginService_GetDicomForInstance = 3000,
481 _OrthancPluginService_RestApiGet = 3001,
482 _OrthancPluginService_RestApiPost = 3002,
483 _OrthancPluginService_RestApiDelete = 3003,
484 _OrthancPluginService_RestApiPut = 3004,
485 _OrthancPluginService_LookupPatient = 3005,
486 _OrthancPluginService_LookupStudy = 3006,
487 _OrthancPluginService_LookupSeries = 3007,
488 _OrthancPluginService_LookupInstance = 3008,
489 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
490 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
491 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
492 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
493 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
494 _OrthancPluginService_ReconstructMainDicomTags = 3014,
495 _OrthancPluginService_RestApiGet2 = 3015,
498 _OrthancPluginService_GetInstanceRemoteAet = 4000,
499 _OrthancPluginService_GetInstanceSize = 4001,
500 _OrthancPluginService_GetInstanceData = 4002,
501 _OrthancPluginService_GetInstanceJson = 4003,
502 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
503 _OrthancPluginService_HasInstanceMetadata = 4005,
504 _OrthancPluginService_GetInstanceMetadata = 4006,
505 _OrthancPluginService_GetInstanceOrigin = 4007,
506 _OrthancPluginService_GetInstanceTransferSyntaxUid = 4008,
507 _OrthancPluginService_HasInstancePixelData = 4009,
508 _OrthancPluginService_CreateDicomInstance = 4010,
509 _OrthancPluginService_FreeDicomInstance = 4011,
510 _OrthancPluginService_GetInstanceFramesCount = 4012,
511 _OrthancPluginService_GetInstanceRawFrame = 4013,
512 _OrthancPluginService_GetInstanceDecodedFrame = 4014,
513 _OrthancPluginService_TranscodeDicomInstance = 4015,
514 _OrthancPluginService_SerializeDicomInstance = 4016,
515 _OrthancPluginService_GetInstanceAdvancedJson = 4017,
516 _OrthancPluginService_GetInstanceDicomWebJson = 4018,
517 _OrthancPluginService_GetInstanceDicomWebXml = 4019,
520 _OrthancPluginService_RegisterDatabaseBackend = 5000,
521 _OrthancPluginService_DatabaseAnswer = 5001,
522 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002,
523 _OrthancPluginService_StorageAreaCreate = 5003,
524 _OrthancPluginService_StorageAreaRead = 5004,
525 _OrthancPluginService_StorageAreaRemove = 5005,
528 _OrthancPluginService_GetImagePixelFormat = 6000,
529 _OrthancPluginService_GetImageWidth = 6001,
530 _OrthancPluginService_GetImageHeight = 6002,
531 _OrthancPluginService_GetImagePitch = 6003,
532 _OrthancPluginService_GetImageBuffer = 6004,
533 _OrthancPluginService_UncompressImage = 6005,
534 _OrthancPluginService_FreeImage = 6006,
535 _OrthancPluginService_CompressImage = 6007,
536 _OrthancPluginService_ConvertPixelFormat = 6008,
537 _OrthancPluginService_GetFontsCount = 6009,
538 _OrthancPluginService_GetFontInfo = 6010,
539 _OrthancPluginService_DrawText = 6011,
540 _OrthancPluginService_CreateImage = 6012,
541 _OrthancPluginService_CreateImageAccessor = 6013,
542 _OrthancPluginService_DecodeDicomImage = 6014,
545 _OrthancPluginService_WorklistAddAnswer = 7000,
546 _OrthancPluginService_WorklistMarkIncomplete = 7001,
547 _OrthancPluginService_WorklistIsMatch = 7002,
548 _OrthancPluginService_WorklistGetDicomQuery = 7003,
549 _OrthancPluginService_FindAddAnswer = 7004,
550 _OrthancPluginService_FindMarkIncomplete = 7005,
551 _OrthancPluginService_GetFindQuerySize = 7006,
552 _OrthancPluginService_GetFindQueryTag = 7007,
553 _OrthancPluginService_GetFindQueryTagName = 7008,
554 _OrthancPluginService_GetFindQueryValue = 7009,
555 _OrthancPluginService_CreateFindMatcher = 7010,
556 _OrthancPluginService_FreeFindMatcher = 7011,
557 _OrthancPluginService_FindMatcherIsMatch = 7012,
560 _OrthancPluginService_GetPeers = 8000,
561 _OrthancPluginService_FreePeers = 8001,
562 _OrthancPluginService_GetPeersCount = 8003,
563 _OrthancPluginService_GetPeerName = 8004,
564 _OrthancPluginService_GetPeerUrl = 8005,
565 _OrthancPluginService_CallPeerApi = 8006,
566 _OrthancPluginService_GetPeerUserProperty = 8007,
569 _OrthancPluginService_CreateJob = 9000,
570 _OrthancPluginService_FreeJob = 9001,
571 _OrthancPluginService_SubmitJob = 9002,
572 _OrthancPluginService_RegisterJobsUnserializer = 9003,
574 _OrthancPluginService_INTERNAL = 0x7fffffff
575 } _OrthancPluginService;
580 _OrthancPluginProperty_Description = 1,
581 _OrthancPluginProperty_RootUri = 2,
582 _OrthancPluginProperty_OrthancExplorer = 3,
584 _OrthancPluginProperty_INTERNAL = 0x7fffffff
585 } _OrthancPluginProperty;
677 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
691 _OrthancPluginContentType_INTERNAL = 0x7fffffff
707 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
738 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
753 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
767 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
805 _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff
820 _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff
831 OrthancPluginDicomToJsonFlags_None = 0,
839 _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff
850 OrthancPluginCreateDicomFlags_None = 0,
854 _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff
870 _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff
886 _OrthancPluginConstraintType_INTERNAL = 0x7fffffff
902 _OrthancPluginInstanceOrigin_INTERNAL = 0x7fffffff
1156 const char* instanceId);
1167 const char* resourceId);
1178 const uint32_t size,
1179 uint32_t frameIndex);
1200 const char* bulkDataUri);
1218 const void* content,
1290 uint64_t rangeStart);
1326 const char* issuerAet,
1327 const char* calledAet);
1358 uint32_t headersCount,
1359 const char*
const* headersKeys,
1360 const char*
const* headersValues);
1393 uint32_t headersCount,
1394 const char*
const* headersKeys,
1395 const char*
const* headersValues,
1396 uint32_t getArgumentsCount,
1397 const char*
const* getArgumentsKeys,
1398 const char*
const* getArgumentsValues);
1419 const char* issuerAet,
1420 const char* calledAet);
1459 typedef void* (*OrthancPluginMoveCallback) (
1461 const char* patientId,
1462 const char* accessionNumber,
1463 const char* studyInstanceUid,
1464 const char* seriesInstanceUid,
1465 const char* sopInstanceUid,
1466 const char* originatorAet,
1467 const char* sourceAet,
1468 const char* targetAet,
1469 uint16_t originatorId);
1554 typedef const char* (*OrthancPluginJobGetContent) (
void* job);
1572 typedef const char* (*OrthancPluginJobGetSerialized) (
void* job);
1645 const char* serialized);
1693 uint32_t levelDepth,
1694 const uint16_t* levelTagGroup,
1695 const uint16_t* levelTagElement,
1696 const uint32_t* levelIndex,
1698 uint16_t tagElement,
1731 uint32_t levelDepth,
1732 const uint16_t* levelTagGroup,
1733 const uint16_t* levelTagElement,
1734 const uint32_t* levelIndex,
1736 uint16_t tagElement,
1745 typedef struct _OrthancPluginContext_t
1747 void* pluginsManager;
1748 const char* orthancVersion;
1751 _OrthancPluginService service,
1752 const void* params);
1813 int expectedRevision)
1815 int major, minor, revision;
1819 sizeof(int32_t) !=
sizeof(_OrthancPluginService) ||
1820 sizeof(int32_t) !=
sizeof(_OrthancPluginProperty) ||
1844 if (!strcmp(context->orthancVersion,
"mainline"))
1856 (context->orthancVersion,
"%4d.%4d.%4d", &major, &minor, &revision) != 3)
1863 if (major > expectedMajor)
1868 if (major < expectedMajor)
1875 if (minor > expectedMinor)
1880 if (minor < expectedMinor)
1887 if (revision >= expectedRevision)
1919 ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER,
1920 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER,
1921 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER);
1937 context->Free(buffer->
data);
1953 context->Free(buffer->
data);
1967 const char* message)
1969 context->InvokeService(context, _OrthancPluginService_LogError, message);
1983 const char* message)
1985 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
1999 const char* message)
2001 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
2008 const char* pathRegularExpression;
2010 } _OrthancPluginRestCallback;
2035 const char* pathRegularExpression,
2038 _OrthancPluginRestCallback params;
2039 params.pathRegularExpression = pathRegularExpression;
2040 params.callback = callback;
2041 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
2075 const char* pathRegularExpression,
2078 _OrthancPluginRestCallback params;
2079 params.pathRegularExpression = pathRegularExpression;
2080 params.callback = callback;
2081 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms);
2089 } _OrthancPluginOnStoredInstanceCallback;
2115 _OrthancPluginOnStoredInstanceCallback params;
2116 params.callback = callback;
2118 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
2127 uint32_t answerSize;
2128 const char* mimeType;
2129 } _OrthancPluginAnswerBuffer;
2147 uint32_t answerSize,
2148 const char* mimeType)
2150 _OrthancPluginAnswerBuffer params;
2151 params.output = output;
2152 params.answer = answer;
2153 params.answerSize = answerSize;
2154 params.mimeType = mimeType;
2155 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms);
2167 } _OrthancPluginCompressAndAnswerPngImage;
2179 } _OrthancPluginCompressAndAnswerImage;
2209 _OrthancPluginCompressAndAnswerImage params;
2210 params.output = output;
2212 params.pixelFormat = format;
2213 params.width = width;
2214 params.height = height;
2215 params.pitch = pitch;
2216 params.buffer = buffer;
2218 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
2226 const char* instanceId;
2227 } _OrthancPluginGetDicomForInstance;
2244 const char* instanceId)
2246 _OrthancPluginGetDicomForInstance params;
2247 params.target = target;
2248 params.instanceId = instanceId;
2249 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
2258 } _OrthancPluginRestApiGet;
2279 _OrthancPluginRestApiGet params;
2280 params.target = target;
2282 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
2309 _OrthancPluginRestApiGet params;
2310 params.target = target;
2312 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms);
2323 } _OrthancPluginRestApiPostPut;
2348 _OrthancPluginRestApiPostPut params;
2349 params.target = target;
2352 params.bodySize = bodySize;
2353 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
2383 _OrthancPluginRestApiPostPut params;
2384 params.target = target;
2387 params.bodySize = bodySize;
2388 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms);
2409 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
2432 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
2460 _OrthancPluginRestApiPostPut params;
2461 params.target = target;
2464 params.bodySize = bodySize;
2465 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
2496 _OrthancPluginRestApiPostPut params;
2497 params.target = target;
2500 params.bodySize = bodySize;
2501 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms);
2509 const char* argument;
2510 } _OrthancPluginOutputPlusArgument;
2526 const char* redirection)
2528 _OrthancPluginOutputPlusArgument params;
2529 params.output = output;
2530 params.argument = redirection;
2531 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
2539 const char* argument;
2540 } _OrthancPluginRetrieveDynamicString;
2557 const char* patientID)
2561 _OrthancPluginRetrieveDynamicString params;
2562 params.result = &result;
2563 params.argument = patientID;
2592 const char* studyUID)
2596 _OrthancPluginRetrieveDynamicString params;
2597 params.result = &result;
2598 params.argument = studyUID;
2627 const char* accessionNumber)
2631 _OrthancPluginRetrieveDynamicString params;
2632 params.result = &result;
2633 params.argument = accessionNumber;
2662 const char* seriesUID)
2666 _OrthancPluginRetrieveDynamicString params;
2667 params.result = &result;
2668 params.argument = seriesUID;
2697 const char* sopInstanceUID)
2701 _OrthancPluginRetrieveDynamicString params;
2702 params.result = &result;
2703 params.argument = sopInstanceUID;
2722 } _OrthancPluginSendHttpStatusCode;
2745 _OrthancPluginSendHttpStatusCode params;
2746 params.output = output;
2747 params.status = status;
2748 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
2768 _OrthancPluginOutputPlusArgument params;
2769 params.output = output;
2770 params.argument = realm;
2771 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
2789 const char* allowedMethods)
2791 _OrthancPluginOutputPlusArgument params;
2792 params.output = output;
2793 params.argument = allowedMethods;
2794 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
2803 } _OrthancPluginSetHttpHeader;
2822 _OrthancPluginSetHttpHeader params;
2823 params.output = output;
2824 params.key = cookie;
2825 params.value = value;
2826 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
2847 _OrthancPluginSetHttpHeader params;
2848 params.output = output;
2850 params.value = value;
2851 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
2857 char** resultStringToFree;
2858 const char** resultString;
2859 int64_t* resultInt64;
2863 } _OrthancPluginAccessDicomInstance;
2883 _OrthancPluginAccessDicomInstance params;
2884 memset(¶ms, 0,
sizeof(params));
2885 params.resultString = &result;
2886 params.instance = instance;
2916 _OrthancPluginAccessDicomInstance params;
2917 memset(¶ms, 0,
sizeof(params));
2918 params.resultInt64 = &size;
2919 params.instance = instance;
2949 _OrthancPluginAccessDicomInstance params;
2950 memset(¶ms, 0,
sizeof(params));
2951 params.resultString = &result;
2952 params.instance = instance;
2985 _OrthancPluginAccessDicomInstance params;
2986 memset(¶ms, 0,
sizeof(params));
2987 params.resultStringToFree = &result;
2988 params.instance = instance;
3023 _OrthancPluginAccessDicomInstance params;
3024 memset(¶ms, 0,
sizeof(params));
3025 params.resultStringToFree = &result;
3026 params.instance = instance;
3059 const char* metadata)
3063 _OrthancPluginAccessDicomInstance params;
3064 memset(¶ms, 0,
sizeof(params));
3065 params.resultInt64 = &result;
3066 params.instance = instance;
3067 params.key = metadata;
3076 return (result != 0);
3100 const char* metadata)
3104 _OrthancPluginAccessDicomInstance params;
3105 memset(¶ms, 0,
sizeof(params));
3106 params.resultString = &result;
3107 params.instance = instance;
3108 params.key = metadata;
3129 } _OrthancPluginRegisterStorageArea;
3152 _OrthancPluginRegisterStorageArea params;
3153 params.create = create;
3155 params.remove = remove;
3158 params.free = ::free;
3163 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
3182 _OrthancPluginRetrieveDynamicString params;
3183 params.result = &result;
3184 params.argument = NULL;
3212 _OrthancPluginRetrieveDynamicString params;
3213 params.result = &result;
3214 params.argument = NULL;
3247 _OrthancPluginRetrieveDynamicString params;
3248 params.result = &result;
3249 params.argument = NULL;
3267 } _OrthancPluginOnChangeCallback;
3293 _OrthancPluginOnChangeCallback params;
3294 params.callback = callback;
3296 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms);
3304 _OrthancPluginProperty property;
3306 } _OrthancPluginSetPluginProperty;
3324 _OrthancPluginSetPluginProperty params;
3325 params.plugin = OrthancPluginGetName();
3326 params.property = _OrthancPluginProperty_RootUri;
3329 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3344 const char* description)
3346 _OrthancPluginSetPluginProperty params;
3347 params.plugin = OrthancPluginGetName();
3348 params.property = _OrthancPluginProperty_Description;
3349 params.value = description;
3351 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3366 const char* javascript)
3368 _OrthancPluginSetPluginProperty params;
3369 params.plugin = OrthancPluginGetName();
3370 params.property = _OrthancPluginProperty_OrthancExplorer;
3371 params.value = javascript;
3373 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3382 } _OrthancPluginGlobalProperty;
3401 const char* defaultValue)
3405 _OrthancPluginGlobalProperty params;
3406 params.result = &result;
3407 params.property = property;
3408 params.value = defaultValue;
3442 _OrthancPluginGlobalProperty params;
3443 params.result = NULL;
3444 params.property = property;
3445 params.value = value;
3447 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms);
3454 int32_t *resultInt32;
3455 uint32_t *resultUint32;
3456 int64_t *resultInt64;
3457 uint64_t *resultUint64;
3458 } _OrthancPluginReturnSingleValue;
3473 _OrthancPluginReturnSingleValue params;
3474 memset(¶ms, 0,
sizeof(params));
3475 params.resultUint32 = &count;
3508 _OrthancPluginGlobalProperty params;
3509 params.result = &result;
3510 params.property = (int32_t) argument;
3511 params.value = NULL;
3539 _OrthancPluginReturnSingleValue params;
3540 memset(¶ms, 0,
sizeof(params));
3541 params.resultUint32 = &count;
3571 _OrthancPluginRetrieveDynamicString params;
3572 params.result = &result;
3573 params.argument = NULL;
3591 const char* subType;
3592 const char* contentType;
3593 } _OrthancPluginStartMultipartAnswer;
3611 const char* subType,
3612 const char* contentType)
3614 _OrthancPluginStartMultipartAnswer params;
3615 params.output = output;
3616 params.subType = subType;
3617 params.contentType = contentType;
3618 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms);
3641 uint32_t answerSize)
3643 _OrthancPluginAnswerBuffer params;
3644 params.output = output;
3645 params.answer = answer;
3646 params.answerSize = answerSize;
3647 params.mimeType = NULL;
3648 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms);
3660 } _OrthancPluginBufferCompression;
3687 _OrthancPluginBufferCompression params;
3688 params.target = target;
3689 params.source = source;
3691 params.compression = compression;
3692 params.uncompress = uncompress;
3694 return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms);
3703 } _OrthancPluginReadFile;
3721 _OrthancPluginReadFile params;
3722 params.target = target;
3724 return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms);
3734 } _OrthancPluginWriteFile;
3753 _OrthancPluginWriteFile params;
3757 return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms);
3764 const char** target;
3766 } _OrthancPluginGetErrorDescription;
3782 const char* result = NULL;
3784 _OrthancPluginGetErrorDescription params;
3785 params.target = &result;
3786 params.error = error;
3791 return "Unknown error code";
3807 } _OrthancPluginSendHttpStatus;
3838 _OrthancPluginSendHttpStatus params;
3839 params.output = output;
3840 params.status = status;
3842 params.bodySize = bodySize;
3843 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms);
3851 uint32_t* resultUint32;
3853 void** resultBuffer;
3854 } _OrthancPluginGetImageInfo;
3873 _OrthancPluginGetImageInfo params;
3874 memset(¶ms, 0,
sizeof(params));
3875 params.image = image;
3876 params.resultPixelFormat = ⌖
3906 _OrthancPluginGetImageInfo params;
3907 memset(¶ms, 0,
sizeof(params));
3908 params.image = image;
3909 params.resultUint32 = &width;
3939 _OrthancPluginGetImageInfo params;
3940 memset(¶ms, 0,
sizeof(params));
3941 params.image = image;
3942 params.resultUint32 = &height;
3974 _OrthancPluginGetImageInfo params;
3975 memset(¶ms, 0,
sizeof(params));
3976 params.image = image;
3977 params.resultUint32 = &pitch;
4006 void* target = NULL;
4008 _OrthancPluginGetImageInfo params;
4009 memset(¶ms, 0,
sizeof(params));
4010 params.resultBuffer = ⌖
4011 params.image = image;
4030 } _OrthancPluginUncompressImage;
4053 _OrthancPluginUncompressImage params;
4054 memset(¶ms, 0,
sizeof(params));
4055 params.target = ⌖
4058 params.format = format;
4076 } _OrthancPluginFreeImage;
4091 _OrthancPluginFreeImage params;
4092 params.image = image;
4094 context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms);
4110 } _OrthancPluginCompressImage;
4141 _OrthancPluginCompressImage params;
4142 memset(¶ms, 0,
sizeof(params));
4143 params.target = target;
4145 params.pixelFormat = format;
4146 params.width = width;
4147 params.height = height;
4148 params.pitch = pitch;
4149 params.buffer = buffer;
4152 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4187 _OrthancPluginCompressImage params;
4188 memset(¶ms, 0,
sizeof(params));
4189 params.target = target;
4191 params.pixelFormat = format;
4192 params.width = width;
4193 params.height = height;
4194 params.pitch = pitch;
4195 params.buffer = buffer;
4196 params.quality = quality;
4198 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4234 _OrthancPluginCompressAndAnswerImage params;
4235 params.output = output;
4237 params.pixelFormat = format;
4238 params.width = width;
4239 params.height = height;
4240 params.pitch = pitch;
4241 params.buffer = buffer;
4242 params.quality = quality;
4243 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
4254 const char* username;
4255 const char* password;
4258 } _OrthancPluginCallHttpClient;
4281 const char* username,
4282 const char* password)
4284 _OrthancPluginCallHttpClient params;
4285 memset(¶ms, 0,
sizeof(params));
4287 params.target = target;
4290 params.username = username;
4291 params.password = password;
4293 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4321 const char* username,
4322 const char* password)
4324 _OrthancPluginCallHttpClient params;
4325 memset(¶ms, 0,
sizeof(params));
4327 params.target = target;
4331 params.bodySize = bodySize;
4332 params.username = username;
4333 params.password = password;
4335 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4363 const char* username,
4364 const char* password)
4366 _OrthancPluginCallHttpClient params;
4367 memset(¶ms, 0,
sizeof(params));
4369 params.target = target;
4373 params.bodySize = bodySize;
4374 params.username = username;
4375 params.password = password;
4377 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4398 const char* username,
4399 const char* password)
4401 _OrthancPluginCallHttpClient params;
4402 memset(¶ms, 0,
sizeof(params));
4406 params.username = username;
4407 params.password = password;
4409 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4419 } _OrthancPluginConvertPixelFormat;
4440 _OrthancPluginConvertPixelFormat params;
4441 params.target = ⌖
4442 params.source = source;
4443 params.targetFormat = targetFormat;
4473 _OrthancPluginReturnSingleValue params;
4474 memset(¶ms, 0,
sizeof(params));
4475 params.resultUint32 = &count;
4496 } _OrthancPluginGetFontInfo;
4512 const char* result = NULL;
4514 _OrthancPluginGetFontInfo params;
4515 memset(¶ms, 0,
sizeof(params));
4516 params.name = &result;
4517 params.fontIndex = fontIndex;
4546 _OrthancPluginGetFontInfo params;
4547 memset(¶ms, 0,
sizeof(params));
4548 params.size = &result;
4549 params.fontIndex = fontIndex;
4567 const char* utf8Text;
4573 } _OrthancPluginDrawText;
4597 const char* utf8Text,
4604 _OrthancPluginDrawText params;
4605 memset(¶ms, 0,
sizeof(params));
4606 params.image = image;
4607 params.fontIndex = fontIndex;
4608 params.utf8Text = utf8Text;
4615 return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms);
4624 const void* content;
4627 } _OrthancPluginStorageAreaCreate;
4651 const void* content,
4655 _OrthancPluginStorageAreaCreate params;
4656 params.storageArea = storageArea;
4658 params.content = content;
4662 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms);
4672 } _OrthancPluginStorageAreaRead;
4698 _OrthancPluginStorageAreaRead params;
4699 params.target = target;
4700 params.storageArea = storageArea;
4704 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms);
4713 } _OrthancPluginStorageAreaRemove;
4736 _OrthancPluginStorageAreaRemove params;
4737 params.storageArea = storageArea;
4741 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms);
4750 uint16_t httpStatus;
4751 const char* message;
4752 } _OrthancPluginRegisterErrorCode;
4772 uint16_t httpStatus,
4773 const char* message)
4777 _OrthancPluginRegisterErrorCode params;
4778 params.target = ⌖
4780 params.httpStatus = httpStatus;
4781 params.message = message;
4802 uint32_t minMultiplicity;
4803 uint32_t maxMultiplicity;
4804 } _OrthancPluginRegisterDictionaryTag;
4831 uint32_t minMultiplicity,
4832 uint32_t maxMultiplicity)
4834 _OrthancPluginRegisterDictionaryTag params;
4835 params.group = group;
4836 params.element = element;
4839 params.minMultiplicity = minMultiplicity;
4840 params.maxMultiplicity = maxMultiplicity;
4842 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, ¶ms);
4853 uint32_t minMultiplicity;
4854 uint32_t maxMultiplicity;
4855 const char* privateCreator;
4856 } _OrthancPluginRegisterPrivateDictionaryTag;
4884 uint32_t minMultiplicity,
4885 uint32_t maxMultiplicity,
4886 const char* privateCreator)
4888 _OrthancPluginRegisterPrivateDictionaryTag params;
4889 params.group = group;
4890 params.element = element;
4893 params.minMultiplicity = minMultiplicity;
4894 params.maxMultiplicity = maxMultiplicity;
4895 params.privateCreator = privateCreator;
4897 return context->InvokeService(context, _OrthancPluginService_RegisterPrivateDictionaryTag, ¶ms);
4906 } _OrthancPluginReconstructMainDicomTags;
4927 _OrthancPluginReconstructMainDicomTags params;
4928 params.level = level;
4929 params.storageArea = storageArea;
4931 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, ¶ms);
4938 const char* instanceId;
4943 uint32_t maxStringLength;
4944 } _OrthancPluginDicomToJson;
4972 uint32_t maxStringLength)
4976 _OrthancPluginDicomToJson params;
4977 memset(¶ms, 0,
sizeof(params));
4978 params.result = &result;
4979 params.buffer = buffer;
4981 params.format = format;
4982 params.flags = flags;
4983 params.maxStringLength = maxStringLength;
5017 const char* instanceId,
5020 uint32_t maxStringLength)
5024 _OrthancPluginDicomToJson params;
5025 memset(¶ms, 0,
sizeof(params));
5026 params.result = &result;
5027 params.instanceId = instanceId;
5028 params.format = format;
5029 params.flags = flags;
5030 params.maxStringLength = maxStringLength;
5048 uint32_t headersCount;
5049 const char*
const* headersKeys;
5050 const char*
const* headersValues;
5051 int32_t afterPlugins;
5052 } _OrthancPluginRestApiGet2;
5077 uint32_t headersCount,
5078 const char*
const* headersKeys,
5079 const char*
const* headersValues,
5080 int32_t afterPlugins)
5082 _OrthancPluginRestApiGet2 params;
5083 params.target = target;
5085 params.headersCount = headersCount;
5086 params.headersKeys = headersKeys;
5087 params.headersValues = headersValues;
5088 params.afterPlugins = afterPlugins;
5090 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, ¶ms);
5098 } _OrthancPluginWorklistCallback;
5115 _OrthancPluginWorklistCallback params;
5116 params.callback = callback;
5118 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, ¶ms);
5129 } _OrthancPluginWorklistAnswersOperation;
5154 _OrthancPluginWorklistAnswersOperation params;
5155 params.answers = answers;
5156 params.query = query;
5157 params.dicom = dicom;
5160 return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, ¶ms);
5181 _OrthancPluginWorklistAnswersOperation params;
5182 params.answers = answers;
5183 params.query = NULL;
5184 params.dicom = NULL;
5187 return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, ¶ms);
5198 } _OrthancPluginWorklistQueryOperation;
5221 int32_t isMatch = 0;
5223 _OrthancPluginWorklistQueryOperation params;
5224 params.query = query;
5225 params.dicom = dicom;
5227 params.isMatch = &isMatch;
5228 params.target = NULL;
5259 _OrthancPluginWorklistQueryOperation params;
5260 params.query = query;
5261 params.dicom = NULL;
5263 params.isMatch = NULL;
5264 params.target = target;
5266 return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, ¶ms);
5286 _OrthancPluginAccessDicomInstance params;
5287 memset(¶ms, 0,
sizeof(params));
5288 params.resultOrigin = &origin;
5289 params.instance = instance;
5309 } _OrthancPluginCreateDicom;
5343 _OrthancPluginCreateDicom params;
5344 params.target = target;
5346 params.pixelData = pixelData;
5347 params.flags = flags;
5349 return context->InvokeService(context, _OrthancPluginService_CreateDicom, ¶ms);
5356 } _OrthancPluginDecodeImageCallback;
5376 _OrthancPluginDecodeImageCallback params;
5377 params.callback = callback;
5379 return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, ¶ms);
5392 const void* constBuffer;
5393 uint32_t bufferSize;
5394 uint32_t frameIndex;
5395 } _OrthancPluginCreateImage;
5418 _OrthancPluginCreateImage params;
5419 memset(¶ms, 0,
sizeof(params));
5420 params.target = ⌖
5421 params.format = format;
5422 params.width = width;
5423 params.height = height;
5463 _OrthancPluginCreateImage params;
5464 memset(¶ms, 0,
sizeof(params));
5465 params.target = ⌖
5466 params.format = format;
5467 params.width = width;
5468 params.height = height;
5469 params.pitch = pitch;
5470 params.buffer = buffer;
5502 uint32_t bufferSize,
5503 uint32_t frameIndex)
5507 _OrthancPluginCreateImage params;
5508 memset(¶ms, 0,
sizeof(params));
5509 params.target = ⌖
5510 params.constBuffer = buffer;
5511 params.bufferSize = bufferSize;
5512 params.frameIndex = frameIndex;
5531 } _OrthancPluginComputeHash;
5552 _OrthancPluginComputeHash params;
5553 params.result = &result;
5554 params.buffer = buffer;
5588 _OrthancPluginComputeHash params;
5589 params.result = &result;
5590 params.buffer = buffer;
5610 } _OrthancPluginLookupDictionary;
5632 _OrthancPluginLookupDictionary params;
5633 params.target = target;
5635 return context->InvokeService(context, _OrthancPluginService_LookupDictionary, ¶ms);
5644 uint32_t answerSize;
5645 uint32_t headersCount;
5646 const char*
const* headersKeys;
5647 const char*
const* headersValues;
5648 } _OrthancPluginSendMultipartItem2;
5674 uint32_t answerSize,
5675 uint32_t headersCount,
5676 const char*
const* headersKeys,
5677 const char*
const* headersValues)
5679 _OrthancPluginSendMultipartItem2 params;
5680 params.output = output;
5681 params.answer = answer;
5682 params.answerSize = answerSize;
5683 params.headersCount = headersCount;
5684 params.headersKeys = headersKeys;
5685 params.headersValues = headersValues;
5687 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem2, ¶ms);
5694 } _OrthancPluginIncomingHttpRequestFilter;
5712 _OrthancPluginIncomingHttpRequestFilter params;
5713 params.callback = callback;
5715 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter, ¶ms);
5724 uint16_t* httpStatus;
5727 uint32_t headersCount;
5728 const char*
const* headersKeys;
5729 const char*
const* headersValues;
5732 const char* username;
5733 const char* password;
5735 const char* certificateFile;
5736 const char* certificateKeyFile;
5737 const char* certificateKeyPassword;
5739 } _OrthancPluginCallHttpClient2;
5786 uint16_t* httpStatus,
5789 uint32_t headersCount,
5790 const char*
const* headersKeys,
5791 const char*
const* headersValues,
5794 const char* username,
5795 const char* password,
5797 const char* certificateFile,
5798 const char* certificateKeyFile,
5799 const char* certificateKeyPassword,
5802 _OrthancPluginCallHttpClient2 params;
5803 memset(¶ms, 0,
sizeof(params));
5805 params.answerBody = answerBody;
5806 params.answerHeaders = answerHeaders;
5807 params.httpStatus = httpStatus;
5808 params.method = method;
5810 params.headersCount = headersCount;
5811 params.headersKeys = headersKeys;
5812 params.headersValues = headersValues;
5814 params.bodySize = bodySize;
5815 params.username = username;
5816 params.password = password;
5817 params.timeout = timeout;
5818 params.certificateFile = certificateFile;
5819 params.certificateKeyFile = certificateKeyFile;
5820 params.certificateKeyPassword = certificateKeyPassword;
5821 params.pkcs11 = pkcs11;
5823 return context->InvokeService(context, _OrthancPluginService_CallHttpClient2, ¶ms);
5842 _OrthancPluginRetrieveDynamicString params;
5843 params.result = &result;
5844 params.argument = NULL;
5863 } _OrthancPluginFindCallback;
5880 _OrthancPluginFindCallback params;
5881 params.callback = callback;
5883 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback, ¶ms);
5894 uint32_t *resultUint32;
5895 uint16_t *resultGroup;
5896 uint16_t *resultElement;
5897 char **resultString;
5898 } _OrthancPluginFindOperation;
5921 _OrthancPluginFindOperation params;
5922 memset(¶ms, 0,
sizeof(params));
5923 params.answers = answers;
5924 params.dicom = dicom;
5927 return context->InvokeService(context, _OrthancPluginService_FindAddAnswer, ¶ms);
5948 _OrthancPluginFindOperation params;
5949 memset(¶ms, 0,
sizeof(params));
5950 params.answers = answers;
5952 return context->InvokeService(context, _OrthancPluginService_FindMarkIncomplete, ¶ms);
5974 _OrthancPluginFindOperation params;
5975 memset(¶ms, 0,
sizeof(params));
5976 params.query = query;
5977 params.resultUint32 = &count;
6012 _OrthancPluginFindOperation params;
6013 memset(¶ms, 0,
sizeof(params));
6014 params.query = query;
6015 params.index = index;
6016 params.resultGroup = group;
6017 params.resultElement = element;
6019 return context->InvokeService(context, _OrthancPluginService_GetFindQueryTag, ¶ms);
6043 _OrthancPluginFindOperation params;
6044 memset(¶ms, 0,
sizeof(params));
6045 params.query = query;
6046 params.index = index;
6047 params.resultString = &result;
6081 _OrthancPluginFindOperation params;
6082 memset(¶ms, 0,
sizeof(params));
6083 params.query = query;
6084 params.index = index;
6085 params.resultString = &result;
6107 } _OrthancPluginMoveCallback;
6129 _OrthancPluginMoveCallback params;
6130 params.callback = callback;
6131 params.getMoveSize = getMoveSize;
6132 params.applyMove = applyMove;
6133 params.freeMove = freeMove;
6135 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback, ¶ms);
6145 } _OrthancPluginCreateFindMatcher;
6168 _OrthancPluginCreateFindMatcher params;
6169 memset(¶ms, 0,
sizeof(params));
6170 params.target = ⌖
6171 params.query = query;
6188 } _OrthancPluginFreeFindMatcher;
6203 _OrthancPluginFreeFindMatcher params;
6204 params.matcher = matcher;
6206 context->InvokeService(context, _OrthancPluginService_FreeFindMatcher, ¶ms);
6216 } _OrthancPluginFindMatcherIsMatch;
6238 int32_t isMatch = 0;
6240 _OrthancPluginFindMatcherIsMatch params;
6241 params.matcher = matcher;
6242 params.dicom = dicom;
6244 params.isMatch = &isMatch;
6261 } _OrthancPluginIncomingHttpRequestFilter2;
6278 _OrthancPluginIncomingHttpRequestFilter2 params;
6279 params.callback = callback;
6281 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter2, ¶ms);
6289 } _OrthancPluginGetPeers;
6307 _OrthancPluginGetPeers params;
6308 memset(¶ms, 0,
sizeof(params));
6309 params.peers = &peers;
6325 } _OrthancPluginFreePeers;
6340 _OrthancPluginFreePeers params;
6341 params.peers = peers;
6343 context->InvokeService(context, _OrthancPluginService_FreePeers, ¶ms);
6351 } _OrthancPluginGetPeersCount;
6370 uint32_t target = 0;
6372 _OrthancPluginGetPeersCount params;
6373 memset(¶ms, 0,
sizeof(params));
6374 params.target = ⌖
6375 params.peers = peers;
6391 const char** target;
6394 const char* userProperty;
6395 } _OrthancPluginGetPeerProperty;
6419 const char* target = NULL;
6421 _OrthancPluginGetPeerProperty params;
6422 memset(¶ms, 0,
sizeof(params));
6423 params.target = ⌖
6424 params.peers = peers;
6425 params.peerIndex = peerIndex;
6426 params.userProperty = NULL;
6460 const char* target = NULL;
6462 _OrthancPluginGetPeerProperty params;
6463 memset(¶ms, 0,
sizeof(params));
6464 params.target = ⌖
6465 params.peers = peers;
6466 params.peerIndex = peerIndex;
6467 params.userProperty = NULL;
6505 const char* userProperty)
6507 const char* target = NULL;
6509 _OrthancPluginGetPeerProperty params;
6510 memset(¶ms, 0,
sizeof(params));
6511 params.target = ⌖
6512 params.peers = peers;
6513 params.peerIndex = peerIndex;
6514 params.userProperty = userProperty;
6533 uint16_t* httpStatus;
6538 uint32_t additionalHeadersCount;
6539 const char*
const* additionalHeadersKeys;
6540 const char*
const* additionalHeadersValues;
6544 } _OrthancPluginCallPeerApi;
6585 uint16_t* httpStatus,
6590 uint32_t additionalHeadersCount,
6591 const char*
const* additionalHeadersKeys,
6592 const char*
const* additionalHeadersValues,
6597 _OrthancPluginCallPeerApi params;
6598 memset(¶ms, 0,
sizeof(params));
6600 params.answerBody = answerBody;
6601 params.answerHeaders = answerHeaders;
6602 params.httpStatus = httpStatus;
6603 params.peers = peers;
6604 params.peerIndex = peerIndex;
6605 params.method = method;
6607 params.additionalHeadersCount = additionalHeadersCount;
6608 params.additionalHeadersKeys = additionalHeadersKeys;
6609 params.additionalHeadersValues = additionalHeadersValues;
6611 params.bodySize = bodySize;
6612 params.timeout = timeout;
6614 return context->InvokeService(context, _OrthancPluginService_CallPeerApi, ¶ms);
6633 } _OrthancPluginCreateJob;
6680 _OrthancPluginCreateJob params;
6681 memset(¶ms, 0,
sizeof(params));
6683 params.target = ⌖
6685 params.finalize = finalize;
6687 params.getProgress = getProgress;
6688 params.getContent = getContent;
6689 params.getSerialized = getSerialized;
6692 params.reset = reset;
6710 } _OrthancPluginFreeJob;
6725 _OrthancPluginFreeJob params;
6728 context->InvokeService(context, _OrthancPluginService_FreeJob, ¶ms);
6738 } _OrthancPluginSubmitJob;
6758 char* resultId = NULL;
6760 _OrthancPluginSubmitJob params;
6761 memset(¶ms, 0,
sizeof(params));
6763 params.resultId = &resultId;
6765 params.priority = priority;
6784 } _OrthancPluginJobsUnserializer;
6802 _OrthancPluginJobsUnserializer params;
6803 params.unserializer = unserializer;
6805 context->InvokeService(context, _OrthancPluginService_RegisterJobsUnserializer, ¶ms);
6813 const char* details;
6815 } _OrthancPluginSetHttpErrorDetails;
6837 const char* details,
6840 _OrthancPluginSetHttpErrorDetails params;
6841 params.output = output;
6842 params.details = details;
6844 context->InvokeService(context, _OrthancPluginService_SetHttpErrorDetails, ¶ms);
6851 const char** result;
6852 const char* argument;
6853 } _OrthancPluginRetrieveStaticString;
6870 const char* result = NULL;
6872 _OrthancPluginRetrieveStaticString params;
6873 params.result = &result;
6874 params.argument = path;
6894 } _OrthancPluginSetMetricsValue;
6916 _OrthancPluginSetMetricsValue params;
6918 params.value = value;
6920 context->InvokeService(context, _OrthancPluginService_SetMetricsValue, ¶ms);
6928 } _OrthancPluginRegisterRefreshMetricsCallback;
6944 _OrthancPluginRegisterRefreshMetricsCallback params;
6945 params.callback = callback;
6946 context->InvokeService(context, _OrthancPluginService_RegisterRefreshMetricsCallback, ¶ms);
6958 } _OrthancPluginEncodeDicomWeb;
6982 char* target = NULL;
6984 _OrthancPluginEncodeDicomWeb params;
6985 params.target = ⌖
6986 params.dicom = dicom;
6987 params.dicomSize = dicomSize;
6988 params.callback = callback;
7024 char* target = NULL;
7026 _OrthancPluginEncodeDicomWeb params;
7027 params.target = ⌖
7028 params.dicom = dicom;
7029 params.dicomSize = dicomSize;
7030 params.callback = callback;
7052 } _OrthancPluginEncodeDicomWeb2;
7077 char* target = NULL;
7079 _OrthancPluginEncodeDicomWeb2 params;
7080 params.target = ⌖
7081 params.dicom = dicom;
7082 params.dicomSize = dicomSize;
7083 params.callback = callback;
7084 params.payload = payload;
7121 char* target = NULL;
7123 _OrthancPluginEncodeDicomWeb2 params;
7124 params.target = ⌖
7125 params.dicom = dicom;
7126 params.dicomSize = dicomSize;
7127 params.callback = callback;
7128 params.payload = payload;
7232 typedef const void* (*OrthancPluginChunkedClientRequestGetChunkData) (
void* request);
7256 uint16_t* httpStatus;
7259 uint32_t headersCount;
7260 const char*
const* headersKeys;
7261 const char*
const* headersValues;
7267 const char* username;
7268 const char* password;
7270 const char* certificateFile;
7271 const char* certificateKeyFile;
7272 const char* certificateKeyPassword;
7274 } _OrthancPluginChunkedHttpClient;
7332 uint16_t* httpStatus,
7335 uint32_t headersCount,
7336 const char*
const* headersKeys,
7337 const char*
const* headersValues,
7343 const char* username,
7344 const char* password,
7346 const char* certificateFile,
7347 const char* certificateKeyFile,
7348 const char* certificateKeyPassword,
7351 _OrthancPluginChunkedHttpClient params;
7352 memset(¶ms, 0,
sizeof(params));
7355 params.httpStatus = httpStatus;
7356 params.method = method;
7358 params.headersCount = headersCount;
7359 params.headersKeys = headersKeys;
7360 params.headersValues = headersValues;
7361 params.username = username;
7362 params.password = password;
7363 params.timeout = timeout;
7364 params.certificateFile = certificateFile;
7365 params.certificateKeyFile = certificateKeyFile;
7366 params.certificateKeyPassword = certificateKeyPassword;
7367 params.pkcs11 = pkcs11;
7370 params.answer = answer;
7371 params.answerAddChunk = answerAddChunk;
7372 params.answerAddHeader = answerAddHeader;
7373 params.request = request;
7374 params.requestIsDone = requestIsDone;
7375 params.requestChunkData = requestChunkData;
7376 params.requestChunkSize = requestChunkSize;
7377 params.requestNext = requestNext;
7379 return context->InvokeService(context, _OrthancPluginService_ChunkedHttpClient, ¶ms);
7469 const char* pathRegularExpression;
7477 } _OrthancPluginChunkedRestCallback;
7511 const char* pathRegularExpression,
7520 _OrthancPluginChunkedRestCallback params;
7521 params.pathRegularExpression = pathRegularExpression;
7522 params.getHandler = getHandler;
7523 params.postHandler = postHandler;
7524 params.deleteHandler = deleteHandler;
7525 params.putHandler = putHandler;
7526 params.addChunk = addChunk;
7527 params.execute = execute;
7528 params.finalize = finalize;
7530 context->InvokeService(context, _OrthancPluginService_RegisterChunkedRestCallback, ¶ms);
7542 const char* privateCreator;
7543 } _OrthancPluginGetTagName;
7564 const char* privateCreator)
7568 _OrthancPluginGetTagName params;
7569 params.result = &result;
7570 params.group = group;
7571 params.element = element;
7572 params.privateCreator = privateCreator;
7618 const char* transactionUid,
7619 const char*
const* sopClassUids,
7620 const char*
const* sopInstanceUids,
7621 uint32_t countInstances,
7622 const char* remoteAet,
7623 const char* calledAet);
7661 const char* sopClassUid,
7662 const char* sopInstanceUid);
7670 } _OrthancPluginRegisterStorageCommitmentScpCallback;
7691 _OrthancPluginRegisterStorageCommitmentScpCallback params;
7692 params.factory = factory;
7693 params.destructor = destructor;
7694 params.lookup = lookup;
7695 return context->InvokeService(context, _OrthancPluginService_RegisterStorageCommitmentScpCallback, ¶ms);
7722 } _OrthancPluginIncomingDicomInstanceFilter;
7750 _OrthancPluginIncomingDicomInstanceFilter params;
7751 params.callback = callback;
7753 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingDicomInstanceFilter, ¶ms);
7776 _OrthancPluginAccessDicomInstance params;
7777 memset(¶ms, 0,
sizeof(params));
7778 params.resultStringToFree = &result;
7779 params.instance = instance;
7809 int64_t hasPixelData;
7811 _OrthancPluginAccessDicomInstance params;
7812 memset(¶ms, 0,
sizeof(params));
7813 params.resultInt64 = &hasPixelData;
7814 params.instance = instance;
7825 return (hasPixelData != 0);
7839 const char* transferSyntax;
7840 } _OrthancPluginCreateDicomInstance;
7862 _OrthancPluginCreateDicomInstance params;
7863 params.target = ⌖
7864 params.buffer = buffer;
7881 } _OrthancPluginFreeDicomInstance;
7897 _OrthancPluginFreeDicomInstance params;
7898 params.dicom = dicom;
7900 context->InvokeService(context, _OrthancPluginService_FreeDicomInstance, ¶ms);
7906 uint32_t* targetUint32;
7909 char** targetStringToFree;
7911 uint32_t frameIndex;
7914 uint32_t maxStringLength;
7916 void* dicomWebPayload;
7917 } _OrthancPluginAccessDicomInstance2;
7936 _OrthancPluginAccessDicomInstance2 params;
7937 memset(¶ms, 0,
sizeof(params));
7938 params.targetUint32 = &count;
7939 params.instance = instance;
7974 uint32_t frameIndex)
7976 _OrthancPluginAccessDicomInstance2 params;
7977 memset(¶ms, 0,
sizeof(params));
7978 params.targetBuffer = target;
7979 params.instance = instance;
7980 params.frameIndex = frameIndex;
7982 return context->InvokeService(context, _OrthancPluginService_GetInstanceRawFrame, ¶ms);
8001 uint32_t frameIndex)
8005 _OrthancPluginAccessDicomInstance2 params;
8006 memset(¶ms, 0,
sizeof(params));
8007 params.targetImage = ⌖
8008 params.instance = instance;
8009 params.frameIndex = frameIndex;
8041 const char* transferSyntax)
8045 _OrthancPluginCreateDicomInstance params;
8046 params.target = ⌖
8047 params.buffer = buffer;
8049 params.transferSyntax = transferSyntax;
8080 _OrthancPluginAccessDicomInstance2 params;
8081 memset(¶ms, 0,
sizeof(params));
8082 params.targetBuffer = target;
8083 params.instance = instance;
8085 return context->InvokeService(context, _OrthancPluginService_SerializeDicomInstance, ¶ms);
8112 uint32_t maxStringLength)
8114 char* result = NULL;
8116 _OrthancPluginAccessDicomInstance2 params;
8117 memset(¶ms, 0,
sizeof(params));
8118 params.targetStringToFree = &result;
8119 params.instance = instance;
8120 params.format = format;
8121 params.flags = flags;
8122 params.maxStringLength = maxStringLength;
8156 char* target = NULL;
8158 _OrthancPluginAccessDicomInstance2 params;
8159 params.targetStringToFree = ⌖
8160 params.instance = instance;
8161 params.dicomWebCallback = callback;
8162 params.dicomWebPayload = payload;
8196 char* target = NULL;
8198 _OrthancPluginAccessDicomInstance2 params;
8199 params.targetStringToFree = ⌖
8200 params.instance = instance;
8201 params.dicomWebCallback = callback;
8202 params.dicomWebPayload = payload;
8239 const char*
const* allowedSyntaxes,
8240 uint32_t countSyntaxes,
8241 uint8_t allowNewSopInstanceUid);
8247 } _OrthancPluginTranscoderCallback;
8266 _OrthancPluginTranscoderCallback params;
8267 params.callback = callback;
8269 return context->InvokeService(context, _OrthancPluginService_RegisterTranscoderCallback, ¶ms);
8278 } _OrthancPluginCreateMemoryBuffer;
8302 _OrthancPluginCreateMemoryBuffer params;
8303 params.target = target;
8306 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer, ¶ms);
8340 _OrthancPluginRetrieveDynamicString params;
8341 params.result = &result;
8342 params.argument = NULL;
8344 if (context->InvokeService(context, _OrthancPluginService_GenerateRestApiAuthorizationToken,
8362 } _OrthancPluginCreateMemoryBuffer64;
8386 _OrthancPluginCreateMemoryBuffer64 params;
8387 params.target = target;
8390 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer64, ¶ms);
8400 } _OrthancPluginRegisterStorageArea2;
8425 _OrthancPluginRegisterStorageArea2 params;
8426 params.create = create;
8427 params.readWhole = readWhole;
8428 params.readRange = readRange;
8429 params.remove = remove;
8430 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea2, ¶ms);
8437 _OrthancPluginCreateDicom createDicom;
8438 const char* privateCreator;
8439 } _OrthancPluginCreateDicom2;
8471 const char* privateCreator)
8473 _OrthancPluginCreateDicom2 params;
8474 params.createDicom.target = target;
8475 params.createDicom.json = json;
8476 params.createDicom.pixelData = pixelData;
8477 params.createDicom.flags = flags;
8478 params.privateCreator = privateCreator;
8480 return context->InvokeService(context, _OrthancPluginService_CreateDicom2, ¶ms);
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:1809
void OrthancPluginRegisterStorageArea(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove)
Register a custom storage area.
Definition: OrthancCPlugin.h:3146
void OrthancPluginRegisterOnStoredInstanceCallback(OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback)
Register a callback for received instances.
Definition: OrthancCPlugin.h:2111
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:1197
OrthancPluginErrorCode OrthancPluginRegisterDecodeImageCallback(OrthancPluginContext *context, OrthancPluginDecodeImageCallback callback)
Register a callback to handle the decoding of DICOM images.
Definition: OrthancCPlugin.h:5372
OrthancPluginChangeType
Definition: OrthancCPlugin.h:717
OrthancPluginErrorCode(* OrthancPluginStorageReadWhole)(OrthancPluginMemoryBuffer64 *target, const char *uuid, OrthancPluginContentType type)
Callback for reading a whole file from the storage area.
Definition: OrthancCPlugin.h:1263
int OrthancPluginCheckVersion(OrthancPluginContext *context)
Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
Definition: OrthancCPlugin.h:1914
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:1175
void OrthancPluginRegisterRefreshMetricsCallback(OrthancPluginContext *context, OrthancPluginRefreshMetricsCallback callback)
Register a callback to refresh the metrics.
Definition: OrthancCPlugin.h:6940
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:1690
OrthancPluginErrorCode OrthancPluginStorageAreaRemove(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Remove a file from the storage area.
Definition: OrthancCPlugin.h:4730
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:8235
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter2(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter2 callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:6274
OrthancPluginErrorCode(* OrthancPluginStorageRead)(void **content, int64_t *size, const char *uuid, OrthancPluginContentType type)
Callback for reading from the storage area.
Definition: OrthancCPlugin.h:1243
void OrthancPluginRegisterRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback.
Definition: OrthancCPlugin.h:2033
uint32_t OrthancPluginGetExpectedDatabaseVersion(OrthancPluginContext *context)
Get the expected version of the database schema.
Definition: OrthancCPlugin.h:3534
void OrthancPluginRegisterOnChangeCallback(OrthancPluginContext *context, OrthancPluginOnChangeCallback callback)
Register a callback to monitor changes.
Definition: OrthancCPlugin.h:3289
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:8418
OrthancPluginErrorCode(* OrthancPluginRestCallback)(OrthancPluginRestOutput *output, const char *url, const OrthancPluginHttpRequest *request)
Signature of a callback function that answers to a REST request.
Definition: OrthancCPlugin.h:1143
void(* OrthancPluginRefreshMetricsCallback)()
Callback executed to update the metrics of the plugin.
Definition: OrthancCPlugin.h:1662
OrthancPluginErrorCode OrthancPluginRegisterTranscoderCallback(OrthancPluginContext *context, OrthancPluginTranscoderCallback callback)
Register a callback to handle the transcoding of DICOM images.
Definition: OrthancCPlugin.h:8262
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:1154
OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, OrthancPluginResourceType level)
Reconstruct the main DICOM tags.
Definition: OrthancCPlugin.h:4922
OrthancPluginErrorCode(* OrthancPluginStorageRemove)(const char *uuid, OrthancPluginContentType type)
Callback for removing a file from the storage area.
Definition: OrthancCPlugin.h:1304
OrthancPluginErrorCode(* OrthancPluginStorageCreate)(const char *uuid, const void *content, int64_t size, OrthancPluginContentType type)
Callback for writing to the storage area.
Definition: OrthancCPlugin.h:1216
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:1728
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:1164
OrthancPluginJob *(* OrthancPluginJobsUnserializer)(const char *jobType, const char *serialized)
Callback executed to unserialize a custom job.
Definition: OrthancCPlugin.h:1644
void OrthancPluginRegisterJobsUnserializer(OrthancPluginContext *context, OrthancPluginJobsUnserializer unserializer)
Register an unserializer for custom jobs.
Definition: OrthancCPlugin.h:6798
void(* OrthancPluginFree)(void *buffer)
Signature of a function to free dynamic memory.
Definition: OrthancCPlugin.h:1187
void OrthancPluginRegisterRestCallbackNoLock(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback, without locking.
Definition: OrthancCPlugin.h:2073
OrthancPluginErrorCode OrthancPluginStorageAreaRead(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Read a file from the storage area.
Definition: OrthancCPlugin.h:4691
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:1286
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:7509
OrthancPluginErrorCode OrthancPluginRegisterIncomingDicomInstanceFilter(OrthancPluginContext *context, OrthancPluginIncomingDicomInstanceFilter callback)
Register a callback to filter incoming DICOM instances.
Definition: OrthancCPlugin.h:7746
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:5708
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:4647
@ OrthancPluginChangeType_OrthancStopped
Definition: OrthancCPlugin.h:729
@ OrthancPluginChangeType_OrthancStarted
Definition: OrthancCPlugin.h:728
@ OrthancPluginChangeType_Deleted
Definition: OrthancCPlugin.h:719
@ OrthancPluginChangeType_JobFailure
Definition: OrthancCPlugin.h:736
@ OrthancPluginChangeType_NewInstance
Definition: OrthancCPlugin.h:721
@ OrthancPluginChangeType_NewPatient
Definition: OrthancCPlugin.h:722
@ OrthancPluginChangeType_JobSubmitted
Definition: OrthancCPlugin.h:734
@ OrthancPluginChangeType_NewSeries
Definition: OrthancCPlugin.h:723
@ OrthancPluginChangeType_StablePatient
Definition: OrthancCPlugin.h:725
@ OrthancPluginChangeType_UpdatedPeers
Definition: OrthancCPlugin.h:732
@ OrthancPluginChangeType_StableStudy
Definition: OrthancCPlugin.h:727
@ OrthancPluginChangeType_CompletedSeries
Definition: OrthancCPlugin.h:718
@ OrthancPluginChangeType_NewChildInstance
Definition: OrthancCPlugin.h:720
@ OrthancPluginChangeType_UpdatedAttachment
Definition: OrthancCPlugin.h:730
@ OrthancPluginChangeType_UpdatedMetadata
Definition: OrthancCPlugin.h:731
@ OrthancPluginChangeType_StableSeries
Definition: OrthancCPlugin.h:726
@ OrthancPluginChangeType_UpdatedModalities
Definition: OrthancCPlugin.h:733
@ OrthancPluginChangeType_JobSuccess
Definition: OrthancCPlugin.h:735
@ OrthancPluginChangeType_NewStudy
Definition: OrthancCPlugin.h:724
uint32_t OrthancPluginGetFindQuerySize(OrthancPluginContext *context, const OrthancPluginFindQuery *query)
Get the number of tags in a C-Find query.
Definition: OrthancCPlugin.h:5968
struct _OrthancPluginFindQuery_t OrthancPluginFindQuery
Opaque structure to an object that represents a C-Find query.
Definition: OrthancCPlugin.h:1094
OrthancPluginErrorCode(* OrthancPluginApplyMove)(void *moveDriver)
Callback to apply one C-Move suboperation.
Definition: OrthancCPlugin.h:1499
OrthancPluginErrorCode OrthancPluginFindMarkIncomplete(OrthancPluginContext *context, OrthancPluginFindAnswers *answers)
Mark the set of C-Find answers as incomplete.
Definition: OrthancCPlugin.h:5944
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:6036
void(* OrthancPluginStorageCommitmentDestructor)(void *handler)
Callback to free one storage commitment SCP handler.
Definition: OrthancCPlugin.h:7637
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:1323
OrthancPluginErrorCode OrthancPluginRegisterMoveCallback(OrthancPluginContext *context, OrthancPluginMoveCallback callback, OrthancPluginGetMoveSize getMoveSize, OrthancPluginApplyMove applyMove, OrthancPluginFreeMove freeMove)
Register a callback to handle C-Move requests.
Definition: OrthancCPlugin.h:6122
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:7615
OrthancPluginErrorCode OrthancPluginRegisterFindCallback(OrthancPluginContext *context, OrthancPluginFindCallback callback)
Register a callback to handle C-Find requests.
Definition: OrthancCPlugin.h:5876
OrthancPluginErrorCode OrthancPluginWorklistGetDicomQuery(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginWorklistQuery *query)
Retrieve the worklist query as a DICOM file.
Definition: OrthancCPlugin.h:5254
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:7658
int32_t OrthancPluginWorklistIsMatch(OrthancPluginContext *context, const OrthancPluginWorklistQuery *query, const void *dicom, uint32_t size)
Test whether a worklist matches the query.
Definition: OrthancCPlugin.h:5215
OrthancPluginErrorCode OrthancPluginFindAddAnswer(OrthancPluginContext *context, OrthancPluginFindAnswers *answers, const void *dicom, uint32_t size)
Add one answer to some C-Find request.
Definition: OrthancCPlugin.h:5915
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:1459
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:7685
struct _OrthancPluginFindAnswers_t OrthancPluginFindAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1102
struct _OrthancPluginWorklistAnswers_t OrthancPluginWorklistAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1086
OrthancPluginErrorCode(* OrthancPluginFindCallback)(OrthancPluginFindAnswers *answers, const OrthancPluginFindQuery *query, const char *issuerAet, const char *calledAet)
Callback to handle incoming C-Find SCP requests.
Definition: OrthancCPlugin.h:1416
uint32_t(* OrthancPluginGetMoveSize)(void *moveDriver)
Callback to read the size of a C-Move driver.
Definition: OrthancCPlugin.h:1484
OrthancPluginErrorCode OrthancPluginRegisterWorklistCallback(OrthancPluginContext *context, OrthancPluginWorklistCallback callback)
Register a callback to handle modality worklists requests.
Definition: OrthancCPlugin.h:5111
OrthancPluginErrorCode OrthancPluginWorklistMarkIncomplete(OrthancPluginContext *context, OrthancPluginWorklistAnswers *answers)
Mark the set of worklist answers as incomplete.
Definition: OrthancCPlugin.h:5177
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:6074
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:6005
void(* OrthancPluginFreeMove)(void *moveDriver)
Callback to free one C-Move driver.
Definition: OrthancCPlugin.h:1513
struct _OrthancPluginWorklistQuery_t OrthancPluginWorklistQuery
Opaque structure to an object that represents a C-Find query for worklists.
Definition: OrthancCPlugin.h:1078
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:5147
int32_t OrthancPluginHasInstancePixelData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Check whether the DICOM file has pixel data.
Definition: OrthancCPlugin.h:7805
char * OrthancPluginGetInstanceDicomWebXml(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb XML.
Definition: OrthancCPlugin.h:8190
struct _OrthancPluginDicomInstance_t OrthancPluginDicomInstance
Opaque structure that represents a DICOM instance that is managed by the Orthanc core.
Definition: OrthancCPlugin.h:1054
char * OrthancPluginGetInstanceTransferSyntaxUid(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the transfer syntax of a DICOM file.
Definition: OrthancCPlugin.h:7770
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:7970
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:8107
const void * OrthancPluginGetInstanceData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the data of a DICOM file.
Definition: OrthancCPlugin.h:2943
OrthancPluginDicomInstance * OrthancPluginCreateDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size)
Parse a DICOM instance.
Definition: OrthancCPlugin.h:7855
uint32_t OrthancPluginGetInstanceFramesCount(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the number of frames in a DICOM instance.
Definition: OrthancCPlugin.h:7930
OrthancPluginImage * OrthancPluginGetInstanceDecodedFrame(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:7998
OrthancPluginInstanceOrigin OrthancPluginGetInstanceOrigin(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the origin of a DICOM file.
Definition: OrthancCPlugin.h:5280
int64_t OrthancPluginGetInstanceSize(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the size of a DICOM file.
Definition: OrthancCPlugin.h:2910
char * OrthancPluginGetInstanceDicomWebJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb JSON.
Definition: OrthancCPlugin.h:8150
char * OrthancPluginGetInstanceSimplifiedJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file (with simplification).
Definition: OrthancCPlugin.h:3017
char * OrthancPluginGetInstanceJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file.
Definition: OrthancCPlugin.h:2979
int OrthancPluginHasInstanceMetadata(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, const char *metadata)
Check whether a DICOM instance is associated with some metadata.
Definition: OrthancCPlugin.h:3056
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:3097
void OrthancPluginFreeDicomInstance(OrthancPluginContext *context, OrthancPluginDicomInstance *dicom)
Free a DICOM instance.
Definition: OrthancCPlugin.h:7893
OrthancPluginErrorCode OrthancPluginSerializeDicomInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginDicomInstance *instance)
Writes a DICOM instance to a memory buffer.
Definition: OrthancCPlugin.h:8075
OrthancPluginDicomInstance * OrthancPluginTranscodeDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size, const char *transferSyntax)
Parse and transcode a DICOM instance.
Definition: OrthancCPlugin.h:8037
const char * OrthancPluginGetInstanceRemoteAet(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the AET of a DICOM instance.
Definition: OrthancCPlugin.h:2877
OrthancPluginPixelFormat
Definition: OrthancCPlugin.h:594
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:4593
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:4177
uint32_t OrthancPluginGetImagePitch(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pitch of an image.
Definition: OrthancCPlugin.h:3968
OrthancPluginImage * OrthancPluginConvertPixelFormat(OrthancPluginContext *context, const OrthancPluginImage *source, OrthancPluginPixelFormat targetFormat)
Change the pixel format of an image.
Definition: OrthancCPlugin.h:4433
OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pixel format of an image.
Definition: OrthancCPlugin.h:3867
uint32_t OrthancPluginGetFontsCount(OrthancPluginContext *context)
Return the number of available fonts.
Definition: OrthancCPlugin.h:4468
uint32_t OrthancPluginGetImageHeight(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the height of an image.
Definition: OrthancCPlugin.h:3933
void OrthancPluginFreeImage(OrthancPluginContext *context, OrthancPluginImage *image)
Free an image.
Definition: OrthancCPlugin.h:4087
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:4132
OrthancPluginImage * OrthancPluginCreateImage(OrthancPluginContext *context, OrthancPluginPixelFormat format, uint32_t width, uint32_t height)
Create an image.
Definition: OrthancCPlugin.h:5410
OrthancPluginImage * OrthancPluginUncompressImage(OrthancPluginContext *context, const void *data, uint32_t size, OrthancPluginImageFormat format)
Decode a compressed image.
Definition: OrthancCPlugin.h:4045
const char * OrthancPluginGetFontName(OrthancPluginContext *context, uint32_t fontIndex)
Return the name of a font.
Definition: OrthancCPlugin.h:4508
void * OrthancPluginGetImageBuffer(OrthancPluginContext *context, const OrthancPluginImage *image)
Return a pointer to the content of an image.
Definition: OrthancCPlugin.h:4002
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:5453
OrthancPluginImageFormat
Definition: OrthancCPlugin.h:762
struct _OrthancPluginStorageArea_t OrthancPluginStorageArea
Opaque structure that represents the storage area that is actually used by Orthanc.
Definition: OrthancCPlugin.h:1070
OrthancPluginCompressionType
Definition: OrthancCPlugin.h:747
uint32_t OrthancPluginGetImageWidth(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the width of an image.
Definition: OrthancCPlugin.h:3900
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:3679
OrthancPluginImage * OrthancPluginDecodeDicomImage(OrthancPluginContext *context, const void *buffer, uint32_t bufferSize, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:5499
uint32_t OrthancPluginGetFontSize(OrthancPluginContext *context, uint32_t fontIndex)
Return the size of a font.
Definition: OrthancCPlugin.h:4540
struct _OrthancPluginImage_t OrthancPluginImage
Opaque structure that represents an image that is uncompressed in memory.
Definition: OrthancCPlugin.h:1062
@ OrthancPluginPixelFormat_RGBA32
Color image in RGBA32 format.
Definition: OrthancCPlugin.h:633
@ OrthancPluginPixelFormat_RGB48
Color image in RGB48 format.
Definition: OrthancCPlugin.h:643
@ OrthancPluginPixelFormat_Grayscale8
Graylevel 8bpp image.
Definition: OrthancCPlugin.h:601
@ OrthancPluginPixelFormat_SignedGrayscale16
Graylevel, signed 16bpp image.
Definition: OrthancCPlugin.h:617
@ OrthancPluginPixelFormat_Float32
Graylevel, floating-point 32bpp image.
Definition: OrthancCPlugin.h:659
@ OrthancPluginPixelFormat_RGB24
Color image in RGB24 format.
Definition: OrthancCPlugin.h:625
@ OrthancPluginPixelFormat_BGRA32
Color image in BGRA32 format.
Definition: OrthancCPlugin.h:667
@ OrthancPluginPixelFormat_Unknown
Definition: OrthancCPlugin.h:635
@ OrthancPluginPixelFormat_Grayscale64
Graylevel, unsigned 64bpp image.
Definition: OrthancCPlugin.h:675
@ OrthancPluginPixelFormat_Grayscale32
Graylevel, unsigned 32bpp image.
Definition: OrthancCPlugin.h:651
@ OrthancPluginPixelFormat_Grayscale16
Graylevel, unsigned 16bpp image.
Definition: OrthancCPlugin.h:609
@ OrthancPluginImageFormat_Png
Definition: OrthancCPlugin.h:763
@ OrthancPluginImageFormat_Jpeg
Definition: OrthancCPlugin.h:764
@ OrthancPluginImageFormat_Dicom
Definition: OrthancCPlugin.h:765
@ OrthancPluginCompressionType_Gzip
Definition: OrthancCPlugin.h:750
@ OrthancPluginCompressionType_ZlibWithSize
Definition: OrthancCPlugin.h:749
@ OrthancPluginCompressionType_Zlib
Definition: OrthancCPlugin.h:748
@ OrthancPluginCompressionType_GzipWithSize
Definition: OrthancCPlugin.h:751
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:2341
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:2376
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:2489
char * OrthancPluginLookupStudy(OrthancPluginContext *context, const char *studyUID)
Look for a study.
Definition: OrthancCPlugin.h:2590
OrthancPluginErrorCode OrthancPluginSetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *value)
Set the value of a global property.
Definition: OrthancCPlugin.h:3437
char * OrthancPluginGetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *defaultValue)
Get the value of a global property.
Definition: OrthancCPlugin.h:3398
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:2453
char * OrthancPluginLookupSeries(OrthancPluginContext *context, const char *seriesUID)
Look for a series.
Definition: OrthancCPlugin.h:2660
char * OrthancPluginLookupStudyWithAccessionNumber(OrthancPluginContext *context, const char *accessionNumber)
Look for a study, using the accession number.
Definition: OrthancCPlugin.h:2625
char * OrthancPluginGenerateRestApiAuthorizationToken(OrthancPluginContext *context)
Generate a token to grant full access to the REST API of Orthanc.
Definition: OrthancCPlugin.h:8335
OrthancPluginErrorCode OrthancPluginRestApiGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2274
char * OrthancPluginLookupInstance(OrthancPluginContext *context, const char *sopInstanceUID)
Look for an instance.
Definition: OrthancCPlugin.h:2695
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:2304
char * OrthancPluginLookupPatient(OrthancPluginContext *context, const char *patientID)
Look for a patient.
Definition: OrthancCPlugin.h:2555
OrthancPluginErrorCode OrthancPluginRestApiDelete(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2405
OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:2428
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:5073
OrthancPluginErrorCode OrthancPluginGetDicomForInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *instanceId)
Retrieve a DICOM instance using its Orthanc identifier.
Definition: OrthancCPlugin.h:2241
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:2200
void OrthancPluginSendUnauthorized(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *realm)
Signal that a REST request is not authorized.
Definition: OrthancCPlugin.h:2763
void OrthancPluginSetHttpErrorDetails(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *details, uint8_t log)
Provide a detailed description for an HTTP error.
Definition: OrthancCPlugin.h:6834
void OrthancPluginSendMethodNotAllowed(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *allowedMethods)
Signal that this URI does not support this HTTP method.
Definition: OrthancCPlugin.h:2786
void OrthancPluginAnswerBuffer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const void *answer, uint32_t answerSize, const char *mimeType)
Answer to a REST request.
Definition: OrthancCPlugin.h:2143
void OrthancPluginSendHttpStatusCode(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status)
Send a HTTP status code.
Definition: OrthancCPlugin.h:2740
void OrthancPluginSetHttpHeader(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *key, const char *value)
Set some HTTP header.
Definition: OrthancCPlugin.h:2841
void OrthancPluginSetCookie(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *cookie, const char *value)
Set a cookie.
Definition: OrthancCPlugin.h:2816
void OrthancPluginRedirect(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *redirection)
Redirect a REST request.
Definition: OrthancCPlugin.h:2523
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:4224
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:3637
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:5670
OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *subType, const char *contentType)
Start an HTTP multipart answer.
Definition: OrthancCPlugin.h:3608
void OrthancPluginSendHttpStatus(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status, const char *body, uint32_t bodySize)
Send a HTTP status, with a custom body.
Definition: OrthancCPlugin.h:3831
An entry in the dictionary of DICOM tags.
Definition: OrthancCPlugin.h:1761
uint32_t minMultiplicity
Definition: OrthancCPlugin.h:1765
uint32_t maxMultiplicity
Definition: OrthancCPlugin.h:1766
OrthancPluginValueRepresentation vr
Definition: OrthancCPlugin.h:1764
uint16_t element
Definition: OrthancCPlugin.h:1763
uint16_t group
Definition: OrthancCPlugin.h:1762
The parameters of a REST request.
Definition: OrthancCPlugin.h:335
const char *const * getValues
For a GET request, the values of the GET parameters.
Definition: OrthancCPlugin.h:364
const char *const * groups
The matched values for the groups of the regular expression.
Definition: OrthancCPlugin.h:349
uint32_t bodySize
For a PUT or POST request, the number of bytes of the body.
Definition: OrthancCPlugin.h:374
uint32_t groupsCount
The number of groups of the regular expression.
Definition: OrthancCPlugin.h:344
const char *const * headersKeys
The keys of the HTTP headers (always converted to low-case).
Definition: OrthancCPlugin.h:389
const void * body
For a PUT or POST request, the content of the body.
Definition: OrthancCPlugin.h:369
const char *const * getKeys
For a GET request, the keys of the GET parameters.
Definition: OrthancCPlugin.h:359
uint32_t headersCount
The number of HTTP headers.
Definition: OrthancCPlugin.h:384
OrthancPluginHttpMethod method
The HTTP method.
Definition: OrthancCPlugin.h:339
uint32_t getCount
For a GET request, the number of GET parameters.
Definition: OrthancCPlugin.h:354
const char *const * headersValues
The values of the HTTP headers.
Definition: OrthancCPlugin.h:394
A 64-bit memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:1027
uint64_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:1036
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:1031
A 32-bit memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:1005
uint32_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:1014
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:1009