114# define ORTHANC_PLUGINS_API __declspec(dllexport)
116# define ORTHANC_PLUGINS_API __attribute__ ((visibility ("default")))
118# define ORTHANC_PLUGINS_API
121#define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 1
122#define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 12
123#define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 2
126#if !defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE)
127#define ORTHANC_PLUGINS_VERSION_IS_ABOVE(major, minor, revision) \
128 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER > major || \
129 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER == major && \
130 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER > minor || \
131 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER == minor && \
132 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER >= revision))))
151#ifndef ORTHANC_PLUGIN_INLINE
152# if __STDC_VERSION__ >= 199901L
154# define ORTHANC_PLUGIN_INLINE static inline
155# elif defined(__cplusplus)
157# define ORTHANC_PLUGIN_INLINE static inline
158# elif defined(__GNUC__)
160# define ORTHANC_PLUGIN_INLINE static __inline
161# elif defined(_MSC_VER)
163# define ORTHANC_PLUGIN_INLINE static __inline
165# error Your compiler is not known to support the "inline" keyword
312 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
320 ORTHANC_PLUGINS_API
const char* OrthancPluginGetName();
333 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
409 _OrthancPluginService_LogInfo = 1,
410 _OrthancPluginService_LogWarning = 2,
411 _OrthancPluginService_LogError = 3,
412 _OrthancPluginService_GetOrthancPath = 4,
413 _OrthancPluginService_GetOrthancDirectory = 5,
414 _OrthancPluginService_GetConfigurationPath = 6,
415 _OrthancPluginService_SetPluginProperty = 7,
416 _OrthancPluginService_GetGlobalProperty = 8,
417 _OrthancPluginService_SetGlobalProperty = 9,
418 _OrthancPluginService_GetCommandLineArgumentsCount = 10,
419 _OrthancPluginService_GetCommandLineArgument = 11,
420 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
421 _OrthancPluginService_GetConfiguration = 13,
422 _OrthancPluginService_BufferCompression = 14,
423 _OrthancPluginService_ReadFile = 15,
424 _OrthancPluginService_WriteFile = 16,
425 _OrthancPluginService_GetErrorDescription = 17,
426 _OrthancPluginService_CallHttpClient = 18,
427 _OrthancPluginService_RegisterErrorCode = 19,
428 _OrthancPluginService_RegisterDictionaryTag = 20,
429 _OrthancPluginService_DicomBufferToJson = 21,
430 _OrthancPluginService_DicomInstanceToJson = 22,
431 _OrthancPluginService_CreateDicom = 23,
432 _OrthancPluginService_ComputeMd5 = 24,
433 _OrthancPluginService_ComputeSha1 = 25,
434 _OrthancPluginService_LookupDictionary = 26,
435 _OrthancPluginService_CallHttpClient2 = 27,
436 _OrthancPluginService_GenerateUuid = 28,
437 _OrthancPluginService_RegisterPrivateDictionaryTag = 29,
438 _OrthancPluginService_AutodetectMimeType = 30,
439 _OrthancPluginService_SetMetricsValue = 31,
440 _OrthancPluginService_EncodeDicomWebJson = 32,
441 _OrthancPluginService_EncodeDicomWebXml = 33,
442 _OrthancPluginService_ChunkedHttpClient = 34,
443 _OrthancPluginService_GetTagName = 35,
444 _OrthancPluginService_EncodeDicomWebJson2 = 36,
445 _OrthancPluginService_EncodeDicomWebXml2 = 37,
446 _OrthancPluginService_CreateMemoryBuffer = 38,
447 _OrthancPluginService_GenerateRestApiAuthorizationToken = 39,
448 _OrthancPluginService_CreateMemoryBuffer64 = 40,
449 _OrthancPluginService_CreateDicom2 = 41,
450 _OrthancPluginService_GetDatabaseServerIdentifier = 42,
451 _OrthancPluginService_SetMetricsIntegerValue = 43,
452 _OrthancPluginService_SetCurrentThreadName = 44,
456 _OrthancPluginService_RegisterRestCallback = 1000,
457 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
458 _OrthancPluginService_RegisterStorageArea = 1002,
459 _OrthancPluginService_RegisterOnChangeCallback = 1003,
460 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
461 _OrthancPluginService_RegisterWorklistCallback = 1005,
462 _OrthancPluginService_RegisterDecodeImageCallback = 1006,
463 _OrthancPluginService_RegisterIncomingHttpRequestFilter = 1007,
464 _OrthancPluginService_RegisterFindCallback = 1008,
465 _OrthancPluginService_RegisterMoveCallback = 1009,
466 _OrthancPluginService_RegisterIncomingHttpRequestFilter2 = 1010,
467 _OrthancPluginService_RegisterRefreshMetricsCallback = 1011,
468 _OrthancPluginService_RegisterChunkedRestCallback = 1012,
469 _OrthancPluginService_RegisterStorageCommitmentScpCallback = 1013,
470 _OrthancPluginService_RegisterIncomingDicomInstanceFilter = 1014,
471 _OrthancPluginService_RegisterTranscoderCallback = 1015,
472 _OrthancPluginService_RegisterStorageArea2 = 1016,
473 _OrthancPluginService_RegisterIncomingCStoreInstanceFilter = 1017,
474 _OrthancPluginService_RegisterReceivedInstanceCallback = 1018,
475 _OrthancPluginService_RegisterWebDavCollection = 1019,
478 _OrthancPluginService_AnswerBuffer = 2000,
479 _OrthancPluginService_CompressAndAnswerPngImage = 2001,
480 _OrthancPluginService_Redirect = 2002,
481 _OrthancPluginService_SendHttpStatusCode = 2003,
482 _OrthancPluginService_SendUnauthorized = 2004,
483 _OrthancPluginService_SendMethodNotAllowed = 2005,
484 _OrthancPluginService_SetCookie = 2006,
485 _OrthancPluginService_SetHttpHeader = 2007,
486 _OrthancPluginService_StartMultipartAnswer = 2008,
487 _OrthancPluginService_SendMultipartItem = 2009,
488 _OrthancPluginService_SendHttpStatus = 2010,
489 _OrthancPluginService_CompressAndAnswerImage = 2011,
490 _OrthancPluginService_SendMultipartItem2 = 2012,
491 _OrthancPluginService_SetHttpErrorDetails = 2013,
494 _OrthancPluginService_GetDicomForInstance = 3000,
495 _OrthancPluginService_RestApiGet = 3001,
496 _OrthancPluginService_RestApiPost = 3002,
497 _OrthancPluginService_RestApiDelete = 3003,
498 _OrthancPluginService_RestApiPut = 3004,
499 _OrthancPluginService_LookupPatient = 3005,
500 _OrthancPluginService_LookupStudy = 3006,
501 _OrthancPluginService_LookupSeries = 3007,
502 _OrthancPluginService_LookupInstance = 3008,
503 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
504 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
505 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
506 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
507 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
508 _OrthancPluginService_ReconstructMainDicomTags = 3014,
509 _OrthancPluginService_RestApiGet2 = 3015,
510 _OrthancPluginService_CallRestApi = 3016,
513 _OrthancPluginService_GetInstanceRemoteAet = 4000,
514 _OrthancPluginService_GetInstanceSize = 4001,
515 _OrthancPluginService_GetInstanceData = 4002,
516 _OrthancPluginService_GetInstanceJson = 4003,
517 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
518 _OrthancPluginService_HasInstanceMetadata = 4005,
519 _OrthancPluginService_GetInstanceMetadata = 4006,
520 _OrthancPluginService_GetInstanceOrigin = 4007,
521 _OrthancPluginService_GetInstanceTransferSyntaxUid = 4008,
522 _OrthancPluginService_HasInstancePixelData = 4009,
523 _OrthancPluginService_CreateDicomInstance = 4010,
524 _OrthancPluginService_FreeDicomInstance = 4011,
525 _OrthancPluginService_GetInstanceFramesCount = 4012,
526 _OrthancPluginService_GetInstanceRawFrame = 4013,
527 _OrthancPluginService_GetInstanceDecodedFrame = 4014,
528 _OrthancPluginService_TranscodeDicomInstance = 4015,
529 _OrthancPluginService_SerializeDicomInstance = 4016,
530 _OrthancPluginService_GetInstanceAdvancedJson = 4017,
531 _OrthancPluginService_GetInstanceDicomWebJson = 4018,
532 _OrthancPluginService_GetInstanceDicomWebXml = 4019,
533 _OrthancPluginService_LoadDicomInstance = 4020,
536 _OrthancPluginService_RegisterDatabaseBackend = 5000,
537 _OrthancPluginService_DatabaseAnswer = 5001,
538 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002,
539 _OrthancPluginService_StorageAreaCreate = 5003,
540 _OrthancPluginService_StorageAreaRead = 5004,
541 _OrthancPluginService_StorageAreaRemove = 5005,
542 _OrthancPluginService_RegisterDatabaseBackendV3 = 5006,
543 _OrthancPluginService_RegisterDatabaseBackendV4 = 5007,
546 _OrthancPluginService_GetImagePixelFormat = 6000,
547 _OrthancPluginService_GetImageWidth = 6001,
548 _OrthancPluginService_GetImageHeight = 6002,
549 _OrthancPluginService_GetImagePitch = 6003,
550 _OrthancPluginService_GetImageBuffer = 6004,
551 _OrthancPluginService_UncompressImage = 6005,
552 _OrthancPluginService_FreeImage = 6006,
553 _OrthancPluginService_CompressImage = 6007,
554 _OrthancPluginService_ConvertPixelFormat = 6008,
555 _OrthancPluginService_GetFontsCount = 6009,
556 _OrthancPluginService_GetFontInfo = 6010,
557 _OrthancPluginService_DrawText = 6011,
558 _OrthancPluginService_CreateImage = 6012,
559 _OrthancPluginService_CreateImageAccessor = 6013,
560 _OrthancPluginService_DecodeDicomImage = 6014,
563 _OrthancPluginService_WorklistAddAnswer = 7000,
564 _OrthancPluginService_WorklistMarkIncomplete = 7001,
565 _OrthancPluginService_WorklistIsMatch = 7002,
566 _OrthancPluginService_WorklistGetDicomQuery = 7003,
567 _OrthancPluginService_FindAddAnswer = 7004,
568 _OrthancPluginService_FindMarkIncomplete = 7005,
569 _OrthancPluginService_GetFindQuerySize = 7006,
570 _OrthancPluginService_GetFindQueryTag = 7007,
571 _OrthancPluginService_GetFindQueryTagName = 7008,
572 _OrthancPluginService_GetFindQueryValue = 7009,
573 _OrthancPluginService_CreateFindMatcher = 7010,
574 _OrthancPluginService_FreeFindMatcher = 7011,
575 _OrthancPluginService_FindMatcherIsMatch = 7012,
578 _OrthancPluginService_GetPeers = 8000,
579 _OrthancPluginService_FreePeers = 8001,
580 _OrthancPluginService_GetPeersCount = 8003,
581 _OrthancPluginService_GetPeerName = 8004,
582 _OrthancPluginService_GetPeerUrl = 8005,
583 _OrthancPluginService_CallPeerApi = 8006,
584 _OrthancPluginService_GetPeerUserProperty = 8007,
587 _OrthancPluginService_CreateJob = 9000,
588 _OrthancPluginService_FreeJob = 9001,
589 _OrthancPluginService_SubmitJob = 9002,
590 _OrthancPluginService_RegisterJobsUnserializer = 9003,
591 _OrthancPluginService_CreateJob2 = 9004,
593 _OrthancPluginService_INTERNAL = 0x7fffffff
594 } _OrthancPluginService;
599 _OrthancPluginProperty_Description = 1,
600 _OrthancPluginProperty_RootUri = 2,
601 _OrthancPluginProperty_OrthancExplorer = 3,
603 _OrthancPluginProperty_INTERNAL = 0x7fffffff
604 } _OrthancPluginProperty;
696 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
711 _OrthancPluginContentType_INTERNAL = 0x7fffffff
727 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
758 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
773 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
787 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
825 _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff
840 _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff
861 _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff
876 _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff
892 _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff
908 _OrthancPluginConstraintType_INTERNAL = 0x7fffffff
924 _OrthancPluginInstanceOrigin_INTERNAL = 0x7fffffff
1041 _OrthancPluginReceivedInstanceAction_INTERNAL = 0x7fffffff
1069 _OrthancPluginLoadDicomInstanceMode_INTERNAL = 0x7fffffff
1232 const char* instanceId);
1243 const char* resourceId);
1254 const uint32_t size,
1255 uint32_t frameIndex);
1276 const char* bulkDataUri);
1294 const void* content,
1366 uint64_t rangeStart);
1402 const char* issuerAet,
1403 const char* calledAet);
1434 uint32_t headersCount,
1435 const char*
const* headersKeys,
1436 const char*
const* headersValues);
1469 uint32_t headersCount,
1470 const char*
const* headersKeys,
1471 const char*
const* headersValues,
1472 uint32_t getArgumentsCount,
1473 const char*
const* getArgumentsKeys,
1474 const char*
const* getArgumentsValues);
1495 const char* issuerAet,
1496 const char* calledAet);
1535 typedef void* (*OrthancPluginMoveCallback) (
1537 const char* patientId,
1538 const char* accessionNumber,
1539 const char* studyInstanceUid,
1540 const char* seriesInstanceUid,
1541 const char* sopInstanceUid,
1542 const char* originatorAet,
1543 const char* sourceAet,
1544 const char* targetAet,
1545 uint16_t originatorId);
1631 typedef const char* (*OrthancPluginJobGetContent) (
void* job);
1669 typedef const char* (*OrthancPluginJobGetSerialized) (
void* job);
1763 const char* serialized);
1812 uint32_t levelDepth,
1813 const uint16_t* levelTagGroup,
1814 const uint16_t* levelTagElement,
1815 const uint32_t* levelIndex,
1817 uint16_t tagElement,
1850 uint32_t levelDepth,
1851 const uint16_t* levelTagGroup,
1852 const uint16_t* levelTagElement,
1853 const uint32_t* levelIndex,
1855 uint16_t tagElement,
1864 typedef struct _OrthancPluginContext_t
1866 void* pluginsManager;
1867 const char* orthancVersion;
1870 _OrthancPluginService service,
1871 const void* params);
1930 int32_t expectedMajor,
1931 int32_t expectedMinor,
1932 int32_t expectedRevision)
1934 int32_t major, minor, revision;
1936 if (
sizeof(
int) !=
sizeof(int32_t) ||
1939 sizeof(int32_t) !=
sizeof(_OrthancPluginService) ||
1940 sizeof(int32_t) !=
sizeof(_OrthancPluginProperty) ||
1965 if (!strcmp(context->orthancVersion,
"mainline"))
1977 (context->orthancVersion,
"%4d.%4d.%4d", &major, &minor, &revision) != 3)
1984 if (major > expectedMajor)
1989 if (major < expectedMajor)
1996 if (minor > expectedMinor)
2001 if (minor < expectedMinor)
2008 if (revision >= expectedRevision)
2040 ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER,
2041 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER,
2042 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER);
2058 context->Free(buffer->
data);
2074 context->Free(buffer->
data);
2088 const char* message)
2090 context->InvokeService(context, _OrthancPluginService_LogError, message);
2104 const char* message)
2106 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
2120 const char* message)
2122 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
2129 const char* pathRegularExpression;
2131 } _OrthancPluginRestCallback;
2156 const char* pathRegularExpression,
2159 _OrthancPluginRestCallback params;
2160 params.pathRegularExpression = pathRegularExpression;
2161 params.callback = callback;
2162 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
2196 const char* pathRegularExpression,
2199 _OrthancPluginRestCallback params;
2200 params.pathRegularExpression = pathRegularExpression;
2201 params.callback = callback;
2202 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms);
2210 } _OrthancPluginOnStoredInstanceCallback;
2236 _OrthancPluginOnStoredInstanceCallback params;
2237 params.callback = callback;
2239 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
2248 uint32_t answerSize;
2249 const char* mimeType;
2250 } _OrthancPluginAnswerBuffer;
2268 uint32_t answerSize,
2269 const char* mimeType)
2271 _OrthancPluginAnswerBuffer params;
2272 params.output = output;
2273 params.answer = answer;
2274 params.answerSize = answerSize;
2275 params.mimeType = mimeType;
2276 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms);
2288 } _OrthancPluginCompressAndAnswerPngImage;
2300 } _OrthancPluginCompressAndAnswerImage;
2330 _OrthancPluginCompressAndAnswerImage params;
2331 params.output = output;
2333 params.pixelFormat = format;
2334 params.width = width;
2335 params.height = height;
2336 params.pitch = pitch;
2337 params.buffer = buffer;
2339 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
2347 const char* instanceId;
2348 } _OrthancPluginGetDicomForInstance;
2365 const char* instanceId)
2367 _OrthancPluginGetDicomForInstance params;
2368 params.target = target;
2369 params.instanceId = instanceId;
2370 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
2379 } _OrthancPluginRestApiGet;
2400 _OrthancPluginRestApiGet params;
2401 params.target = target;
2403 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
2430 _OrthancPluginRestApiGet params;
2431 params.target = target;
2433 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms);
2444 } _OrthancPluginRestApiPostPut;
2469 _OrthancPluginRestApiPostPut params;
2470 params.target = target;
2473 params.bodySize = bodySize;
2474 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
2504 _OrthancPluginRestApiPostPut params;
2505 params.target = target;
2508 params.bodySize = bodySize;
2509 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms);
2530 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
2553 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
2581 _OrthancPluginRestApiPostPut params;
2582 params.target = target;
2585 params.bodySize = bodySize;
2586 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
2617 _OrthancPluginRestApiPostPut params;
2618 params.target = target;
2621 params.bodySize = bodySize;
2622 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms);
2630 const char* argument;
2631 } _OrthancPluginOutputPlusArgument;
2647 const char* redirection)
2649 _OrthancPluginOutputPlusArgument params;
2650 params.output = output;
2651 params.argument = redirection;
2652 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
2660 const char* argument;
2661 } _OrthancPluginRetrieveDynamicString;
2678 const char* patientID)
2682 _OrthancPluginRetrieveDynamicString params;
2683 params.result = &result;
2684 params.argument = patientID;
2713 const char* studyUID)
2717 _OrthancPluginRetrieveDynamicString params;
2718 params.result = &result;
2719 params.argument = studyUID;
2748 const char* accessionNumber)
2752 _OrthancPluginRetrieveDynamicString params;
2753 params.result = &result;
2754 params.argument = accessionNumber;
2783 const char* seriesUID)
2787 _OrthancPluginRetrieveDynamicString params;
2788 params.result = &result;
2789 params.argument = seriesUID;
2818 const char* sopInstanceUID)
2822 _OrthancPluginRetrieveDynamicString params;
2823 params.result = &result;
2824 params.argument = sopInstanceUID;
2843 } _OrthancPluginSendHttpStatusCode;
2866 _OrthancPluginSendHttpStatusCode params;
2867 params.output = output;
2868 params.status = status;
2869 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
2889 _OrthancPluginOutputPlusArgument params;
2890 params.output = output;
2891 params.argument = realm;
2892 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
2910 const char* allowedMethods)
2912 _OrthancPluginOutputPlusArgument params;
2913 params.output = output;
2914 params.argument = allowedMethods;
2915 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
2924 } _OrthancPluginSetHttpHeader;
2943 _OrthancPluginSetHttpHeader params;
2944 params.output = output;
2945 params.key = cookie;
2946 params.value = value;
2947 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
2968 _OrthancPluginSetHttpHeader params;
2969 params.output = output;
2971 params.value = value;
2972 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
2978 char** resultStringToFree;
2979 const char** resultString;
2980 int64_t* resultInt64;
2984 } _OrthancPluginAccessDicomInstance;
3004 _OrthancPluginAccessDicomInstance params;
3005 memset(¶ms, 0,
sizeof(params));
3006 params.resultString = &result;
3007 params.instance = instance;
3037 _OrthancPluginAccessDicomInstance params;
3038 memset(¶ms, 0,
sizeof(params));
3039 params.resultInt64 = &size;
3040 params.instance = instance;
3070 _OrthancPluginAccessDicomInstance params;
3071 memset(¶ms, 0,
sizeof(params));
3072 params.resultString = &result;
3073 params.instance = instance;
3106 _OrthancPluginAccessDicomInstance params;
3107 memset(¶ms, 0,
sizeof(params));
3108 params.resultStringToFree = &result;
3109 params.instance = instance;
3144 _OrthancPluginAccessDicomInstance params;
3145 memset(¶ms, 0,
sizeof(params));
3146 params.resultStringToFree = &result;
3147 params.instance = instance;
3180 const char* metadata)
3184 _OrthancPluginAccessDicomInstance params;
3185 memset(¶ms, 0,
sizeof(params));
3186 params.resultInt64 = &result;
3187 params.instance = instance;
3188 params.key = metadata;
3197 return (result != 0);
3221 const char* metadata)
3225 _OrthancPluginAccessDicomInstance params;
3226 memset(¶ms, 0,
sizeof(params));
3227 params.resultString = &result;
3228 params.instance = instance;
3229 params.key = metadata;
3250 } _OrthancPluginRegisterStorageArea;
3273 _OrthancPluginRegisterStorageArea params;
3274 params.create = create;
3276 params.remove = remove;
3279 params.free = ::free;
3284 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
3303 _OrthancPluginRetrieveDynamicString params;
3304 params.result = &result;
3305 params.argument = NULL;
3333 _OrthancPluginRetrieveDynamicString params;
3334 params.result = &result;
3335 params.argument = NULL;
3368 _OrthancPluginRetrieveDynamicString params;
3369 params.result = &result;
3370 params.argument = NULL;
3388 } _OrthancPluginOnChangeCallback;
3414 _OrthancPluginOnChangeCallback params;
3415 params.callback = callback;
3417 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms);
3425 _OrthancPluginProperty property;
3427 } _OrthancPluginSetPluginProperty;
3445 _OrthancPluginSetPluginProperty params;
3446 params.plugin = OrthancPluginGetName();
3447 params.property = _OrthancPluginProperty_RootUri;
3450 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3465 const char* description)
3467 _OrthancPluginSetPluginProperty params;
3468 params.plugin = OrthancPluginGetName();
3469 params.property = _OrthancPluginProperty_Description;
3470 params.value = description;
3472 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3487 const char* javascript)
3489 _OrthancPluginSetPluginProperty params;
3490 params.plugin = OrthancPluginGetName();
3491 params.property = _OrthancPluginProperty_OrthancExplorer;
3492 params.value = javascript;
3494 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3503 } _OrthancPluginGlobalProperty;
3522 const char* defaultValue)
3526 _OrthancPluginGlobalProperty params;
3527 params.result = &result;
3528 params.property = property;
3529 params.value = defaultValue;
3563 _OrthancPluginGlobalProperty params;
3564 params.result = NULL;
3565 params.property = property;
3566 params.value = value;
3568 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms);
3575 int32_t *resultInt32;
3576 uint32_t *resultUint32;
3577 int64_t *resultInt64;
3578 uint64_t *resultUint64;
3579 } _OrthancPluginReturnSingleValue;
3594 _OrthancPluginReturnSingleValue params;
3595 memset(¶ms, 0,
sizeof(params));
3596 params.resultUint32 = &count;
3629 _OrthancPluginGlobalProperty params;
3630 params.result = &result;
3631 params.property = (int32_t) argument;
3632 params.value = NULL;
3660 _OrthancPluginReturnSingleValue params;
3661 memset(¶ms, 0,
sizeof(params));
3662 params.resultUint32 = &count;
3692 _OrthancPluginRetrieveDynamicString params;
3693 params.result = &result;
3694 params.argument = NULL;
3712 const char* subType;
3713 const char* contentType;
3714 } _OrthancPluginStartMultipartAnswer;
3732 const char* subType,
3733 const char* contentType)
3735 _OrthancPluginStartMultipartAnswer params;
3736 params.output = output;
3737 params.subType = subType;
3738 params.contentType = contentType;
3739 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms);
3762 uint32_t answerSize)
3764 _OrthancPluginAnswerBuffer params;
3765 params.output = output;
3766 params.answer = answer;
3767 params.answerSize = answerSize;
3768 params.mimeType = NULL;
3769 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms);
3781 } _OrthancPluginBufferCompression;
3808 _OrthancPluginBufferCompression params;
3809 params.target = target;
3810 params.source = source;
3812 params.compression = compression;
3813 params.uncompress = uncompress;
3815 return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms);
3824 } _OrthancPluginReadFile;
3842 _OrthancPluginReadFile params;
3843 params.target = target;
3845 return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms);
3855 } _OrthancPluginWriteFile;
3874 _OrthancPluginWriteFile params;
3878 return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms);
3885 const char** target;
3887 } _OrthancPluginGetErrorDescription;
3903 const char* result = NULL;
3905 _OrthancPluginGetErrorDescription params;
3906 params.target = &result;
3907 params.error = error;
3912 return "Unknown error code";
3928 } _OrthancPluginSendHttpStatus;
3959 _OrthancPluginSendHttpStatus params;
3960 params.output = output;
3961 params.status = status;
3963 params.bodySize = bodySize;
3964 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms);
3972 uint32_t* resultUint32;
3974 void** resultBuffer;
3975 } _OrthancPluginGetImageInfo;
3994 _OrthancPluginGetImageInfo params;
3995 memset(¶ms, 0,
sizeof(params));
3996 params.image = image;
3997 params.resultPixelFormat = ⌖
4027 _OrthancPluginGetImageInfo params;
4028 memset(¶ms, 0,
sizeof(params));
4029 params.image = image;
4030 params.resultUint32 = &width;
4060 _OrthancPluginGetImageInfo params;
4061 memset(¶ms, 0,
sizeof(params));
4062 params.image = image;
4063 params.resultUint32 = &height;
4095 _OrthancPluginGetImageInfo params;
4096 memset(¶ms, 0,
sizeof(params));
4097 params.image = image;
4098 params.resultUint32 = &pitch;
4127 void* target = NULL;
4129 _OrthancPluginGetImageInfo params;
4130 memset(¶ms, 0,
sizeof(params));
4131 params.resultBuffer = ⌖
4132 params.image = image;
4151 } _OrthancPluginUncompressImage;
4174 _OrthancPluginUncompressImage params;
4175 memset(¶ms, 0,
sizeof(params));
4176 params.target = ⌖
4179 params.format = format;
4197 } _OrthancPluginFreeImage;
4212 _OrthancPluginFreeImage params;
4213 params.image = image;
4215 context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms);
4231 } _OrthancPluginCompressImage;
4262 _OrthancPluginCompressImage params;
4263 memset(¶ms, 0,
sizeof(params));
4264 params.target = target;
4266 params.pixelFormat = format;
4267 params.width = width;
4268 params.height = height;
4269 params.pitch = pitch;
4270 params.buffer = buffer;
4273 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4308 _OrthancPluginCompressImage params;
4309 memset(¶ms, 0,
sizeof(params));
4310 params.target = target;
4312 params.pixelFormat = format;
4313 params.width = width;
4314 params.height = height;
4315 params.pitch = pitch;
4316 params.buffer = buffer;
4317 params.quality = quality;
4319 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4355 _OrthancPluginCompressAndAnswerImage params;
4356 params.output = output;
4358 params.pixelFormat = format;
4359 params.width = width;
4360 params.height = height;
4361 params.pitch = pitch;
4362 params.buffer = buffer;
4363 params.quality = quality;
4364 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
4375 const char* username;
4376 const char* password;
4379 } _OrthancPluginCallHttpClient;
4402 const char* username,
4403 const char* password)
4405 _OrthancPluginCallHttpClient params;
4406 memset(¶ms, 0,
sizeof(params));
4408 params.target = target;
4411 params.username = username;
4412 params.password = password;
4414 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4442 const char* username,
4443 const char* password)
4445 _OrthancPluginCallHttpClient params;
4446 memset(¶ms, 0,
sizeof(params));
4448 params.target = target;
4452 params.bodySize = bodySize;
4453 params.username = username;
4454 params.password = password;
4456 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4484 const char* username,
4485 const char* password)
4487 _OrthancPluginCallHttpClient params;
4488 memset(¶ms, 0,
sizeof(params));
4490 params.target = target;
4494 params.bodySize = bodySize;
4495 params.username = username;
4496 params.password = password;
4498 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4519 const char* username,
4520 const char* password)
4522 _OrthancPluginCallHttpClient params;
4523 memset(¶ms, 0,
sizeof(params));
4527 params.username = username;
4528 params.password = password;
4530 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4540 } _OrthancPluginConvertPixelFormat;
4561 _OrthancPluginConvertPixelFormat params;
4562 params.target = ⌖
4563 params.source = source;
4564 params.targetFormat = targetFormat;
4594 _OrthancPluginReturnSingleValue params;
4595 memset(¶ms, 0,
sizeof(params));
4596 params.resultUint32 = &count;
4617 } _OrthancPluginGetFontInfo;
4633 const char* result = NULL;
4635 _OrthancPluginGetFontInfo params;
4636 memset(¶ms, 0,
sizeof(params));
4637 params.name = &result;
4638 params.fontIndex = fontIndex;
4667 _OrthancPluginGetFontInfo params;
4668 memset(¶ms, 0,
sizeof(params));
4669 params.size = &result;
4670 params.fontIndex = fontIndex;
4688 const char* utf8Text;
4694 } _OrthancPluginDrawText;
4718 const char* utf8Text,
4725 _OrthancPluginDrawText params;
4726 memset(¶ms, 0,
sizeof(params));
4727 params.image = image;
4728 params.fontIndex = fontIndex;
4729 params.utf8Text = utf8Text;
4736 return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms);
4745 const void* content;
4748 } _OrthancPluginStorageAreaCreate;
4772 const void* content,
4776 _OrthancPluginStorageAreaCreate params;
4777 params.storageArea = storageArea;
4779 params.content = content;
4783 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms);
4793 } _OrthancPluginStorageAreaRead;
4819 _OrthancPluginStorageAreaRead params;
4820 params.target = target;
4821 params.storageArea = storageArea;
4825 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms);
4834 } _OrthancPluginStorageAreaRemove;
4857 _OrthancPluginStorageAreaRemove params;
4858 params.storageArea = storageArea;
4862 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms);
4871 uint16_t httpStatus;
4872 const char* message;
4873 } _OrthancPluginRegisterErrorCode;
4893 uint16_t httpStatus,
4894 const char* message)
4898 _OrthancPluginRegisterErrorCode params;
4899 params.target = ⌖
4901 params.httpStatus = httpStatus;
4902 params.message = message;
4923 uint32_t minMultiplicity;
4924 uint32_t maxMultiplicity;
4925 } _OrthancPluginRegisterDictionaryTag;
4952 uint32_t minMultiplicity,
4953 uint32_t maxMultiplicity)
4955 _OrthancPluginRegisterDictionaryTag params;
4956 params.group = group;
4957 params.element = element;
4960 params.minMultiplicity = minMultiplicity;
4961 params.maxMultiplicity = maxMultiplicity;
4963 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, ¶ms);
4974 uint32_t minMultiplicity;
4975 uint32_t maxMultiplicity;
4976 const char* privateCreator;
4977 } _OrthancPluginRegisterPrivateDictionaryTag;
5005 uint32_t minMultiplicity,
5006 uint32_t maxMultiplicity,
5007 const char* privateCreator)
5009 _OrthancPluginRegisterPrivateDictionaryTag params;
5010 params.group = group;
5011 params.element = element;
5014 params.minMultiplicity = minMultiplicity;
5015 params.maxMultiplicity = maxMultiplicity;
5016 params.privateCreator = privateCreator;
5018 return context->InvokeService(context, _OrthancPluginService_RegisterPrivateDictionaryTag, ¶ms);
5027 } _OrthancPluginReconstructMainDicomTags;
5048 _OrthancPluginReconstructMainDicomTags params;
5049 params.level = level;
5050 params.storageArea = storageArea;
5052 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, ¶ms);
5059 const char* instanceId;
5064 uint32_t maxStringLength;
5065 } _OrthancPluginDicomToJson;
5093 uint32_t maxStringLength)
5097 _OrthancPluginDicomToJson params;
5098 memset(¶ms, 0,
sizeof(params));
5099 params.result = &result;
5100 params.buffer = buffer;
5102 params.format = format;
5103 params.flags = flags;
5104 params.maxStringLength = maxStringLength;
5138 const char* instanceId,
5141 uint32_t maxStringLength)
5145 _OrthancPluginDicomToJson params;
5146 memset(¶ms, 0,
sizeof(params));
5147 params.result = &result;
5148 params.instanceId = instanceId;
5149 params.format = format;
5150 params.flags = flags;
5151 params.maxStringLength = maxStringLength;
5169 uint32_t headersCount;
5170 const char*
const* headersKeys;
5171 const char*
const* headersValues;
5172 int32_t afterPlugins;
5173 } _OrthancPluginRestApiGet2;
5198 uint32_t headersCount,
5199 const char*
const* headersKeys,
5200 const char*
const* headersValues,
5201 int32_t afterPlugins)
5203 _OrthancPluginRestApiGet2 params;
5204 params.target = target;
5206 params.headersCount = headersCount;
5207 params.headersKeys = headersKeys;
5208 params.headersValues = headersValues;
5209 params.afterPlugins = afterPlugins;
5211 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, ¶ms);
5219 } _OrthancPluginWorklistCallback;
5236 _OrthancPluginWorklistCallback params;
5237 params.callback = callback;
5239 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, ¶ms);
5250 } _OrthancPluginWorklistAnswersOperation;
5275 _OrthancPluginWorklistAnswersOperation params;
5276 params.answers = answers;
5277 params.query = query;
5278 params.dicom = dicom;
5281 return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, ¶ms);
5302 _OrthancPluginWorklistAnswersOperation params;
5303 params.answers = answers;
5304 params.query = NULL;
5305 params.dicom = NULL;
5308 return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, ¶ms);
5319 } _OrthancPluginWorklistQueryOperation;
5342 int32_t isMatch = 0;
5344 _OrthancPluginWorklistQueryOperation params;
5345 params.query = query;
5346 params.dicom = dicom;
5348 params.isMatch = &isMatch;
5349 params.target = NULL;
5380 _OrthancPluginWorklistQueryOperation params;
5381 params.query = query;
5382 params.dicom = NULL;
5384 params.isMatch = NULL;
5385 params.target = target;
5387 return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, ¶ms);
5407 _OrthancPluginAccessDicomInstance params;
5408 memset(¶ms, 0,
sizeof(params));
5409 params.resultOrigin = &origin;
5410 params.instance = instance;
5430 } _OrthancPluginCreateDicom;
5464 _OrthancPluginCreateDicom params;
5465 params.target = target;
5467 params.pixelData = pixelData;
5468 params.flags = flags;
5470 return context->InvokeService(context, _OrthancPluginService_CreateDicom, ¶ms);
5477 } _OrthancPluginDecodeImageCallback;
5497 _OrthancPluginDecodeImageCallback params;
5498 params.callback = callback;
5500 return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, ¶ms);
5513 const void* constBuffer;
5514 uint32_t bufferSize;
5515 uint32_t frameIndex;
5516 } _OrthancPluginCreateImage;
5539 _OrthancPluginCreateImage params;
5540 memset(¶ms, 0,
sizeof(params));
5541 params.target = ⌖
5542 params.format = format;
5543 params.width = width;
5544 params.height = height;
5584 _OrthancPluginCreateImage params;
5585 memset(¶ms, 0,
sizeof(params));
5586 params.target = ⌖
5587 params.format = format;
5588 params.width = width;
5589 params.height = height;
5590 params.pitch = pitch;
5591 params.buffer = buffer;
5623 uint32_t bufferSize,
5624 uint32_t frameIndex)
5628 _OrthancPluginCreateImage params;
5629 memset(¶ms, 0,
sizeof(params));
5630 params.target = ⌖
5631 params.constBuffer = buffer;
5632 params.bufferSize = bufferSize;
5633 params.frameIndex = frameIndex;
5652 } _OrthancPluginComputeHash;
5673 _OrthancPluginComputeHash params;
5674 params.result = &result;
5675 params.buffer = buffer;
5709 _OrthancPluginComputeHash params;
5710 params.result = &result;
5711 params.buffer = buffer;
5731 } _OrthancPluginLookupDictionary;
5753 _OrthancPluginLookupDictionary params;
5754 params.target = target;
5756 return context->InvokeService(context, _OrthancPluginService_LookupDictionary, ¶ms);
5765 uint32_t answerSize;
5766 uint32_t headersCount;
5767 const char*
const* headersKeys;
5768 const char*
const* headersValues;
5769 } _OrthancPluginSendMultipartItem2;
5795 uint32_t answerSize,
5796 uint32_t headersCount,
5797 const char*
const* headersKeys,
5798 const char*
const* headersValues)
5800 _OrthancPluginSendMultipartItem2 params;
5801 params.output = output;
5802 params.answer = answer;
5803 params.answerSize = answerSize;
5804 params.headersCount = headersCount;
5805 params.headersKeys = headersKeys;
5806 params.headersValues = headersValues;
5808 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem2, ¶ms);
5815 } _OrthancPluginIncomingHttpRequestFilter;
5833 _OrthancPluginIncomingHttpRequestFilter params;
5834 params.callback = callback;
5836 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter, ¶ms);
5845 uint16_t* httpStatus;
5848 uint32_t headersCount;
5849 const char*
const* headersKeys;
5850 const char*
const* headersValues;
5853 const char* username;
5854 const char* password;
5856 const char* certificateFile;
5857 const char* certificateKeyFile;
5858 const char* certificateKeyPassword;
5860 } _OrthancPluginCallHttpClient2;
5908 uint16_t* httpStatus,
5911 uint32_t headersCount,
5912 const char*
const* headersKeys,
5913 const char*
const* headersValues,
5916 const char* username,
5917 const char* password,
5919 const char* certificateFile,
5920 const char* certificateKeyFile,
5921 const char* certificateKeyPassword,
5924 _OrthancPluginCallHttpClient2 params;
5925 memset(¶ms, 0,
sizeof(params));
5927 params.answerBody = answerBody;
5928 params.answerHeaders = answerHeaders;
5929 params.httpStatus = httpStatus;
5930 params.method = method;
5932 params.headersCount = headersCount;
5933 params.headersKeys = headersKeys;
5934 params.headersValues = headersValues;
5936 params.bodySize = bodySize;
5937 params.username = username;
5938 params.password = password;
5939 params.timeout = timeout;
5940 params.certificateFile = certificateFile;
5941 params.certificateKeyFile = certificateKeyFile;
5942 params.certificateKeyPassword = certificateKeyPassword;
5943 params.pkcs11 = pkcs11;
5945 return context->InvokeService(context, _OrthancPluginService_CallHttpClient2, ¶ms);
5964 _OrthancPluginRetrieveDynamicString params;
5965 params.result = &result;
5966 params.argument = NULL;
5985 } _OrthancPluginFindCallback;
6002 _OrthancPluginFindCallback params;
6003 params.callback = callback;
6005 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback, ¶ms);
6016 uint32_t *resultUint32;
6017 uint16_t *resultGroup;
6018 uint16_t *resultElement;
6019 char **resultString;
6020 } _OrthancPluginFindOperation;
6043 _OrthancPluginFindOperation params;
6044 memset(¶ms, 0,
sizeof(params));
6045 params.answers = answers;
6046 params.dicom = dicom;
6049 return context->InvokeService(context, _OrthancPluginService_FindAddAnswer, ¶ms);
6070 _OrthancPluginFindOperation params;
6071 memset(¶ms, 0,
sizeof(params));
6072 params.answers = answers;
6074 return context->InvokeService(context, _OrthancPluginService_FindMarkIncomplete, ¶ms);
6096 _OrthancPluginFindOperation params;
6097 memset(¶ms, 0,
sizeof(params));
6098 params.query = query;
6099 params.resultUint32 = &count;
6134 _OrthancPluginFindOperation params;
6135 memset(¶ms, 0,
sizeof(params));
6136 params.query = query;
6137 params.index = index;
6138 params.resultGroup = group;
6139 params.resultElement = element;
6141 return context->InvokeService(context, _OrthancPluginService_GetFindQueryTag, ¶ms);
6165 _OrthancPluginFindOperation params;
6166 memset(¶ms, 0,
sizeof(params));
6167 params.query = query;
6168 params.index = index;
6169 params.resultString = &result;
6203 _OrthancPluginFindOperation params;
6204 memset(¶ms, 0,
sizeof(params));
6205 params.query = query;
6206 params.index = index;
6207 params.resultString = &result;
6229 } _OrthancPluginMoveCallback;
6251 _OrthancPluginMoveCallback params;
6252 params.callback = callback;
6253 params.getMoveSize = getMoveSize;
6254 params.applyMove = applyMove;
6255 params.freeMove = freeMove;
6257 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback, ¶ms);
6267 } _OrthancPluginCreateFindMatcher;
6290 _OrthancPluginCreateFindMatcher params;
6291 memset(¶ms, 0,
sizeof(params));
6292 params.target = ⌖
6293 params.query = query;
6310 } _OrthancPluginFreeFindMatcher;
6325 _OrthancPluginFreeFindMatcher params;
6326 params.matcher = matcher;
6328 context->InvokeService(context, _OrthancPluginService_FreeFindMatcher, ¶ms);
6338 } _OrthancPluginFindMatcherIsMatch;
6360 int32_t isMatch = 0;
6362 _OrthancPluginFindMatcherIsMatch params;
6363 params.matcher = matcher;
6364 params.dicom = dicom;
6366 params.isMatch = &isMatch;
6383 } _OrthancPluginIncomingHttpRequestFilter2;
6400 _OrthancPluginIncomingHttpRequestFilter2 params;
6401 params.callback = callback;
6403 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter2, ¶ms);
6411 } _OrthancPluginGetPeers;
6429 _OrthancPluginGetPeers params;
6430 memset(¶ms, 0,
sizeof(params));
6431 params.peers = &peers;
6447 } _OrthancPluginFreePeers;
6462 _OrthancPluginFreePeers params;
6463 params.peers = peers;
6465 context->InvokeService(context, _OrthancPluginService_FreePeers, ¶ms);
6473 } _OrthancPluginGetPeersCount;
6492 uint32_t target = 0;
6494 _OrthancPluginGetPeersCount params;
6495 memset(¶ms, 0,
sizeof(params));
6496 params.target = ⌖
6497 params.peers = peers;
6513 const char** target;
6516 const char* userProperty;
6517 } _OrthancPluginGetPeerProperty;
6541 const char* target = NULL;
6543 _OrthancPluginGetPeerProperty params;
6544 memset(¶ms, 0,
sizeof(params));
6545 params.target = ⌖
6546 params.peers = peers;
6547 params.peerIndex = peerIndex;
6548 params.userProperty = NULL;
6582 const char* target = NULL;
6584 _OrthancPluginGetPeerProperty params;
6585 memset(¶ms, 0,
sizeof(params));
6586 params.target = ⌖
6587 params.peers = peers;
6588 params.peerIndex = peerIndex;
6589 params.userProperty = NULL;
6627 const char* userProperty)
6629 const char* target = NULL;
6631 _OrthancPluginGetPeerProperty params;
6632 memset(¶ms, 0,
sizeof(params));
6633 params.target = ⌖
6634 params.peers = peers;
6635 params.peerIndex = peerIndex;
6636 params.userProperty = userProperty;
6655 uint16_t* httpStatus;
6660 uint32_t additionalHeadersCount;
6661 const char*
const* additionalHeadersKeys;
6662 const char*
const* additionalHeadersValues;
6666 } _OrthancPluginCallPeerApi;
6708 uint16_t* httpStatus,
6713 uint32_t additionalHeadersCount,
6714 const char*
const* additionalHeadersKeys,
6715 const char*
const* additionalHeadersValues,
6720 _OrthancPluginCallPeerApi params;
6721 memset(¶ms, 0,
sizeof(params));
6723 params.answerBody = answerBody;
6724 params.answerHeaders = answerHeaders;
6725 params.httpStatus = httpStatus;
6726 params.peers = peers;
6727 params.peerIndex = peerIndex;
6728 params.method = method;
6730 params.additionalHeadersCount = additionalHeadersCount;
6731 params.additionalHeadersKeys = additionalHeadersKeys;
6732 params.additionalHeadersValues = additionalHeadersValues;
6734 params.bodySize = bodySize;
6735 params.timeout = timeout;
6737 return context->InvokeService(context, _OrthancPluginService_CallPeerApi, ¶ms);
6756 } _OrthancPluginCreateJob;
6804 _OrthancPluginCreateJob params;
6805 memset(¶ms, 0,
sizeof(params));
6807 params.target = ⌖
6809 params.finalize = finalize;
6811 params.getProgress = getProgress;
6812 params.getContent = getContent;
6813 params.getSerialized = getSerialized;
6816 params.reset = reset;
6843 } _OrthancPluginCreateJob2;
6890 _OrthancPluginCreateJob2 params;
6891 memset(¶ms, 0,
sizeof(params));
6893 params.target = ⌖
6895 params.finalize = finalize;
6897 params.getProgress = getProgress;
6898 params.getContent = getContent;
6899 params.getSerialized = getSerialized;
6902 params.reset = reset;
6920 } _OrthancPluginFreeJob;
6935 _OrthancPluginFreeJob params;
6938 context->InvokeService(context, _OrthancPluginService_FreeJob, ¶ms);
6948 } _OrthancPluginSubmitJob;
6968 char* resultId = NULL;
6970 _OrthancPluginSubmitJob params;
6971 memset(¶ms, 0,
sizeof(params));
6973 params.resultId = &resultId;
6975 params.priority = priority;
6994 } _OrthancPluginJobsUnserializer;
7012 _OrthancPluginJobsUnserializer params;
7013 params.unserializer = unserializer;
7015 context->InvokeService(context, _OrthancPluginService_RegisterJobsUnserializer, ¶ms);
7023 const char* details;
7025 } _OrthancPluginSetHttpErrorDetails;
7047 const char* details,
7050 _OrthancPluginSetHttpErrorDetails params;
7051 params.output = output;
7052 params.details = details;
7054 context->InvokeService(context, _OrthancPluginService_SetHttpErrorDetails, ¶ms);
7061 const char** result;
7062 const char* argument;
7063 } _OrthancPluginRetrieveStaticString;
7080 const char* result = NULL;
7082 _OrthancPluginRetrieveStaticString params;
7083 params.result = &result;
7084 params.argument = path;
7104 } _OrthancPluginSetMetricsValue;
7128 _OrthancPluginSetMetricsValue params;
7130 params.value = value;
7132 context->InvokeService(context, _OrthancPluginService_SetMetricsValue, ¶ms);
7140 } _OrthancPluginRegisterRefreshMetricsCallback;
7157 _OrthancPluginRegisterRefreshMetricsCallback params;
7158 params.callback = callback;
7159 context->InvokeService(context, _OrthancPluginService_RegisterRefreshMetricsCallback, ¶ms);
7171 } _OrthancPluginEncodeDicomWeb;
7195 char* target = NULL;
7197 _OrthancPluginEncodeDicomWeb params;
7198 params.target = ⌖
7199 params.dicom = dicom;
7200 params.dicomSize = dicomSize;
7201 params.callback = callback;
7237 char* target = NULL;
7239 _OrthancPluginEncodeDicomWeb params;
7240 params.target = ⌖
7241 params.dicom = dicom;
7242 params.dicomSize = dicomSize;
7243 params.callback = callback;
7265 } _OrthancPluginEncodeDicomWeb2;
7290 char* target = NULL;
7292 _OrthancPluginEncodeDicomWeb2 params;
7293 params.target = ⌖
7294 params.dicom = dicom;
7295 params.dicomSize = dicomSize;
7296 params.callback = callback;
7297 params.payload = payload;
7334 char* target = NULL;
7336 _OrthancPluginEncodeDicomWeb2 params;
7337 params.target = ⌖
7338 params.dicom = dicom;
7339 params.dicomSize = dicomSize;
7340 params.callback = callback;
7341 params.payload = payload;
7445 typedef const void* (*OrthancPluginChunkedClientRequestGetChunkData) (
void* request);
7469 uint16_t* httpStatus;
7472 uint32_t headersCount;
7473 const char*
const* headersKeys;
7474 const char*
const* headersValues;
7480 const char* username;
7481 const char* password;
7483 const char* certificateFile;
7484 const char* certificateKeyFile;
7485 const char* certificateKeyPassword;
7487 } _OrthancPluginChunkedHttpClient;
7545 uint16_t* httpStatus,
7548 uint32_t headersCount,
7549 const char*
const* headersKeys,
7550 const char*
const* headersValues,
7556 const char* username,
7557 const char* password,
7559 const char* certificateFile,
7560 const char* certificateKeyFile,
7561 const char* certificateKeyPassword,
7564 _OrthancPluginChunkedHttpClient params;
7565 memset(¶ms, 0,
sizeof(params));
7568 params.httpStatus = httpStatus;
7569 params.method = method;
7571 params.headersCount = headersCount;
7572 params.headersKeys = headersKeys;
7573 params.headersValues = headersValues;
7574 params.username = username;
7575 params.password = password;
7576 params.timeout = timeout;
7577 params.certificateFile = certificateFile;
7578 params.certificateKeyFile = certificateKeyFile;
7579 params.certificateKeyPassword = certificateKeyPassword;
7580 params.pkcs11 = pkcs11;
7583 params.answer = answer;
7584 params.answerAddChunk = answerAddChunk;
7585 params.answerAddHeader = answerAddHeader;
7586 params.request = request;
7587 params.requestIsDone = requestIsDone;
7588 params.requestChunkData = requestChunkData;
7589 params.requestChunkSize = requestChunkSize;
7590 params.requestNext = requestNext;
7592 return context->InvokeService(context, _OrthancPluginService_ChunkedHttpClient, ¶ms);
7682 const char* pathRegularExpression;
7690 } _OrthancPluginChunkedRestCallback;
7724 const char* pathRegularExpression,
7733 _OrthancPluginChunkedRestCallback params;
7734 params.pathRegularExpression = pathRegularExpression;
7735 params.getHandler = getHandler;
7736 params.postHandler = postHandler;
7737 params.deleteHandler = deleteHandler;
7738 params.putHandler = putHandler;
7739 params.addChunk = addChunk;
7740 params.execute = execute;
7741 params.finalize = finalize;
7743 context->InvokeService(context, _OrthancPluginService_RegisterChunkedRestCallback, ¶ms);
7755 const char* privateCreator;
7756 } _OrthancPluginGetTagName;
7777 const char* privateCreator)
7781 _OrthancPluginGetTagName params;
7782 params.result = &result;
7783 params.group = group;
7784 params.element = element;
7785 params.privateCreator = privateCreator;
7831 const char* transactionUid,
7832 const char*
const* sopClassUids,
7833 const char*
const* sopInstanceUids,
7834 uint32_t countInstances,
7835 const char* remoteAet,
7836 const char* calledAet);
7874 const char* sopClassUid,
7875 const char* sopInstanceUid);
7883 } _OrthancPluginRegisterStorageCommitmentScpCallback;
7904 _OrthancPluginRegisterStorageCommitmentScpCallback params;
7905 params.factory = factory;
7906 params.destructor = destructor;
7907 params.lookup = lookup;
7908 return context->InvokeService(context, _OrthancPluginService_RegisterStorageCommitmentScpCallback, ¶ms);
7945 } _OrthancPluginIncomingDicomInstanceFilter;
7963 _OrthancPluginIncomingDicomInstanceFilter params;
7964 params.callback = callback;
7966 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingDicomInstanceFilter, ¶ms);
8001 uint16_t* dimseStatus ,
8008 } _OrthancPluginIncomingCStoreInstanceFilter;
8026 _OrthancPluginIncomingCStoreInstanceFilter params;
8027 params.callback = callback;
8029 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingCStoreInstanceFilter, ¶ms);
8069 const void* receivedDicomBuffer,
8070 uint64_t receivedDicomBufferSize,
8077 } _OrthancPluginReceivedInstanceCallback;
8103 _OrthancPluginReceivedInstanceCallback params;
8104 params.callback = callback;
8106 return context->InvokeService(context, _OrthancPluginService_RegisterReceivedInstanceCallback, ¶ms);
8128 _OrthancPluginAccessDicomInstance params;
8129 memset(¶ms, 0,
sizeof(params));
8130 params.resultStringToFree = &result;
8131 params.instance = instance;
8161 int64_t hasPixelData;
8163 _OrthancPluginAccessDicomInstance params;
8164 memset(¶ms, 0,
sizeof(params));
8165 params.resultInt64 = &hasPixelData;
8166 params.instance = instance;
8177 return (hasPixelData != 0);
8191 const char* transferSyntax;
8192 } _OrthancPluginCreateDicomInstance;
8214 _OrthancPluginCreateDicomInstance params;
8215 params.target = ⌖
8216 params.buffer = buffer;
8233 } _OrthancPluginFreeDicomInstance;
8249 _OrthancPluginFreeDicomInstance params;
8250 params.dicom = dicom;
8252 context->InvokeService(context, _OrthancPluginService_FreeDicomInstance, ¶ms);
8258 uint32_t* targetUint32;
8261 char** targetStringToFree;
8263 uint32_t frameIndex;
8266 uint32_t maxStringLength;
8268 void* dicomWebPayload;
8269 } _OrthancPluginAccessDicomInstance2;
8288 _OrthancPluginAccessDicomInstance2 params;
8289 memset(¶ms, 0,
sizeof(params));
8290 params.targetUint32 = &count;
8291 params.instance = instance;
8326 uint32_t frameIndex)
8328 _OrthancPluginAccessDicomInstance2 params;
8329 memset(¶ms, 0,
sizeof(params));
8330 params.targetBuffer = target;
8331 params.instance = instance;
8332 params.frameIndex = frameIndex;
8334 return context->InvokeService(context, _OrthancPluginService_GetInstanceRawFrame, ¶ms);
8353 uint32_t frameIndex)
8357 _OrthancPluginAccessDicomInstance2 params;
8358 memset(¶ms, 0,
sizeof(params));
8359 params.targetImage = ⌖
8360 params.instance = instance;
8361 params.frameIndex = frameIndex;
8393 const char* transferSyntax)
8397 _OrthancPluginCreateDicomInstance params;
8398 params.target = ⌖
8399 params.buffer = buffer;
8401 params.transferSyntax = transferSyntax;
8432 _OrthancPluginAccessDicomInstance2 params;
8433 memset(¶ms, 0,
sizeof(params));
8434 params.targetBuffer = target;
8435 params.instance = instance;
8437 return context->InvokeService(context, _OrthancPluginService_SerializeDicomInstance, ¶ms);
8464 uint32_t maxStringLength)
8466 char* result = NULL;
8468 _OrthancPluginAccessDicomInstance2 params;
8469 memset(¶ms, 0,
sizeof(params));
8470 params.targetStringToFree = &result;
8471 params.instance = instance;
8472 params.format = format;
8473 params.flags = flags;
8474 params.maxStringLength = maxStringLength;
8508 char* target = NULL;
8510 _OrthancPluginAccessDicomInstance2 params;
8511 params.targetStringToFree = ⌖
8512 params.instance = instance;
8513 params.dicomWebCallback = callback;
8514 params.dicomWebPayload = payload;
8548 char* target = NULL;
8550 _OrthancPluginAccessDicomInstance2 params;
8551 params.targetStringToFree = ⌖
8552 params.instance = instance;
8553 params.dicomWebCallback = callback;
8554 params.dicomWebPayload = payload;
8591 const char*
const* allowedSyntaxes,
8592 uint32_t countSyntaxes,
8593 uint8_t allowNewSopInstanceUid);
8599 } _OrthancPluginTranscoderCallback;
8618 _OrthancPluginTranscoderCallback params;
8619 params.callback = callback;
8621 return context->InvokeService(context, _OrthancPluginService_RegisterTranscoderCallback, ¶ms);
8630 } _OrthancPluginCreateMemoryBuffer;
8654 _OrthancPluginCreateMemoryBuffer params;
8655 params.target = target;
8658 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer, ¶ms);
8692 _OrthancPluginRetrieveDynamicString params;
8693 params.result = &result;
8694 params.argument = NULL;
8696 if (context->InvokeService(context, _OrthancPluginService_GenerateRestApiAuthorizationToken,
8714 } _OrthancPluginCreateMemoryBuffer64;
8738 _OrthancPluginCreateMemoryBuffer64 params;
8739 params.target = target;
8742 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer64, ¶ms);
8752 } _OrthancPluginRegisterStorageArea2;
8777 _OrthancPluginRegisterStorageArea2 params;
8778 params.create = create;
8779 params.readWhole = readWhole;
8780 params.readRange = readRange;
8781 params.remove = remove;
8782 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea2, ¶ms);
8789 _OrthancPluginCreateDicom createDicom;
8790 const char* privateCreator;
8791 } _OrthancPluginCreateDicom2;
8823 const char* privateCreator)
8825 _OrthancPluginCreateDicom2 params;
8826 params.createDicom.target = target;
8827 params.createDicom.json = json;
8828 params.createDicom.pixelData = pixelData;
8829 params.createDicom.flags = flags;
8830 params.privateCreator = privateCreator;
8832 return context->InvokeService(context, _OrthancPluginService_CreateDicom2, ¶ms);
8844 uint16_t* httpStatus;
8847 uint32_t headersCount;
8848 const char*
const* headersKeys;
8849 const char*
const* headersValues;
8852 uint8_t afterPlugins;
8853 } _OrthancPluginCallRestApi;
8889 uint16_t* httpStatus,
8892 uint32_t headersCount,
8893 const char*
const* headersKeys,
8894 const char*
const* headersValues,
8897 uint8_t afterPlugins)
8899 _OrthancPluginCallRestApi params;
8900 memset(¶ms, 0,
sizeof(params));
8902 params.answerBody = answerBody;
8903 params.answerHeaders = answerHeaders;
8904 params.httpStatus = httpStatus;
8905 params.method = method;
8907 params.headersCount = headersCount;
8908 params.headersKeys = headersKeys;
8909 params.headersValues = headersValues;
8911 params.bodySize = bodySize;
8912 params.afterPlugins = afterPlugins;
8914 return context->InvokeService(context, _OrthancPluginService_CallRestApi, ¶ms);
8946 const char* mimeType,
8947 const char* dateTime);
8966 const char* dateTime);
8994 const char* mimeType,
8995 const char* dateTime);
9012 uint8_t* isExisting,
9014 const char*
const* pathItems,
9037 uint8_t* isExisting,
9042 const char*
const* pathItems,
9066 const char*
const* pathItems,
9086 uint8_t* isReadOnly,
9088 const char*
const* pathItems,
9108 uint8_t* isReadOnly,
9110 const char*
const* pathItems,
9128 uint8_t* isReadOnly,
9130 const char*
const* pathItems,
9144 } _OrthancPluginRegisterWebDavCollection;
9177 _OrthancPluginRegisterWebDavCollection params;
9179 params.isExistingFolder = isExistingFolder;
9180 params.listFolder = listFolder;
9181 params.retrieveFile = retrieveFile;
9182 params.storeFile = storeFile;
9183 params.createFolder = createFolder;
9184 params.deleteItem = deleteItem;
9185 params.payload = payload;
9187 return context->InvokeService(context, _OrthancPluginService_RegisterWebDavCollection, ¶ms);
9204 _OrthancPluginRetrieveStaticString params;
9205 params.result = &result;
9206 params.argument = NULL;
9229 const void* request,
9230 uint64_t requestSize);
9242 uint32_t maxDatabaseRetries;
9245 } _OrthancPluginRegisterDatabaseBackendV4;
9267 uint32_t maxDatabaseRetries,
9271 _OrthancPluginRegisterDatabaseBackendV4 params;
9272 params.backend = backend;
9273 params.maxDatabaseRetries = maxDatabaseRetries;
9274 params.operations = operations;
9275 params.finalize = finalize;
9277 return context->InvokeService(context, _OrthancPluginService_RegisterDatabaseBackendV4, ¶ms);
9284 const char* instanceId;
9286 } _OrthancPluginLoadDicomInstance;
9303 const char* instanceId,
9308 _OrthancPluginLoadDicomInstance params;
9309 params.target = ⌖
9310 params.instanceId = instanceId;
9330 } _OrthancPluginSetMetricsIntegerValue;
9353 _OrthancPluginSetMetricsIntegerValue params;
9355 params.value = value;
9357 context->InvokeService(context, _OrthancPluginService_SetMetricsIntegerValue, ¶ms);
9376 const char* threadName)
9378 return context->InvokeService(context, _OrthancPluginService_SetCurrentThreadName, threadName);
OrthancPluginErrorCode OrthancPluginRegisterDatabaseBackendV4(OrthancPluginContext *context, void *backend, uint32_t maxDatabaseRetries, OrthancPluginCallDatabaseBackendV4 operations, OrthancPluginFinalizeDatabaseBackendV4 finalize)
Register a custom database back-end.
Definition: OrthancCPlugin.h:9264
OrthancPluginErrorCode(* OrthancPluginCallDatabaseBackendV4)(OrthancPluginMemoryBuffer64 *response, void *backend, const void *request, uint64_t requestSize)
Signature of a callback function that is triggered when the Orthanc core requests an operation from t...
Definition: OrthancCPlugin.h:9226
OrthancPluginReceivedInstanceAction(* OrthancPluginReceivedInstanceCallback)(OrthancPluginMemoryBuffer64 *modifiedDicomBuffer, const void *receivedDicomBuffer, uint64_t receivedDicomBufferSize, OrthancPluginInstanceOrigin origin)
Callback to keep/discard/modify a DICOM instance received by Orthanc from any source (C-STORE or REST...
Definition: OrthancCPlugin.h:8067
OrthancPluginErrorCode(* OrthancPluginWebDavAddFile)(OrthancPluginWebDavCollection *collection, const char *name, uint64_t size, const char *mimeType, const char *dateTime)
Declare a file while returning the content of a folder.
Definition: OrthancCPlugin.h:8942
void OrthancPluginRegisterStorageArea(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove)
Register a custom storage area.
Definition: OrthancCPlugin.h:3267
void OrthancPluginRegisterOnStoredInstanceCallback(OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback)
Register a callback for received instances.
Definition: OrthancCPlugin.h:2232
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:1273
OrthancPluginErrorCode OrthancPluginRegisterDecodeImageCallback(OrthancPluginContext *context, OrthancPluginDecodeImageCallback callback)
Register a callback to handle the decoding of DICOM images.
Definition: OrthancCPlugin.h:5493
OrthancPluginChangeType
Definition: OrthancCPlugin.h:737
OrthancPluginErrorCode(* OrthancPluginStorageReadWhole)(OrthancPluginMemoryBuffer64 *target, const char *uuid, OrthancPluginContentType type)
Callback for reading a whole file from the storage area.
Definition: OrthancCPlugin.h:1339
OrthancPluginErrorCode OrthancPluginRegisterIncomingCStoreInstanceFilter(OrthancPluginContext *context, OrthancPluginIncomingCStoreInstanceFilter callback)
Register a callback to filter incoming DICOM instances received by Orthanc through C-STORE.
Definition: OrthancCPlugin.h:8022
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:1251
void OrthancPluginRegisterRefreshMetricsCallback(OrthancPluginContext *context, OrthancPluginRefreshMetricsCallback callback)
Register a callback to refresh the metrics.
Definition: OrthancCPlugin.h:7153
OrthancPluginErrorCode(* OrthancPluginWebDavCreateFolderCallback)(uint8_t *isReadOnly, uint32_t pathSize, const char *const *pathItems, void *payload)
Callback to create a folder.
Definition: OrthancCPlugin.h:9107
struct _OrthancPluginWebDavCollection_t OrthancPluginWebDavCollection
Opaque structure that represents a WebDAV collection.
Definition: OrthancCPlugin.h:8923
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:1809
OrthancPluginErrorCode(* OrthancPluginWebDavRetrieveFileCallback)(OrthancPluginWebDavCollection *collection, OrthancPluginWebDavRetrieveFile retrieveFile, uint32_t pathSize, const char *const *pathItems, void *payload)
Callback for retrieving the content of a file.
Definition: OrthancCPlugin.h:9062
int32_t(* OrthancPluginIncomingDicomInstanceFilter)(const OrthancPluginDicomInstance *instance)
Callback to filter incoming DICOM instances received by Orthanc.
Definition: OrthancCPlugin.h:7938
OrthancPluginErrorCode OrthancPluginStorageAreaRemove(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Remove a file from the storage area.
Definition: OrthancCPlugin.h:4851
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:8587
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter2(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter2 callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:6396
OrthancPluginErrorCode(* OrthancPluginWebDavRetrieveFile)(OrthancPluginWebDavCollection *collection, const void *data, uint64_t size, const char *mimeType, const char *dateTime)
Retrieve the content of a file.
Definition: OrthancCPlugin.h:8990
OrthancPluginErrorCode(* OrthancPluginStorageRead)(void **content, int64_t *size, const char *uuid, OrthancPluginContentType type)
Callback for reading from the storage area.
Definition: OrthancCPlugin.h:1319
void OrthancPluginRegisterRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback.
Definition: OrthancCPlugin.h:2154
uint32_t OrthancPluginGetExpectedDatabaseVersion(OrthancPluginContext *context)
Get the expected version of the database schema.
Definition: OrthancCPlugin.h:3655
OrthancPluginErrorCode OrthancPluginRegisterReceivedInstanceCallback(OrthancPluginContext *context, OrthancPluginReceivedInstanceCallback callback)
Register a callback to keep/discard/modify a DICOM instance received by Orthanc from any source (C-ST...
Definition: OrthancCPlugin.h:8099
int32_t OrthancPluginCheckVersion(OrthancPluginContext *context)
Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
Definition: OrthancCPlugin.h:2035
OrthancPluginErrorCode(* OrthancPluginWebDavListFolderCallback)(uint8_t *isExisting, OrthancPluginWebDavCollection *collection, OrthancPluginWebDavAddFile addFile, OrthancPluginWebDavAddFolder addFolder, uint32_t pathSize, const char *const *pathItems, void *payload)
Callback for listing the content of a folder.
Definition: OrthancCPlugin.h:9036
OrthancPluginJob *(* OrthancPluginJobsUnserializer)(const char *jobType, const char *serialized)
Callback executed to unserialize a custom job.
Definition: OrthancCPlugin.h:1762
struct _OrthancPluginRestOutput_t OrthancPluginRestOutput
Opaque structure that represents the HTTP connection to the client application.
Definition: OrthancCPlugin.h:1122
void OrthancPluginRegisterOnChangeCallback(OrthancPluginContext *context, OrthancPluginOnChangeCallback callback)
Register a callback to monitor changes.
Definition: OrthancCPlugin.h:3410
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:8770
OrthancPluginErrorCode(* OrthancPluginWebDavAddFolder)(OrthancPluginWebDavCollection *collection, const char *name, const char *dateTime)
Declare a subfolder while returning the content of a folder.
Definition: OrthancCPlugin.h:8963
OrthancPluginErrorCode OrthancPluginRegisterWebDavCollection(OrthancPluginContext *context, const char *uri, OrthancPluginWebDavIsExistingFolderCallback isExistingFolder, OrthancPluginWebDavListFolderCallback listFolder, OrthancPluginWebDavRetrieveFileCallback retrieveFile, OrthancPluginWebDavStoreFileCallback storeFile, OrthancPluginWebDavCreateFolderCallback createFolder, OrthancPluginWebDavDeleteItemCallback deleteItem, void *payload)
Register a WebDAV virtual filesystem.
Definition: OrthancCPlugin.h:9166
int32_t(* OrthancPluginIncomingHttpRequestFilter2)(OrthancPluginHttpMethod method, const char *uri, const char *ip, uint32_t headersCount, const char *const *headersKeys, const char *const *headersValues, uint32_t getArgumentsCount, const char *const *getArgumentsKeys, const char *const *getArgumentsValues)
Callback to filter incoming HTTP requests received by Orthanc.
Definition: OrthancCPlugin.h:1465
OrthancPluginErrorCode(* OrthancPluginRestCallback)(OrthancPluginRestOutput *output, const char *url, const OrthancPluginHttpRequest *request)
Signature of a callback function that answers to a REST request.
Definition: OrthancCPlugin.h:1219
void(* OrthancPluginRefreshMetricsCallback)()
Callback executed to update the metrics of the plugin.
Definition: OrthancCPlugin.h:1781
OrthancPluginErrorCode OrthancPluginRegisterTranscoderCallback(OrthancPluginContext *context, OrthancPluginTranscoderCallback callback)
Register a callback to handle the transcoding of DICOM images.
Definition: OrthancCPlugin.h:8614
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:1230
OrthancPluginErrorCode(* OrthancPluginWebDavStoreFileCallback)(uint8_t *isReadOnly, uint32_t pathSize, const char *const *pathItems, const void *data, uint64_t size, void *payload)
Callback to store a file.
Definition: OrthancCPlugin.h:9085
OrthancPluginErrorCode(* OrthancPluginWebDavDeleteItemCallback)(uint8_t *isReadOnly, uint32_t pathSize, const char *const *pathItems, void *payload)
Callback to remove a file or a folder.
Definition: OrthancCPlugin.h:9127
OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, OrthancPluginResourceType level)
Reconstruct the main DICOM tags.
Definition: OrthancCPlugin.h:5043
OrthancPluginErrorCode(* OrthancPluginStorageRemove)(const char *uuid, OrthancPluginContentType type)
Callback for removing a file from the storage area.
Definition: OrthancCPlugin.h:1380
OrthancPluginErrorCode(* OrthancPluginStorageCreate)(const char *uuid, const void *content, int64_t size, OrthancPluginContentType type)
Callback for writing to the storage area.
Definition: OrthancCPlugin.h:1292
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:1847
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:1240
void(* OrthancPluginFinalizeDatabaseBackendV4)(void *backend)
Signature of a callback function that is triggered when the database plugin must be finalized.
Definition: OrthancCPlugin.h:9237
struct _OrthancPluginServerChunkedRequestReader_t OrthancPluginServerChunkedRequestReader
Opaque structure that reads the content of a HTTP request body during a chunked HTTP transfer.
Definition: OrthancCPlugin.h:7601
OrthancPluginErrorCode(* OrthancPluginWebDavIsExistingFolderCallback)(uint8_t *isExisting, uint32_t pathSize, const char *const *pathItems, void *payload)
Callback for testing the existence of a folder.
Definition: OrthancCPlugin.h:9011
int32_t(* OrthancPluginIncomingHttpRequestFilter)(OrthancPluginHttpMethod method, const char *uri, const char *ip, uint32_t headersCount, const char *const *headersKeys, const char *const *headersValues)
Callback to filter incoming HTTP requests received by Orthanc.
Definition: OrthancCPlugin.h:1430
void OrthancPluginRegisterJobsUnserializer(OrthancPluginContext *context, OrthancPluginJobsUnserializer unserializer)
Register an unserializer for custom jobs.
Definition: OrthancCPlugin.h:7008
void(* OrthancPluginFree)(void *buffer)
Signature of a function to free dynamic memory.
Definition: OrthancCPlugin.h:1263
void OrthancPluginRegisterRestCallbackNoLock(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback, without locking.
Definition: OrthancCPlugin.h:2194
OrthancPluginErrorCode OrthancPluginStorageAreaRead(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Read a file from the storage area.
Definition: OrthancCPlugin.h:4812
int32_t OrthancPluginCheckVersionAdvanced(OrthancPluginContext *context, int32_t expectedMajor, int32_t expectedMinor, int32_t expectedRevision)
Check that the version of the hosting Orthanc is above a given version.
Definition: OrthancCPlugin.h:1928
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:1362
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:7722
int32_t(* OrthancPluginIncomingCStoreInstanceFilter)(uint16_t *dimseStatus, const OrthancPluginDicomInstance *instance)
Callback to filter incoming DICOM instances received by Orthanc through C-STORE.
Definition: OrthancCPlugin.h:8000
OrthancPluginErrorCode OrthancPluginRegisterIncomingDicomInstanceFilter(OrthancPluginContext *context, OrthancPluginIncomingDicomInstanceFilter callback)
Register a callback to filter incoming DICOM instances.
Definition: OrthancCPlugin.h:7959
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:5829
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:4768
@ OrthancPluginChangeType_OrthancStopped
Definition: OrthancCPlugin.h:749
@ OrthancPluginChangeType_OrthancStarted
Definition: OrthancCPlugin.h:748
@ OrthancPluginChangeType_Deleted
Definition: OrthancCPlugin.h:739
@ OrthancPluginChangeType_JobFailure
Definition: OrthancCPlugin.h:756
@ OrthancPluginChangeType_NewInstance
Definition: OrthancCPlugin.h:741
@ OrthancPluginChangeType_NewPatient
Definition: OrthancCPlugin.h:742
@ OrthancPluginChangeType_JobSubmitted
Definition: OrthancCPlugin.h:754
@ OrthancPluginChangeType_NewSeries
Definition: OrthancCPlugin.h:743
@ OrthancPluginChangeType_StablePatient
Definition: OrthancCPlugin.h:745
@ OrthancPluginChangeType_UpdatedPeers
Definition: OrthancCPlugin.h:752
@ OrthancPluginChangeType_StableStudy
Definition: OrthancCPlugin.h:747
@ OrthancPluginChangeType_CompletedSeries
Definition: OrthancCPlugin.h:738
@ OrthancPluginChangeType_NewChildInstance
Definition: OrthancCPlugin.h:740
@ OrthancPluginChangeType_UpdatedAttachment
Definition: OrthancCPlugin.h:750
@ OrthancPluginChangeType_UpdatedMetadata
Definition: OrthancCPlugin.h:751
@ OrthancPluginChangeType_StableSeries
Definition: OrthancCPlugin.h:746
@ OrthancPluginChangeType_UpdatedModalities
Definition: OrthancCPlugin.h:753
@ OrthancPluginChangeType_JobSuccess
Definition: OrthancCPlugin.h:755
@ OrthancPluginChangeType_NewStudy
Definition: OrthancCPlugin.h:744
uint32_t OrthancPluginGetFindQuerySize(OrthancPluginContext *context, const OrthancPluginFindQuery *query)
Get the number of tags in a C-Find query.
Definition: OrthancCPlugin.h:6090
struct _OrthancPluginFindQuery_t OrthancPluginFindQuery
Opaque structure to an object that represents a C-Find query.
Definition: OrthancCPlugin.h:1170
OrthancPluginErrorCode(* OrthancPluginApplyMove)(void *moveDriver)
Callback to apply one C-Move suboperation.
Definition: OrthancCPlugin.h:1575
OrthancPluginErrorCode OrthancPluginFindMarkIncomplete(OrthancPluginContext *context, OrthancPluginFindAnswers *answers)
Mark the set of C-Find answers as incomplete.
Definition: OrthancCPlugin.h:6066
void(* OrthancPluginStorageCommitmentDestructor)(void *handler)
Callback to free one storage commitment SCP handler.
Definition: OrthancCPlugin.h:7850
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:1399
OrthancPluginErrorCode OrthancPluginRegisterMoveCallback(OrthancPluginContext *context, OrthancPluginMoveCallback callback, OrthancPluginGetMoveSize getMoveSize, OrthancPluginApplyMove applyMove, OrthancPluginFreeMove freeMove)
Register a callback to handle C-Move requests.
Definition: OrthancCPlugin.h:6244
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:6196
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:7828
OrthancPluginErrorCode OrthancPluginRegisterFindCallback(OrthancPluginContext *context, OrthancPluginFindCallback callback)
Register a callback to handle C-Find requests.
Definition: OrthancCPlugin.h:5998
OrthancPluginErrorCode OrthancPluginWorklistGetDicomQuery(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginWorklistQuery *query)
Retrieve the worklist query as a DICOM file.
Definition: OrthancCPlugin.h:5375
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:7871
int32_t OrthancPluginWorklistIsMatch(OrthancPluginContext *context, const OrthancPluginWorklistQuery *query, const void *dicom, uint32_t size)
Test whether a worklist matches the query.
Definition: OrthancCPlugin.h:5336
OrthancPluginErrorCode OrthancPluginFindAddAnswer(OrthancPluginContext *context, OrthancPluginFindAnswers *answers, const void *dicom, uint32_t size)
Add one answer to some C-Find request.
Definition: OrthancCPlugin.h:6037
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:7898
struct _OrthancPluginFindAnswers_t OrthancPluginFindAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1178
struct _OrthancPluginWorklistAnswers_t OrthancPluginWorklistAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1162
OrthancPluginErrorCode(* OrthancPluginFindCallback)(OrthancPluginFindAnswers *answers, const OrthancPluginFindQuery *query, const char *issuerAet, const char *calledAet)
Callback to handle incoming C-Find SCP requests.
Definition: OrthancCPlugin.h:1492
uint32_t(* OrthancPluginGetMoveSize)(void *moveDriver)
Callback to read the size of a C-Move driver.
Definition: OrthancCPlugin.h:1560
OrthancPluginErrorCode OrthancPluginRegisterWorklistCallback(OrthancPluginContext *context, OrthancPluginWorklistCallback callback)
Register a callback to handle modality worklists requests.
Definition: OrthancCPlugin.h:5232
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:6158
OrthancPluginErrorCode OrthancPluginWorklistMarkIncomplete(OrthancPluginContext *context, OrthancPluginWorklistAnswers *answers)
Mark the set of worklist answers as incomplete.
Definition: OrthancCPlugin.h:5298
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:6127
void(* OrthancPluginFreeMove)(void *moveDriver)
Callback to free one C-Move driver.
Definition: OrthancCPlugin.h:1589
struct _OrthancPluginWorklistQuery_t OrthancPluginWorklistQuery
Opaque structure to an object that represents a C-Find query for worklists.
Definition: OrthancCPlugin.h:1154
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:1535
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:5268
int32_t OrthancPluginHasInstancePixelData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Check whether the DICOM file has pixel data.
Definition: OrthancCPlugin.h:8157
char * OrthancPluginGetInstanceDicomWebXml(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb XML.
Definition: OrthancCPlugin.h:8542
struct _OrthancPluginDicomInstance_t OrthancPluginDicomInstance
Opaque structure that represents a DICOM instance that is managed by the Orthanc core.
Definition: OrthancCPlugin.h:1130
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:8322
const char * OrthancPluginGetInstanceRemoteAet(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the AET of a DICOM instance.
Definition: OrthancCPlugin.h:2998
OrthancPluginDicomInstance * OrthancPluginLoadDicomInstance(OrthancPluginContext *context, const char *instanceId, OrthancPluginLoadDicomInstanceMode mode)
Load a DICOM instance from the Orthanc server.
Definition: OrthancCPlugin.h:9301
char * OrthancPluginGetInstanceJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file.
Definition: OrthancCPlugin.h:3100
OrthancPluginDicomInstance * OrthancPluginTranscodeDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size, const char *transferSyntax)
Parse and transcode a DICOM instance.
Definition: OrthancCPlugin.h:8389
int32_t OrthancPluginHasInstanceMetadata(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, const char *metadata)
Check whether a DICOM instance is associated with some metadata.
Definition: OrthancCPlugin.h:3177
OrthancPluginDicomInstance * OrthancPluginCreateDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size)
Parse a DICOM instance.
Definition: OrthancCPlugin.h:8207
uint32_t OrthancPluginGetInstanceFramesCount(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the number of frames in a DICOM instance.
Definition: OrthancCPlugin.h:8282
OrthancPluginInstanceOrigin OrthancPluginGetInstanceOrigin(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the origin of a DICOM file.
Definition: OrthancCPlugin.h:5401
int64_t OrthancPluginGetInstanceSize(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the size of a DICOM file.
Definition: OrthancCPlugin.h:3031
char * OrthancPluginGetInstanceDicomWebJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb JSON.
Definition: OrthancCPlugin.h:8502
char * OrthancPluginGetInstanceTransferSyntaxUid(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the transfer syntax of a DICOM file.
Definition: OrthancCPlugin.h:8122
void OrthancPluginFreeDicomInstance(OrthancPluginContext *context, OrthancPluginDicomInstance *dicom)
Free a DICOM instance.
Definition: OrthancCPlugin.h:8245
OrthancPluginErrorCode OrthancPluginSerializeDicomInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginDicomInstance *instance)
Writes a DICOM instance to a memory buffer.
Definition: OrthancCPlugin.h:8427
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:3218
char * OrthancPluginGetInstanceSimplifiedJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file (with simplification).
Definition: OrthancCPlugin.h:3138
const void * OrthancPluginGetInstanceData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the data of a DICOM file.
Definition: OrthancCPlugin.h:3064
OrthancPluginImage * OrthancPluginGetInstanceDecodedFrame(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:8350
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:8459
OrthancPluginImage * OrthancPluginConvertPixelFormat(OrthancPluginContext *context, const OrthancPluginImage *source, OrthancPluginPixelFormat targetFormat)
Change the pixel format of an image.
Definition: OrthancCPlugin.h:4554
OrthancPluginPixelFormat
Definition: OrthancCPlugin.h:613
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:4714
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:4298
uint32_t OrthancPluginGetImagePitch(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pitch of an image.
Definition: OrthancCPlugin.h:4089
OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pixel format of an image.
Definition: OrthancCPlugin.h:3988
OrthancPluginImage * OrthancPluginCreateImage(OrthancPluginContext *context, OrthancPluginPixelFormat format, uint32_t width, uint32_t height)
Create an image.
Definition: OrthancCPlugin.h:5531
uint32_t OrthancPluginGetFontsCount(OrthancPluginContext *context)
Return the number of available fonts.
Definition: OrthancCPlugin.h:4589
uint32_t OrthancPluginGetImageHeight(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the height of an image.
Definition: OrthancCPlugin.h:4054
void * OrthancPluginGetImageBuffer(OrthancPluginContext *context, const OrthancPluginImage *image)
Return a pointer to the content of an image.
Definition: OrthancCPlugin.h:4123
void OrthancPluginFreeImage(OrthancPluginContext *context, OrthancPluginImage *image)
Free an image.
Definition: OrthancCPlugin.h:4208
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:4253
OrthancPluginImage * OrthancPluginDecodeDicomImage(OrthancPluginContext *context, const void *buffer, uint32_t bufferSize, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:5620
OrthancPluginImage * OrthancPluginUncompressImage(OrthancPluginContext *context, const void *data, uint32_t size, OrthancPluginImageFormat format)
Decode a compressed image.
Definition: OrthancCPlugin.h:4166
const char * OrthancPluginGetFontName(OrthancPluginContext *context, uint32_t fontIndex)
Return the name of a font.
Definition: OrthancCPlugin.h:4629
OrthancPluginImageFormat
Definition: OrthancCPlugin.h:782
struct _OrthancPluginStorageArea_t OrthancPluginStorageArea
Opaque structure that represents the storage area that is actually used by Orthanc.
Definition: OrthancCPlugin.h:1146
OrthancPluginCompressionType
Definition: OrthancCPlugin.h:767
uint32_t OrthancPluginGetImageWidth(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the width of an image.
Definition: OrthancCPlugin.h:4021
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:3800
uint32_t OrthancPluginGetFontSize(OrthancPluginContext *context, uint32_t fontIndex)
Return the size of a font.
Definition: OrthancCPlugin.h:4661
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:5574
struct _OrthancPluginImage_t OrthancPluginImage
Opaque structure that represents an image that is uncompressed in memory.
Definition: OrthancCPlugin.h:1138
@ OrthancPluginPixelFormat_RGBA32
Color image in RGBA32 format.
Definition: OrthancCPlugin.h:652
@ OrthancPluginPixelFormat_RGB48
Color image in RGB48 format.
Definition: OrthancCPlugin.h:662
@ OrthancPluginPixelFormat_Grayscale8
Graylevel 8bpp image.
Definition: OrthancCPlugin.h:620
@ OrthancPluginPixelFormat_SignedGrayscale16
Graylevel, signed 16bpp image.
Definition: OrthancCPlugin.h:636
@ OrthancPluginPixelFormat_Float32
Graylevel, floating-point 32bpp image.
Definition: OrthancCPlugin.h:678
@ OrthancPluginPixelFormat_RGB24
Color image in RGB24 format.
Definition: OrthancCPlugin.h:644
@ OrthancPluginPixelFormat_BGRA32
Color image in BGRA32 format.
Definition: OrthancCPlugin.h:686
@ OrthancPluginPixelFormat_Unknown
Definition: OrthancCPlugin.h:654
@ OrthancPluginPixelFormat_Grayscale64
Graylevel, unsigned 64bpp image.
Definition: OrthancCPlugin.h:694
@ OrthancPluginPixelFormat_Grayscale32
Graylevel, unsigned 32bpp image.
Definition: OrthancCPlugin.h:670
@ OrthancPluginPixelFormat_Grayscale16
Graylevel, unsigned 16bpp image.
Definition: OrthancCPlugin.h:628
@ OrthancPluginImageFormat_Png
Definition: OrthancCPlugin.h:783
@ OrthancPluginImageFormat_Jpeg
Definition: OrthancCPlugin.h:784
@ OrthancPluginImageFormat_Dicom
Definition: OrthancCPlugin.h:785
@ OrthancPluginCompressionType_Gzip
Definition: OrthancCPlugin.h:770
@ OrthancPluginCompressionType_ZlibWithSize
Definition: OrthancCPlugin.h:769
@ OrthancPluginCompressionType_Zlib
Definition: OrthancCPlugin.h:768
@ OrthancPluginCompressionType_GzipWithSize
Definition: OrthancCPlugin.h:771
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:2462
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:2497
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:2610
char * OrthancPluginLookupStudyWithAccessionNumber(OrthancPluginContext *context, const char *accessionNumber)
Look for a study, using the accession number.
Definition: OrthancCPlugin.h:2746
char * OrthancPluginLookupSeries(OrthancPluginContext *context, const char *seriesUID)
Look for a series.
Definition: OrthancCPlugin.h:2781
OrthancPluginErrorCode OrthancPluginSetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *value)
Set the value of a global property.
Definition: OrthancCPlugin.h:3558
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:2574
char * OrthancPluginGetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *defaultValue)
Get the value of a global property.
Definition: OrthancCPlugin.h:3519
char * OrthancPluginLookupStudy(OrthancPluginContext *context, const char *studyUID)
Look for a study.
Definition: OrthancCPlugin.h:2711
OrthancPluginErrorCode OrthancPluginRestApiGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2395
char * OrthancPluginLookupInstance(OrthancPluginContext *context, const char *sopInstanceUID)
Look for an instance.
Definition: OrthancCPlugin.h:2816
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:2425
char * OrthancPluginLookupPatient(OrthancPluginContext *context, const char *patientID)
Look for a patient.
Definition: OrthancCPlugin.h:2676
OrthancPluginErrorCode OrthancPluginRestApiDelete(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2526
OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:2549
OrthancPluginErrorCode OrthancPluginCallRestApi(OrthancPluginContext *context, OrthancPluginMemoryBuffer *answerBody, OrthancPluginMemoryBuffer *answerHeaders, uint16_t *httpStatus, OrthancPluginHttpMethod method, const char *uri, uint32_t headersCount, const char *const *headersKeys, const char *const *headersValues, const void *body, uint32_t bodySize, uint8_t afterPlugins)
Call the REST API of Orthanc with full flexibility.
Definition: OrthancCPlugin.h:8885
char * OrthancPluginGenerateRestApiAuthorizationToken(OrthancPluginContext *context)
Generate a token to grant full access to the REST API of Orthanc.
Definition: OrthancCPlugin.h:8687
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:5194
OrthancPluginErrorCode OrthancPluginGetDicomForInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *instanceId)
Retrieve a DICOM instance using its Orthanc identifier.
Definition: OrthancCPlugin.h:2362
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:2321
void OrthancPluginSendUnauthorized(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *realm)
Signal that a REST request is not authorized.
Definition: OrthancCPlugin.h:2884
void OrthancPluginSetHttpErrorDetails(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *details, uint8_t log)
Provide a detailed description for an HTTP error.
Definition: OrthancCPlugin.h:7044
void OrthancPluginSendMethodNotAllowed(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *allowedMethods)
Signal that this URI does not support this HTTP method.
Definition: OrthancCPlugin.h:2907
void OrthancPluginAnswerBuffer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const void *answer, uint32_t answerSize, const char *mimeType)
Answer to a REST request.
Definition: OrthancCPlugin.h:2264
void OrthancPluginSendHttpStatusCode(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status)
Send a HTTP status code.
Definition: OrthancCPlugin.h:2861
void OrthancPluginSetHttpHeader(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *key, const char *value)
Set some HTTP header.
Definition: OrthancCPlugin.h:2962
void OrthancPluginSetCookie(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *cookie, const char *value)
Set a cookie.
Definition: OrthancCPlugin.h:2937
void OrthancPluginRedirect(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *redirection)
Redirect a REST request.
Definition: OrthancCPlugin.h:2644
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:4345
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:3758
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:5791
void OrthancPluginSendHttpStatus(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status, const void *body, uint32_t bodySize)
Send a HTTP status, with a custom body.
Definition: OrthancCPlugin.h:3952
OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *subType, const char *contentType)
Start an HTTP multipart answer.
Definition: OrthancCPlugin.h:3729
An entry in the dictionary of DICOM tags.
Definition: OrthancCPlugin.h:1880
uint32_t minMultiplicity
Definition: OrthancCPlugin.h:1884
uint32_t maxMultiplicity
Definition: OrthancCPlugin.h:1885
OrthancPluginValueRepresentation vr
Definition: OrthancCPlugin.h:1883
uint16_t element
Definition: OrthancCPlugin.h:1882
uint16_t group
Definition: OrthancCPlugin.h:1881
The parameters of a REST request.
Definition: OrthancCPlugin.h:342
const char *const * getValues
For a GET request, the values of the GET parameters.
Definition: OrthancCPlugin.h:371
const char *const * groups
The matched values for the groups of the regular expression.
Definition: OrthancCPlugin.h:356
uint32_t bodySize
For a PUT or POST request, the number of bytes of the body.
Definition: OrthancCPlugin.h:381
uint32_t groupsCount
The number of groups of the regular expression.
Definition: OrthancCPlugin.h:351
const char *const * headersKeys
The keys of the HTTP headers (always converted to low-case).
Definition: OrthancCPlugin.h:396
const void * body
For a PUT or POST request, the content of the body.
Definition: OrthancCPlugin.h:376
const char *const * getKeys
For a GET request, the keys of the GET parameters.
Definition: OrthancCPlugin.h:366
uint32_t headersCount
The number of HTTP headers.
Definition: OrthancCPlugin.h:391
OrthancPluginHttpMethod method
The HTTP method.
Definition: OrthancCPlugin.h:346
uint32_t getCount
For a GET request, the number of GET parameters.
Definition: OrthancCPlugin.h:361
const char *const * headersValues
The values of the HTTP headers.
Definition: OrthancCPlugin.h:401
A 64-bit memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:1103
uint64_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:1112
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:1107
A 32-bit memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:1081
uint32_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:1090
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:1085