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,
841 _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff
852 OrthancPluginCreateDicomFlags_None = 0,
856 _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff
872 _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff
888 _OrthancPluginConstraintType_INTERNAL = 0x7fffffff
904 _OrthancPluginInstanceOrigin_INTERNAL = 0x7fffffff
1158 const char* instanceId);
1169 const char* resourceId);
1180 const uint32_t size,
1181 uint32_t frameIndex);
1202 const char* bulkDataUri);
1220 const void* content,
1292 uint64_t rangeStart);
1328 const char* issuerAet,
1329 const char* calledAet);
1360 uint32_t headersCount,
1361 const char*
const* headersKeys,
1362 const char*
const* headersValues);
1395 uint32_t headersCount,
1396 const char*
const* headersKeys,
1397 const char*
const* headersValues,
1398 uint32_t getArgumentsCount,
1399 const char*
const* getArgumentsKeys,
1400 const char*
const* getArgumentsValues);
1421 const char* issuerAet,
1422 const char* calledAet);
1461 typedef void* (*OrthancPluginMoveCallback) (
1463 const char* patientId,
1464 const char* accessionNumber,
1465 const char* studyInstanceUid,
1466 const char* seriesInstanceUid,
1467 const char* sopInstanceUid,
1468 const char* originatorAet,
1469 const char* sourceAet,
1470 const char* targetAet,
1471 uint16_t originatorId);
1556 typedef const char* (*OrthancPluginJobGetContent) (
void* job);
1574 typedef const char* (*OrthancPluginJobGetSerialized) (
void* job);
1647 const char* serialized);
1695 uint32_t levelDepth,
1696 const uint16_t* levelTagGroup,
1697 const uint16_t* levelTagElement,
1698 const uint32_t* levelIndex,
1700 uint16_t tagElement,
1733 uint32_t levelDepth,
1734 const uint16_t* levelTagGroup,
1735 const uint16_t* levelTagElement,
1736 const uint32_t* levelIndex,
1738 uint16_t tagElement,
1747 typedef struct _OrthancPluginContext_t
1749 void* pluginsManager;
1750 const char* orthancVersion;
1753 _OrthancPluginService service,
1754 const void* params);
1815 int expectedRevision)
1817 int major, minor, revision;
1821 sizeof(int32_t) !=
sizeof(_OrthancPluginService) ||
1822 sizeof(int32_t) !=
sizeof(_OrthancPluginProperty) ||
1846 if (!strcmp(context->orthancVersion,
"mainline"))
1858 (context->orthancVersion,
"%4d.%4d.%4d", &major, &minor, &revision) != 3)
1865 if (major > expectedMajor)
1870 if (major < expectedMajor)
1877 if (minor > expectedMinor)
1882 if (minor < expectedMinor)
1889 if (revision >= expectedRevision)
1921 ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER,
1922 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER,
1923 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER);
1939 context->Free(buffer->
data);
1955 context->Free(buffer->
data);
1969 const char* message)
1971 context->InvokeService(context, _OrthancPluginService_LogError, message);
1985 const char* message)
1987 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
2001 const char* message)
2003 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
2010 const char* pathRegularExpression;
2012 } _OrthancPluginRestCallback;
2037 const char* pathRegularExpression,
2040 _OrthancPluginRestCallback params;
2041 params.pathRegularExpression = pathRegularExpression;
2042 params.callback = callback;
2043 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
2077 const char* pathRegularExpression,
2080 _OrthancPluginRestCallback params;
2081 params.pathRegularExpression = pathRegularExpression;
2082 params.callback = callback;
2083 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms);
2091 } _OrthancPluginOnStoredInstanceCallback;
2117 _OrthancPluginOnStoredInstanceCallback params;
2118 params.callback = callback;
2120 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
2129 uint32_t answerSize;
2130 const char* mimeType;
2131 } _OrthancPluginAnswerBuffer;
2149 uint32_t answerSize,
2150 const char* mimeType)
2152 _OrthancPluginAnswerBuffer params;
2153 params.output = output;
2154 params.answer = answer;
2155 params.answerSize = answerSize;
2156 params.mimeType = mimeType;
2157 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms);
2169 } _OrthancPluginCompressAndAnswerPngImage;
2181 } _OrthancPluginCompressAndAnswerImage;
2211 _OrthancPluginCompressAndAnswerImage params;
2212 params.output = output;
2214 params.pixelFormat = format;
2215 params.width = width;
2216 params.height = height;
2217 params.pitch = pitch;
2218 params.buffer = buffer;
2220 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
2228 const char* instanceId;
2229 } _OrthancPluginGetDicomForInstance;
2246 const char* instanceId)
2248 _OrthancPluginGetDicomForInstance params;
2249 params.target = target;
2250 params.instanceId = instanceId;
2251 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
2260 } _OrthancPluginRestApiGet;
2281 _OrthancPluginRestApiGet params;
2282 params.target = target;
2284 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
2311 _OrthancPluginRestApiGet params;
2312 params.target = target;
2314 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms);
2325 } _OrthancPluginRestApiPostPut;
2350 _OrthancPluginRestApiPostPut params;
2351 params.target = target;
2354 params.bodySize = bodySize;
2355 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
2385 _OrthancPluginRestApiPostPut params;
2386 params.target = target;
2389 params.bodySize = bodySize;
2390 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms);
2411 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
2434 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
2462 _OrthancPluginRestApiPostPut params;
2463 params.target = target;
2466 params.bodySize = bodySize;
2467 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
2498 _OrthancPluginRestApiPostPut params;
2499 params.target = target;
2502 params.bodySize = bodySize;
2503 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms);
2511 const char* argument;
2512 } _OrthancPluginOutputPlusArgument;
2528 const char* redirection)
2530 _OrthancPluginOutputPlusArgument params;
2531 params.output = output;
2532 params.argument = redirection;
2533 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
2541 const char* argument;
2542 } _OrthancPluginRetrieveDynamicString;
2559 const char* patientID)
2563 _OrthancPluginRetrieveDynamicString params;
2564 params.result = &result;
2565 params.argument = patientID;
2594 const char* studyUID)
2598 _OrthancPluginRetrieveDynamicString params;
2599 params.result = &result;
2600 params.argument = studyUID;
2629 const char* accessionNumber)
2633 _OrthancPluginRetrieveDynamicString params;
2634 params.result = &result;
2635 params.argument = accessionNumber;
2664 const char* seriesUID)
2668 _OrthancPluginRetrieveDynamicString params;
2669 params.result = &result;
2670 params.argument = seriesUID;
2699 const char* sopInstanceUID)
2703 _OrthancPluginRetrieveDynamicString params;
2704 params.result = &result;
2705 params.argument = sopInstanceUID;
2724 } _OrthancPluginSendHttpStatusCode;
2747 _OrthancPluginSendHttpStatusCode params;
2748 params.output = output;
2749 params.status = status;
2750 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
2770 _OrthancPluginOutputPlusArgument params;
2771 params.output = output;
2772 params.argument = realm;
2773 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
2791 const char* allowedMethods)
2793 _OrthancPluginOutputPlusArgument params;
2794 params.output = output;
2795 params.argument = allowedMethods;
2796 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
2805 } _OrthancPluginSetHttpHeader;
2824 _OrthancPluginSetHttpHeader params;
2825 params.output = output;
2826 params.key = cookie;
2827 params.value = value;
2828 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
2849 _OrthancPluginSetHttpHeader params;
2850 params.output = output;
2852 params.value = value;
2853 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
2859 char** resultStringToFree;
2860 const char** resultString;
2861 int64_t* resultInt64;
2865 } _OrthancPluginAccessDicomInstance;
2885 _OrthancPluginAccessDicomInstance params;
2886 memset(¶ms, 0,
sizeof(params));
2887 params.resultString = &result;
2888 params.instance = instance;
2918 _OrthancPluginAccessDicomInstance params;
2919 memset(¶ms, 0,
sizeof(params));
2920 params.resultInt64 = &size;
2921 params.instance = instance;
2951 _OrthancPluginAccessDicomInstance params;
2952 memset(¶ms, 0,
sizeof(params));
2953 params.resultString = &result;
2954 params.instance = instance;
2987 _OrthancPluginAccessDicomInstance params;
2988 memset(¶ms, 0,
sizeof(params));
2989 params.resultStringToFree = &result;
2990 params.instance = instance;
3025 _OrthancPluginAccessDicomInstance params;
3026 memset(¶ms, 0,
sizeof(params));
3027 params.resultStringToFree = &result;
3028 params.instance = instance;
3061 const char* metadata)
3065 _OrthancPluginAccessDicomInstance params;
3066 memset(¶ms, 0,
sizeof(params));
3067 params.resultInt64 = &result;
3068 params.instance = instance;
3069 params.key = metadata;
3078 return (result != 0);
3102 const char* metadata)
3106 _OrthancPluginAccessDicomInstance params;
3107 memset(¶ms, 0,
sizeof(params));
3108 params.resultString = &result;
3109 params.instance = instance;
3110 params.key = metadata;
3131 } _OrthancPluginRegisterStorageArea;
3154 _OrthancPluginRegisterStorageArea params;
3155 params.create = create;
3157 params.remove = remove;
3160 params.free = ::free;
3165 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
3184 _OrthancPluginRetrieveDynamicString params;
3185 params.result = &result;
3186 params.argument = NULL;
3214 _OrthancPluginRetrieveDynamicString params;
3215 params.result = &result;
3216 params.argument = NULL;
3249 _OrthancPluginRetrieveDynamicString params;
3250 params.result = &result;
3251 params.argument = NULL;
3269 } _OrthancPluginOnChangeCallback;
3295 _OrthancPluginOnChangeCallback params;
3296 params.callback = callback;
3298 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms);
3306 _OrthancPluginProperty property;
3308 } _OrthancPluginSetPluginProperty;
3326 _OrthancPluginSetPluginProperty params;
3327 params.plugin = OrthancPluginGetName();
3328 params.property = _OrthancPluginProperty_RootUri;
3331 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3346 const char* description)
3348 _OrthancPluginSetPluginProperty params;
3349 params.plugin = OrthancPluginGetName();
3350 params.property = _OrthancPluginProperty_Description;
3351 params.value = description;
3353 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3368 const char* javascript)
3370 _OrthancPluginSetPluginProperty params;
3371 params.plugin = OrthancPluginGetName();
3372 params.property = _OrthancPluginProperty_OrthancExplorer;
3373 params.value = javascript;
3375 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3384 } _OrthancPluginGlobalProperty;
3403 const char* defaultValue)
3407 _OrthancPluginGlobalProperty params;
3408 params.result = &result;
3409 params.property = property;
3410 params.value = defaultValue;
3444 _OrthancPluginGlobalProperty params;
3445 params.result = NULL;
3446 params.property = property;
3447 params.value = value;
3449 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms);
3456 int32_t *resultInt32;
3457 uint32_t *resultUint32;
3458 int64_t *resultInt64;
3459 uint64_t *resultUint64;
3460 } _OrthancPluginReturnSingleValue;
3475 _OrthancPluginReturnSingleValue params;
3476 memset(¶ms, 0,
sizeof(params));
3477 params.resultUint32 = &count;
3510 _OrthancPluginGlobalProperty params;
3511 params.result = &result;
3512 params.property = (int32_t) argument;
3513 params.value = NULL;
3541 _OrthancPluginReturnSingleValue params;
3542 memset(¶ms, 0,
sizeof(params));
3543 params.resultUint32 = &count;
3573 _OrthancPluginRetrieveDynamicString params;
3574 params.result = &result;
3575 params.argument = NULL;
3593 const char* subType;
3594 const char* contentType;
3595 } _OrthancPluginStartMultipartAnswer;
3613 const char* subType,
3614 const char* contentType)
3616 _OrthancPluginStartMultipartAnswer params;
3617 params.output = output;
3618 params.subType = subType;
3619 params.contentType = contentType;
3620 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms);
3643 uint32_t answerSize)
3645 _OrthancPluginAnswerBuffer params;
3646 params.output = output;
3647 params.answer = answer;
3648 params.answerSize = answerSize;
3649 params.mimeType = NULL;
3650 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms);
3662 } _OrthancPluginBufferCompression;
3689 _OrthancPluginBufferCompression params;
3690 params.target = target;
3691 params.source = source;
3693 params.compression = compression;
3694 params.uncompress = uncompress;
3696 return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms);
3705 } _OrthancPluginReadFile;
3723 _OrthancPluginReadFile params;
3724 params.target = target;
3726 return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms);
3736 } _OrthancPluginWriteFile;
3755 _OrthancPluginWriteFile params;
3759 return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms);
3766 const char** target;
3768 } _OrthancPluginGetErrorDescription;
3784 const char* result = NULL;
3786 _OrthancPluginGetErrorDescription params;
3787 params.target = &result;
3788 params.error = error;
3793 return "Unknown error code";
3809 } _OrthancPluginSendHttpStatus;
3840 _OrthancPluginSendHttpStatus params;
3841 params.output = output;
3842 params.status = status;
3844 params.bodySize = bodySize;
3845 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms);
3853 uint32_t* resultUint32;
3855 void** resultBuffer;
3856 } _OrthancPluginGetImageInfo;
3875 _OrthancPluginGetImageInfo params;
3876 memset(¶ms, 0,
sizeof(params));
3877 params.image = image;
3878 params.resultPixelFormat = ⌖
3908 _OrthancPluginGetImageInfo params;
3909 memset(¶ms, 0,
sizeof(params));
3910 params.image = image;
3911 params.resultUint32 = &width;
3941 _OrthancPluginGetImageInfo params;
3942 memset(¶ms, 0,
sizeof(params));
3943 params.image = image;
3944 params.resultUint32 = &height;
3976 _OrthancPluginGetImageInfo params;
3977 memset(¶ms, 0,
sizeof(params));
3978 params.image = image;
3979 params.resultUint32 = &pitch;
4008 void* target = NULL;
4010 _OrthancPluginGetImageInfo params;
4011 memset(¶ms, 0,
sizeof(params));
4012 params.resultBuffer = ⌖
4013 params.image = image;
4032 } _OrthancPluginUncompressImage;
4055 _OrthancPluginUncompressImage params;
4056 memset(¶ms, 0,
sizeof(params));
4057 params.target = ⌖
4060 params.format = format;
4078 } _OrthancPluginFreeImage;
4093 _OrthancPluginFreeImage params;
4094 params.image = image;
4096 context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms);
4112 } _OrthancPluginCompressImage;
4143 _OrthancPluginCompressImage params;
4144 memset(¶ms, 0,
sizeof(params));
4145 params.target = target;
4147 params.pixelFormat = format;
4148 params.width = width;
4149 params.height = height;
4150 params.pitch = pitch;
4151 params.buffer = buffer;
4154 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4189 _OrthancPluginCompressImage params;
4190 memset(¶ms, 0,
sizeof(params));
4191 params.target = target;
4193 params.pixelFormat = format;
4194 params.width = width;
4195 params.height = height;
4196 params.pitch = pitch;
4197 params.buffer = buffer;
4198 params.quality = quality;
4200 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4236 _OrthancPluginCompressAndAnswerImage params;
4237 params.output = output;
4239 params.pixelFormat = format;
4240 params.width = width;
4241 params.height = height;
4242 params.pitch = pitch;
4243 params.buffer = buffer;
4244 params.quality = quality;
4245 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
4256 const char* username;
4257 const char* password;
4260 } _OrthancPluginCallHttpClient;
4283 const char* username,
4284 const char* password)
4286 _OrthancPluginCallHttpClient params;
4287 memset(¶ms, 0,
sizeof(params));
4289 params.target = target;
4292 params.username = username;
4293 params.password = password;
4295 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4323 const char* username,
4324 const char* password)
4326 _OrthancPluginCallHttpClient params;
4327 memset(¶ms, 0,
sizeof(params));
4329 params.target = target;
4333 params.bodySize = bodySize;
4334 params.username = username;
4335 params.password = password;
4337 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4365 const char* username,
4366 const char* password)
4368 _OrthancPluginCallHttpClient params;
4369 memset(¶ms, 0,
sizeof(params));
4371 params.target = target;
4375 params.bodySize = bodySize;
4376 params.username = username;
4377 params.password = password;
4379 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4400 const char* username,
4401 const char* password)
4403 _OrthancPluginCallHttpClient params;
4404 memset(¶ms, 0,
sizeof(params));
4408 params.username = username;
4409 params.password = password;
4411 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4421 } _OrthancPluginConvertPixelFormat;
4442 _OrthancPluginConvertPixelFormat params;
4443 params.target = ⌖
4444 params.source = source;
4445 params.targetFormat = targetFormat;
4475 _OrthancPluginReturnSingleValue params;
4476 memset(¶ms, 0,
sizeof(params));
4477 params.resultUint32 = &count;
4498 } _OrthancPluginGetFontInfo;
4514 const char* result = NULL;
4516 _OrthancPluginGetFontInfo params;
4517 memset(¶ms, 0,
sizeof(params));
4518 params.name = &result;
4519 params.fontIndex = fontIndex;
4548 _OrthancPluginGetFontInfo params;
4549 memset(¶ms, 0,
sizeof(params));
4550 params.size = &result;
4551 params.fontIndex = fontIndex;
4569 const char* utf8Text;
4575 } _OrthancPluginDrawText;
4599 const char* utf8Text,
4606 _OrthancPluginDrawText params;
4607 memset(¶ms, 0,
sizeof(params));
4608 params.image = image;
4609 params.fontIndex = fontIndex;
4610 params.utf8Text = utf8Text;
4617 return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms);
4626 const void* content;
4629 } _OrthancPluginStorageAreaCreate;
4653 const void* content,
4657 _OrthancPluginStorageAreaCreate params;
4658 params.storageArea = storageArea;
4660 params.content = content;
4664 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms);
4674 } _OrthancPluginStorageAreaRead;
4700 _OrthancPluginStorageAreaRead params;
4701 params.target = target;
4702 params.storageArea = storageArea;
4706 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms);
4715 } _OrthancPluginStorageAreaRemove;
4738 _OrthancPluginStorageAreaRemove params;
4739 params.storageArea = storageArea;
4743 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms);
4752 uint16_t httpStatus;
4753 const char* message;
4754 } _OrthancPluginRegisterErrorCode;
4774 uint16_t httpStatus,
4775 const char* message)
4779 _OrthancPluginRegisterErrorCode params;
4780 params.target = ⌖
4782 params.httpStatus = httpStatus;
4783 params.message = message;
4804 uint32_t minMultiplicity;
4805 uint32_t maxMultiplicity;
4806 } _OrthancPluginRegisterDictionaryTag;
4833 uint32_t minMultiplicity,
4834 uint32_t maxMultiplicity)
4836 _OrthancPluginRegisterDictionaryTag params;
4837 params.group = group;
4838 params.element = element;
4841 params.minMultiplicity = minMultiplicity;
4842 params.maxMultiplicity = maxMultiplicity;
4844 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, ¶ms);
4855 uint32_t minMultiplicity;
4856 uint32_t maxMultiplicity;
4857 const char* privateCreator;
4858 } _OrthancPluginRegisterPrivateDictionaryTag;
4886 uint32_t minMultiplicity,
4887 uint32_t maxMultiplicity,
4888 const char* privateCreator)
4890 _OrthancPluginRegisterPrivateDictionaryTag params;
4891 params.group = group;
4892 params.element = element;
4895 params.minMultiplicity = minMultiplicity;
4896 params.maxMultiplicity = maxMultiplicity;
4897 params.privateCreator = privateCreator;
4899 return context->InvokeService(context, _OrthancPluginService_RegisterPrivateDictionaryTag, ¶ms);
4908 } _OrthancPluginReconstructMainDicomTags;
4929 _OrthancPluginReconstructMainDicomTags params;
4930 params.level = level;
4931 params.storageArea = storageArea;
4933 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, ¶ms);
4940 const char* instanceId;
4945 uint32_t maxStringLength;
4946 } _OrthancPluginDicomToJson;
4974 uint32_t maxStringLength)
4978 _OrthancPluginDicomToJson params;
4979 memset(¶ms, 0,
sizeof(params));
4980 params.result = &result;
4981 params.buffer = buffer;
4983 params.format = format;
4984 params.flags = flags;
4985 params.maxStringLength = maxStringLength;
5019 const char* instanceId,
5022 uint32_t maxStringLength)
5026 _OrthancPluginDicomToJson params;
5027 memset(¶ms, 0,
sizeof(params));
5028 params.result = &result;
5029 params.instanceId = instanceId;
5030 params.format = format;
5031 params.flags = flags;
5032 params.maxStringLength = maxStringLength;
5050 uint32_t headersCount;
5051 const char*
const* headersKeys;
5052 const char*
const* headersValues;
5053 int32_t afterPlugins;
5054 } _OrthancPluginRestApiGet2;
5079 uint32_t headersCount,
5080 const char*
const* headersKeys,
5081 const char*
const* headersValues,
5082 int32_t afterPlugins)
5084 _OrthancPluginRestApiGet2 params;
5085 params.target = target;
5087 params.headersCount = headersCount;
5088 params.headersKeys = headersKeys;
5089 params.headersValues = headersValues;
5090 params.afterPlugins = afterPlugins;
5092 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, ¶ms);
5100 } _OrthancPluginWorklistCallback;
5117 _OrthancPluginWorklistCallback params;
5118 params.callback = callback;
5120 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, ¶ms);
5131 } _OrthancPluginWorklistAnswersOperation;
5156 _OrthancPluginWorklistAnswersOperation params;
5157 params.answers = answers;
5158 params.query = query;
5159 params.dicom = dicom;
5162 return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, ¶ms);
5183 _OrthancPluginWorklistAnswersOperation params;
5184 params.answers = answers;
5185 params.query = NULL;
5186 params.dicom = NULL;
5189 return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, ¶ms);
5200 } _OrthancPluginWorklistQueryOperation;
5223 int32_t isMatch = 0;
5225 _OrthancPluginWorklistQueryOperation params;
5226 params.query = query;
5227 params.dicom = dicom;
5229 params.isMatch = &isMatch;
5230 params.target = NULL;
5261 _OrthancPluginWorklistQueryOperation params;
5262 params.query = query;
5263 params.dicom = NULL;
5265 params.isMatch = NULL;
5266 params.target = target;
5268 return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, ¶ms);
5288 _OrthancPluginAccessDicomInstance params;
5289 memset(¶ms, 0,
sizeof(params));
5290 params.resultOrigin = &origin;
5291 params.instance = instance;
5311 } _OrthancPluginCreateDicom;
5345 _OrthancPluginCreateDicom params;
5346 params.target = target;
5348 params.pixelData = pixelData;
5349 params.flags = flags;
5351 return context->InvokeService(context, _OrthancPluginService_CreateDicom, ¶ms);
5358 } _OrthancPluginDecodeImageCallback;
5378 _OrthancPluginDecodeImageCallback params;
5379 params.callback = callback;
5381 return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, ¶ms);
5394 const void* constBuffer;
5395 uint32_t bufferSize;
5396 uint32_t frameIndex;
5397 } _OrthancPluginCreateImage;
5420 _OrthancPluginCreateImage params;
5421 memset(¶ms, 0,
sizeof(params));
5422 params.target = ⌖
5423 params.format = format;
5424 params.width = width;
5425 params.height = height;
5465 _OrthancPluginCreateImage params;
5466 memset(¶ms, 0,
sizeof(params));
5467 params.target = ⌖
5468 params.format = format;
5469 params.width = width;
5470 params.height = height;
5471 params.pitch = pitch;
5472 params.buffer = buffer;
5504 uint32_t bufferSize,
5505 uint32_t frameIndex)
5509 _OrthancPluginCreateImage params;
5510 memset(¶ms, 0,
sizeof(params));
5511 params.target = ⌖
5512 params.constBuffer = buffer;
5513 params.bufferSize = bufferSize;
5514 params.frameIndex = frameIndex;
5533 } _OrthancPluginComputeHash;
5554 _OrthancPluginComputeHash params;
5555 params.result = &result;
5556 params.buffer = buffer;
5590 _OrthancPluginComputeHash params;
5591 params.result = &result;
5592 params.buffer = buffer;
5612 } _OrthancPluginLookupDictionary;
5634 _OrthancPluginLookupDictionary params;
5635 params.target = target;
5637 return context->InvokeService(context, _OrthancPluginService_LookupDictionary, ¶ms);
5646 uint32_t answerSize;
5647 uint32_t headersCount;
5648 const char*
const* headersKeys;
5649 const char*
const* headersValues;
5650 } _OrthancPluginSendMultipartItem2;
5676 uint32_t answerSize,
5677 uint32_t headersCount,
5678 const char*
const* headersKeys,
5679 const char*
const* headersValues)
5681 _OrthancPluginSendMultipartItem2 params;
5682 params.output = output;
5683 params.answer = answer;
5684 params.answerSize = answerSize;
5685 params.headersCount = headersCount;
5686 params.headersKeys = headersKeys;
5687 params.headersValues = headersValues;
5689 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem2, ¶ms);
5696 } _OrthancPluginIncomingHttpRequestFilter;
5714 _OrthancPluginIncomingHttpRequestFilter params;
5715 params.callback = callback;
5717 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter, ¶ms);
5726 uint16_t* httpStatus;
5729 uint32_t headersCount;
5730 const char*
const* headersKeys;
5731 const char*
const* headersValues;
5734 const char* username;
5735 const char* password;
5737 const char* certificateFile;
5738 const char* certificateKeyFile;
5739 const char* certificateKeyPassword;
5741 } _OrthancPluginCallHttpClient2;
5788 uint16_t* httpStatus,
5791 uint32_t headersCount,
5792 const char*
const* headersKeys,
5793 const char*
const* headersValues,
5796 const char* username,
5797 const char* password,
5799 const char* certificateFile,
5800 const char* certificateKeyFile,
5801 const char* certificateKeyPassword,
5804 _OrthancPluginCallHttpClient2 params;
5805 memset(¶ms, 0,
sizeof(params));
5807 params.answerBody = answerBody;
5808 params.answerHeaders = answerHeaders;
5809 params.httpStatus = httpStatus;
5810 params.method = method;
5812 params.headersCount = headersCount;
5813 params.headersKeys = headersKeys;
5814 params.headersValues = headersValues;
5816 params.bodySize = bodySize;
5817 params.username = username;
5818 params.password = password;
5819 params.timeout = timeout;
5820 params.certificateFile = certificateFile;
5821 params.certificateKeyFile = certificateKeyFile;
5822 params.certificateKeyPassword = certificateKeyPassword;
5823 params.pkcs11 = pkcs11;
5825 return context->InvokeService(context, _OrthancPluginService_CallHttpClient2, ¶ms);
5844 _OrthancPluginRetrieveDynamicString params;
5845 params.result = &result;
5846 params.argument = NULL;
5865 } _OrthancPluginFindCallback;
5882 _OrthancPluginFindCallback params;
5883 params.callback = callback;
5885 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback, ¶ms);
5896 uint32_t *resultUint32;
5897 uint16_t *resultGroup;
5898 uint16_t *resultElement;
5899 char **resultString;
5900 } _OrthancPluginFindOperation;
5923 _OrthancPluginFindOperation params;
5924 memset(¶ms, 0,
sizeof(params));
5925 params.answers = answers;
5926 params.dicom = dicom;
5929 return context->InvokeService(context, _OrthancPluginService_FindAddAnswer, ¶ms);
5950 _OrthancPluginFindOperation params;
5951 memset(¶ms, 0,
sizeof(params));
5952 params.answers = answers;
5954 return context->InvokeService(context, _OrthancPluginService_FindMarkIncomplete, ¶ms);
5976 _OrthancPluginFindOperation params;
5977 memset(¶ms, 0,
sizeof(params));
5978 params.query = query;
5979 params.resultUint32 = &count;
6014 _OrthancPluginFindOperation params;
6015 memset(¶ms, 0,
sizeof(params));
6016 params.query = query;
6017 params.index = index;
6018 params.resultGroup = group;
6019 params.resultElement = element;
6021 return context->InvokeService(context, _OrthancPluginService_GetFindQueryTag, ¶ms);
6045 _OrthancPluginFindOperation params;
6046 memset(¶ms, 0,
sizeof(params));
6047 params.query = query;
6048 params.index = index;
6049 params.resultString = &result;
6083 _OrthancPluginFindOperation params;
6084 memset(¶ms, 0,
sizeof(params));
6085 params.query = query;
6086 params.index = index;
6087 params.resultString = &result;
6109 } _OrthancPluginMoveCallback;
6131 _OrthancPluginMoveCallback params;
6132 params.callback = callback;
6133 params.getMoveSize = getMoveSize;
6134 params.applyMove = applyMove;
6135 params.freeMove = freeMove;
6137 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback, ¶ms);
6147 } _OrthancPluginCreateFindMatcher;
6170 _OrthancPluginCreateFindMatcher params;
6171 memset(¶ms, 0,
sizeof(params));
6172 params.target = ⌖
6173 params.query = query;
6190 } _OrthancPluginFreeFindMatcher;
6205 _OrthancPluginFreeFindMatcher params;
6206 params.matcher = matcher;
6208 context->InvokeService(context, _OrthancPluginService_FreeFindMatcher, ¶ms);
6218 } _OrthancPluginFindMatcherIsMatch;
6240 int32_t isMatch = 0;
6242 _OrthancPluginFindMatcherIsMatch params;
6243 params.matcher = matcher;
6244 params.dicom = dicom;
6246 params.isMatch = &isMatch;
6263 } _OrthancPluginIncomingHttpRequestFilter2;
6280 _OrthancPluginIncomingHttpRequestFilter2 params;
6281 params.callback = callback;
6283 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter2, ¶ms);
6291 } _OrthancPluginGetPeers;
6309 _OrthancPluginGetPeers params;
6310 memset(¶ms, 0,
sizeof(params));
6311 params.peers = &peers;
6327 } _OrthancPluginFreePeers;
6342 _OrthancPluginFreePeers params;
6343 params.peers = peers;
6345 context->InvokeService(context, _OrthancPluginService_FreePeers, ¶ms);
6353 } _OrthancPluginGetPeersCount;
6372 uint32_t target = 0;
6374 _OrthancPluginGetPeersCount params;
6375 memset(¶ms, 0,
sizeof(params));
6376 params.target = ⌖
6377 params.peers = peers;
6393 const char** target;
6396 const char* userProperty;
6397 } _OrthancPluginGetPeerProperty;
6421 const char* target = NULL;
6423 _OrthancPluginGetPeerProperty params;
6424 memset(¶ms, 0,
sizeof(params));
6425 params.target = ⌖
6426 params.peers = peers;
6427 params.peerIndex = peerIndex;
6428 params.userProperty = NULL;
6462 const char* target = NULL;
6464 _OrthancPluginGetPeerProperty params;
6465 memset(¶ms, 0,
sizeof(params));
6466 params.target = ⌖
6467 params.peers = peers;
6468 params.peerIndex = peerIndex;
6469 params.userProperty = NULL;
6507 const char* userProperty)
6509 const char* target = NULL;
6511 _OrthancPluginGetPeerProperty params;
6512 memset(¶ms, 0,
sizeof(params));
6513 params.target = ⌖
6514 params.peers = peers;
6515 params.peerIndex = peerIndex;
6516 params.userProperty = userProperty;
6535 uint16_t* httpStatus;
6540 uint32_t additionalHeadersCount;
6541 const char*
const* additionalHeadersKeys;
6542 const char*
const* additionalHeadersValues;
6546 } _OrthancPluginCallPeerApi;
6587 uint16_t* httpStatus,
6592 uint32_t additionalHeadersCount,
6593 const char*
const* additionalHeadersKeys,
6594 const char*
const* additionalHeadersValues,
6599 _OrthancPluginCallPeerApi params;
6600 memset(¶ms, 0,
sizeof(params));
6602 params.answerBody = answerBody;
6603 params.answerHeaders = answerHeaders;
6604 params.httpStatus = httpStatus;
6605 params.peers = peers;
6606 params.peerIndex = peerIndex;
6607 params.method = method;
6609 params.additionalHeadersCount = additionalHeadersCount;
6610 params.additionalHeadersKeys = additionalHeadersKeys;
6611 params.additionalHeadersValues = additionalHeadersValues;
6613 params.bodySize = bodySize;
6614 params.timeout = timeout;
6616 return context->InvokeService(context, _OrthancPluginService_CallPeerApi, ¶ms);
6635 } _OrthancPluginCreateJob;
6682 _OrthancPluginCreateJob params;
6683 memset(¶ms, 0,
sizeof(params));
6685 params.target = ⌖
6687 params.finalize = finalize;
6689 params.getProgress = getProgress;
6690 params.getContent = getContent;
6691 params.getSerialized = getSerialized;
6694 params.reset = reset;
6712 } _OrthancPluginFreeJob;
6727 _OrthancPluginFreeJob params;
6730 context->InvokeService(context, _OrthancPluginService_FreeJob, ¶ms);
6740 } _OrthancPluginSubmitJob;
6760 char* resultId = NULL;
6762 _OrthancPluginSubmitJob params;
6763 memset(¶ms, 0,
sizeof(params));
6765 params.resultId = &resultId;
6767 params.priority = priority;
6786 } _OrthancPluginJobsUnserializer;
6804 _OrthancPluginJobsUnserializer params;
6805 params.unserializer = unserializer;
6807 context->InvokeService(context, _OrthancPluginService_RegisterJobsUnserializer, ¶ms);
6815 const char* details;
6817 } _OrthancPluginSetHttpErrorDetails;
6839 const char* details,
6842 _OrthancPluginSetHttpErrorDetails params;
6843 params.output = output;
6844 params.details = details;
6846 context->InvokeService(context, _OrthancPluginService_SetHttpErrorDetails, ¶ms);
6853 const char** result;
6854 const char* argument;
6855 } _OrthancPluginRetrieveStaticString;
6872 const char* result = NULL;
6874 _OrthancPluginRetrieveStaticString params;
6875 params.result = &result;
6876 params.argument = path;
6896 } _OrthancPluginSetMetricsValue;
6918 _OrthancPluginSetMetricsValue params;
6920 params.value = value;
6922 context->InvokeService(context, _OrthancPluginService_SetMetricsValue, ¶ms);
6930 } _OrthancPluginRegisterRefreshMetricsCallback;
6946 _OrthancPluginRegisterRefreshMetricsCallback params;
6947 params.callback = callback;
6948 context->InvokeService(context, _OrthancPluginService_RegisterRefreshMetricsCallback, ¶ms);
6960 } _OrthancPluginEncodeDicomWeb;
6984 char* target = NULL;
6986 _OrthancPluginEncodeDicomWeb params;
6987 params.target = ⌖
6988 params.dicom = dicom;
6989 params.dicomSize = dicomSize;
6990 params.callback = callback;
7026 char* target = NULL;
7028 _OrthancPluginEncodeDicomWeb params;
7029 params.target = ⌖
7030 params.dicom = dicom;
7031 params.dicomSize = dicomSize;
7032 params.callback = callback;
7054 } _OrthancPluginEncodeDicomWeb2;
7079 char* target = NULL;
7081 _OrthancPluginEncodeDicomWeb2 params;
7082 params.target = ⌖
7083 params.dicom = dicom;
7084 params.dicomSize = dicomSize;
7085 params.callback = callback;
7086 params.payload = payload;
7123 char* target = NULL;
7125 _OrthancPluginEncodeDicomWeb2 params;
7126 params.target = ⌖
7127 params.dicom = dicom;
7128 params.dicomSize = dicomSize;
7129 params.callback = callback;
7130 params.payload = payload;
7234 typedef const void* (*OrthancPluginChunkedClientRequestGetChunkData) (
void* request);
7258 uint16_t* httpStatus;
7261 uint32_t headersCount;
7262 const char*
const* headersKeys;
7263 const char*
const* headersValues;
7269 const char* username;
7270 const char* password;
7272 const char* certificateFile;
7273 const char* certificateKeyFile;
7274 const char* certificateKeyPassword;
7276 } _OrthancPluginChunkedHttpClient;
7334 uint16_t* httpStatus,
7337 uint32_t headersCount,
7338 const char*
const* headersKeys,
7339 const char*
const* headersValues,
7345 const char* username,
7346 const char* password,
7348 const char* certificateFile,
7349 const char* certificateKeyFile,
7350 const char* certificateKeyPassword,
7353 _OrthancPluginChunkedHttpClient params;
7354 memset(¶ms, 0,
sizeof(params));
7357 params.httpStatus = httpStatus;
7358 params.method = method;
7360 params.headersCount = headersCount;
7361 params.headersKeys = headersKeys;
7362 params.headersValues = headersValues;
7363 params.username = username;
7364 params.password = password;
7365 params.timeout = timeout;
7366 params.certificateFile = certificateFile;
7367 params.certificateKeyFile = certificateKeyFile;
7368 params.certificateKeyPassword = certificateKeyPassword;
7369 params.pkcs11 = pkcs11;
7372 params.answer = answer;
7373 params.answerAddChunk = answerAddChunk;
7374 params.answerAddHeader = answerAddHeader;
7375 params.request = request;
7376 params.requestIsDone = requestIsDone;
7377 params.requestChunkData = requestChunkData;
7378 params.requestChunkSize = requestChunkSize;
7379 params.requestNext = requestNext;
7381 return context->InvokeService(context, _OrthancPluginService_ChunkedHttpClient, ¶ms);
7471 const char* pathRegularExpression;
7479 } _OrthancPluginChunkedRestCallback;
7513 const char* pathRegularExpression,
7522 _OrthancPluginChunkedRestCallback params;
7523 params.pathRegularExpression = pathRegularExpression;
7524 params.getHandler = getHandler;
7525 params.postHandler = postHandler;
7526 params.deleteHandler = deleteHandler;
7527 params.putHandler = putHandler;
7528 params.addChunk = addChunk;
7529 params.execute = execute;
7530 params.finalize = finalize;
7532 context->InvokeService(context, _OrthancPluginService_RegisterChunkedRestCallback, ¶ms);
7544 const char* privateCreator;
7545 } _OrthancPluginGetTagName;
7566 const char* privateCreator)
7570 _OrthancPluginGetTagName params;
7571 params.result = &result;
7572 params.group = group;
7573 params.element = element;
7574 params.privateCreator = privateCreator;
7620 const char* transactionUid,
7621 const char*
const* sopClassUids,
7622 const char*
const* sopInstanceUids,
7623 uint32_t countInstances,
7624 const char* remoteAet,
7625 const char* calledAet);
7663 const char* sopClassUid,
7664 const char* sopInstanceUid);
7672 } _OrthancPluginRegisterStorageCommitmentScpCallback;
7693 _OrthancPluginRegisterStorageCommitmentScpCallback params;
7694 params.factory = factory;
7695 params.destructor = destructor;
7696 params.lookup = lookup;
7697 return context->InvokeService(context, _OrthancPluginService_RegisterStorageCommitmentScpCallback, ¶ms);
7724 } _OrthancPluginIncomingDicomInstanceFilter;
7752 _OrthancPluginIncomingDicomInstanceFilter params;
7753 params.callback = callback;
7755 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingDicomInstanceFilter, ¶ms);
7778 _OrthancPluginAccessDicomInstance params;
7779 memset(¶ms, 0,
sizeof(params));
7780 params.resultStringToFree = &result;
7781 params.instance = instance;
7811 int64_t hasPixelData;
7813 _OrthancPluginAccessDicomInstance params;
7814 memset(¶ms, 0,
sizeof(params));
7815 params.resultInt64 = &hasPixelData;
7816 params.instance = instance;
7827 return (hasPixelData != 0);
7841 const char* transferSyntax;
7842 } _OrthancPluginCreateDicomInstance;
7864 _OrthancPluginCreateDicomInstance params;
7865 params.target = ⌖
7866 params.buffer = buffer;
7883 } _OrthancPluginFreeDicomInstance;
7899 _OrthancPluginFreeDicomInstance params;
7900 params.dicom = dicom;
7902 context->InvokeService(context, _OrthancPluginService_FreeDicomInstance, ¶ms);
7908 uint32_t* targetUint32;
7911 char** targetStringToFree;
7913 uint32_t frameIndex;
7916 uint32_t maxStringLength;
7918 void* dicomWebPayload;
7919 } _OrthancPluginAccessDicomInstance2;
7938 _OrthancPluginAccessDicomInstance2 params;
7939 memset(¶ms, 0,
sizeof(params));
7940 params.targetUint32 = &count;
7941 params.instance = instance;
7976 uint32_t frameIndex)
7978 _OrthancPluginAccessDicomInstance2 params;
7979 memset(¶ms, 0,
sizeof(params));
7980 params.targetBuffer = target;
7981 params.instance = instance;
7982 params.frameIndex = frameIndex;
7984 return context->InvokeService(context, _OrthancPluginService_GetInstanceRawFrame, ¶ms);
8003 uint32_t frameIndex)
8007 _OrthancPluginAccessDicomInstance2 params;
8008 memset(¶ms, 0,
sizeof(params));
8009 params.targetImage = ⌖
8010 params.instance = instance;
8011 params.frameIndex = frameIndex;
8043 const char* transferSyntax)
8047 _OrthancPluginCreateDicomInstance params;
8048 params.target = ⌖
8049 params.buffer = buffer;
8051 params.transferSyntax = transferSyntax;
8082 _OrthancPluginAccessDicomInstance2 params;
8083 memset(¶ms, 0,
sizeof(params));
8084 params.targetBuffer = target;
8085 params.instance = instance;
8087 return context->InvokeService(context, _OrthancPluginService_SerializeDicomInstance, ¶ms);
8114 uint32_t maxStringLength)
8116 char* result = NULL;
8118 _OrthancPluginAccessDicomInstance2 params;
8119 memset(¶ms, 0,
sizeof(params));
8120 params.targetStringToFree = &result;
8121 params.instance = instance;
8122 params.format = format;
8123 params.flags = flags;
8124 params.maxStringLength = maxStringLength;
8158 char* target = NULL;
8160 _OrthancPluginAccessDicomInstance2 params;
8161 params.targetStringToFree = ⌖
8162 params.instance = instance;
8163 params.dicomWebCallback = callback;
8164 params.dicomWebPayload = payload;
8198 char* target = NULL;
8200 _OrthancPluginAccessDicomInstance2 params;
8201 params.targetStringToFree = ⌖
8202 params.instance = instance;
8203 params.dicomWebCallback = callback;
8204 params.dicomWebPayload = payload;
8241 const char*
const* allowedSyntaxes,
8242 uint32_t countSyntaxes,
8243 uint8_t allowNewSopInstanceUid);
8249 } _OrthancPluginTranscoderCallback;
8268 _OrthancPluginTranscoderCallback params;
8269 params.callback = callback;
8271 return context->InvokeService(context, _OrthancPluginService_RegisterTranscoderCallback, ¶ms);
8280 } _OrthancPluginCreateMemoryBuffer;
8304 _OrthancPluginCreateMemoryBuffer params;
8305 params.target = target;
8308 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer, ¶ms);
8342 _OrthancPluginRetrieveDynamicString params;
8343 params.result = &result;
8344 params.argument = NULL;
8346 if (context->InvokeService(context, _OrthancPluginService_GenerateRestApiAuthorizationToken,
8364 } _OrthancPluginCreateMemoryBuffer64;
8388 _OrthancPluginCreateMemoryBuffer64 params;
8389 params.target = target;
8392 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer64, ¶ms);
8402 } _OrthancPluginRegisterStorageArea2;
8427 _OrthancPluginRegisterStorageArea2 params;
8428 params.create = create;
8429 params.readWhole = readWhole;
8430 params.readRange = readRange;
8431 params.remove = remove;
8432 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea2, ¶ms);
8439 _OrthancPluginCreateDicom createDicom;
8440 const char* privateCreator;
8441 } _OrthancPluginCreateDicom2;
8473 const char* privateCreator)
8475 _OrthancPluginCreateDicom2 params;
8476 params.createDicom.target = target;
8477 params.createDicom.json = json;
8478 params.createDicom.pixelData = pixelData;
8479 params.createDicom.flags = flags;
8480 params.privateCreator = privateCreator;
8482 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:1811
void OrthancPluginRegisterStorageArea(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove)
Register a custom storage area.
Definition: OrthancCPlugin.h:3148
void OrthancPluginRegisterOnStoredInstanceCallback(OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback)
Register a callback for received instances.
Definition: OrthancCPlugin.h:2113
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:1199
OrthancPluginErrorCode OrthancPluginRegisterDecodeImageCallback(OrthancPluginContext *context, OrthancPluginDecodeImageCallback callback)
Register a callback to handle the decoding of DICOM images.
Definition: OrthancCPlugin.h:5374
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:1265
int OrthancPluginCheckVersion(OrthancPluginContext *context)
Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
Definition: OrthancCPlugin.h:1916
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:1177
void OrthancPluginRegisterRefreshMetricsCallback(OrthancPluginContext *context, OrthancPluginRefreshMetricsCallback callback)
Register a callback to refresh the metrics.
Definition: OrthancCPlugin.h:6942
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:1692
OrthancPluginErrorCode OrthancPluginStorageAreaRemove(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Remove a file from the storage area.
Definition: OrthancCPlugin.h:4732
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:8237
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter2(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter2 callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:6276
OrthancPluginErrorCode(* OrthancPluginStorageRead)(void **content, int64_t *size, const char *uuid, OrthancPluginContentType type)
Callback for reading from the storage area.
Definition: OrthancCPlugin.h:1245
void OrthancPluginRegisterRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback.
Definition: OrthancCPlugin.h:2035
uint32_t OrthancPluginGetExpectedDatabaseVersion(OrthancPluginContext *context)
Get the expected version of the database schema.
Definition: OrthancCPlugin.h:3536
void OrthancPluginRegisterOnChangeCallback(OrthancPluginContext *context, OrthancPluginOnChangeCallback callback)
Register a callback to monitor changes.
Definition: OrthancCPlugin.h:3291
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:8420
OrthancPluginErrorCode(* OrthancPluginRestCallback)(OrthancPluginRestOutput *output, const char *url, const OrthancPluginHttpRequest *request)
Signature of a callback function that answers to a REST request.
Definition: OrthancCPlugin.h:1145
void(* OrthancPluginRefreshMetricsCallback)()
Callback executed to update the metrics of the plugin.
Definition: OrthancCPlugin.h:1664
OrthancPluginErrorCode OrthancPluginRegisterTranscoderCallback(OrthancPluginContext *context, OrthancPluginTranscoderCallback callback)
Register a callback to handle the transcoding of DICOM images.
Definition: OrthancCPlugin.h:8264
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:1156
OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, OrthancPluginResourceType level)
Reconstruct the main DICOM tags.
Definition: OrthancCPlugin.h:4924
OrthancPluginErrorCode(* OrthancPluginStorageRemove)(const char *uuid, OrthancPluginContentType type)
Callback for removing a file from the storage area.
Definition: OrthancCPlugin.h:1306
OrthancPluginErrorCode(* OrthancPluginStorageCreate)(const char *uuid, const void *content, int64_t size, OrthancPluginContentType type)
Callback for writing to the storage area.
Definition: OrthancCPlugin.h:1218
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:1730
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:1166
OrthancPluginJob *(* OrthancPluginJobsUnserializer)(const char *jobType, const char *serialized)
Callback executed to unserialize a custom job.
Definition: OrthancCPlugin.h:1646
void OrthancPluginRegisterJobsUnserializer(OrthancPluginContext *context, OrthancPluginJobsUnserializer unserializer)
Register an unserializer for custom jobs.
Definition: OrthancCPlugin.h:6800
void(* OrthancPluginFree)(void *buffer)
Signature of a function to free dynamic memory.
Definition: OrthancCPlugin.h:1189
void OrthancPluginRegisterRestCallbackNoLock(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback, without locking.
Definition: OrthancCPlugin.h:2075
OrthancPluginErrorCode OrthancPluginStorageAreaRead(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Read a file from the storage area.
Definition: OrthancCPlugin.h:4693
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:1288
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:7511
OrthancPluginErrorCode OrthancPluginRegisterIncomingDicomInstanceFilter(OrthancPluginContext *context, OrthancPluginIncomingDicomInstanceFilter callback)
Register a callback to filter incoming DICOM instances.
Definition: OrthancCPlugin.h:7748
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:5710
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:4649
@ 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:5970
struct _OrthancPluginFindQuery_t OrthancPluginFindQuery
Opaque structure to an object that represents a C-Find query.
Definition: OrthancCPlugin.h:1096
OrthancPluginErrorCode(* OrthancPluginApplyMove)(void *moveDriver)
Callback to apply one C-Move suboperation.
Definition: OrthancCPlugin.h:1501
OrthancPluginErrorCode OrthancPluginFindMarkIncomplete(OrthancPluginContext *context, OrthancPluginFindAnswers *answers)
Mark the set of C-Find answers as incomplete.
Definition: OrthancCPlugin.h:5946
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:6038
void(* OrthancPluginStorageCommitmentDestructor)(void *handler)
Callback to free one storage commitment SCP handler.
Definition: OrthancCPlugin.h:7639
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:1325
OrthancPluginErrorCode OrthancPluginRegisterMoveCallback(OrthancPluginContext *context, OrthancPluginMoveCallback callback, OrthancPluginGetMoveSize getMoveSize, OrthancPluginApplyMove applyMove, OrthancPluginFreeMove freeMove)
Register a callback to handle C-Move requests.
Definition: OrthancCPlugin.h:6124
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:7617
OrthancPluginErrorCode OrthancPluginRegisterFindCallback(OrthancPluginContext *context, OrthancPluginFindCallback callback)
Register a callback to handle C-Find requests.
Definition: OrthancCPlugin.h:5878
OrthancPluginErrorCode OrthancPluginWorklistGetDicomQuery(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginWorklistQuery *query)
Retrieve the worklist query as a DICOM file.
Definition: OrthancCPlugin.h:5256
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:7660
int32_t OrthancPluginWorklistIsMatch(OrthancPluginContext *context, const OrthancPluginWorklistQuery *query, const void *dicom, uint32_t size)
Test whether a worklist matches the query.
Definition: OrthancCPlugin.h:5217
OrthancPluginErrorCode OrthancPluginFindAddAnswer(OrthancPluginContext *context, OrthancPluginFindAnswers *answers, const void *dicom, uint32_t size)
Add one answer to some C-Find request.
Definition: OrthancCPlugin.h:5917
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:1461
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:7687
struct _OrthancPluginFindAnswers_t OrthancPluginFindAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1104
struct _OrthancPluginWorklistAnswers_t OrthancPluginWorklistAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1088
OrthancPluginErrorCode(* OrthancPluginFindCallback)(OrthancPluginFindAnswers *answers, const OrthancPluginFindQuery *query, const char *issuerAet, const char *calledAet)
Callback to handle incoming C-Find SCP requests.
Definition: OrthancCPlugin.h:1418
uint32_t(* OrthancPluginGetMoveSize)(void *moveDriver)
Callback to read the size of a C-Move driver.
Definition: OrthancCPlugin.h:1486
OrthancPluginErrorCode OrthancPluginRegisterWorklistCallback(OrthancPluginContext *context, OrthancPluginWorklistCallback callback)
Register a callback to handle modality worklists requests.
Definition: OrthancCPlugin.h:5113
OrthancPluginErrorCode OrthancPluginWorklistMarkIncomplete(OrthancPluginContext *context, OrthancPluginWorklistAnswers *answers)
Mark the set of worklist answers as incomplete.
Definition: OrthancCPlugin.h:5179
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:6076
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:6007
void(* OrthancPluginFreeMove)(void *moveDriver)
Callback to free one C-Move driver.
Definition: OrthancCPlugin.h:1515
struct _OrthancPluginWorklistQuery_t OrthancPluginWorklistQuery
Opaque structure to an object that represents a C-Find query for worklists.
Definition: OrthancCPlugin.h:1080
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:5149
int32_t OrthancPluginHasInstancePixelData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Check whether the DICOM file has pixel data.
Definition: OrthancCPlugin.h:7807
char * OrthancPluginGetInstanceDicomWebXml(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb XML.
Definition: OrthancCPlugin.h:8192
struct _OrthancPluginDicomInstance_t OrthancPluginDicomInstance
Opaque structure that represents a DICOM instance that is managed by the Orthanc core.
Definition: OrthancCPlugin.h:1056
char * OrthancPluginGetInstanceTransferSyntaxUid(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the transfer syntax of a DICOM file.
Definition: OrthancCPlugin.h:7772
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:7972
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:8109
const void * OrthancPluginGetInstanceData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the data of a DICOM file.
Definition: OrthancCPlugin.h:2945
OrthancPluginDicomInstance * OrthancPluginCreateDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size)
Parse a DICOM instance.
Definition: OrthancCPlugin.h:7857
uint32_t OrthancPluginGetInstanceFramesCount(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the number of frames in a DICOM instance.
Definition: OrthancCPlugin.h:7932
OrthancPluginImage * OrthancPluginGetInstanceDecodedFrame(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:8000
OrthancPluginInstanceOrigin OrthancPluginGetInstanceOrigin(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the origin of a DICOM file.
Definition: OrthancCPlugin.h:5282
int64_t OrthancPluginGetInstanceSize(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the size of a DICOM file.
Definition: OrthancCPlugin.h:2912
char * OrthancPluginGetInstanceDicomWebJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb JSON.
Definition: OrthancCPlugin.h:8152
char * OrthancPluginGetInstanceSimplifiedJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file (with simplification).
Definition: OrthancCPlugin.h:3019
char * OrthancPluginGetInstanceJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file.
Definition: OrthancCPlugin.h:2981
int OrthancPluginHasInstanceMetadata(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, const char *metadata)
Check whether a DICOM instance is associated with some metadata.
Definition: OrthancCPlugin.h:3058
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:3099
void OrthancPluginFreeDicomInstance(OrthancPluginContext *context, OrthancPluginDicomInstance *dicom)
Free a DICOM instance.
Definition: OrthancCPlugin.h:7895
OrthancPluginErrorCode OrthancPluginSerializeDicomInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginDicomInstance *instance)
Writes a DICOM instance to a memory buffer.
Definition: OrthancCPlugin.h:8077
OrthancPluginDicomInstance * OrthancPluginTranscodeDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size, const char *transferSyntax)
Parse and transcode a DICOM instance.
Definition: OrthancCPlugin.h:8039
const char * OrthancPluginGetInstanceRemoteAet(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the AET of a DICOM instance.
Definition: OrthancCPlugin.h:2879
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:4595
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:4179
uint32_t OrthancPluginGetImagePitch(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pitch of an image.
Definition: OrthancCPlugin.h:3970
OrthancPluginImage * OrthancPluginConvertPixelFormat(OrthancPluginContext *context, const OrthancPluginImage *source, OrthancPluginPixelFormat targetFormat)
Change the pixel format of an image.
Definition: OrthancCPlugin.h:4435
OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pixel format of an image.
Definition: OrthancCPlugin.h:3869
uint32_t OrthancPluginGetFontsCount(OrthancPluginContext *context)
Return the number of available fonts.
Definition: OrthancCPlugin.h:4470
uint32_t OrthancPluginGetImageHeight(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the height of an image.
Definition: OrthancCPlugin.h:3935
void OrthancPluginFreeImage(OrthancPluginContext *context, OrthancPluginImage *image)
Free an image.
Definition: OrthancCPlugin.h:4089
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:4134
OrthancPluginImage * OrthancPluginCreateImage(OrthancPluginContext *context, OrthancPluginPixelFormat format, uint32_t width, uint32_t height)
Create an image.
Definition: OrthancCPlugin.h:5412
OrthancPluginImage * OrthancPluginUncompressImage(OrthancPluginContext *context, const void *data, uint32_t size, OrthancPluginImageFormat format)
Decode a compressed image.
Definition: OrthancCPlugin.h:4047
const char * OrthancPluginGetFontName(OrthancPluginContext *context, uint32_t fontIndex)
Return the name of a font.
Definition: OrthancCPlugin.h:4510
void * OrthancPluginGetImageBuffer(OrthancPluginContext *context, const OrthancPluginImage *image)
Return a pointer to the content of an image.
Definition: OrthancCPlugin.h:4004
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:5455
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:1072
OrthancPluginCompressionType
Definition: OrthancCPlugin.h:747
uint32_t OrthancPluginGetImageWidth(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the width of an image.
Definition: OrthancCPlugin.h:3902
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:3681
OrthancPluginImage * OrthancPluginDecodeDicomImage(OrthancPluginContext *context, const void *buffer, uint32_t bufferSize, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:5501
uint32_t OrthancPluginGetFontSize(OrthancPluginContext *context, uint32_t fontIndex)
Return the size of a font.
Definition: OrthancCPlugin.h:4542
struct _OrthancPluginImage_t OrthancPluginImage
Opaque structure that represents an image that is uncompressed in memory.
Definition: OrthancCPlugin.h:1064
@ 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:2343
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:2378
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:2491
char * OrthancPluginLookupStudy(OrthancPluginContext *context, const char *studyUID)
Look for a study.
Definition: OrthancCPlugin.h:2592
OrthancPluginErrorCode OrthancPluginSetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *value)
Set the value of a global property.
Definition: OrthancCPlugin.h:3439
char * OrthancPluginGetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *defaultValue)
Get the value of a global property.
Definition: OrthancCPlugin.h:3400
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:2455
char * OrthancPluginLookupSeries(OrthancPluginContext *context, const char *seriesUID)
Look for a series.
Definition: OrthancCPlugin.h:2662
char * OrthancPluginLookupStudyWithAccessionNumber(OrthancPluginContext *context, const char *accessionNumber)
Look for a study, using the accession number.
Definition: OrthancCPlugin.h:2627
char * OrthancPluginGenerateRestApiAuthorizationToken(OrthancPluginContext *context)
Generate a token to grant full access to the REST API of Orthanc.
Definition: OrthancCPlugin.h:8337
OrthancPluginErrorCode OrthancPluginRestApiGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2276
char * OrthancPluginLookupInstance(OrthancPluginContext *context, const char *sopInstanceUID)
Look for an instance.
Definition: OrthancCPlugin.h:2697
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:2306
char * OrthancPluginLookupPatient(OrthancPluginContext *context, const char *patientID)
Look for a patient.
Definition: OrthancCPlugin.h:2557
OrthancPluginErrorCode OrthancPluginRestApiDelete(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2407
OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:2430
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:5075
OrthancPluginErrorCode OrthancPluginGetDicomForInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *instanceId)
Retrieve a DICOM instance using its Orthanc identifier.
Definition: OrthancCPlugin.h:2243
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:2202
void OrthancPluginSendUnauthorized(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *realm)
Signal that a REST request is not authorized.
Definition: OrthancCPlugin.h:2765
void OrthancPluginSetHttpErrorDetails(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *details, uint8_t log)
Provide a detailed description for an HTTP error.
Definition: OrthancCPlugin.h:6836
void OrthancPluginSendMethodNotAllowed(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *allowedMethods)
Signal that this URI does not support this HTTP method.
Definition: OrthancCPlugin.h:2788
void OrthancPluginAnswerBuffer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const void *answer, uint32_t answerSize, const char *mimeType)
Answer to a REST request.
Definition: OrthancCPlugin.h:2145
void OrthancPluginSendHttpStatusCode(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status)
Send a HTTP status code.
Definition: OrthancCPlugin.h:2742
void OrthancPluginSetHttpHeader(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *key, const char *value)
Set some HTTP header.
Definition: OrthancCPlugin.h:2843
void OrthancPluginSetCookie(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *cookie, const char *value)
Set a cookie.
Definition: OrthancCPlugin.h:2818
void OrthancPluginRedirect(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *redirection)
Redirect a REST request.
Definition: OrthancCPlugin.h:2525
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:4226
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:3639
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:5672
OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *subType, const char *contentType)
Start an HTTP multipart answer.
Definition: OrthancCPlugin.h:3610
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:3833
An entry in the dictionary of DICOM tags.
Definition: OrthancCPlugin.h:1763
uint32_t minMultiplicity
Definition: OrthancCPlugin.h:1767
uint32_t maxMultiplicity
Definition: OrthancCPlugin.h:1768
OrthancPluginValueRepresentation vr
Definition: OrthancCPlugin.h:1766
uint16_t element
Definition: OrthancCPlugin.h:1765
uint16_t group
Definition: OrthancCPlugin.h:1764
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:1029
uint64_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:1038
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:1033
A 32-bit memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:1007
uint32_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:1016
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:1011