 |
Orthanc Plugin SDK
1.6.0
Documentation of the plugin interface of Orthanc
|
118 # define ORTHANC_PLUGINS_API __declspec(dllexport)
120 # define ORTHANC_PLUGINS_API __attribute__ ((visibility ("default")))
122 # define ORTHANC_PLUGINS_API
125 #define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 1
126 #define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 6
127 #define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 0
130 #if !defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE)
131 #define ORTHANC_PLUGINS_VERSION_IS_ABOVE(major, minor, revision) \
132 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER > major || \
133 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER == major && \
134 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER > minor || \
135 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER == minor && \
136 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER >= revision))))
155 #ifndef ORTHANC_PLUGIN_INLINE
156 # if __STDC_VERSION__ >= 199901L
158 # define ORTHANC_PLUGIN_INLINE static inline
159 # elif defined(__cplusplus)
161 # define ORTHANC_PLUGIN_INLINE static inline
162 # elif defined(__GNUC__)
164 # define ORTHANC_PLUGIN_INLINE static __inline
165 # elif defined(_MSC_VER)
167 # define ORTHANC_PLUGIN_INLINE static __inline
169 # error Your compiler is not known to support the "inline" keyword
308 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
316 ORTHANC_PLUGINS_API
const char* OrthancPluginGetName();
329 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
347 uint32_t groupsCount;
352 const char*
const* groups;
362 const char*
const* getKeys;
367 const char*
const* getValues;
387 uint32_t headersCount;
392 const char*
const* headersKeys;
397 const char*
const* headersValues;
405 _OrthancPluginService_LogInfo = 1,
406 _OrthancPluginService_LogWarning = 2,
407 _OrthancPluginService_LogError = 3,
408 _OrthancPluginService_GetOrthancPath = 4,
409 _OrthancPluginService_GetOrthancDirectory = 5,
410 _OrthancPluginService_GetConfigurationPath = 6,
411 _OrthancPluginService_SetPluginProperty = 7,
412 _OrthancPluginService_GetGlobalProperty = 8,
413 _OrthancPluginService_SetGlobalProperty = 9,
414 _OrthancPluginService_GetCommandLineArgumentsCount = 10,
415 _OrthancPluginService_GetCommandLineArgument = 11,
416 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
417 _OrthancPluginService_GetConfiguration = 13,
418 _OrthancPluginService_BufferCompression = 14,
419 _OrthancPluginService_ReadFile = 15,
420 _OrthancPluginService_WriteFile = 16,
421 _OrthancPluginService_GetErrorDescription = 17,
422 _OrthancPluginService_CallHttpClient = 18,
423 _OrthancPluginService_RegisterErrorCode = 19,
424 _OrthancPluginService_RegisterDictionaryTag = 20,
425 _OrthancPluginService_DicomBufferToJson = 21,
426 _OrthancPluginService_DicomInstanceToJson = 22,
427 _OrthancPluginService_CreateDicom = 23,
428 _OrthancPluginService_ComputeMd5 = 24,
429 _OrthancPluginService_ComputeSha1 = 25,
430 _OrthancPluginService_LookupDictionary = 26,
431 _OrthancPluginService_CallHttpClient2 = 27,
432 _OrthancPluginService_GenerateUuid = 28,
433 _OrthancPluginService_RegisterPrivateDictionaryTag = 29,
434 _OrthancPluginService_AutodetectMimeType = 30,
435 _OrthancPluginService_SetMetricsValue = 31,
436 _OrthancPluginService_EncodeDicomWebJson = 32,
437 _OrthancPluginService_EncodeDicomWebXml = 33,
438 _OrthancPluginService_ChunkedHttpClient = 34,
439 _OrthancPluginService_GetTagName = 35,
442 _OrthancPluginService_RegisterRestCallback = 1000,
443 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
444 _OrthancPluginService_RegisterStorageArea = 1002,
445 _OrthancPluginService_RegisterOnChangeCallback = 1003,
446 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
447 _OrthancPluginService_RegisterWorklistCallback = 1005,
448 _OrthancPluginService_RegisterDecodeImageCallback = 1006,
449 _OrthancPluginService_RegisterIncomingHttpRequestFilter = 1007,
450 _OrthancPluginService_RegisterFindCallback = 1008,
451 _OrthancPluginService_RegisterMoveCallback = 1009,
452 _OrthancPluginService_RegisterIncomingHttpRequestFilter2 = 1010,
453 _OrthancPluginService_RegisterRefreshMetricsCallback = 1011,
454 _OrthancPluginService_RegisterChunkedRestCallback = 1012,
455 _OrthancPluginService_RegisterStorageCommitmentScpCallback = 1013,
458 _OrthancPluginService_AnswerBuffer = 2000,
459 _OrthancPluginService_CompressAndAnswerPngImage = 2001,
460 _OrthancPluginService_Redirect = 2002,
461 _OrthancPluginService_SendHttpStatusCode = 2003,
462 _OrthancPluginService_SendUnauthorized = 2004,
463 _OrthancPluginService_SendMethodNotAllowed = 2005,
464 _OrthancPluginService_SetCookie = 2006,
465 _OrthancPluginService_SetHttpHeader = 2007,
466 _OrthancPluginService_StartMultipartAnswer = 2008,
467 _OrthancPluginService_SendMultipartItem = 2009,
468 _OrthancPluginService_SendHttpStatus = 2010,
469 _OrthancPluginService_CompressAndAnswerImage = 2011,
470 _OrthancPluginService_SendMultipartItem2 = 2012,
471 _OrthancPluginService_SetHttpErrorDetails = 2013,
474 _OrthancPluginService_GetDicomForInstance = 3000,
475 _OrthancPluginService_RestApiGet = 3001,
476 _OrthancPluginService_RestApiPost = 3002,
477 _OrthancPluginService_RestApiDelete = 3003,
478 _OrthancPluginService_RestApiPut = 3004,
479 _OrthancPluginService_LookupPatient = 3005,
480 _OrthancPluginService_LookupStudy = 3006,
481 _OrthancPluginService_LookupSeries = 3007,
482 _OrthancPluginService_LookupInstance = 3008,
483 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
484 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
485 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
486 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
487 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
488 _OrthancPluginService_ReconstructMainDicomTags = 3014,
489 _OrthancPluginService_RestApiGet2 = 3015,
492 _OrthancPluginService_GetInstanceRemoteAet = 4000,
493 _OrthancPluginService_GetInstanceSize = 4001,
494 _OrthancPluginService_GetInstanceData = 4002,
495 _OrthancPluginService_GetInstanceJson = 4003,
496 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
497 _OrthancPluginService_HasInstanceMetadata = 4005,
498 _OrthancPluginService_GetInstanceMetadata = 4006,
499 _OrthancPluginService_GetInstanceOrigin = 4007,
502 _OrthancPluginService_RegisterDatabaseBackend = 5000,
503 _OrthancPluginService_DatabaseAnswer = 5001,
504 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002,
505 _OrthancPluginService_StorageAreaCreate = 5003,
506 _OrthancPluginService_StorageAreaRead = 5004,
507 _OrthancPluginService_StorageAreaRemove = 5005,
510 _OrthancPluginService_GetImagePixelFormat = 6000,
511 _OrthancPluginService_GetImageWidth = 6001,
512 _OrthancPluginService_GetImageHeight = 6002,
513 _OrthancPluginService_GetImagePitch = 6003,
514 _OrthancPluginService_GetImageBuffer = 6004,
515 _OrthancPluginService_UncompressImage = 6005,
516 _OrthancPluginService_FreeImage = 6006,
517 _OrthancPluginService_CompressImage = 6007,
518 _OrthancPluginService_ConvertPixelFormat = 6008,
519 _OrthancPluginService_GetFontsCount = 6009,
520 _OrthancPluginService_GetFontInfo = 6010,
521 _OrthancPluginService_DrawText = 6011,
522 _OrthancPluginService_CreateImage = 6012,
523 _OrthancPluginService_CreateImageAccessor = 6013,
524 _OrthancPluginService_DecodeDicomImage = 6014,
527 _OrthancPluginService_WorklistAddAnswer = 7000,
528 _OrthancPluginService_WorklistMarkIncomplete = 7001,
529 _OrthancPluginService_WorklistIsMatch = 7002,
530 _OrthancPluginService_WorklistGetDicomQuery = 7003,
531 _OrthancPluginService_FindAddAnswer = 7004,
532 _OrthancPluginService_FindMarkIncomplete = 7005,
533 _OrthancPluginService_GetFindQuerySize = 7006,
534 _OrthancPluginService_GetFindQueryTag = 7007,
535 _OrthancPluginService_GetFindQueryTagName = 7008,
536 _OrthancPluginService_GetFindQueryValue = 7009,
537 _OrthancPluginService_CreateFindMatcher = 7010,
538 _OrthancPluginService_FreeFindMatcher = 7011,
539 _OrthancPluginService_FindMatcherIsMatch = 7012,
542 _OrthancPluginService_GetPeers = 8000,
543 _OrthancPluginService_FreePeers = 8001,
544 _OrthancPluginService_GetPeersCount = 8003,
545 _OrthancPluginService_GetPeerName = 8004,
546 _OrthancPluginService_GetPeerUrl = 8005,
547 _OrthancPluginService_CallPeerApi = 8006,
548 _OrthancPluginService_GetPeerUserProperty = 8007,
551 _OrthancPluginService_CreateJob = 9000,
552 _OrthancPluginService_FreeJob = 9001,
553 _OrthancPluginService_SubmitJob = 9002,
554 _OrthancPluginService_RegisterJobsUnserializer = 9003,
556 _OrthancPluginService_INTERNAL = 0x7fffffff
557 } _OrthancPluginService;
562 _OrthancPluginProperty_Description = 1,
563 _OrthancPluginProperty_RootUri = 2,
564 _OrthancPluginProperty_OrthancExplorer = 3,
566 _OrthancPluginProperty_INTERNAL = 0x7fffffff
567 } _OrthancPluginProperty;
659 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
673 _OrthancPluginContentType_INTERNAL = 0x7fffffff
689 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
717 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
732 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
746 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
784 _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff
799 _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff
810 OrthancPluginDicomToJsonFlags_None = 0,
818 _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff
829 OrthancPluginCreateDicomFlags_None = 0,
833 _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff
849 _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff
865 _OrthancPluginConstraintType_INTERNAL = 0x7fffffff
880 _OrthancPluginInstanceOrigin_INTERNAL = 0x7fffffff
1111 const char* instanceId);
1122 const char* resourceId);
1133 const uint32_t size,
1134 uint32_t frameIndex);
1155 const char* bulkDataUri);
1173 const void* content,
1237 const char* issuerAet,
1238 const char* calledAet);
1265 uint32_t headersCount,
1266 const char*
const* headersKeys,
1267 const char*
const* headersValues);
1296 uint32_t headersCount,
1297 const char*
const* headersKeys,
1298 const char*
const* headersValues,
1299 uint32_t getArgumentsCount,
1300 const char*
const* getArgumentsKeys,
1301 const char*
const* getArgumentsValues);
1322 const char* issuerAet,
1323 const char* calledAet);
1362 typedef void* (*OrthancPluginMoveCallback) (
1364 const char* patientId,
1365 const char* accessionNumber,
1366 const char* studyInstanceUid,
1367 const char* seriesInstanceUid,
1368 const char* sopInstanceUid,
1369 const char* originatorAet,
1370 const char* sourceAet,
1371 const char* targetAet,
1372 uint16_t originatorId);
1457 typedef const char* (*OrthancPluginJobGetContent) (
void* job);
1475 typedef const char* (*OrthancPluginJobGetSerialized) (
void* job);
1547 typedef OrthancPluginJob* (*OrthancPluginJobsUnserializer) (
const char* jobType,
1548 const char* serialized);
1596 uint32_t levelDepth,
1597 const uint16_t* levelTagGroup,
1598 const uint16_t* levelTagElement,
1599 const uint32_t* levelIndex,
1601 uint16_t tagElement,
1609 typedef struct _OrthancPluginContext_t
1611 void* pluginsManager;
1612 const char* orthancVersion;
1615 _OrthancPluginService service,
1616 const void* params);
1629 uint32_t minMultiplicity;
1630 uint32_t maxMultiplicity;
1677 int expectedRevision)
1679 int major, minor, revision;
1683 sizeof(int32_t) !=
sizeof(_OrthancPluginService) ||
1684 sizeof(int32_t) !=
sizeof(_OrthancPluginProperty) ||
1708 if (!strcmp(context->orthancVersion,
"mainline"))
1720 (context->orthancVersion,
"%4d.%4d.%4d", &major, &minor, &revision) != 3)
1727 if (major > expectedMajor)
1732 if (major < expectedMajor)
1739 if (minor > expectedMinor)
1744 if (minor < expectedMinor)
1751 if (revision >= expectedRevision)
1783 ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER,
1784 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER,
1785 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER);
1801 context->Free(buffer->
data);
1815 const char* message)
1817 context->InvokeService(context, _OrthancPluginService_LogError, message);
1831 const char* message)
1833 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
1847 const char* message)
1849 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
1856 const char* pathRegularExpression;
1858 } _OrthancPluginRestCallback;
1883 const char* pathRegularExpression,
1886 _OrthancPluginRestCallback params;
1887 params.pathRegularExpression = pathRegularExpression;
1888 params.callback = callback;
1889 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
1923 const char* pathRegularExpression,
1926 _OrthancPluginRestCallback params;
1927 params.pathRegularExpression = pathRegularExpression;
1928 params.callback = callback;
1929 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms);
1937 } _OrthancPluginOnStoredInstanceCallback;
1953 _OrthancPluginOnStoredInstanceCallback params;
1954 params.callback = callback;
1956 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
1965 uint32_t answerSize;
1966 const char* mimeType;
1967 } _OrthancPluginAnswerBuffer;
1985 uint32_t answerSize,
1986 const char* mimeType)
1988 _OrthancPluginAnswerBuffer params;
1989 params.output = output;
1990 params.answer = answer;
1991 params.answerSize = answerSize;
1992 params.mimeType = mimeType;
1993 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms);
2005 } _OrthancPluginCompressAndAnswerPngImage;
2017 } _OrthancPluginCompressAndAnswerImage;
2047 _OrthancPluginCompressAndAnswerImage params;
2048 params.output = output;
2050 params.pixelFormat = format;
2051 params.width = width;
2052 params.height = height;
2053 params.pitch = pitch;
2054 params.buffer = buffer;
2056 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
2064 const char* instanceId;
2065 } _OrthancPluginGetDicomForInstance;
2082 const char* instanceId)
2084 _OrthancPluginGetDicomForInstance params;
2085 params.target = target;
2086 params.instanceId = instanceId;
2087 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
2096 } _OrthancPluginRestApiGet;
2117 _OrthancPluginRestApiGet params;
2118 params.target = target;
2120 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
2147 _OrthancPluginRestApiGet params;
2148 params.target = target;
2150 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms);
2161 } _OrthancPluginRestApiPostPut;
2186 _OrthancPluginRestApiPostPut params;
2187 params.target = target;
2190 params.bodySize = bodySize;
2191 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
2221 _OrthancPluginRestApiPostPut params;
2222 params.target = target;
2225 params.bodySize = bodySize;
2226 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms);
2247 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
2270 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
2298 _OrthancPluginRestApiPostPut params;
2299 params.target = target;
2302 params.bodySize = bodySize;
2303 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
2334 _OrthancPluginRestApiPostPut params;
2335 params.target = target;
2338 params.bodySize = bodySize;
2339 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms);
2347 const char* argument;
2348 } _OrthancPluginOutputPlusArgument;
2364 const char* redirection)
2366 _OrthancPluginOutputPlusArgument params;
2367 params.output = output;
2368 params.argument = redirection;
2369 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
2377 const char* argument;
2378 } _OrthancPluginRetrieveDynamicString;
2395 const char* patientID)
2399 _OrthancPluginRetrieveDynamicString params;
2400 params.result = &result;
2401 params.argument = patientID;
2430 const char* studyUID)
2434 _OrthancPluginRetrieveDynamicString params;
2435 params.result = &result;
2436 params.argument = studyUID;
2465 const char* accessionNumber)
2469 _OrthancPluginRetrieveDynamicString params;
2470 params.result = &result;
2471 params.argument = accessionNumber;
2500 const char* seriesUID)
2504 _OrthancPluginRetrieveDynamicString params;
2505 params.result = &result;
2506 params.argument = seriesUID;
2535 const char* sopInstanceUID)
2539 _OrthancPluginRetrieveDynamicString params;
2540 params.result = &result;
2541 params.argument = sopInstanceUID;
2560 } _OrthancPluginSendHttpStatusCode;
2583 _OrthancPluginSendHttpStatusCode params;
2584 params.output = output;
2585 params.status = status;
2586 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
2606 _OrthancPluginOutputPlusArgument params;
2607 params.output = output;
2608 params.argument = realm;
2609 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
2627 const char* allowedMethods)
2629 _OrthancPluginOutputPlusArgument params;
2630 params.output = output;
2631 params.argument = allowedMethods;
2632 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
2641 } _OrthancPluginSetHttpHeader;
2660 _OrthancPluginSetHttpHeader params;
2661 params.output = output;
2662 params.key = cookie;
2663 params.value = value;
2664 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
2685 _OrthancPluginSetHttpHeader params;
2686 params.output = output;
2688 params.value = value;
2689 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
2695 char** resultStringToFree;
2696 const char** resultString;
2697 int64_t* resultInt64;
2701 } _OrthancPluginAccessDicomInstance;
2721 _OrthancPluginAccessDicomInstance params;
2722 memset(¶ms, 0,
sizeof(params));
2723 params.resultString = &result;
2724 params.instance = instance;
2754 _OrthancPluginAccessDicomInstance params;
2755 memset(¶ms, 0,
sizeof(params));
2756 params.resultInt64 = &size;
2757 params.instance = instance;
2787 _OrthancPluginAccessDicomInstance params;
2788 memset(¶ms, 0,
sizeof(params));
2789 params.resultString = &result;
2790 params.instance = instance;
2823 _OrthancPluginAccessDicomInstance params;
2824 memset(¶ms, 0,
sizeof(params));
2825 params.resultStringToFree = &result;
2826 params.instance = instance;
2861 _OrthancPluginAccessDicomInstance params;
2862 memset(¶ms, 0,
sizeof(params));
2863 params.resultStringToFree = &result;
2864 params.instance = instance;
2897 const char* metadata)
2901 _OrthancPluginAccessDicomInstance params;
2902 memset(¶ms, 0,
sizeof(params));
2903 params.resultInt64 = &result;
2904 params.instance = instance;
2905 params.key = metadata;
2914 return (result != 0);
2938 const char* metadata)
2942 _OrthancPluginAccessDicomInstance params;
2943 memset(¶ms, 0,
sizeof(params));
2944 params.resultString = &result;
2945 params.instance = instance;
2946 params.key = metadata;
2967 } _OrthancPluginRegisterStorageArea;
2989 _OrthancPluginRegisterStorageArea params;
2990 params.create = create;
2992 params.remove = remove;
2995 params.free = ::free;
3000 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
3019 _OrthancPluginRetrieveDynamicString params;
3020 params.result = &result;
3021 params.argument = NULL;
3049 _OrthancPluginRetrieveDynamicString params;
3050 params.result = &result;
3051 params.argument = NULL;
3084 _OrthancPluginRetrieveDynamicString params;
3085 params.result = &result;
3086 params.argument = NULL;
3104 } _OrthancPluginOnChangeCallback;
3126 _OrthancPluginOnChangeCallback params;
3127 params.callback = callback;
3129 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms);
3137 _OrthancPluginProperty property;
3139 } _OrthancPluginSetPluginProperty;
3157 _OrthancPluginSetPluginProperty params;
3158 params.plugin = OrthancPluginGetName();
3159 params.property = _OrthancPluginProperty_RootUri;
3162 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3177 const char* description)
3179 _OrthancPluginSetPluginProperty params;
3180 params.plugin = OrthancPluginGetName();
3181 params.property = _OrthancPluginProperty_Description;
3182 params.value = description;
3184 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3199 const char* javascript)
3201 _OrthancPluginSetPluginProperty params;
3202 params.plugin = OrthancPluginGetName();
3203 params.property = _OrthancPluginProperty_OrthancExplorer;
3204 params.value = javascript;
3206 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3215 } _OrthancPluginGlobalProperty;
3234 const char* defaultValue)
3238 _OrthancPluginGlobalProperty params;
3239 params.result = &result;
3240 params.property = property;
3241 params.value = defaultValue;
3275 _OrthancPluginGlobalProperty params;
3276 params.result = NULL;
3277 params.property = property;
3278 params.value = value;
3280 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms);
3287 int32_t *resultInt32;
3288 uint32_t *resultUint32;
3289 int64_t *resultInt64;
3290 uint64_t *resultUint64;
3291 } _OrthancPluginReturnSingleValue;
3306 _OrthancPluginReturnSingleValue params;
3307 memset(¶ms, 0,
sizeof(params));
3308 params.resultUint32 = &count;
3341 _OrthancPluginGlobalProperty params;
3342 params.result = &result;
3343 params.property = (int32_t) argument;
3344 params.value = NULL;
3372 _OrthancPluginReturnSingleValue params;
3373 memset(¶ms, 0,
sizeof(params));
3374 params.resultUint32 = &count;
3404 _OrthancPluginRetrieveDynamicString params;
3405 params.result = &result;
3406 params.argument = NULL;
3424 const char* subType;
3425 const char* contentType;
3426 } _OrthancPluginStartMultipartAnswer;
3444 const char* subType,
3445 const char* contentType)
3447 _OrthancPluginStartMultipartAnswer params;
3448 params.output = output;
3449 params.subType = subType;
3450 params.contentType = contentType;
3451 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms);
3474 uint32_t answerSize)
3476 _OrthancPluginAnswerBuffer params;
3477 params.output = output;
3478 params.answer = answer;
3479 params.answerSize = answerSize;
3480 params.mimeType = NULL;
3481 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms);
3493 } _OrthancPluginBufferCompression;
3520 _OrthancPluginBufferCompression params;
3521 params.target = target;
3522 params.source = source;
3524 params.compression = compression;
3525 params.uncompress = uncompress;
3527 return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms);
3536 } _OrthancPluginReadFile;
3554 _OrthancPluginReadFile params;
3555 params.target = target;
3557 return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms);
3567 } _OrthancPluginWriteFile;
3586 _OrthancPluginWriteFile params;
3590 return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms);
3597 const char** target;
3599 } _OrthancPluginGetErrorDescription;
3615 const char* result = NULL;
3617 _OrthancPluginGetErrorDescription params;
3618 params.target = &result;
3619 params.error = error;
3624 return "Unknown error code";
3640 } _OrthancPluginSendHttpStatus;
3671 _OrthancPluginSendHttpStatus params;
3672 params.output = output;
3673 params.status = status;
3675 params.bodySize = bodySize;
3676 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms);
3684 uint32_t* resultUint32;
3686 void** resultBuffer;
3687 } _OrthancPluginGetImageInfo;
3706 _OrthancPluginGetImageInfo params;
3707 memset(¶ms, 0,
sizeof(params));
3708 params.image = image;
3709 params.resultPixelFormat = ⌖
3739 _OrthancPluginGetImageInfo params;
3740 memset(¶ms, 0,
sizeof(params));
3741 params.image = image;
3742 params.resultUint32 = &width;
3772 _OrthancPluginGetImageInfo params;
3773 memset(¶ms, 0,
sizeof(params));
3774 params.image = image;
3775 params.resultUint32 = &height;
3807 _OrthancPluginGetImageInfo params;
3808 memset(¶ms, 0,
sizeof(params));
3809 params.image = image;
3810 params.resultUint32 = &pitch;
3839 void* target = NULL;
3841 _OrthancPluginGetImageInfo params;
3842 memset(¶ms, 0,
sizeof(params));
3843 params.resultBuffer = ⌖
3844 params.image = image;
3863 } _OrthancPluginUncompressImage;
3886 _OrthancPluginUncompressImage params;
3887 memset(¶ms, 0,
sizeof(params));
3888 params.target = ⌖
3891 params.format = format;
3909 } _OrthancPluginFreeImage;
3924 _OrthancPluginFreeImage params;
3925 params.image = image;
3927 context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms);
3943 } _OrthancPluginCompressImage;
3974 _OrthancPluginCompressImage params;
3975 memset(¶ms, 0,
sizeof(params));
3976 params.target = target;
3978 params.pixelFormat = format;
3979 params.width = width;
3980 params.height = height;
3981 params.pitch = pitch;
3982 params.buffer = buffer;
3985 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4020 _OrthancPluginCompressImage params;
4021 memset(¶ms, 0,
sizeof(params));
4022 params.target = target;
4024 params.pixelFormat = format;
4025 params.width = width;
4026 params.height = height;
4027 params.pitch = pitch;
4028 params.buffer = buffer;
4029 params.quality = quality;
4031 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4067 _OrthancPluginCompressAndAnswerImage params;
4068 params.output = output;
4070 params.pixelFormat = format;
4071 params.width = width;
4072 params.height = height;
4073 params.pitch = pitch;
4074 params.buffer = buffer;
4075 params.quality = quality;
4076 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
4087 const char* username;
4088 const char* password;
4091 } _OrthancPluginCallHttpClient;
4114 const char* username,
4115 const char* password)
4117 _OrthancPluginCallHttpClient params;
4118 memset(¶ms, 0,
sizeof(params));
4120 params.target = target;
4123 params.username = username;
4124 params.password = password;
4126 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4154 const char* username,
4155 const char* password)
4157 _OrthancPluginCallHttpClient params;
4158 memset(¶ms, 0,
sizeof(params));
4160 params.target = target;
4164 params.bodySize = bodySize;
4165 params.username = username;
4166 params.password = password;
4168 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4196 const char* username,
4197 const char* password)
4199 _OrthancPluginCallHttpClient params;
4200 memset(¶ms, 0,
sizeof(params));
4202 params.target = target;
4206 params.bodySize = bodySize;
4207 params.username = username;
4208 params.password = password;
4210 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4231 const char* username,
4232 const char* password)
4234 _OrthancPluginCallHttpClient params;
4235 memset(¶ms, 0,
sizeof(params));
4239 params.username = username;
4240 params.password = password;
4242 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4252 } _OrthancPluginConvertPixelFormat;
4273 _OrthancPluginConvertPixelFormat params;
4274 params.target = ⌖
4275 params.source = source;
4276 params.targetFormat = targetFormat;
4306 _OrthancPluginReturnSingleValue params;
4307 memset(¶ms, 0,
sizeof(params));
4308 params.resultUint32 = &count;
4329 } _OrthancPluginGetFontInfo;
4345 const char* result = NULL;
4347 _OrthancPluginGetFontInfo params;
4348 memset(¶ms, 0,
sizeof(params));
4349 params.name = &result;
4350 params.fontIndex = fontIndex;
4379 _OrthancPluginGetFontInfo params;
4380 memset(¶ms, 0,
sizeof(params));
4381 params.size = &result;
4382 params.fontIndex = fontIndex;
4400 const char* utf8Text;
4406 } _OrthancPluginDrawText;
4430 const char* utf8Text,
4437 _OrthancPluginDrawText params;
4438 memset(¶ms, 0,
sizeof(params));
4439 params.image = image;
4440 params.fontIndex = fontIndex;
4441 params.utf8Text = utf8Text;
4448 return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms);
4457 const void* content;
4460 } _OrthancPluginStorageAreaCreate;
4482 const void* content,
4486 _OrthancPluginStorageAreaCreate params;
4487 params.storageArea = storageArea;
4489 params.content = content;
4493 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms);
4503 } _OrthancPluginStorageAreaRead;
4527 _OrthancPluginStorageAreaRead params;
4528 params.target = target;
4529 params.storageArea = storageArea;
4533 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms);
4542 } _OrthancPluginStorageAreaRemove;
4563 _OrthancPluginStorageAreaRemove params;
4564 params.storageArea = storageArea;
4568 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms);
4577 uint16_t httpStatus;
4578 const char* message;
4579 } _OrthancPluginRegisterErrorCode;
4599 uint16_t httpStatus,
4600 const char* message)
4604 _OrthancPluginRegisterErrorCode params;
4605 params.target = ⌖
4607 params.httpStatus = httpStatus;
4608 params.message = message;
4629 uint32_t minMultiplicity;
4630 uint32_t maxMultiplicity;
4631 } _OrthancPluginRegisterDictionaryTag;
4658 uint32_t minMultiplicity,
4659 uint32_t maxMultiplicity)
4661 _OrthancPluginRegisterDictionaryTag params;
4662 params.group = group;
4663 params.element = element;
4666 params.minMultiplicity = minMultiplicity;
4667 params.maxMultiplicity = maxMultiplicity;
4669 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, ¶ms);
4680 uint32_t minMultiplicity;
4681 uint32_t maxMultiplicity;
4682 const char* privateCreator;
4683 } _OrthancPluginRegisterPrivateDictionaryTag;
4711 uint32_t minMultiplicity,
4712 uint32_t maxMultiplicity,
4713 const char* privateCreator)
4715 _OrthancPluginRegisterPrivateDictionaryTag params;
4716 params.group = group;
4717 params.element = element;
4720 params.minMultiplicity = minMultiplicity;
4721 params.maxMultiplicity = maxMultiplicity;
4722 params.privateCreator = privateCreator;
4724 return context->InvokeService(context, _OrthancPluginService_RegisterPrivateDictionaryTag, ¶ms);
4733 } _OrthancPluginReconstructMainDicomTags;
4754 _OrthancPluginReconstructMainDicomTags params;
4755 params.level = level;
4756 params.storageArea = storageArea;
4758 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, ¶ms);
4765 const char* instanceId;
4770 uint32_t maxStringLength;
4771 } _OrthancPluginDicomToJson;
4799 uint32_t maxStringLength)
4803 _OrthancPluginDicomToJson params;
4804 memset(¶ms, 0,
sizeof(params));
4805 params.result = &result;
4806 params.buffer = buffer;
4808 params.format = format;
4809 params.flags = flags;
4810 params.maxStringLength = maxStringLength;
4844 const char* instanceId,
4847 uint32_t maxStringLength)
4851 _OrthancPluginDicomToJson params;
4852 memset(¶ms, 0,
sizeof(params));
4853 params.result = &result;
4854 params.instanceId = instanceId;
4855 params.format = format;
4856 params.flags = flags;
4857 params.maxStringLength = maxStringLength;
4875 uint32_t headersCount;
4876 const char*
const* headersKeys;
4877 const char*
const* headersValues;
4878 int32_t afterPlugins;
4879 } _OrthancPluginRestApiGet2;
4904 uint32_t headersCount,
4905 const char*
const* headersKeys,
4906 const char*
const* headersValues,
4907 int32_t afterPlugins)
4909 _OrthancPluginRestApiGet2 params;
4910 params.target = target;
4912 params.headersCount = headersCount;
4913 params.headersKeys = headersKeys;
4914 params.headersValues = headersValues;
4915 params.afterPlugins = afterPlugins;
4917 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, ¶ms);
4925 } _OrthancPluginWorklistCallback;
4942 _OrthancPluginWorklistCallback params;
4943 params.callback = callback;
4945 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, ¶ms);
4956 } _OrthancPluginWorklistAnswersOperation;
4981 _OrthancPluginWorklistAnswersOperation params;
4982 params.answers = answers;
4983 params.query = query;
4984 params.dicom = dicom;
4987 return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, ¶ms);
5008 _OrthancPluginWorklistAnswersOperation params;
5009 params.answers = answers;
5010 params.query = NULL;
5011 params.dicom = NULL;
5014 return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, ¶ms);
5025 } _OrthancPluginWorklistQueryOperation;
5048 int32_t isMatch = 0;
5050 _OrthancPluginWorklistQueryOperation params;
5051 params.query = query;
5052 params.dicom = dicom;
5054 params.isMatch = &isMatch;
5055 params.target = NULL;
5086 _OrthancPluginWorklistQueryOperation params;
5087 params.query = query;
5088 params.dicom = NULL;
5090 params.isMatch = NULL;
5091 params.target = target;
5093 return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, ¶ms);
5113 _OrthancPluginAccessDicomInstance params;
5114 memset(¶ms, 0,
sizeof(params));
5115 params.resultOrigin = &origin;
5116 params.instance = instance;
5136 } _OrthancPluginCreateDicom;
5163 _OrthancPluginCreateDicom params;
5164 params.target = target;
5166 params.pixelData = pixelData;
5167 params.flags = flags;
5169 return context->InvokeService(context, _OrthancPluginService_CreateDicom, ¶ms);
5176 } _OrthancPluginDecodeImageCallback;
5193 _OrthancPluginDecodeImageCallback params;
5194 params.callback = callback;
5196 return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, ¶ms);
5209 const void* constBuffer;
5210 uint32_t bufferSize;
5211 uint32_t frameIndex;
5212 } _OrthancPluginCreateImage;
5235 _OrthancPluginCreateImage params;
5236 memset(¶ms, 0,
sizeof(params));
5237 params.target = ⌖
5238 params.format = format;
5239 params.width = width;
5240 params.height = height;
5280 _OrthancPluginCreateImage params;
5281 memset(¶ms, 0,
sizeof(params));
5282 params.target = ⌖
5283 params.format = format;
5284 params.width = width;
5285 params.height = height;
5286 params.pitch = pitch;
5287 params.buffer = buffer;
5318 uint32_t bufferSize,
5319 uint32_t frameIndex)
5323 _OrthancPluginCreateImage params;
5324 memset(¶ms, 0,
sizeof(params));
5325 params.target = ⌖
5326 params.constBuffer = buffer;
5327 params.bufferSize = bufferSize;
5328 params.frameIndex = frameIndex;
5347 } _OrthancPluginComputeHash;
5368 _OrthancPluginComputeHash params;
5369 params.result = &result;
5370 params.buffer = buffer;
5404 _OrthancPluginComputeHash params;
5405 params.result = &result;
5406 params.buffer = buffer;
5426 } _OrthancPluginLookupDictionary;
5448 _OrthancPluginLookupDictionary params;
5449 params.target = target;
5451 return context->InvokeService(context, _OrthancPluginService_LookupDictionary, ¶ms);
5460 uint32_t answerSize;
5461 uint32_t headersCount;
5462 const char*
const* headersKeys;
5463 const char*
const* headersValues;
5464 } _OrthancPluginSendMultipartItem2;
5490 uint32_t answerSize,
5491 uint32_t headersCount,
5492 const char*
const* headersKeys,
5493 const char*
const* headersValues)
5495 _OrthancPluginSendMultipartItem2 params;
5496 params.output = output;
5497 params.answer = answer;
5498 params.answerSize = answerSize;
5499 params.headersCount = headersCount;
5500 params.headersKeys = headersKeys;
5501 params.headersValues = headersValues;
5503 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem2, ¶ms);
5510 } _OrthancPluginIncomingHttpRequestFilter;
5528 _OrthancPluginIncomingHttpRequestFilter params;
5529 params.callback = callback;
5531 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter, ¶ms);
5540 uint16_t* httpStatus;
5543 uint32_t headersCount;
5544 const char*
const* headersKeys;
5545 const char*
const* headersValues;
5548 const char* username;
5549 const char* password;
5551 const char* certificateFile;
5552 const char* certificateKeyFile;
5553 const char* certificateKeyPassword;
5555 } _OrthancPluginCallHttpClient2;
5602 uint16_t* httpStatus,
5605 uint32_t headersCount,
5606 const char*
const* headersKeys,
5607 const char*
const* headersValues,
5610 const char* username,
5611 const char* password,
5613 const char* certificateFile,
5614 const char* certificateKeyFile,
5615 const char* certificateKeyPassword,
5618 _OrthancPluginCallHttpClient2 params;
5619 memset(¶ms, 0,
sizeof(params));
5621 params.answerBody = answerBody;
5622 params.answerHeaders = answerHeaders;
5623 params.httpStatus = httpStatus;
5624 params.method = method;
5626 params.headersCount = headersCount;
5627 params.headersKeys = headersKeys;
5628 params.headersValues = headersValues;
5630 params.bodySize = bodySize;
5631 params.username = username;
5632 params.password = password;
5633 params.timeout = timeout;
5634 params.certificateFile = certificateFile;
5635 params.certificateKeyFile = certificateKeyFile;
5636 params.certificateKeyPassword = certificateKeyPassword;
5637 params.pkcs11 = pkcs11;
5639 return context->InvokeService(context, _OrthancPluginService_CallHttpClient2, ¶ms);
5658 _OrthancPluginRetrieveDynamicString params;
5659 params.result = &result;
5660 params.argument = NULL;
5679 } _OrthancPluginFindCallback;
5696 _OrthancPluginFindCallback params;
5697 params.callback = callback;
5699 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback, ¶ms);
5710 uint32_t *resultUint32;
5711 uint16_t *resultGroup;
5712 uint16_t *resultElement;
5713 char **resultString;
5714 } _OrthancPluginFindOperation;
5737 _OrthancPluginFindOperation params;
5738 memset(¶ms, 0,
sizeof(params));
5739 params.answers = answers;
5740 params.dicom = dicom;
5743 return context->InvokeService(context, _OrthancPluginService_FindAddAnswer, ¶ms);
5764 _OrthancPluginFindOperation params;
5765 memset(¶ms, 0,
sizeof(params));
5766 params.answers = answers;
5768 return context->InvokeService(context, _OrthancPluginService_FindMarkIncomplete, ¶ms);
5790 _OrthancPluginFindOperation params;
5791 memset(¶ms, 0,
sizeof(params));
5792 params.query = query;
5793 params.resultUint32 = &count;
5828 _OrthancPluginFindOperation params;
5829 memset(¶ms, 0,
sizeof(params));
5830 params.query = query;
5831 params.index = index;
5832 params.resultGroup = group;
5833 params.resultElement = element;
5835 return context->InvokeService(context, _OrthancPluginService_GetFindQueryTag, ¶ms);
5859 _OrthancPluginFindOperation params;
5860 memset(¶ms, 0,
sizeof(params));
5861 params.query = query;
5862 params.index = index;
5863 params.resultString = &result;
5897 _OrthancPluginFindOperation params;
5898 memset(¶ms, 0,
sizeof(params));
5899 params.query = query;
5900 params.index = index;
5901 params.resultString = &result;
5923 } _OrthancPluginMoveCallback;
5945 _OrthancPluginMoveCallback params;
5946 params.callback = callback;
5947 params.getMoveSize = getMoveSize;
5948 params.applyMove = applyMove;
5949 params.freeMove = freeMove;
5951 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback, ¶ms);
5961 } _OrthancPluginCreateFindMatcher;
5984 _OrthancPluginCreateFindMatcher params;
5985 memset(¶ms, 0,
sizeof(params));
5986 params.target = ⌖
5987 params.query = query;
6004 } _OrthancPluginFreeFindMatcher;
6019 _OrthancPluginFreeFindMatcher params;
6020 params.matcher = matcher;
6022 context->InvokeService(context, _OrthancPluginService_FreeFindMatcher, ¶ms);
6032 } _OrthancPluginFindMatcherIsMatch;
6054 int32_t isMatch = 0;
6056 _OrthancPluginFindMatcherIsMatch params;
6057 params.matcher = matcher;
6058 params.dicom = dicom;
6060 params.isMatch = &isMatch;
6077 } _OrthancPluginIncomingHttpRequestFilter2;
6094 _OrthancPluginIncomingHttpRequestFilter2 params;
6095 params.callback = callback;
6097 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter2, ¶ms);
6105 } _OrthancPluginGetPeers;
6123 _OrthancPluginGetPeers params;
6124 memset(¶ms, 0,
sizeof(params));
6125 params.peers = &peers;
6141 } _OrthancPluginFreePeers;
6156 _OrthancPluginFreePeers params;
6157 params.peers = peers;
6159 context->InvokeService(context, _OrthancPluginService_FreePeers, ¶ms);
6167 } _OrthancPluginGetPeersCount;
6186 uint32_t target = 0;
6188 _OrthancPluginGetPeersCount params;
6189 memset(¶ms, 0,
sizeof(params));
6190 params.target = ⌖
6191 params.peers = peers;
6207 const char** target;
6210 const char* userProperty;
6211 } _OrthancPluginGetPeerProperty;
6235 const char* target = NULL;
6237 _OrthancPluginGetPeerProperty params;
6238 memset(¶ms, 0,
sizeof(params));
6239 params.target = ⌖
6240 params.peers = peers;
6241 params.peerIndex = peerIndex;
6242 params.userProperty = NULL;
6276 const char* target = NULL;
6278 _OrthancPluginGetPeerProperty params;
6279 memset(¶ms, 0,
sizeof(params));
6280 params.target = ⌖
6281 params.peers = peers;
6282 params.peerIndex = peerIndex;
6283 params.userProperty = NULL;
6321 const char* userProperty)
6323 const char* target = NULL;
6325 _OrthancPluginGetPeerProperty params;
6326 memset(¶ms, 0,
sizeof(params));
6327 params.target = ⌖
6328 params.peers = peers;
6329 params.peerIndex = peerIndex;
6330 params.userProperty = userProperty;
6349 uint16_t* httpStatus;
6354 uint32_t additionalHeadersCount;
6355 const char*
const* additionalHeadersKeys;
6356 const char*
const* additionalHeadersValues;
6360 } _OrthancPluginCallPeerApi;
6401 uint16_t* httpStatus,
6406 uint32_t additionalHeadersCount,
6407 const char*
const* additionalHeadersKeys,
6408 const char*
const* additionalHeadersValues,
6413 _OrthancPluginCallPeerApi params;
6414 memset(¶ms, 0,
sizeof(params));
6416 params.answerBody = answerBody;
6417 params.answerHeaders = answerHeaders;
6418 params.httpStatus = httpStatus;
6419 params.peers = peers;
6420 params.peerIndex = peerIndex;
6421 params.method = method;
6423 params.additionalHeadersCount = additionalHeadersCount;
6424 params.additionalHeadersKeys = additionalHeadersKeys;
6425 params.additionalHeadersValues = additionalHeadersValues;
6427 params.bodySize = bodySize;
6428 params.timeout = timeout;
6430 return context->InvokeService(context, _OrthancPluginService_CallPeerApi, ¶ms);
6449 } _OrthancPluginCreateJob;
6496 _OrthancPluginCreateJob params;
6497 memset(¶ms, 0,
sizeof(params));
6499 params.target = ⌖
6501 params.finalize = finalize;
6503 params.getProgress = getProgress;
6504 params.getContent = getContent;
6505 params.getSerialized = getSerialized;
6508 params.reset = reset;
6526 } _OrthancPluginFreeJob;
6541 _OrthancPluginFreeJob params;
6544 context->InvokeService(context, _OrthancPluginService_FreeJob, ¶ms);
6554 } _OrthancPluginSubmitJob;
6574 char* resultId = NULL;
6576 _OrthancPluginSubmitJob params;
6577 memset(¶ms, 0,
sizeof(params));
6579 params.resultId = &resultId;
6581 params.priority = priority;
6600 } _OrthancPluginJobsUnserializer;
6618 _OrthancPluginJobsUnserializer params;
6619 params.unserializer = unserializer;
6621 context->InvokeService(context, _OrthancPluginService_RegisterJobsUnserializer, ¶ms);
6629 const char* details;
6631 } _OrthancPluginSetHttpErrorDetails;
6653 const char* details,
6656 _OrthancPluginSetHttpErrorDetails params;
6657 params.output = output;
6658 params.details = details;
6660 context->InvokeService(context, _OrthancPluginService_SetHttpErrorDetails, ¶ms);
6667 const char** result;
6668 const char* argument;
6669 } _OrthancPluginRetrieveStaticString;
6686 const char* result = NULL;
6688 _OrthancPluginRetrieveStaticString params;
6689 params.result = &result;
6690 params.argument = path;
6710 } _OrthancPluginSetMetricsValue;
6732 _OrthancPluginSetMetricsValue params;
6734 params.value = value;
6736 context->InvokeService(context, _OrthancPluginService_SetMetricsValue, ¶ms);
6744 } _OrthancPluginRegisterRefreshMetricsCallback;
6760 _OrthancPluginRegisterRefreshMetricsCallback params;
6761 params.callback = callback;
6762 context->InvokeService(context, _OrthancPluginService_RegisterRefreshMetricsCallback, ¶ms);
6774 } _OrthancPluginEncodeDicomWeb;
6797 char* target = NULL;
6799 _OrthancPluginEncodeDicomWeb params;
6800 params.target = ⌖
6801 params.dicom = dicom;
6802 params.dicomSize = dicomSize;
6803 params.callback = callback;
6838 char* target = NULL;
6840 _OrthancPluginEncodeDicomWeb params;
6841 params.target = ⌖
6842 params.dicom = dicom;
6843 params.dicomSize = dicomSize;
6844 params.callback = callback;
6948 typedef const void* (*OrthancPluginChunkedClientRequestGetChunkData) (
void* request);
6972 uint16_t* httpStatus;
6975 uint32_t headersCount;
6976 const char*
const* headersKeys;
6977 const char*
const* headersValues;
6983 const char* username;
6984 const char* password;
6986 const char* certificateFile;
6987 const char* certificateKeyFile;
6988 const char* certificateKeyPassword;
6990 } _OrthancPluginChunkedHttpClient;
7048 uint16_t* httpStatus,
7051 uint32_t headersCount,
7052 const char*
const* headersKeys,
7053 const char*
const* headersValues,
7059 const char* username,
7060 const char* password,
7062 const char* certificateFile,
7063 const char* certificateKeyFile,
7064 const char* certificateKeyPassword,
7067 _OrthancPluginChunkedHttpClient params;
7068 memset(¶ms, 0,
sizeof(params));
7071 params.httpStatus = httpStatus;
7072 params.method = method;
7074 params.headersCount = headersCount;
7075 params.headersKeys = headersKeys;
7076 params.headersValues = headersValues;
7077 params.username = username;
7078 params.password = password;
7079 params.timeout = timeout;
7080 params.certificateFile = certificateFile;
7081 params.certificateKeyFile = certificateKeyFile;
7082 params.certificateKeyPassword = certificateKeyPassword;
7083 params.pkcs11 = pkcs11;
7086 params.answer = answer;
7087 params.answerAddChunk = answerAddChunk;
7088 params.answerAddHeader = answerAddHeader;
7089 params.request = request;
7090 params.requestIsDone = requestIsDone;
7091 params.requestChunkData = requestChunkData;
7092 params.requestChunkSize = requestChunkSize;
7093 params.requestNext = requestNext;
7095 return context->InvokeService(context, _OrthancPluginService_ChunkedHttpClient, ¶ms);
7185 const char* pathRegularExpression;
7193 } _OrthancPluginChunkedRestCallback;
7227 const char* pathRegularExpression,
7236 _OrthancPluginChunkedRestCallback params;
7237 params.pathRegularExpression = pathRegularExpression;
7238 params.getHandler = getHandler;
7239 params.postHandler = postHandler;
7240 params.deleteHandler = deleteHandler;
7241 params.putHandler = putHandler;
7242 params.addChunk = addChunk;
7243 params.execute = execute;
7244 params.finalize = finalize;
7246 context->InvokeService(context, _OrthancPluginService_RegisterChunkedRestCallback, ¶ms);
7258 const char* privateCreator;
7259 } _OrthancPluginGetTagName;
7280 const char* privateCreator)
7284 _OrthancPluginGetTagName params;
7285 params.result = &result;
7286 params.group = group;
7287 params.element = element;
7288 params.privateCreator = privateCreator;
7334 const char* transactionUid,
7335 const char*
const* sopClassUids,
7336 const char*
const* sopInstanceUids,
7337 uint32_t countInstances,
7338 const char* remoteAet,
7339 const char* calledAet);
7377 const char* sopClassUid,
7378 const char* sopInstanceUid);
7386 } _OrthancPluginRegisterStorageCommitmentScpCallback;
7407 _OrthancPluginRegisterStorageCommitmentScpCallback params;
7408 params.factory = factory;
7409 params.destructor = destructor;
7410 params.lookup = lookup;
7411 context->InvokeService(context, _OrthancPluginService_RegisterStorageCommitmentScpCallback, ¶ms);
Definition: OrthancCPlugin.h:701
OrthancPluginImage * OrthancPluginConvertPixelFormat(OrthancPluginContext *context, const OrthancPluginImage *source, OrthancPluginPixelFormat targetFormat)
Change the pixel format of an image.
Definition: OrthancCPlugin.h:4263
uint32_t(* OrthancPluginGetMoveSize)(void *moveDriver)
Callback to read the size of a C-Move driver.
Definition: OrthancCPlugin.h:1384
OrthancPluginInstanceOrigin OrthancPluginGetInstanceOrigin(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the origin of a DICOM file.
Definition: OrthancCPlugin.h:5104
int OrthancPluginCheckVersion(OrthancPluginContext *context)
Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
Definition: OrthancCPlugin.h:1775
Definition: OrthancCPlugin.h:726
void OrthancPluginRegisterOnStoredInstanceCallback(OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback)
Register a callback for received instances.
Definition: OrthancCPlugin.h:1946
Definition: OrthancCPlugin.h:709
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:3661
OrthancPluginErrorCode OrthancPluginFindAddAnswer(OrthancPluginContext *context, OrthancPluginFindAnswers *answers, const void *dicom, uint32_t size)
Add one answer to some C-Find request.
Definition: OrthancCPlugin.h:5728
void OrthancPluginAnswerBuffer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const void *answer, uint32_t answerSize, const char *mimeType)
Answer to a REST request.
Definition: OrthancCPlugin.h:1978
Color image in RGBA32 format.
Definition: OrthancCPlugin.h:612
Definition: OrthancCPlugin.h:706
OrthancPluginErrorCode OrthancPluginRestApiDelete(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2240
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:2324
Color image in BGRA32 format.
Definition: OrthancCPlugin.h:646
Graylevel, floating-point 32bpp image.
Definition: OrthancCPlugin.h:638
OrthancPluginImage * OrthancPluginCreateImage(OrthancPluginContext *context, OrthancPluginPixelFormat format, uint32_t width, uint32_t height)
Create an image.
Definition: OrthancCPlugin.h:5224
char * OrthancPluginLookupSeries(OrthancPluginContext *context, const char *seriesUID)
Look for a series.
Definition: OrthancCPlugin.h:2495
Definition: OrthancCPlugin.h:708
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:4054
OrthancPluginImageFormat
Definition: OrthancCPlugin.h:737
OrthancPluginErrorCode OrthancPluginStorageAreaRead(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Read a file from the storage area.
Definition: OrthancCPlugin.h:4517
OrthancPluginErrorCode OrthancPluginRegisterDecodeImageCallback(OrthancPluginContext *context, OrthancPluginDecodeImageCallback callback)
Register a callback to handle the decoding of DICOM images.
Definition: OrthancCPlugin.h:5186
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:2211
Definition: OrthancCPlugin.h:697
The parameters of a REST request.
Definition: OrthancCPlugin.h:334
const char * OrthancPluginGetInstanceRemoteAet(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the AET of a DICOM instance.
Definition: OrthancCPlugin.h:2712
uint32_t OrthancPluginGetImageWidth(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the width of an image.
Definition: OrthancCPlugin.h:3730
Definition: OrthancCPlugin.h:699
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:1231
Definition: OrthancCPlugin.h:711
uint32_t OrthancPluginGetImagePitch(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pitch of an image.
Definition: OrthancCPlugin.h:3798
char * OrthancPluginGetInstanceJson(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file.
Definition: OrthancCPlugin.h:2814
OrthancPluginErrorCode(* OrthancPluginRestCallback)(OrthancPluginRestOutput *output, const char *url, const OrthancPluginHttpRequest *request)
Signature of a callback function that answers to a REST request.
Definition: OrthancCPlugin.h:1095
OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, OrthancPluginResourceType level)
Reconstruct the main DICOM tags.
Definition: OrthancCPlugin.h:4746
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:5818
OrthancPluginCompressionType
Definition: OrthancCPlugin.h:722
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:5521
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:3962
Definition: OrthancCPlugin.h:700
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:4423
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:4971
Graylevel 8bpp image.
Definition: OrthancCPlugin.h:580
struct _OrthancPluginStorageArea_t OrthancPluginStorageArea
Opaque structure that represents the storage area that is actually used by Orthanc.
Definition: OrthancCPlugin.h:1022
void OrthancPluginSendHttpStatusCode(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status)
Send a HTTP status code.
Definition: OrthancCPlugin.h:2575
OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:2263
void(* OrthancPluginRefreshMetricsCallback)()
Callback executed to update the metrics of the plugin.
Definition: OrthancCPlugin.h:1562
Definition: OrthancCPlugin.h:614
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter2(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter2 callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:6087
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:4897
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:1116
char * OrthancPluginLookupStudyWithAccessionNumber(OrthancPluginContext *context, const char *accessionNumber)
Look for a study, using the accession number.
Definition: OrthancCPlugin.h:2460
Definition: OrthancCPlugin.h:725
struct _OrthancPluginWorklistQuery_t OrthancPluginWorklistQuery
Opaque structure to an object that represents a C-Find query for worklists.
Definition: OrthancCPlugin.h:1030
Definition: OrthancCPlugin.h:740
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:1149
OrthancPluginErrorCode OrthancPluginRestApiGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2109
Definition: OrthancCPlugin.h:724
Color image in RGB48 format.
Definition: OrthancCPlugin.h:622
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:2035
int64_t OrthancPluginGetInstanceSize(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the size of a DICOM file.
Definition: OrthancCPlugin.h:2745
Definition: OrthancCPlugin.h:705
OrthancPluginErrorCode(* OrthancPluginStorageCreate)(const char *uuid, const void *content, int64_t size, OrthancPluginContentType type)
Callback for writing to the storage area.
Definition: OrthancCPlugin.h:1168
OrthancPluginErrorCode OrthancPluginSendMultipartItem(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *answer, uint32_t answerSize)
Send an item as a part of some HTTP multipart answer.
Definition: OrthancCPlugin.h:3467
const char * OrthancPluginGetInstanceData(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the data of a DICOM file.
Definition: OrthancCPlugin.h:2778
Definition: OrthancCPlugin.h:727
OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *subType, const char *contentType)
Start an HTTP multipart answer.
Definition: OrthancCPlugin.h:3438
void * OrthancPluginGetImageBuffer(OrthancPluginContext *context, const OrthancPluginImage *image)
Return a pointer to the content of an image.
Definition: OrthancCPlugin.h:3832
OrthancPluginErrorCode(* OrthancPluginStorageRemove)(const char *uuid, OrthancPluginContentType type)
Callback for removing a file from the storage area.
Definition: OrthancCPlugin.h:1212
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:2288
uint32_t OrthancPluginGetFontsCount(OrthancPluginContext *context)
Return the number of available fonts.
Definition: OrthancCPlugin.h:4298
void OrthancPluginRegisterStorageCommitmentScpCallback(OrthancPluginContext *context, OrthancPluginStorageCommitmentFactory factory, OrthancPluginStorageCommitmentDestructor destructor, OrthancPluginStorageCommitmentLookup lookup)
Register a callback to handle incoming requests to the storage commitment SCP.
Definition: OrthancCPlugin.h:7398
Definition: OrthancCPlugin.h:704
char * OrthancPluginGetInstanceSimplifiedJson(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file (with simplification).
Definition: OrthancCPlugin.h:2852
uint32_t OrthancPluginGetExpectedDatabaseVersion(OrthancPluginContext *context)
Get the expected version of the database schema.
Definition: OrthancCPlugin.h:3364
void OrthancPluginRegisterOnChangeCallback(OrthancPluginContext *context, OrthancPluginOnChangeCallback callback)
Register a callback to monitor changes.
Definition: OrthancCPlugin.h:3119
Definition: OrthancCPlugin.h:707
Definition: OrthancCPlugin.h:702
const char * OrthancPluginGetInstanceMetadata(OrthancPluginContext *context, OrthancPluginDicomInstance *instance, const char *metadata)
Get the value of some metadata associated with a given DICOM instance.
Definition: OrthancCPlugin.h:2932
OrthancPluginErrorCode OrthancPluginRegisterWorklistCallback(OrthancPluginContext *context, OrthancPluginWorklistCallback callback)
Register a callback to handle modality worklists requests.
Definition: OrthancCPlugin.h:4935
uint32_t OrthancPluginGetFontSize(OrthancPluginContext *context, uint32_t fontIndex)
Return the size of a font.
Definition: OrthancCPlugin.h:4370
OrthancPluginErrorCode OrthancPluginSetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *value)
Set the value of a global property.
Definition: OrthancCPlugin.h:3267
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:1127
void OrthancPluginRegisterRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback.
Definition: OrthancCPlugin.h:1878
Definition: OrthancCPlugin.h:698
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:1359
Definition: OrthancCPlugin.h:741
char * OrthancPluginGetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *defaultValue)
Get the value of a global property.
Definition: OrthancCPlugin.h:3228
uint32_t OrthancPluginGetImageHeight(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the height of an image.
Definition: OrthancCPlugin.h:3763
Color image in RGB24 format.
Definition: OrthancCPlugin.h:604
struct _OrthancPluginFindAnswers_t OrthancPluginFindAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1054
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:984
Graylevel, signed 16bpp image.
Definition: OrthancCPlugin.h:596
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:4007
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:4475
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:7371
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:7222
OrthancPluginErrorCode OrthancPluginRegisterMoveCallback(OrthancPluginContext *context, OrthancPluginMoveCallback callback, OrthancPluginGetMoveSize getMoveSize, OrthancPluginApplyMove applyMove, OrthancPluginFreeMove freeMove)
Register a callback to handle C-Move requests.
Definition: OrthancCPlugin.h:5935
void OrthancPluginRegisterJobsUnserializer(OrthancPluginContext *context, OrthancPluginJobsUnserializer unserializer)
Register an unserializer for custom jobs.
Definition: OrthancCPlugin.h:6611
Definition: OrthancCPlugin.h:712
Graylevel, unsigned 64bpp image.
Definition: OrthancCPlugin.h:654
OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pixel format of an image.
Definition: OrthancCPlugin.h:3697
void(* OrthancPluginFree)(void *buffer)
Signature of a function to free dynamic memory.
Definition: OrthancCPlugin.h:1139
void OrthancPluginRedirect(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *redirection)
Redirect a REST request.
Definition: OrthancCPlugin.h:2358
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:5849
OrthancPluginErrorCode OrthancPluginWorklistMarkIncomplete(OrthancPluginContext *context, OrthancPluginWorklistAnswers *answers)
Mark the set of worklist answers as incomplete.
Definition: OrthancCPlugin.h:5001
OrthancPluginErrorCode(* OrthancPluginStorageRead)(void **content, int64_t *size, const char *uuid, OrthancPluginContentType type)
Callback for reading from the storage area.
Definition: OrthancCPlugin.h:1194
OrthancPluginJob *(* OrthancPluginJobsUnserializer)(const char *jobType, const char *serialized)
Callback executed to unserialize a custom job.
Definition: OrthancCPlugin.h:1544
Definition: OrthancCPlugin.h:710
A memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:979
struct _OrthancPluginWorklistAnswers_t OrthancPluginWorklistAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1038
OrthancPluginErrorCode OrthancPluginRegisterFindCallback(OrthancPluginContext *context, OrthancPluginFindCallback callback)
Register a callback to handle C-Find requests.
Definition: OrthancCPlugin.h:5689
struct _OrthancPluginImage_t OrthancPluginImage
Opaque structure that represents an image that is uncompressed in memory.
Definition: OrthancCPlugin.h:1014
OrthancPluginErrorCode(* OrthancPluginFindCallback)(OrthancPluginFindAnswers *answers, const OrthancPluginFindQuery *query, const char *issuerAet, const char *calledAet)
Callback to handle incoming C-Find SCP requests.
Definition: OrthancCPlugin.h:1316
void OrthancPluginFreeImage(OrthancPluginContext *context, OrthancPluginImage *image)
Free an image.
Definition: OrthancCPlugin.h:3917
void(* OrthancPluginFreeMove)(void *moveDriver)
Callback to free one C-Move driver.
Definition: OrthancCPlugin.h:1413
const char * OrthancPluginGetFontName(OrthancPluginContext *context, uint32_t fontIndex)
Return the name of a font.
Definition: OrthancCPlugin.h:4338
void OrthancPluginSetCookie(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *cookie, const char *value)
Set a cookie.
Definition: OrthancCPlugin.h:2651
OrthancPluginErrorCode(* OrthancPluginApplyMove)(void *moveDriver)
Callback to apply one C-Move suboperation.
Definition: OrthancCPlugin.h:1399
Graylevel, unsigned 32bpp image.
Definition: OrthancCPlugin.h:630
void OrthancPluginRegisterRefreshMetricsCallback(OrthancPluginContext *context, OrthancPluginRefreshMetricsCallback callback)
Register a callback to refresh the metrics.
Definition: OrthancCPlugin.h:6753
Definition: OrthancCPlugin.h:703
An entry in the dictionary of DICOM tags.
Definition: OrthancCPlugin.h:1621
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:5267
char * OrthancPluginLookupPatient(OrthancPluginContext *context, const char *patientID)
Look for a patient.
Definition: OrthancCPlugin.h:2390
char * OrthancPluginLookupInstance(OrthancPluginContext *context, const char *sopInstanceUID)
Look for an instance.
Definition: OrthancCPlugin.h:2530
OrthancPluginChangeType
Definition: OrthancCPlugin.h:695
OrthancPluginImage * OrthancPluginUncompressImage(OrthancPluginContext *context, const void *data, uint32_t size, OrthancPluginImageFormat format)
Decode a compressed image.
Definition: OrthancCPlugin.h:3875
void OrthancPluginRegisterRestCallbackNoLock(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback, without locking.
Definition: OrthancCPlugin.h:1918
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:1670
int32_t OrthancPluginWorklistIsMatch(OrthancPluginContext *context, const OrthancPluginWorklistQuery *query, const void *dicom, uint32_t size)
Test whether a worklist matches the query.
Definition: OrthancCPlugin.h:5039
uint32_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:989
OrthancPluginErrorCode OrthancPluginStorageAreaRemove(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Remove a file from the storage area.
Definition: OrthancCPlugin.h:4554
uint32_t OrthancPluginGetFindQuerySize(OrthancPluginContext *context, const OrthancPluginFindQuery *query)
Get the number of tags in a C-Find query.
Definition: OrthancCPlugin.h:5781
int OrthancPluginHasInstanceMetadata(OrthancPluginContext *context, OrthancPluginDicomInstance *instance, const char *metadata)
Check whether a DICOM instance is associated with some metadata.
Definition: OrthancCPlugin.h:2891
OrthancPluginErrorCode OrthancPluginFindMarkIncomplete(OrthancPluginContext *context, OrthancPluginFindAnswers *answers)
Mark the set of C-Find answers as incomplete.
Definition: OrthancCPlugin.h:5757
struct _OrthancPluginFindQuery_t OrthancPluginFindQuery
Opaque structure to an object that represents a C-Find query.
Definition: OrthancCPlugin.h:1046
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:1590
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:3509
OrthancPluginErrorCode OrthancPluginGetDicomForInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *instanceId)
Retrieve a DICOM instance using its Orthanc identifier.
Definition: OrthancCPlugin.h:2076
OrthancPluginErrorCode(* OrthancPluginOnStoredInstanceCallback)(OrthancPluginDicomInstance *instance, const char *instanceId)
Signature of a callback function that is triggered when Orthanc receives a DICOM instance.
Definition: OrthancCPlugin.h:1106
OrthancPluginErrorCode OrthancPluginWorklistGetDicomQuery(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginWorklistQuery *query)
Retrieve the worklist query as a DICOM file.
Definition: OrthancCPlugin.h:5078
void OrthancPluginSetHttpErrorDetails(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *details, uint8_t log)
Provide a detailed description for an HTTP error.
Definition: OrthancCPlugin.h:6647
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:2176
void OrthancPluginRegisterStorageArea(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove)
Register a custom storage area.
Definition: OrthancCPlugin.h:2980
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:7328
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:2139
OrthancPluginErrorCode OrthancPluginSendMultipartItem2(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *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:5483
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:5887
Definition: OrthancCPlugin.h:739
OrthancPluginPixelFormat
Definition: OrthancCPlugin.h:572
void OrthancPluginSendUnauthorized(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *realm)
Signal that a REST request is not authorized.
Definition: OrthancCPlugin.h:2598
Graylevel, unsigned 16bpp image.
Definition: OrthancCPlugin.h:588
void OrthancPluginSendMethodNotAllowed(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *allowedMethods)
Signal that this URI does not support this HTTP method.
Definition: OrthancCPlugin.h:2621
void(* OrthancPluginStorageCommitmentDestructor)(void *handler)
Callback to free one storage commitment SCP handler.
Definition: OrthancCPlugin.h:7350
void OrthancPluginSetHttpHeader(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *key, const char *value)
Set some HTTP header.
Definition: OrthancCPlugin.h:2676
char * OrthancPluginLookupStudy(OrthancPluginContext *context, const char *studyUID)
Look for a study.
Definition: OrthancCPlugin.h:2425
OrthancPluginImage * OrthancPluginDecodeDicomImage(OrthancPluginContext *context, const void *buffer, uint32_t bufferSize, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:5312