115 # define ORTHANC_PLUGINS_API __declspec(dllexport)
117 # define ORTHANC_PLUGINS_API __attribute__ ((visibility ("default")))
119 # define ORTHANC_PLUGINS_API
122 #define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 1
123 #define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 12
124 #define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 6
127 #if !defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE)
128 #define ORTHANC_PLUGINS_VERSION_IS_ABOVE(major, minor, revision) \
129 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER > major || \
130 (ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER == major && \
131 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER > minor || \
132 (ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER == minor && \
133 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER >= revision))))
152 #ifndef ORTHANC_PLUGIN_INLINE
153 # if __STDC_VERSION__ >= 199901L
155 # define ORTHANC_PLUGIN_INLINE static inline
156 # elif defined(__cplusplus)
158 # define ORTHANC_PLUGIN_INLINE static inline
159 # elif defined(__GNUC__)
161 # define ORTHANC_PLUGIN_INLINE static __inline
162 # elif defined(_MSC_VER)
164 # define ORTHANC_PLUGIN_INLINE static __inline
166 # error Your compiler is not known to support the "inline" keyword
171 #ifndef ORTHANC_PLUGIN_DEPRECATED
172 # if defined(_MSC_VER)
173 # define ORTHANC_PLUGIN_DEPRECATED __declspec(deprecated)
175 # define ORTHANC_PLUGIN_DEPRECATED __attribute__ ((deprecated))
176 # elif defined(__clang__)
177 # define ORTHANC_PLUGIN_DEPRECATED __attribute__ ((deprecated))
179 # pragma message("WARNING: You need to implement ORTHANC_PLUGINS_DEPRECATED for this compiler")
180 # define ORTHANC_PLUGIN_DEPRECATED
330 _OrthancPluginErrorCode_INTERNAL = 0x7fffffff
338 ORTHANC_PLUGINS_API
const char* OrthancPluginGetName();
351 _OrthancPluginHttpMethod_INTERNAL = 0x7fffffff
427 _OrthancPluginService_LogInfo = 1,
428 _OrthancPluginService_LogWarning = 2,
429 _OrthancPluginService_LogError = 3,
430 _OrthancPluginService_GetOrthancPath = 4,
431 _OrthancPluginService_GetOrthancDirectory = 5,
432 _OrthancPluginService_GetConfigurationPath = 6,
433 _OrthancPluginService_SetPluginProperty = 7,
434 _OrthancPluginService_GetGlobalProperty = 8,
435 _OrthancPluginService_SetGlobalProperty = 9,
436 _OrthancPluginService_GetCommandLineArgumentsCount = 10,
437 _OrthancPluginService_GetCommandLineArgument = 11,
438 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
439 _OrthancPluginService_GetConfiguration = 13,
440 _OrthancPluginService_BufferCompression = 14,
441 _OrthancPluginService_ReadFile = 15,
442 _OrthancPluginService_WriteFile = 16,
443 _OrthancPluginService_GetErrorDescription = 17,
444 _OrthancPluginService_CallHttpClient = 18,
445 _OrthancPluginService_RegisterErrorCode = 19,
446 _OrthancPluginService_RegisterDictionaryTag = 20,
447 _OrthancPluginService_DicomBufferToJson = 21,
448 _OrthancPluginService_DicomInstanceToJson = 22,
449 _OrthancPluginService_CreateDicom = 23,
450 _OrthancPluginService_ComputeMd5 = 24,
451 _OrthancPluginService_ComputeSha1 = 25,
452 _OrthancPluginService_LookupDictionary = 26,
453 _OrthancPluginService_CallHttpClient2 = 27,
454 _OrthancPluginService_GenerateUuid = 28,
455 _OrthancPluginService_RegisterPrivateDictionaryTag = 29,
456 _OrthancPluginService_AutodetectMimeType = 30,
457 _OrthancPluginService_SetMetricsValue = 31,
458 _OrthancPluginService_EncodeDicomWebJson = 32,
459 _OrthancPluginService_EncodeDicomWebXml = 33,
460 _OrthancPluginService_ChunkedHttpClient = 34,
461 _OrthancPluginService_GetTagName = 35,
462 _OrthancPluginService_EncodeDicomWebJson2 = 36,
463 _OrthancPluginService_EncodeDicomWebXml2 = 37,
464 _OrthancPluginService_CreateMemoryBuffer = 38,
465 _OrthancPluginService_GenerateRestApiAuthorizationToken = 39,
466 _OrthancPluginService_CreateMemoryBuffer64 = 40,
467 _OrthancPluginService_CreateDicom2 = 41,
468 _OrthancPluginService_GetDatabaseServerIdentifier = 42,
469 _OrthancPluginService_SetMetricsIntegerValue = 43,
470 _OrthancPluginService_SetCurrentThreadName = 44,
471 _OrthancPluginService_LogMessage = 45,
475 _OrthancPluginService_RegisterRestCallback = 1000,
476 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
477 _OrthancPluginService_RegisterStorageArea = 1002,
478 _OrthancPluginService_RegisterOnChangeCallback = 1003,
479 _OrthancPluginService_RegisterRestCallbackNoLock = 1004,
480 _OrthancPluginService_RegisterWorklistCallback = 1005,
481 _OrthancPluginService_RegisterDecodeImageCallback = 1006,
482 _OrthancPluginService_RegisterIncomingHttpRequestFilter = 1007,
483 _OrthancPluginService_RegisterFindCallback = 1008,
484 _OrthancPluginService_RegisterMoveCallback = 1009,
485 _OrthancPluginService_RegisterIncomingHttpRequestFilter2 = 1010,
486 _OrthancPluginService_RegisterRefreshMetricsCallback = 1011,
487 _OrthancPluginService_RegisterChunkedRestCallback = 1012,
488 _OrthancPluginService_RegisterStorageCommitmentScpCallback = 1013,
489 _OrthancPluginService_RegisterIncomingDicomInstanceFilter = 1014,
490 _OrthancPluginService_RegisterTranscoderCallback = 1015,
491 _OrthancPluginService_RegisterStorageArea2 = 1016,
492 _OrthancPluginService_RegisterIncomingCStoreInstanceFilter = 1017,
493 _OrthancPluginService_RegisterReceivedInstanceCallback = 1018,
494 _OrthancPluginService_RegisterWebDavCollection = 1019,
497 _OrthancPluginService_AnswerBuffer = 2000,
498 _OrthancPluginService_CompressAndAnswerPngImage = 2001,
499 _OrthancPluginService_Redirect = 2002,
500 _OrthancPluginService_SendHttpStatusCode = 2003,
501 _OrthancPluginService_SendUnauthorized = 2004,
502 _OrthancPluginService_SendMethodNotAllowed = 2005,
503 _OrthancPluginService_SetCookie = 2006,
504 _OrthancPluginService_SetHttpHeader = 2007,
505 _OrthancPluginService_StartMultipartAnswer = 2008,
506 _OrthancPluginService_SendMultipartItem = 2009,
507 _OrthancPluginService_SendHttpStatus = 2010,
508 _OrthancPluginService_CompressAndAnswerImage = 2011,
509 _OrthancPluginService_SendMultipartItem2 = 2012,
510 _OrthancPluginService_SetHttpErrorDetails = 2013,
511 _OrthancPluginService_StartStreamAnswer = 2014,
512 _OrthancPluginService_SendStreamChunk = 2015,
515 _OrthancPluginService_GetDicomForInstance = 3000,
516 _OrthancPluginService_RestApiGet = 3001,
517 _OrthancPluginService_RestApiPost = 3002,
518 _OrthancPluginService_RestApiDelete = 3003,
519 _OrthancPluginService_RestApiPut = 3004,
520 _OrthancPluginService_LookupPatient = 3005,
521 _OrthancPluginService_LookupStudy = 3006,
522 _OrthancPluginService_LookupSeries = 3007,
523 _OrthancPluginService_LookupInstance = 3008,
524 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
525 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
526 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
527 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
528 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
529 _OrthancPluginService_ReconstructMainDicomTags = 3014,
530 _OrthancPluginService_RestApiGet2 = 3015,
531 _OrthancPluginService_CallRestApi = 3016,
534 _OrthancPluginService_GetInstanceRemoteAet = 4000,
535 _OrthancPluginService_GetInstanceSize = 4001,
536 _OrthancPluginService_GetInstanceData = 4002,
537 _OrthancPluginService_GetInstanceJson = 4003,
538 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
539 _OrthancPluginService_HasInstanceMetadata = 4005,
540 _OrthancPluginService_GetInstanceMetadata = 4006,
541 _OrthancPluginService_GetInstanceOrigin = 4007,
542 _OrthancPluginService_GetInstanceTransferSyntaxUid = 4008,
543 _OrthancPluginService_HasInstancePixelData = 4009,
544 _OrthancPluginService_CreateDicomInstance = 4010,
545 _OrthancPluginService_FreeDicomInstance = 4011,
546 _OrthancPluginService_GetInstanceFramesCount = 4012,
547 _OrthancPluginService_GetInstanceRawFrame = 4013,
548 _OrthancPluginService_GetInstanceDecodedFrame = 4014,
549 _OrthancPluginService_TranscodeDicomInstance = 4015,
550 _OrthancPluginService_SerializeDicomInstance = 4016,
551 _OrthancPluginService_GetInstanceAdvancedJson = 4017,
552 _OrthancPluginService_GetInstanceDicomWebJson = 4018,
553 _OrthancPluginService_GetInstanceDicomWebXml = 4019,
554 _OrthancPluginService_LoadDicomInstance = 4020,
557 _OrthancPluginService_RegisterDatabaseBackend = 5000,
558 _OrthancPluginService_DatabaseAnswer = 5001,
559 _OrthancPluginService_RegisterDatabaseBackendV2 = 5002,
560 _OrthancPluginService_StorageAreaCreate = 5003,
561 _OrthancPluginService_StorageAreaRead = 5004,
562 _OrthancPluginService_StorageAreaRemove = 5005,
563 _OrthancPluginService_RegisterDatabaseBackendV3 = 5006,
564 _OrthancPluginService_RegisterDatabaseBackendV4 = 5007,
567 _OrthancPluginService_GetImagePixelFormat = 6000,
568 _OrthancPluginService_GetImageWidth = 6001,
569 _OrthancPluginService_GetImageHeight = 6002,
570 _OrthancPluginService_GetImagePitch = 6003,
571 _OrthancPluginService_GetImageBuffer = 6004,
572 _OrthancPluginService_UncompressImage = 6005,
573 _OrthancPluginService_FreeImage = 6006,
574 _OrthancPluginService_CompressImage = 6007,
575 _OrthancPluginService_ConvertPixelFormat = 6008,
576 _OrthancPluginService_GetFontsCount = 6009,
577 _OrthancPluginService_GetFontInfo = 6010,
578 _OrthancPluginService_DrawText = 6011,
579 _OrthancPluginService_CreateImage = 6012,
580 _OrthancPluginService_CreateImageAccessor = 6013,
581 _OrthancPluginService_DecodeDicomImage = 6014,
584 _OrthancPluginService_WorklistAddAnswer = 7000,
585 _OrthancPluginService_WorklistMarkIncomplete = 7001,
586 _OrthancPluginService_WorklistIsMatch = 7002,
587 _OrthancPluginService_WorklistGetDicomQuery = 7003,
588 _OrthancPluginService_FindAddAnswer = 7004,
589 _OrthancPluginService_FindMarkIncomplete = 7005,
590 _OrthancPluginService_GetFindQuerySize = 7006,
591 _OrthancPluginService_GetFindQueryTag = 7007,
592 _OrthancPluginService_GetFindQueryTagName = 7008,
593 _OrthancPluginService_GetFindQueryValue = 7009,
594 _OrthancPluginService_CreateFindMatcher = 7010,
595 _OrthancPluginService_FreeFindMatcher = 7011,
596 _OrthancPluginService_FindMatcherIsMatch = 7012,
599 _OrthancPluginService_GetPeers = 8000,
600 _OrthancPluginService_FreePeers = 8001,
601 _OrthancPluginService_GetPeersCount = 8003,
602 _OrthancPluginService_GetPeerName = 8004,
603 _OrthancPluginService_GetPeerUrl = 8005,
604 _OrthancPluginService_CallPeerApi = 8006,
605 _OrthancPluginService_GetPeerUserProperty = 8007,
608 _OrthancPluginService_CreateJob = 9000,
609 _OrthancPluginService_FreeJob = 9001,
610 _OrthancPluginService_SubmitJob = 9002,
611 _OrthancPluginService_RegisterJobsUnserializer = 9003,
612 _OrthancPluginService_CreateJob2 = 9004,
614 _OrthancPluginService_INTERNAL = 0x7fffffff
615 } _OrthancPluginService;
620 _OrthancPluginProperty_Description = 1,
621 _OrthancPluginProperty_RootUri = 2,
622 _OrthancPluginProperty_OrthancExplorer = 3,
624 _OrthancPluginProperty_INTERNAL = 0x7fffffff
625 } _OrthancPluginProperty;
717 _OrthancPluginPixelFormat_INTERNAL = 0x7fffffff
732 _OrthancPluginContentType_INTERNAL = 0x7fffffff
748 _OrthancPluginResourceType_INTERNAL = 0x7fffffff
780 _OrthancPluginChangeType_INTERNAL = 0x7fffffff
795 _OrthancPluginCompressionType_INTERNAL = 0x7fffffff
809 _OrthancPluginImageFormat_INTERNAL = 0x7fffffff
847 _OrthancPluginValueRepresentation_INTERNAL = 0x7fffffff
862 _OrthancPluginDicomToJsonFormat_INTERNAL = 0x7fffffff
883 _OrthancPluginDicomToJsonFlags_INTERNAL = 0x7fffffff
898 _OrthancPluginCreateDicomFlags_INTERNAL = 0x7fffffff
914 _OrthancPluginIdentifierConstraint_INTERNAL = 0x7fffffff
930 _OrthancPluginConstraintType_INTERNAL = 0x7fffffff
946 _OrthancPluginInstanceOrigin_INTERNAL = 0x7fffffff
1063 _OrthancPluginReceivedInstanceAction_INTERNAL = 0x7fffffff
1091 _OrthancPluginLoadDicomInstanceMode_INTERNAL = 0x7fffffff
1108 _OrthancPluginLogLevel_INTERNAL = 0x7fffffff
1128 _OrthancPluginLogCategory_INTERNAL = 0x7fffffff
1291 const char* instanceId);
1302 const char* resourceId);
1313 const uint32_t size,
1314 uint32_t frameIndex);
1335 const char* bulkDataUri);
1353 const void* content,
1425 uint64_t rangeStart);
1461 const char* issuerAet,
1462 const char* calledAet);
1493 uint32_t headersCount,
1494 const char*
const* headersKeys,
1495 const char*
const* headersValues);
1528 uint32_t headersCount,
1529 const char*
const* headersKeys,
1530 const char*
const* headersValues,
1531 uint32_t getArgumentsCount,
1532 const char*
const* getArgumentsKeys,
1533 const char*
const* getArgumentsValues);
1554 const char* issuerAet,
1555 const char* calledAet);
1594 typedef void* (*OrthancPluginMoveCallback) (
1596 const char* patientId,
1597 const char* accessionNumber,
1598 const char* studyInstanceUid,
1599 const char* seriesInstanceUid,
1600 const char* sopInstanceUid,
1601 const char* originatorAet,
1602 const char* sourceAet,
1603 const char* targetAet,
1604 uint16_t originatorId);
1690 typedef const char* (*OrthancPluginJobGetContent) (
void* job);
1728 typedef const char* (*OrthancPluginJobGetSerialized) (
void* job);
1822 const char* serialized);
1871 uint32_t levelDepth,
1872 const uint16_t* levelTagGroup,
1873 const uint16_t* levelTagElement,
1874 const uint32_t* levelIndex,
1876 uint16_t tagElement,
1909 uint32_t levelDepth,
1910 const uint16_t* levelTagGroup,
1911 const uint16_t* levelTagElement,
1912 const uint32_t* levelIndex,
1914 uint16_t tagElement,
1923 typedef struct _OrthancPluginContext_t
1925 void* pluginsManager;
1926 const char* orthancVersion;
1929 _OrthancPluginService service,
1930 const void* params);
1989 int32_t expectedMajor,
1990 int32_t expectedMinor,
1991 int32_t expectedRevision)
1993 int32_t major, minor, revision;
1995 if (
sizeof(
int) !=
sizeof(int32_t) ||
1998 sizeof(int32_t) !=
sizeof(_OrthancPluginService) ||
1999 sizeof(int32_t) !=
sizeof(_OrthancPluginProperty) ||
2026 if (!strcmp(context->orthancVersion,
"mainline"))
2038 (context->orthancVersion,
"%4d.%4d.%4d", &major, &minor, &revision) != 3)
2045 if (major > expectedMajor)
2050 if (major < expectedMajor)
2057 if (minor > expectedMinor)
2062 if (minor < expectedMinor)
2069 if (revision >= expectedRevision)
2101 ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER,
2102 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER,
2103 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER);
2119 context->Free(buffer->
data);
2135 context->Free(buffer->
data);
2149 const char* message)
2151 context->InvokeService(context, _OrthancPluginService_LogError, message);
2165 const char* message)
2167 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
2181 const char* message)
2183 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
2190 const char* pathRegularExpression;
2192 } _OrthancPluginRestCallback;
2217 const char* pathRegularExpression,
2220 _OrthancPluginRestCallback params;
2221 params.pathRegularExpression = pathRegularExpression;
2222 params.callback = callback;
2223 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
2257 const char* pathRegularExpression,
2260 _OrthancPluginRestCallback params;
2261 params.pathRegularExpression = pathRegularExpression;
2262 params.callback = callback;
2263 context->InvokeService(context, _OrthancPluginService_RegisterRestCallbackNoLock, ¶ms);
2271 } _OrthancPluginOnStoredInstanceCallback;
2297 _OrthancPluginOnStoredInstanceCallback params;
2298 params.callback = callback;
2300 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
2309 uint32_t answerSize;
2310 const char* mimeType;
2311 } _OrthancPluginAnswerBuffer;
2329 uint32_t answerSize,
2330 const char* mimeType)
2332 _OrthancPluginAnswerBuffer params;
2333 params.output = output;
2334 params.answer = answer;
2335 params.answerSize = answerSize;
2336 params.mimeType = mimeType;
2337 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms);
2349 } _OrthancPluginCompressAndAnswerPngImage;
2361 } _OrthancPluginCompressAndAnswerImage;
2391 _OrthancPluginCompressAndAnswerImage params;
2392 params.output = output;
2394 params.pixelFormat = format;
2395 params.width = width;
2396 params.height = height;
2397 params.pitch = pitch;
2398 params.buffer = buffer;
2400 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
2408 const char* instanceId;
2409 } _OrthancPluginGetDicomForInstance;
2426 const char* instanceId)
2428 _OrthancPluginGetDicomForInstance params;
2429 params.target = target;
2430 params.instanceId = instanceId;
2431 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
2440 } _OrthancPluginRestApiGet;
2461 _OrthancPluginRestApiGet params;
2462 params.target = target;
2464 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
2491 _OrthancPluginRestApiGet params;
2492 params.target = target;
2494 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms);
2505 } _OrthancPluginRestApiPostPut;
2530 _OrthancPluginRestApiPostPut params;
2531 params.target = target;
2534 params.bodySize = bodySize;
2535 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
2565 _OrthancPluginRestApiPostPut params;
2566 params.target = target;
2569 params.bodySize = bodySize;
2570 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms);
2591 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
2614 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
2642 _OrthancPluginRestApiPostPut params;
2643 params.target = target;
2646 params.bodySize = bodySize;
2647 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
2678 _OrthancPluginRestApiPostPut params;
2679 params.target = target;
2682 params.bodySize = bodySize;
2683 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms);
2691 const char* argument;
2692 } _OrthancPluginOutputPlusArgument;
2708 const char* redirection)
2710 _OrthancPluginOutputPlusArgument params;
2711 params.output = output;
2712 params.argument = redirection;
2713 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
2721 const char* argument;
2722 } _OrthancPluginRetrieveDynamicString;
2739 const char* patientID)
2743 _OrthancPluginRetrieveDynamicString params;
2744 params.result = &result;
2745 params.argument = patientID;
2774 const char* studyUID)
2778 _OrthancPluginRetrieveDynamicString params;
2779 params.result = &result;
2780 params.argument = studyUID;
2809 const char* accessionNumber)
2813 _OrthancPluginRetrieveDynamicString params;
2814 params.result = &result;
2815 params.argument = accessionNumber;
2844 const char* seriesUID)
2848 _OrthancPluginRetrieveDynamicString params;
2849 params.result = &result;
2850 params.argument = seriesUID;
2879 const char* sopInstanceUID)
2883 _OrthancPluginRetrieveDynamicString params;
2884 params.result = &result;
2885 params.argument = sopInstanceUID;
2904 } _OrthancPluginSendHttpStatusCode;
2927 _OrthancPluginSendHttpStatusCode params;
2928 params.output = output;
2929 params.status = status;
2930 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
2950 _OrthancPluginOutputPlusArgument params;
2951 params.output = output;
2952 params.argument = realm;
2953 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
2971 const char* allowedMethods)
2973 _OrthancPluginOutputPlusArgument params;
2974 params.output = output;
2975 params.argument = allowedMethods;
2976 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
2985 } _OrthancPluginSetHttpHeader;
3004 _OrthancPluginSetHttpHeader params;
3005 params.output = output;
3006 params.key = cookie;
3007 params.value = value;
3008 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
3029 _OrthancPluginSetHttpHeader params;
3030 params.output = output;
3032 params.value = value;
3033 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
3039 char** resultStringToFree;
3040 const char** resultString;
3041 int64_t* resultInt64;
3045 } _OrthancPluginAccessDicomInstance;
3065 _OrthancPluginAccessDicomInstance params;
3066 memset(¶ms, 0,
sizeof(params));
3067 params.resultString = &result;
3068 params.instance = instance;
3098 _OrthancPluginAccessDicomInstance params;
3099 memset(¶ms, 0,
sizeof(params));
3100 params.resultInt64 = &size;
3101 params.instance = instance;
3131 _OrthancPluginAccessDicomInstance params;
3132 memset(¶ms, 0,
sizeof(params));
3133 params.resultString = &result;
3134 params.instance = instance;
3167 _OrthancPluginAccessDicomInstance params;
3168 memset(¶ms, 0,
sizeof(params));
3169 params.resultStringToFree = &result;
3170 params.instance = instance;
3205 _OrthancPluginAccessDicomInstance params;
3206 memset(¶ms, 0,
sizeof(params));
3207 params.resultStringToFree = &result;
3208 params.instance = instance;
3241 const char* metadata)
3245 _OrthancPluginAccessDicomInstance params;
3246 memset(¶ms, 0,
sizeof(params));
3247 params.resultInt64 = &result;
3248 params.instance = instance;
3249 params.key = metadata;
3258 return (result != 0);
3282 const char* metadata)
3286 _OrthancPluginAccessDicomInstance params;
3287 memset(¶ms, 0,
sizeof(params));
3288 params.resultString = &result;
3289 params.instance = instance;
3290 params.key = metadata;
3311 } _OrthancPluginRegisterStorageArea;
3334 _OrthancPluginRegisterStorageArea params;
3335 params.create = create;
3337 params.remove = remove;
3340 params.free = ::free;
3345 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
3364 _OrthancPluginRetrieveDynamicString params;
3365 params.result = &result;
3366 params.argument = NULL;
3394 _OrthancPluginRetrieveDynamicString params;
3395 params.result = &result;
3396 params.argument = NULL;
3429 _OrthancPluginRetrieveDynamicString params;
3430 params.result = &result;
3431 params.argument = NULL;
3449 } _OrthancPluginOnChangeCallback;
3475 _OrthancPluginOnChangeCallback params;
3476 params.callback = callback;
3478 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms);
3486 _OrthancPluginProperty property;
3488 } _OrthancPluginSetPluginProperty;
3510 _OrthancPluginSetPluginProperty params;
3511 params.plugin = OrthancPluginGetName();
3512 params.property = _OrthancPluginProperty_RootUri;
3515 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3536 _OrthancPluginSetPluginProperty params;
3537 params.plugin = plugin;
3538 params.property = _OrthancPluginProperty_RootUri;
3541 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3560 const char* description)
3562 _OrthancPluginSetPluginProperty params;
3563 params.plugin = OrthancPluginGetName();
3564 params.property = _OrthancPluginProperty_Description;
3565 params.value = description;
3567 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3584 const char* description)
3586 _OrthancPluginSetPluginProperty params;
3587 params.plugin = plugin;
3588 params.property = _OrthancPluginProperty_Description;
3589 params.value = description;
3591 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3610 const char* javascript)
3612 _OrthancPluginSetPluginProperty params;
3613 params.plugin = OrthancPluginGetName();
3614 params.property = _OrthancPluginProperty_OrthancExplorer;
3615 params.value = javascript;
3617 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3634 const char* javascript)
3636 _OrthancPluginSetPluginProperty params;
3637 params.plugin = plugin;
3638 params.property = _OrthancPluginProperty_OrthancExplorer;
3639 params.value = javascript;
3641 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
3650 } _OrthancPluginGlobalProperty;
3669 const char* defaultValue)
3673 _OrthancPluginGlobalProperty params;
3674 params.result = &result;
3675 params.property = property;
3676 params.value = defaultValue;
3710 _OrthancPluginGlobalProperty params;
3711 params.result = NULL;
3712 params.property = property;
3713 params.value = value;
3715 return context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms);
3722 int32_t *resultInt32;
3723 uint32_t *resultUint32;
3724 int64_t *resultInt64;
3725 uint64_t *resultUint64;
3726 } _OrthancPluginReturnSingleValue;
3741 _OrthancPluginReturnSingleValue params;
3742 memset(¶ms, 0,
sizeof(params));
3743 params.resultUint32 = &count;
3776 _OrthancPluginGlobalProperty params;
3777 params.result = &result;
3778 params.property = (int32_t) argument;
3779 params.value = NULL;
3807 _OrthancPluginReturnSingleValue params;
3808 memset(¶ms, 0,
sizeof(params));
3809 params.resultUint32 = &count;
3839 _OrthancPluginRetrieveDynamicString params;
3840 params.result = &result;
3841 params.argument = NULL;
3859 const char* subType;
3860 const char* contentType;
3861 } _OrthancPluginStartMultipartAnswer;
3879 const char* subType,
3880 const char* contentType)
3882 _OrthancPluginStartMultipartAnswer params;
3883 params.output = output;
3884 params.subType = subType;
3885 params.contentType = contentType;
3886 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms);
3909 uint32_t answerSize)
3911 _OrthancPluginAnswerBuffer params;
3912 params.output = output;
3913 params.answer = answer;
3914 params.answerSize = answerSize;
3915 params.mimeType = NULL;
3916 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms);
3928 } _OrthancPluginBufferCompression;
3955 _OrthancPluginBufferCompression params;
3956 params.target = target;
3957 params.source = source;
3959 params.compression = compression;
3960 params.uncompress = uncompress;
3962 return context->InvokeService(context, _OrthancPluginService_BufferCompression, ¶ms);
3971 } _OrthancPluginReadFile;
3989 _OrthancPluginReadFile params;
3990 params.target = target;
3992 return context->InvokeService(context, _OrthancPluginService_ReadFile, ¶ms);
4002 } _OrthancPluginWriteFile;
4021 _OrthancPluginWriteFile params;
4025 return context->InvokeService(context, _OrthancPluginService_WriteFile, ¶ms);
4032 const char** target;
4034 } _OrthancPluginGetErrorDescription;
4050 const char* result = NULL;
4052 _OrthancPluginGetErrorDescription params;
4053 params.target = &result;
4054 params.error = error;
4059 return "Unknown error code";
4075 } _OrthancPluginSendHttpStatus;
4106 _OrthancPluginSendHttpStatus params;
4107 params.output = output;
4108 params.status = status;
4110 params.bodySize = bodySize;
4111 context->InvokeService(context, _OrthancPluginService_SendHttpStatus, ¶ms);
4119 uint32_t* resultUint32;
4121 void** resultBuffer;
4122 } _OrthancPluginGetImageInfo;
4141 _OrthancPluginGetImageInfo params;
4142 memset(¶ms, 0,
sizeof(params));
4143 params.image = image;
4144 params.resultPixelFormat = ⌖
4174 _OrthancPluginGetImageInfo params;
4175 memset(¶ms, 0,
sizeof(params));
4176 params.image = image;
4177 params.resultUint32 = &width;
4207 _OrthancPluginGetImageInfo params;
4208 memset(¶ms, 0,
sizeof(params));
4209 params.image = image;
4210 params.resultUint32 = &height;
4242 _OrthancPluginGetImageInfo params;
4243 memset(¶ms, 0,
sizeof(params));
4244 params.image = image;
4245 params.resultUint32 = &pitch;
4274 void* target = NULL;
4276 _OrthancPluginGetImageInfo params;
4277 memset(¶ms, 0,
sizeof(params));
4278 params.resultBuffer = ⌖
4279 params.image = image;
4298 } _OrthancPluginUncompressImage;
4321 _OrthancPluginUncompressImage params;
4322 memset(¶ms, 0,
sizeof(params));
4323 params.target = ⌖
4326 params.format = format;
4344 } _OrthancPluginFreeImage;
4359 _OrthancPluginFreeImage params;
4360 params.image = image;
4362 context->InvokeService(context, _OrthancPluginService_FreeImage, ¶ms);
4378 } _OrthancPluginCompressImage;
4409 _OrthancPluginCompressImage params;
4410 memset(¶ms, 0,
sizeof(params));
4411 params.target = target;
4413 params.pixelFormat = format;
4414 params.width = width;
4415 params.height = height;
4416 params.pitch = pitch;
4417 params.buffer = buffer;
4420 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4455 _OrthancPluginCompressImage params;
4456 memset(¶ms, 0,
sizeof(params));
4457 params.target = target;
4459 params.pixelFormat = format;
4460 params.width = width;
4461 params.height = height;
4462 params.pitch = pitch;
4463 params.buffer = buffer;
4464 params.quality = quality;
4466 return context->InvokeService(context, _OrthancPluginService_CompressImage, ¶ms);
4502 _OrthancPluginCompressAndAnswerImage params;
4503 params.output = output;
4505 params.pixelFormat = format;
4506 params.width = width;
4507 params.height = height;
4508 params.pitch = pitch;
4509 params.buffer = buffer;
4510 params.quality = quality;
4511 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerImage, ¶ms);
4522 const char* username;
4523 const char* password;
4526 } _OrthancPluginCallHttpClient;
4549 const char* username,
4550 const char* password)
4552 _OrthancPluginCallHttpClient params;
4553 memset(¶ms, 0,
sizeof(params));
4555 params.target = target;
4558 params.username = username;
4559 params.password = password;
4561 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4589 const char* username,
4590 const char* password)
4592 _OrthancPluginCallHttpClient params;
4593 memset(¶ms, 0,
sizeof(params));
4595 params.target = target;
4599 params.bodySize = bodySize;
4600 params.username = username;
4601 params.password = password;
4603 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4631 const char* username,
4632 const char* password)
4634 _OrthancPluginCallHttpClient params;
4635 memset(¶ms, 0,
sizeof(params));
4637 params.target = target;
4641 params.bodySize = bodySize;
4642 params.username = username;
4643 params.password = password;
4645 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4666 const char* username,
4667 const char* password)
4669 _OrthancPluginCallHttpClient params;
4670 memset(¶ms, 0,
sizeof(params));
4674 params.username = username;
4675 params.password = password;
4677 return context->InvokeService(context, _OrthancPluginService_CallHttpClient, ¶ms);
4687 } _OrthancPluginConvertPixelFormat;
4708 _OrthancPluginConvertPixelFormat params;
4709 params.target = ⌖
4710 params.source = source;
4711 params.targetFormat = targetFormat;
4741 _OrthancPluginReturnSingleValue params;
4742 memset(¶ms, 0,
sizeof(params));
4743 params.resultUint32 = &count;
4764 } _OrthancPluginGetFontInfo;
4780 const char* result = NULL;
4782 _OrthancPluginGetFontInfo params;
4783 memset(¶ms, 0,
sizeof(params));
4784 params.name = &result;
4785 params.fontIndex = fontIndex;
4814 _OrthancPluginGetFontInfo params;
4815 memset(¶ms, 0,
sizeof(params));
4816 params.size = &result;
4817 params.fontIndex = fontIndex;
4835 const char* utf8Text;
4841 } _OrthancPluginDrawText;
4865 const char* utf8Text,
4872 _OrthancPluginDrawText params;
4873 memset(¶ms, 0,
sizeof(params));
4874 params.image = image;
4875 params.fontIndex = fontIndex;
4876 params.utf8Text = utf8Text;
4883 return context->InvokeService(context, _OrthancPluginService_DrawText, ¶ms);
4892 const void* content;
4895 } _OrthancPluginStorageAreaCreate;
4919 const void* content,
4923 _OrthancPluginStorageAreaCreate params;
4924 params.storageArea = storageArea;
4926 params.content = content;
4930 return context->InvokeService(context, _OrthancPluginService_StorageAreaCreate, ¶ms);
4940 } _OrthancPluginStorageAreaRead;
4966 _OrthancPluginStorageAreaRead params;
4967 params.target = target;
4968 params.storageArea = storageArea;
4972 return context->InvokeService(context, _OrthancPluginService_StorageAreaRead, ¶ms);
4981 } _OrthancPluginStorageAreaRemove;
5004 _OrthancPluginStorageAreaRemove params;
5005 params.storageArea = storageArea;
5009 return context->InvokeService(context, _OrthancPluginService_StorageAreaRemove, ¶ms);
5018 uint16_t httpStatus;
5019 const char* message;
5020 } _OrthancPluginRegisterErrorCode;
5040 uint16_t httpStatus,
5041 const char* message)
5045 _OrthancPluginRegisterErrorCode params;
5046 params.target = ⌖
5048 params.httpStatus = httpStatus;
5049 params.message = message;
5070 uint32_t minMultiplicity;
5071 uint32_t maxMultiplicity;
5072 } _OrthancPluginRegisterDictionaryTag;
5099 uint32_t minMultiplicity,
5100 uint32_t maxMultiplicity)
5102 _OrthancPluginRegisterDictionaryTag params;
5103 params.group = group;
5104 params.element = element;
5107 params.minMultiplicity = minMultiplicity;
5108 params.maxMultiplicity = maxMultiplicity;
5110 return context->InvokeService(context, _OrthancPluginService_RegisterDictionaryTag, ¶ms);
5121 uint32_t minMultiplicity;
5122 uint32_t maxMultiplicity;
5123 const char* privateCreator;
5124 } _OrthancPluginRegisterPrivateDictionaryTag;
5152 uint32_t minMultiplicity,
5153 uint32_t maxMultiplicity,
5154 const char* privateCreator)
5156 _OrthancPluginRegisterPrivateDictionaryTag params;
5157 params.group = group;
5158 params.element = element;
5161 params.minMultiplicity = minMultiplicity;
5162 params.maxMultiplicity = maxMultiplicity;
5163 params.privateCreator = privateCreator;
5165 return context->InvokeService(context, _OrthancPluginService_RegisterPrivateDictionaryTag, ¶ms);
5174 } _OrthancPluginReconstructMainDicomTags;
5195 _OrthancPluginReconstructMainDicomTags params;
5196 params.level = level;
5197 params.storageArea = storageArea;
5199 return context->InvokeService(context, _OrthancPluginService_ReconstructMainDicomTags, ¶ms);
5206 const char* instanceId;
5211 uint32_t maxStringLength;
5212 } _OrthancPluginDicomToJson;
5240 uint32_t maxStringLength)
5244 _OrthancPluginDicomToJson params;
5245 memset(¶ms, 0,
sizeof(params));
5246 params.result = &result;
5247 params.buffer = buffer;
5249 params.format = format;
5250 params.flags = flags;
5251 params.maxStringLength = maxStringLength;
5285 const char* instanceId,
5288 uint32_t maxStringLength)
5292 _OrthancPluginDicomToJson params;
5293 memset(¶ms, 0,
sizeof(params));
5294 params.result = &result;
5295 params.instanceId = instanceId;
5296 params.format = format;
5297 params.flags = flags;
5298 params.maxStringLength = maxStringLength;
5316 uint32_t headersCount;
5317 const char*
const* headersKeys;
5318 const char*
const* headersValues;
5319 int32_t afterPlugins;
5320 } _OrthancPluginRestApiGet2;
5345 uint32_t headersCount,
5346 const char*
const* headersKeys,
5347 const char*
const* headersValues,
5348 int32_t afterPlugins)
5350 _OrthancPluginRestApiGet2 params;
5351 params.target = target;
5353 params.headersCount = headersCount;
5354 params.headersKeys = headersKeys;
5355 params.headersValues = headersValues;
5356 params.afterPlugins = afterPlugins;
5358 return context->InvokeService(context, _OrthancPluginService_RestApiGet2, ¶ms);
5366 } _OrthancPluginWorklistCallback;
5383 _OrthancPluginWorklistCallback params;
5384 params.callback = callback;
5386 return context->InvokeService(context, _OrthancPluginService_RegisterWorklistCallback, ¶ms);
5397 } _OrthancPluginWorklistAnswersOperation;
5422 _OrthancPluginWorklistAnswersOperation params;
5423 params.answers = answers;
5424 params.query = query;
5425 params.dicom = dicom;
5428 return context->InvokeService(context, _OrthancPluginService_WorklistAddAnswer, ¶ms);
5449 _OrthancPluginWorklistAnswersOperation params;
5450 params.answers = answers;
5451 params.query = NULL;
5452 params.dicom = NULL;
5455 return context->InvokeService(context, _OrthancPluginService_WorklistMarkIncomplete, ¶ms);
5466 } _OrthancPluginWorklistQueryOperation;
5489 int32_t isMatch = 0;
5491 _OrthancPluginWorklistQueryOperation params;
5492 params.query = query;
5493 params.dicom = dicom;
5495 params.isMatch = &isMatch;
5496 params.target = NULL;
5527 _OrthancPluginWorklistQueryOperation params;
5528 params.query = query;
5529 params.dicom = NULL;
5531 params.isMatch = NULL;
5532 params.target = target;
5534 return context->InvokeService(context, _OrthancPluginService_WorklistGetDicomQuery, ¶ms);
5554 _OrthancPluginAccessDicomInstance params;
5555 memset(¶ms, 0,
sizeof(params));
5556 params.resultOrigin = &origin;
5557 params.instance = instance;
5577 } _OrthancPluginCreateDicom;
5611 _OrthancPluginCreateDicom params;
5612 params.target = target;
5614 params.pixelData = pixelData;
5615 params.flags = flags;
5617 return context->InvokeService(context, _OrthancPluginService_CreateDicom, ¶ms);
5624 } _OrthancPluginDecodeImageCallback;
5644 _OrthancPluginDecodeImageCallback params;
5645 params.callback = callback;
5647 return context->InvokeService(context, _OrthancPluginService_RegisterDecodeImageCallback, ¶ms);
5660 const void* constBuffer;
5661 uint32_t bufferSize;
5662 uint32_t frameIndex;
5663 } _OrthancPluginCreateImage;
5686 _OrthancPluginCreateImage params;
5687 memset(¶ms, 0,
sizeof(params));
5688 params.target = ⌖
5689 params.format = format;
5690 params.width = width;
5691 params.height = height;
5731 _OrthancPluginCreateImage params;
5732 memset(¶ms, 0,
sizeof(params));
5733 params.target = ⌖
5734 params.format = format;
5735 params.width = width;
5736 params.height = height;
5737 params.pitch = pitch;
5738 params.buffer = buffer;
5770 uint32_t bufferSize,
5771 uint32_t frameIndex)
5775 _OrthancPluginCreateImage params;
5776 memset(¶ms, 0,
sizeof(params));
5777 params.target = ⌖
5778 params.constBuffer = buffer;
5779 params.bufferSize = bufferSize;
5780 params.frameIndex = frameIndex;
5799 } _OrthancPluginComputeHash;
5820 _OrthancPluginComputeHash params;
5821 params.result = &result;
5822 params.buffer = buffer;
5856 _OrthancPluginComputeHash params;
5857 params.result = &result;
5858 params.buffer = buffer;
5878 } _OrthancPluginLookupDictionary;
5900 _OrthancPluginLookupDictionary params;
5901 params.target = target;
5903 return context->InvokeService(context, _OrthancPluginService_LookupDictionary, ¶ms);
5912 uint32_t answerSize;
5913 uint32_t headersCount;
5914 const char*
const* headersKeys;
5915 const char*
const* headersValues;
5916 } _OrthancPluginSendMultipartItem2;
5942 uint32_t answerSize,
5943 uint32_t headersCount,
5944 const char*
const* headersKeys,
5945 const char*
const* headersValues)
5947 _OrthancPluginSendMultipartItem2 params;
5948 params.output = output;
5949 params.answer = answer;
5950 params.answerSize = answerSize;
5951 params.headersCount = headersCount;
5952 params.headersKeys = headersKeys;
5953 params.headersValues = headersValues;
5955 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem2, ¶ms);
5962 } _OrthancPluginIncomingHttpRequestFilter;
5980 _OrthancPluginIncomingHttpRequestFilter params;
5981 params.callback = callback;
5983 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter, ¶ms);
5992 uint16_t* httpStatus;
5995 uint32_t headersCount;
5996 const char*
const* headersKeys;
5997 const char*
const* headersValues;
6000 const char* username;
6001 const char* password;
6003 const char* certificateFile;
6004 const char* certificateKeyFile;
6005 const char* certificateKeyPassword;
6007 } _OrthancPluginCallHttpClient2;
6055 uint16_t* httpStatus,
6058 uint32_t headersCount,
6059 const char*
const* headersKeys,
6060 const char*
const* headersValues,
6063 const char* username,
6064 const char* password,
6066 const char* certificateFile,
6067 const char* certificateKeyFile,
6068 const char* certificateKeyPassword,
6071 _OrthancPluginCallHttpClient2 params;
6072 memset(¶ms, 0,
sizeof(params));
6074 params.answerBody = answerBody;
6075 params.answerHeaders = answerHeaders;
6076 params.httpStatus = httpStatus;
6077 params.method = method;
6079 params.headersCount = headersCount;
6080 params.headersKeys = headersKeys;
6081 params.headersValues = headersValues;
6083 params.bodySize = bodySize;
6084 params.username = username;
6085 params.password = password;
6086 params.timeout = timeout;
6087 params.certificateFile = certificateFile;
6088 params.certificateKeyFile = certificateKeyFile;
6089 params.certificateKeyPassword = certificateKeyPassword;
6090 params.pkcs11 = pkcs11;
6092 return context->InvokeService(context, _OrthancPluginService_CallHttpClient2, ¶ms);
6111 _OrthancPluginRetrieveDynamicString params;
6112 params.result = &result;
6113 params.argument = NULL;
6132 } _OrthancPluginFindCallback;
6149 _OrthancPluginFindCallback params;
6150 params.callback = callback;
6152 return context->InvokeService(context, _OrthancPluginService_RegisterFindCallback, ¶ms);
6163 uint32_t *resultUint32;
6164 uint16_t *resultGroup;
6165 uint16_t *resultElement;
6166 char **resultString;
6167 } _OrthancPluginFindOperation;
6190 _OrthancPluginFindOperation params;
6191 memset(¶ms, 0,
sizeof(params));
6192 params.answers = answers;
6193 params.dicom = dicom;
6196 return context->InvokeService(context, _OrthancPluginService_FindAddAnswer, ¶ms);
6217 _OrthancPluginFindOperation params;
6218 memset(¶ms, 0,
sizeof(params));
6219 params.answers = answers;
6221 return context->InvokeService(context, _OrthancPluginService_FindMarkIncomplete, ¶ms);
6243 _OrthancPluginFindOperation params;
6244 memset(¶ms, 0,
sizeof(params));
6245 params.query = query;
6246 params.resultUint32 = &count;
6281 _OrthancPluginFindOperation params;
6282 memset(¶ms, 0,
sizeof(params));
6283 params.query = query;
6284 params.index = index;
6285 params.resultGroup = group;
6286 params.resultElement = element;
6288 return context->InvokeService(context, _OrthancPluginService_GetFindQueryTag, ¶ms);
6312 _OrthancPluginFindOperation params;
6313 memset(¶ms, 0,
sizeof(params));
6314 params.query = query;
6315 params.index = index;
6316 params.resultString = &result;
6350 _OrthancPluginFindOperation params;
6351 memset(¶ms, 0,
sizeof(params));
6352 params.query = query;
6353 params.index = index;
6354 params.resultString = &result;
6376 } _OrthancPluginMoveCallback;
6398 _OrthancPluginMoveCallback params;
6399 params.callback = callback;
6400 params.getMoveSize = getMoveSize;
6401 params.applyMove = applyMove;
6402 params.freeMove = freeMove;
6404 return context->InvokeService(context, _OrthancPluginService_RegisterMoveCallback, ¶ms);
6414 } _OrthancPluginCreateFindMatcher;
6437 _OrthancPluginCreateFindMatcher params;
6438 memset(¶ms, 0,
sizeof(params));
6439 params.target = ⌖
6440 params.query = query;
6457 } _OrthancPluginFreeFindMatcher;
6472 _OrthancPluginFreeFindMatcher params;
6473 params.matcher = matcher;
6475 context->InvokeService(context, _OrthancPluginService_FreeFindMatcher, ¶ms);
6485 } _OrthancPluginFindMatcherIsMatch;
6507 int32_t isMatch = 0;
6509 _OrthancPluginFindMatcherIsMatch params;
6510 params.matcher = matcher;
6511 params.dicom = dicom;
6513 params.isMatch = &isMatch;
6530 } _OrthancPluginIncomingHttpRequestFilter2;
6547 _OrthancPluginIncomingHttpRequestFilter2 params;
6548 params.callback = callback;
6550 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingHttpRequestFilter2, ¶ms);
6558 } _OrthancPluginGetPeers;
6576 _OrthancPluginGetPeers params;
6577 memset(¶ms, 0,
sizeof(params));
6578 params.peers = &peers;
6594 } _OrthancPluginFreePeers;
6609 _OrthancPluginFreePeers params;
6610 params.peers = peers;
6612 context->InvokeService(context, _OrthancPluginService_FreePeers, ¶ms);
6620 } _OrthancPluginGetPeersCount;
6639 uint32_t target = 0;
6641 _OrthancPluginGetPeersCount params;
6642 memset(¶ms, 0,
sizeof(params));
6643 params.target = ⌖
6644 params.peers = peers;
6660 const char** target;
6663 const char* userProperty;
6664 } _OrthancPluginGetPeerProperty;
6688 const char* target = NULL;
6690 _OrthancPluginGetPeerProperty params;
6691 memset(¶ms, 0,
sizeof(params));
6692 params.target = ⌖
6693 params.peers = peers;
6694 params.peerIndex = peerIndex;
6695 params.userProperty = NULL;
6729 const char* target = NULL;
6731 _OrthancPluginGetPeerProperty params;
6732 memset(¶ms, 0,
sizeof(params));
6733 params.target = ⌖
6734 params.peers = peers;
6735 params.peerIndex = peerIndex;
6736 params.userProperty = NULL;
6774 const char* userProperty)
6776 const char* target = NULL;
6778 _OrthancPluginGetPeerProperty params;
6779 memset(¶ms, 0,
sizeof(params));
6780 params.target = ⌖
6781 params.peers = peers;
6782 params.peerIndex = peerIndex;
6783 params.userProperty = userProperty;
6802 uint16_t* httpStatus;
6807 uint32_t additionalHeadersCount;
6808 const char*
const* additionalHeadersKeys;
6809 const char*
const* additionalHeadersValues;
6813 } _OrthancPluginCallPeerApi;
6855 uint16_t* httpStatus,
6860 uint32_t additionalHeadersCount,
6861 const char*
const* additionalHeadersKeys,
6862 const char*
const* additionalHeadersValues,
6867 _OrthancPluginCallPeerApi params;
6868 memset(¶ms, 0,
sizeof(params));
6870 params.answerBody = answerBody;
6871 params.answerHeaders = answerHeaders;
6872 params.httpStatus = httpStatus;
6873 params.peers = peers;
6874 params.peerIndex = peerIndex;
6875 params.method = method;
6877 params.additionalHeadersCount = additionalHeadersCount;
6878 params.additionalHeadersKeys = additionalHeadersKeys;
6879 params.additionalHeadersValues = additionalHeadersValues;
6881 params.bodySize = bodySize;
6882 params.timeout = timeout;
6884 return context->InvokeService(context, _OrthancPluginService_CallPeerApi, ¶ms);
6903 } _OrthancPluginCreateJob;
6951 _OrthancPluginCreateJob params;
6952 memset(¶ms, 0,
sizeof(params));
6954 params.target = ⌖
6956 params.finalize = finalize;
6958 params.getProgress = getProgress;
6959 params.getContent = getContent;
6960 params.getSerialized = getSerialized;
6963 params.reset = reset;
6990 } _OrthancPluginCreateJob2;
7037 _OrthancPluginCreateJob2 params;
7038 memset(¶ms, 0,
sizeof(params));
7040 params.target = ⌖
7042 params.finalize = finalize;
7044 params.getProgress = getProgress;
7045 params.getContent = getContent;
7046 params.getSerialized = getSerialized;
7049 params.reset = reset;
7067 } _OrthancPluginFreeJob;
7082 _OrthancPluginFreeJob params;
7085 context->InvokeService(context, _OrthancPluginService_FreeJob, ¶ms);
7095 } _OrthancPluginSubmitJob;
7115 char* resultId = NULL;
7117 _OrthancPluginSubmitJob params;
7118 memset(¶ms, 0,
sizeof(params));
7120 params.resultId = &resultId;
7122 params.priority = priority;
7141 } _OrthancPluginJobsUnserializer;
7159 _OrthancPluginJobsUnserializer params;
7160 params.unserializer = unserializer;
7162 context->InvokeService(context, _OrthancPluginService_RegisterJobsUnserializer, ¶ms);
7170 const char* details;
7172 } _OrthancPluginSetHttpErrorDetails;
7194 const char* details,
7197 _OrthancPluginSetHttpErrorDetails params;
7198 params.output = output;
7199 params.details = details;
7201 context->InvokeService(context, _OrthancPluginService_SetHttpErrorDetails, ¶ms);
7208 const char** result;
7209 const char* argument;
7210 } _OrthancPluginRetrieveStaticString;
7227 const char* result = NULL;
7229 _OrthancPluginRetrieveStaticString params;
7230 params.result = &result;
7231 params.argument = path;
7251 } _OrthancPluginSetMetricsValue;
7275 _OrthancPluginSetMetricsValue params;
7277 params.value = value;
7279 context->InvokeService(context, _OrthancPluginService_SetMetricsValue, ¶ms);
7287 } _OrthancPluginRegisterRefreshMetricsCallback;
7304 _OrthancPluginRegisterRefreshMetricsCallback params;
7305 params.callback = callback;
7306 context->InvokeService(context, _OrthancPluginService_RegisterRefreshMetricsCallback, ¶ms);
7318 } _OrthancPluginEncodeDicomWeb;
7342 char* target = NULL;
7344 _OrthancPluginEncodeDicomWeb params;
7345 params.target = ⌖
7346 params.dicom = dicom;
7347 params.dicomSize = dicomSize;
7348 params.callback = callback;
7384 char* target = NULL;
7386 _OrthancPluginEncodeDicomWeb params;
7387 params.target = ⌖
7388 params.dicom = dicom;
7389 params.dicomSize = dicomSize;
7390 params.callback = callback;
7412 } _OrthancPluginEncodeDicomWeb2;
7437 char* target = NULL;
7439 _OrthancPluginEncodeDicomWeb2 params;
7440 params.target = ⌖
7441 params.dicom = dicom;
7442 params.dicomSize = dicomSize;
7443 params.callback = callback;
7444 params.payload = payload;
7481 char* target = NULL;
7483 _OrthancPluginEncodeDicomWeb2 params;
7484 params.target = ⌖
7485 params.dicom = dicom;
7486 params.dicomSize = dicomSize;
7487 params.callback = callback;
7488 params.payload = payload;
7592 typedef const void* (*OrthancPluginChunkedClientRequestGetChunkData) (
void* request);
7616 uint16_t* httpStatus;
7619 uint32_t headersCount;
7620 const char*
const* headersKeys;
7621 const char*
const* headersValues;
7627 const char* username;
7628 const char* password;
7630 const char* certificateFile;
7631 const char* certificateKeyFile;
7632 const char* certificateKeyPassword;
7634 } _OrthancPluginChunkedHttpClient;
7692 uint16_t* httpStatus,
7695 uint32_t headersCount,
7696 const char*
const* headersKeys,
7697 const char*
const* headersValues,
7703 const char* username,
7704 const char* password,
7706 const char* certificateFile,
7707 const char* certificateKeyFile,
7708 const char* certificateKeyPassword,
7711 _OrthancPluginChunkedHttpClient params;
7712 memset(¶ms, 0,
sizeof(params));
7715 params.httpStatus = httpStatus;
7716 params.method = method;
7718 params.headersCount = headersCount;
7719 params.headersKeys = headersKeys;
7720 params.headersValues = headersValues;
7721 params.username = username;
7722 params.password = password;
7723 params.timeout = timeout;
7724 params.certificateFile = certificateFile;
7725 params.certificateKeyFile = certificateKeyFile;
7726 params.certificateKeyPassword = certificateKeyPassword;
7727 params.pkcs11 = pkcs11;
7730 params.answer = answer;
7731 params.answerAddChunk = answerAddChunk;
7732 params.answerAddHeader = answerAddHeader;
7733 params.request = request;
7734 params.requestIsDone = requestIsDone;
7735 params.requestChunkData = requestChunkData;
7736 params.requestChunkSize = requestChunkSize;
7737 params.requestNext = requestNext;
7739 return context->InvokeService(context, _OrthancPluginService_ChunkedHttpClient, ¶ms);
7829 const char* pathRegularExpression;
7837 } _OrthancPluginChunkedRestCallback;
7871 const char* pathRegularExpression,
7880 _OrthancPluginChunkedRestCallback params;
7881 params.pathRegularExpression = pathRegularExpression;
7882 params.getHandler = getHandler;
7883 params.postHandler = postHandler;
7884 params.deleteHandler = deleteHandler;
7885 params.putHandler = putHandler;
7886 params.addChunk = addChunk;
7887 params.execute = execute;
7888 params.finalize = finalize;
7890 context->InvokeService(context, _OrthancPluginService_RegisterChunkedRestCallback, ¶ms);
7902 const char* privateCreator;
7903 } _OrthancPluginGetTagName;
7924 const char* privateCreator)
7928 _OrthancPluginGetTagName params;
7929 params.result = &result;
7930 params.group = group;
7931 params.element = element;
7932 params.privateCreator = privateCreator;
7978 const char* transactionUid,
7979 const char*
const* sopClassUids,
7980 const char*
const* sopInstanceUids,
7981 uint32_t countInstances,
7982 const char* remoteAet,
7983 const char* calledAet);
8021 const char* sopClassUid,
8022 const char* sopInstanceUid);
8030 } _OrthancPluginRegisterStorageCommitmentScpCallback;
8051 _OrthancPluginRegisterStorageCommitmentScpCallback params;
8052 params.factory = factory;
8053 params.destructor = destructor;
8054 params.lookup = lookup;
8055 return context->InvokeService(context, _OrthancPluginService_RegisterStorageCommitmentScpCallback, ¶ms);
8092 } _OrthancPluginIncomingDicomInstanceFilter;
8110 _OrthancPluginIncomingDicomInstanceFilter params;
8111 params.callback = callback;
8113 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingDicomInstanceFilter, ¶ms);
8148 uint16_t* dimseStatus ,
8155 } _OrthancPluginIncomingCStoreInstanceFilter;
8173 _OrthancPluginIncomingCStoreInstanceFilter params;
8174 params.callback = callback;
8176 return context->InvokeService(context, _OrthancPluginService_RegisterIncomingCStoreInstanceFilter, ¶ms);
8216 const void* receivedDicomBuffer,
8217 uint64_t receivedDicomBufferSize,
8224 } _OrthancPluginReceivedInstanceCallback;
8250 _OrthancPluginReceivedInstanceCallback params;
8251 params.callback = callback;
8253 return context->InvokeService(context, _OrthancPluginService_RegisterReceivedInstanceCallback, ¶ms);
8275 _OrthancPluginAccessDicomInstance params;
8276 memset(¶ms, 0,
sizeof(params));
8277 params.resultStringToFree = &result;
8278 params.instance = instance;
8308 int64_t hasPixelData;
8310 _OrthancPluginAccessDicomInstance params;
8311 memset(¶ms, 0,
sizeof(params));
8312 params.resultInt64 = &hasPixelData;
8313 params.instance = instance;
8324 return (hasPixelData != 0);
8338 const char* transferSyntax;
8339 } _OrthancPluginCreateDicomInstance;
8361 _OrthancPluginCreateDicomInstance params;
8362 params.target = ⌖
8363 params.buffer = buffer;
8380 } _OrthancPluginFreeDicomInstance;
8396 _OrthancPluginFreeDicomInstance params;
8397 params.dicom = dicom;
8399 context->InvokeService(context, _OrthancPluginService_FreeDicomInstance, ¶ms);
8405 uint32_t* targetUint32;
8408 char** targetStringToFree;
8410 uint32_t frameIndex;
8413 uint32_t maxStringLength;
8415 void* dicomWebPayload;
8416 } _OrthancPluginAccessDicomInstance2;
8435 _OrthancPluginAccessDicomInstance2 params;
8436 memset(¶ms, 0,
sizeof(params));
8437 params.targetUint32 = &count;
8438 params.instance = instance;
8473 uint32_t frameIndex)
8475 _OrthancPluginAccessDicomInstance2 params;
8476 memset(¶ms, 0,
sizeof(params));
8477 params.targetBuffer = target;
8478 params.instance = instance;
8479 params.frameIndex = frameIndex;
8481 return context->InvokeService(context, _OrthancPluginService_GetInstanceRawFrame, ¶ms);
8500 uint32_t frameIndex)
8504 _OrthancPluginAccessDicomInstance2 params;
8505 memset(¶ms, 0,
sizeof(params));
8506 params.targetImage = ⌖
8507 params.instance = instance;
8508 params.frameIndex = frameIndex;
8540 const char* transferSyntax)
8544 _OrthancPluginCreateDicomInstance params;
8545 params.target = ⌖
8546 params.buffer = buffer;
8548 params.transferSyntax = transferSyntax;
8579 _OrthancPluginAccessDicomInstance2 params;
8580 memset(¶ms, 0,
sizeof(params));
8581 params.targetBuffer = target;
8582 params.instance = instance;
8584 return context->InvokeService(context, _OrthancPluginService_SerializeDicomInstance, ¶ms);
8611 uint32_t maxStringLength)
8613 char* result = NULL;
8615 _OrthancPluginAccessDicomInstance2 params;
8616 memset(¶ms, 0,
sizeof(params));
8617 params.targetStringToFree = &result;
8618 params.instance = instance;
8619 params.format = format;
8620 params.flags = flags;
8621 params.maxStringLength = maxStringLength;
8655 char* target = NULL;
8657 _OrthancPluginAccessDicomInstance2 params;
8658 params.targetStringToFree = ⌖
8659 params.instance = instance;
8660 params.dicomWebCallback = callback;
8661 params.dicomWebPayload = payload;
8695 char* target = NULL;
8697 _OrthancPluginAccessDicomInstance2 params;
8698 params.targetStringToFree = ⌖
8699 params.instance = instance;
8700 params.dicomWebCallback = callback;
8701 params.dicomWebPayload = payload;
8738 const char*
const* allowedSyntaxes,
8739 uint32_t countSyntaxes,
8740 uint8_t allowNewSopInstanceUid);
8746 } _OrthancPluginTranscoderCallback;
8765 _OrthancPluginTranscoderCallback params;
8766 params.callback = callback;
8768 return context->InvokeService(context, _OrthancPluginService_RegisterTranscoderCallback, ¶ms);
8777 } _OrthancPluginCreateMemoryBuffer;
8801 _OrthancPluginCreateMemoryBuffer params;
8802 params.target = target;
8805 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer, ¶ms);
8839 _OrthancPluginRetrieveDynamicString params;
8840 params.result = &result;
8841 params.argument = NULL;
8843 if (context->InvokeService(context, _OrthancPluginService_GenerateRestApiAuthorizationToken,
8861 } _OrthancPluginCreateMemoryBuffer64;
8885 _OrthancPluginCreateMemoryBuffer64 params;
8886 params.target = target;
8889 return context->InvokeService(context, _OrthancPluginService_CreateMemoryBuffer64, ¶ms);
8899 } _OrthancPluginRegisterStorageArea2;
8924 _OrthancPluginRegisterStorageArea2 params;
8925 params.create = create;
8926 params.readWhole = readWhole;
8927 params.readRange = readRange;
8928 params.remove = remove;
8929 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea2, ¶ms);
8936 _OrthancPluginCreateDicom createDicom;
8937 const char* privateCreator;
8938 } _OrthancPluginCreateDicom2;
8970 const char* privateCreator)
8972 _OrthancPluginCreateDicom2 params;
8973 params.createDicom.target = target;
8974 params.createDicom.json = json;
8975 params.createDicom.pixelData = pixelData;
8976 params.createDicom.flags = flags;
8977 params.privateCreator = privateCreator;
8979 return context->InvokeService(context, _OrthancPluginService_CreateDicom2, ¶ms);
8991 uint16_t* httpStatus;
8994 uint32_t headersCount;
8995 const char*
const* headersKeys;
8996 const char*
const* headersValues;
8999 uint8_t afterPlugins;
9000 } _OrthancPluginCallRestApi;
9036 uint16_t* httpStatus,
9039 uint32_t headersCount,
9040 const char*
const* headersKeys,
9041 const char*
const* headersValues,
9044 uint8_t afterPlugins)
9046 _OrthancPluginCallRestApi params;
9047 memset(¶ms, 0,
sizeof(params));
9049 params.answerBody = answerBody;
9050 params.answerHeaders = answerHeaders;
9051 params.httpStatus = httpStatus;
9052 params.method = method;
9054 params.headersCount = headersCount;
9055 params.headersKeys = headersKeys;
9056 params.headersValues = headersValues;
9058 params.bodySize = bodySize;
9059 params.afterPlugins = afterPlugins;
9061 return context->InvokeService(context, _OrthancPluginService_CallRestApi, ¶ms);
9093 const char* mimeType,
9094 const char* dateTime);
9113 const char* dateTime);
9141 const char* mimeType,
9142 const char* dateTime);
9159 uint8_t* isExisting,
9161 const char*
const* pathItems,
9184 uint8_t* isExisting,
9189 const char*
const* pathItems,
9213 const char*
const* pathItems,
9233 uint8_t* isReadOnly,
9235 const char*
const* pathItems,
9255 uint8_t* isReadOnly,
9257 const char*
const* pathItems,
9275 uint8_t* isReadOnly,
9277 const char*
const* pathItems,
9291 } _OrthancPluginRegisterWebDavCollection;
9324 _OrthancPluginRegisterWebDavCollection params;
9326 params.isExistingFolder = isExistingFolder;
9327 params.listFolder = listFolder;
9328 params.retrieveFile = retrieveFile;
9329 params.storeFile = storeFile;
9330 params.createFolder = createFolder;
9331 params.deleteItem = deleteItem;
9332 params.payload = payload;
9334 return context->InvokeService(context, _OrthancPluginService_RegisterWebDavCollection, ¶ms);
9351 _OrthancPluginRetrieveStaticString params;
9352 params.result = &result;
9353 params.argument = NULL;
9376 const void* request,
9377 uint64_t requestSize);
9389 uint32_t maxDatabaseRetries;
9392 } _OrthancPluginRegisterDatabaseBackendV4;
9414 uint32_t maxDatabaseRetries,
9418 _OrthancPluginRegisterDatabaseBackendV4 params;
9419 params.backend = backend;
9420 params.maxDatabaseRetries = maxDatabaseRetries;
9421 params.operations = operations;
9422 params.finalize = finalize;
9424 return context->InvokeService(context, _OrthancPluginService_RegisterDatabaseBackendV4, ¶ms);
9431 const char* instanceId;
9433 } _OrthancPluginLoadDicomInstance;
9450 const char* instanceId,
9455 _OrthancPluginLoadDicomInstance params;
9456 params.target = ⌖
9457 params.instanceId = instanceId;
9477 } _OrthancPluginSetMetricsIntegerValue;
9500 _OrthancPluginSetMetricsIntegerValue params;
9502 params.value = value;
9504 context->InvokeService(context, _OrthancPluginService_SetMetricsIntegerValue, ¶ms);
9523 const char* threadName)
9525 return context->InvokeService(context, _OrthancPluginService_SetCurrentThreadName, threadName);
9532 const char* message;
9538 } _OrthancPluginLogMessage;
9556 const char* message,
9563 _OrthancPluginLogMessage m;
9564 m.message = message;
9568 m.category = category;
9570 context->InvokeService(context, _OrthancPluginService_LogMessage, &m);
9577 const char* contentType;
9578 } _OrthancPluginStartStreamAnswer;
9595 const char* contentType)
9597 _OrthancPluginStartStreamAnswer params;
9598 params.output = output;
9599 params.contentType = contentType;
9600 return context->InvokeService(context, _OrthancPluginService_StartStreamAnswer, ¶ms);
9623 uint32_t answerSize)
9625 _OrthancPluginAnswerBuffer params;
9626 params.output = output;
9627 params.answer = answer;
9628 params.answerSize = answerSize;
9629 params.mimeType = NULL;
9630 return context->InvokeService(context, _OrthancPluginService_SendStreamChunk, ¶ms);
OrthancPluginErrorCode OrthancPluginRegisterDatabaseBackendV4(OrthancPluginContext *context, void *backend, uint32_t maxDatabaseRetries, OrthancPluginCallDatabaseBackendV4 operations, OrthancPluginFinalizeDatabaseBackendV4 finalize)
Register a custom database back-end.
Definition: OrthancCPlugin.h:9411
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:9373
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:8214
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:9089
void OrthancPluginRegisterStorageArea(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove)
Register a custom storage area.
Definition: OrthancCPlugin.h:3328
void OrthancPluginRegisterOnStoredInstanceCallback(OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback)
Register a callback for received instances.
Definition: OrthancCPlugin.h:2293
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:1332
OrthancPluginErrorCode OrthancPluginRegisterDecodeImageCallback(OrthancPluginContext *context, OrthancPluginDecodeImageCallback callback)
Register a callback to handle the decoding of DICOM images.
Definition: OrthancCPlugin.h:5640
OrthancPluginChangeType
Definition: OrthancCPlugin.h:759
OrthancPluginErrorCode(* OrthancPluginStorageReadWhole)(OrthancPluginMemoryBuffer64 *target, const char *uuid, OrthancPluginContentType type)
Callback for reading a whole file from the storage area.
Definition: OrthancCPlugin.h:1398
OrthancPluginErrorCode OrthancPluginRegisterIncomingCStoreInstanceFilter(OrthancPluginContext *context, OrthancPluginIncomingCStoreInstanceFilter callback)
Register a callback to filter incoming DICOM instances received by Orthanc through C-STORE.
Definition: OrthancCPlugin.h:8169
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:1310
void OrthancPluginRegisterRefreshMetricsCallback(OrthancPluginContext *context, OrthancPluginRefreshMetricsCallback callback)
Register a callback to refresh the metrics.
Definition: OrthancCPlugin.h:7300
OrthancPluginErrorCode(* OrthancPluginWebDavCreateFolderCallback)(uint8_t *isReadOnly, uint32_t pathSize, const char *const *pathItems, void *payload)
Callback to create a folder.
Definition: OrthancCPlugin.h:9254
struct _OrthancPluginWebDavCollection_t OrthancPluginWebDavCollection
Opaque structure that represents a WebDAV collection.
Definition: OrthancCPlugin.h:9070
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:1868
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:9209
int32_t(* OrthancPluginIncomingDicomInstanceFilter)(const OrthancPluginDicomInstance *instance)
Callback to filter incoming DICOM instances received by Orthanc.
Definition: OrthancCPlugin.h:8085
OrthancPluginErrorCode OrthancPluginStorageAreaRemove(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Remove a file from the storage area.
Definition: OrthancCPlugin.h:4998
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:8734
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter2(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter2 callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:6543
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:9137
OrthancPluginErrorCode(* OrthancPluginStorageRead)(void **content, int64_t *size, const char *uuid, OrthancPluginContentType type)
Callback for reading from the storage area.
Definition: OrthancCPlugin.h:1378
void OrthancPluginRegisterRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback.
Definition: OrthancCPlugin.h:2215
uint32_t OrthancPluginGetExpectedDatabaseVersion(OrthancPluginContext *context)
Get the expected version of the database schema.
Definition: OrthancCPlugin.h:3802
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:8246
int32_t OrthancPluginCheckVersion(OrthancPluginContext *context)
Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
Definition: OrthancCPlugin.h:2096
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:9183
struct _OrthancPluginRestOutput_t OrthancPluginRestOutput
Opaque structure that represents the HTTP connection to the client application.
Definition: OrthancCPlugin.h:1181
void OrthancPluginRegisterOnChangeCallback(OrthancPluginContext *context, OrthancPluginOnChangeCallback callback)
Register a callback to monitor changes.
Definition: OrthancCPlugin.h:3471
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:8917
OrthancPluginErrorCode(* OrthancPluginWebDavAddFolder)(OrthancPluginWebDavCollection *collection, const char *name, const char *dateTime)
Declare a subfolder while returning the content of a folder.
Definition: OrthancCPlugin.h:9110
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:9313
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:1524
OrthancPluginErrorCode(* OrthancPluginRestCallback)(OrthancPluginRestOutput *output, const char *url, const OrthancPluginHttpRequest *request)
Signature of a callback function that answers to a REST request.
Definition: OrthancCPlugin.h:1278
void(* OrthancPluginRefreshMetricsCallback)()
Callback executed to update the metrics of the plugin.
Definition: OrthancCPlugin.h:1840
OrthancPluginErrorCode OrthancPluginRegisterTranscoderCallback(OrthancPluginContext *context, OrthancPluginTranscoderCallback callback)
Register a callback to handle the transcoding of DICOM images.
Definition: OrthancCPlugin.h:8761
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:1289
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:9232
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:9274
OrthancPluginErrorCode OrthancPluginReconstructMainDicomTags(OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, OrthancPluginResourceType level)
Reconstruct the main DICOM tags.
Definition: OrthancCPlugin.h:5190
OrthancPluginErrorCode(* OrthancPluginStorageRemove)(const char *uuid, OrthancPluginContentType type)
Callback for removing a file from the storage area.
Definition: OrthancCPlugin.h:1439
OrthancPluginErrorCode(* OrthancPluginStorageCreate)(const char *uuid, const void *content, int64_t size, OrthancPluginContentType type)
Callback for writing to the storage area.
Definition: OrthancCPlugin.h:1351
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:1906
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:1299
void(* OrthancPluginFinalizeDatabaseBackendV4)(void *backend)
Signature of a callback function that is triggered when the database plugin must be finalized.
Definition: OrthancCPlugin.h:9384
struct _OrthancPluginServerChunkedRequestReader_t OrthancPluginServerChunkedRequestReader
Opaque structure that reads the content of a HTTP request body during a chunked HTTP transfer.
Definition: OrthancCPlugin.h:7748
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:9158
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:1489
OrthancPluginJob *(* OrthancPluginJobsUnserializer)(const char *jobType, const char *serialized)
Callback executed to unserialize a custom job.
Definition: OrthancCPlugin.h:1821
void OrthancPluginRegisterJobsUnserializer(OrthancPluginContext *context, OrthancPluginJobsUnserializer unserializer)
Register an unserializer for custom jobs.
Definition: OrthancCPlugin.h:7155
void(* OrthancPluginFree)(void *buffer)
Signature of a function to free dynamic memory.
Definition: OrthancCPlugin.h:1322
void OrthancPluginRegisterRestCallbackNoLock(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback, without locking.
Definition: OrthancCPlugin.h:2255
OrthancPluginErrorCode OrthancPluginStorageAreaRead(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type)
Read a file from the storage area.
Definition: OrthancCPlugin.h:4959
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:1987
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:1421
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:7869
int32_t(* OrthancPluginIncomingCStoreInstanceFilter)(uint16_t *dimseStatus, const OrthancPluginDicomInstance *instance)
Callback to filter incoming DICOM instances received by Orthanc through C-STORE.
Definition: OrthancCPlugin.h:8147
OrthancPluginErrorCode OrthancPluginRegisterIncomingDicomInstanceFilter(OrthancPluginContext *context, OrthancPluginIncomingDicomInstanceFilter callback)
Register a callback to filter incoming DICOM instances.
Definition: OrthancCPlugin.h:8106
OrthancPluginErrorCode OrthancPluginRegisterIncomingHttpRequestFilter(OrthancPluginContext *context, OrthancPluginIncomingHttpRequestFilter callback)
Register a callback to filter incoming HTTP requests.
Definition: OrthancCPlugin.h:5976
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:4915
@ OrthancPluginChangeType_OrthancStopped
Definition: OrthancCPlugin.h:771
@ OrthancPluginChangeType_OrthancStarted
Definition: OrthancCPlugin.h:770
@ OrthancPluginChangeType_Deleted
Definition: OrthancCPlugin.h:761
@ OrthancPluginChangeType_JobFailure
Definition: OrthancCPlugin.h:778
@ OrthancPluginChangeType_NewInstance
Definition: OrthancCPlugin.h:763
@ OrthancPluginChangeType_NewPatient
Definition: OrthancCPlugin.h:764
@ OrthancPluginChangeType_JobSubmitted
Definition: OrthancCPlugin.h:776
@ OrthancPluginChangeType_NewSeries
Definition: OrthancCPlugin.h:765
@ OrthancPluginChangeType_StablePatient
Definition: OrthancCPlugin.h:767
@ OrthancPluginChangeType_UpdatedPeers
Definition: OrthancCPlugin.h:774
@ OrthancPluginChangeType_StableStudy
Definition: OrthancCPlugin.h:769
@ OrthancPluginChangeType_CompletedSeries
Definition: OrthancCPlugin.h:760
@ OrthancPluginChangeType_NewChildInstance
Definition: OrthancCPlugin.h:762
@ OrthancPluginChangeType_UpdatedAttachment
Definition: OrthancCPlugin.h:772
@ OrthancPluginChangeType_UpdatedMetadata
Definition: OrthancCPlugin.h:773
@ OrthancPluginChangeType_StableSeries
Definition: OrthancCPlugin.h:768
@ OrthancPluginChangeType_UpdatedModalities
Definition: OrthancCPlugin.h:775
@ OrthancPluginChangeType_JobSuccess
Definition: OrthancCPlugin.h:777
@ OrthancPluginChangeType_NewStudy
Definition: OrthancCPlugin.h:766
uint32_t OrthancPluginGetFindQuerySize(OrthancPluginContext *context, const OrthancPluginFindQuery *query)
Get the number of tags in a C-Find query.
Definition: OrthancCPlugin.h:6237
struct _OrthancPluginFindQuery_t OrthancPluginFindQuery
Opaque structure to an object that represents a C-Find query.
Definition: OrthancCPlugin.h:1229
OrthancPluginErrorCode(* OrthancPluginApplyMove)(void *moveDriver)
Callback to apply one C-Move suboperation.
Definition: OrthancCPlugin.h:1634
OrthancPluginErrorCode OrthancPluginFindMarkIncomplete(OrthancPluginContext *context, OrthancPluginFindAnswers *answers)
Mark the set of C-Find answers as incomplete.
Definition: OrthancCPlugin.h:6213
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:6305
void(* OrthancPluginStorageCommitmentDestructor)(void *handler)
Callback to free one storage commitment SCP handler.
Definition: OrthancCPlugin.h:7997
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:1458
OrthancPluginErrorCode OrthancPluginRegisterMoveCallback(OrthancPluginContext *context, OrthancPluginMoveCallback callback, OrthancPluginGetMoveSize getMoveSize, OrthancPluginApplyMove applyMove, OrthancPluginFreeMove freeMove)
Register a callback to handle C-Move requests.
Definition: OrthancCPlugin.h:6391
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:7975
OrthancPluginErrorCode OrthancPluginRegisterFindCallback(OrthancPluginContext *context, OrthancPluginFindCallback callback)
Register a callback to handle C-Find requests.
Definition: OrthancCPlugin.h:6145
OrthancPluginErrorCode OrthancPluginWorklistGetDicomQuery(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginWorklistQuery *query)
Retrieve the worklist query as a DICOM file.
Definition: OrthancCPlugin.h:5522
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:8018
int32_t OrthancPluginWorklistIsMatch(OrthancPluginContext *context, const OrthancPluginWorklistQuery *query, const void *dicom, uint32_t size)
Test whether a worklist matches the query.
Definition: OrthancCPlugin.h:5483
OrthancPluginErrorCode OrthancPluginFindAddAnswer(OrthancPluginContext *context, OrthancPluginFindAnswers *answers, const void *dicom, uint32_t size)
Add one answer to some C-Find request.
Definition: OrthancCPlugin.h:6184
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:1594
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:8045
struct _OrthancPluginFindAnswers_t OrthancPluginFindAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1237
struct _OrthancPluginWorklistAnswers_t OrthancPluginWorklistAnswers
Opaque structure to an object that represents the answers to a C-Find query for worklists.
Definition: OrthancCPlugin.h:1221
OrthancPluginErrorCode(* OrthancPluginFindCallback)(OrthancPluginFindAnswers *answers, const OrthancPluginFindQuery *query, const char *issuerAet, const char *calledAet)
Callback to handle incoming C-Find SCP requests.
Definition: OrthancCPlugin.h:1551
uint32_t(* OrthancPluginGetMoveSize)(void *moveDriver)
Callback to read the size of a C-Move driver.
Definition: OrthancCPlugin.h:1619
OrthancPluginErrorCode OrthancPluginRegisterWorklistCallback(OrthancPluginContext *context, OrthancPluginWorklistCallback callback)
Register a callback to handle modality worklists requests.
Definition: OrthancCPlugin.h:5379
OrthancPluginErrorCode OrthancPluginWorklistMarkIncomplete(OrthancPluginContext *context, OrthancPluginWorklistAnswers *answers)
Mark the set of worklist answers as incomplete.
Definition: OrthancCPlugin.h:5445
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:6343
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:6274
void(* OrthancPluginFreeMove)(void *moveDriver)
Callback to free one C-Move driver.
Definition: OrthancCPlugin.h:1648
struct _OrthancPluginWorklistQuery_t OrthancPluginWorklistQuery
Opaque structure to an object that represents a C-Find query for worklists.
Definition: OrthancCPlugin.h:1213
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:5415
int32_t OrthancPluginHasInstancePixelData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Check whether the DICOM file has pixel data.
Definition: OrthancCPlugin.h:8304
char * OrthancPluginGetInstanceDicomWebXml(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb XML.
Definition: OrthancCPlugin.h:8689
struct _OrthancPluginDicomInstance_t OrthancPluginDicomInstance
Opaque structure that represents a DICOM instance that is managed by the Orthanc core.
Definition: OrthancCPlugin.h:1189
char * OrthancPluginGetInstanceTransferSyntaxUid(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the transfer syntax of a DICOM file.
Definition: OrthancCPlugin.h:8269
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:8469
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:8606
const void * OrthancPluginGetInstanceData(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the data of a DICOM file.
Definition: OrthancCPlugin.h:3125
OrthancPluginDicomInstance * OrthancPluginCreateDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size)
Parse a DICOM instance.
Definition: OrthancCPlugin.h:8354
int32_t OrthancPluginHasInstanceMetadata(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, const char *metadata)
Check whether a DICOM instance is associated with some metadata.
Definition: OrthancCPlugin.h:3238
uint32_t OrthancPluginGetInstanceFramesCount(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the number of frames in a DICOM instance.
Definition: OrthancCPlugin.h:8429
OrthancPluginImage * OrthancPluginGetInstanceDecodedFrame(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:8497
OrthancPluginDicomInstance * OrthancPluginLoadDicomInstance(OrthancPluginContext *context, const char *instanceId, OrthancPluginLoadDicomInstanceMode mode)
Load a DICOM instance from the Orthanc server.
Definition: OrthancCPlugin.h:9448
OrthancPluginInstanceOrigin OrthancPluginGetInstanceOrigin(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the origin of a DICOM file.
Definition: OrthancCPlugin.h:5548
int64_t OrthancPluginGetInstanceSize(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the size of a DICOM file.
Definition: OrthancCPlugin.h:3092
char * OrthancPluginGetInstanceDicomWebJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance, OrthancPluginDicomWebBinaryCallback2 callback, void *payload)
Convert a DICOM instance to DICOMweb JSON.
Definition: OrthancCPlugin.h:8649
char * OrthancPluginGetInstanceSimplifiedJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file (with simplification).
Definition: OrthancCPlugin.h:3199
char * OrthancPluginGetInstanceJson(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file.
Definition: OrthancCPlugin.h:3161
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:3279
void OrthancPluginFreeDicomInstance(OrthancPluginContext *context, OrthancPluginDicomInstance *dicom)
Free a DICOM instance.
Definition: OrthancCPlugin.h:8392
OrthancPluginErrorCode OrthancPluginSerializeDicomInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const OrthancPluginDicomInstance *instance)
Writes a DICOM instance to a memory buffer.
Definition: OrthancCPlugin.h:8574
OrthancPluginDicomInstance * OrthancPluginTranscodeDicomInstance(OrthancPluginContext *context, const void *buffer, uint32_t size, const char *transferSyntax)
Parse and transcode a DICOM instance.
Definition: OrthancCPlugin.h:8536
const char * OrthancPluginGetInstanceRemoteAet(OrthancPluginContext *context, const OrthancPluginDicomInstance *instance)
Get the AET of a DICOM instance.
Definition: OrthancCPlugin.h:3059
OrthancPluginPixelFormat
Definition: OrthancCPlugin.h:634
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:4861
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:4445
uint32_t OrthancPluginGetImagePitch(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pitch of an image.
Definition: OrthancCPlugin.h:4236
OrthancPluginImage * OrthancPluginConvertPixelFormat(OrthancPluginContext *context, const OrthancPluginImage *source, OrthancPluginPixelFormat targetFormat)
Change the pixel format of an image.
Definition: OrthancCPlugin.h:4701
OrthancPluginPixelFormat OrthancPluginGetImagePixelFormat(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the pixel format of an image.
Definition: OrthancCPlugin.h:4135
uint32_t OrthancPluginGetFontsCount(OrthancPluginContext *context)
Return the number of available fonts.
Definition: OrthancCPlugin.h:4736
uint32_t OrthancPluginGetImageHeight(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the height of an image.
Definition: OrthancCPlugin.h:4201
void OrthancPluginFreeImage(OrthancPluginContext *context, OrthancPluginImage *image)
Free an image.
Definition: OrthancCPlugin.h:4355
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:4400
OrthancPluginImage * OrthancPluginCreateImage(OrthancPluginContext *context, OrthancPluginPixelFormat format, uint32_t width, uint32_t height)
Create an image.
Definition: OrthancCPlugin.h:5678
OrthancPluginImage * OrthancPluginUncompressImage(OrthancPluginContext *context, const void *data, uint32_t size, OrthancPluginImageFormat format)
Decode a compressed image.
Definition: OrthancCPlugin.h:4313
const char * OrthancPluginGetFontName(OrthancPluginContext *context, uint32_t fontIndex)
Return the name of a font.
Definition: OrthancCPlugin.h:4776
void * OrthancPluginGetImageBuffer(OrthancPluginContext *context, const OrthancPluginImage *image)
Return a pointer to the content of an image.
Definition: OrthancCPlugin.h:4270
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:5721
OrthancPluginImageFormat
Definition: OrthancCPlugin.h:804
struct _OrthancPluginStorageArea_t OrthancPluginStorageArea
Opaque structure that represents the storage area that is actually used by Orthanc.
Definition: OrthancCPlugin.h:1205
OrthancPluginCompressionType
Definition: OrthancCPlugin.h:789
uint32_t OrthancPluginGetImageWidth(OrthancPluginContext *context, const OrthancPluginImage *image)
Return the width of an image.
Definition: OrthancCPlugin.h:4168
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:3947
OrthancPluginImage * OrthancPluginDecodeDicomImage(OrthancPluginContext *context, const void *buffer, uint32_t bufferSize, uint32_t frameIndex)
Decode one frame from a DICOM instance.
Definition: OrthancCPlugin.h:5767
uint32_t OrthancPluginGetFontSize(OrthancPluginContext *context, uint32_t fontIndex)
Return the size of a font.
Definition: OrthancCPlugin.h:4808
struct _OrthancPluginImage_t OrthancPluginImage
Opaque structure that represents an image that is uncompressed in memory.
Definition: OrthancCPlugin.h:1197
@ OrthancPluginPixelFormat_RGBA32
Color image in RGBA32 format.
Definition: OrthancCPlugin.h:673
@ OrthancPluginPixelFormat_RGB48
Color image in RGB48 format.
Definition: OrthancCPlugin.h:683
@ OrthancPluginPixelFormat_Grayscale8
Graylevel 8bpp image.
Definition: OrthancCPlugin.h:641
@ OrthancPluginPixelFormat_SignedGrayscale16
Graylevel, signed 16bpp image.
Definition: OrthancCPlugin.h:657
@ OrthancPluginPixelFormat_Float32
Graylevel, floating-point 32bpp image.
Definition: OrthancCPlugin.h:699
@ OrthancPluginPixelFormat_RGB24
Color image in RGB24 format.
Definition: OrthancCPlugin.h:665
@ OrthancPluginPixelFormat_BGRA32
Color image in BGRA32 format.
Definition: OrthancCPlugin.h:707
@ OrthancPluginPixelFormat_Unknown
Definition: OrthancCPlugin.h:675
@ OrthancPluginPixelFormat_Grayscale64
Graylevel, unsigned 64bpp image.
Definition: OrthancCPlugin.h:715
@ OrthancPluginPixelFormat_Grayscale32
Graylevel, unsigned 32bpp image.
Definition: OrthancCPlugin.h:691
@ OrthancPluginPixelFormat_Grayscale16
Graylevel, unsigned 16bpp image.
Definition: OrthancCPlugin.h:649
@ OrthancPluginImageFormat_Png
Definition: OrthancCPlugin.h:805
@ OrthancPluginImageFormat_Jpeg
Definition: OrthancCPlugin.h:806
@ OrthancPluginImageFormat_Dicom
Definition: OrthancCPlugin.h:807
@ OrthancPluginCompressionType_Gzip
Definition: OrthancCPlugin.h:792
@ OrthancPluginCompressionType_ZlibWithSize
Definition: OrthancCPlugin.h:791
@ OrthancPluginCompressionType_Zlib
Definition: OrthancCPlugin.h:790
@ OrthancPluginCompressionType_GzipWithSize
Definition: OrthancCPlugin.h:793
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:2523
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:2558
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:2671
char * OrthancPluginLookupStudy(OrthancPluginContext *context, const char *studyUID)
Look for a study.
Definition: OrthancCPlugin.h:2772
OrthancPluginErrorCode OrthancPluginSetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *value)
Set the value of a global property.
Definition: OrthancCPlugin.h:3705
char * OrthancPluginGetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *defaultValue)
Get the value of a global property.
Definition: OrthancCPlugin.h:3666
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:2635
char * OrthancPluginLookupSeries(OrthancPluginContext *context, const char *seriesUID)
Look for a series.
Definition: OrthancCPlugin.h:2842
char * OrthancPluginLookupStudyWithAccessionNumber(OrthancPluginContext *context, const char *accessionNumber)
Look for a study, using the accession number.
Definition: OrthancCPlugin.h:2807
char * OrthancPluginGenerateRestApiAuthorizationToken(OrthancPluginContext *context)
Generate a token to grant full access to the REST API of Orthanc.
Definition: OrthancCPlugin.h:8834
OrthancPluginErrorCode OrthancPluginRestApiGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2456
char * OrthancPluginLookupInstance(OrthancPluginContext *context, const char *sopInstanceUID)
Look for an instance.
Definition: OrthancCPlugin.h:2877
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:2486
char * OrthancPluginLookupPatient(OrthancPluginContext *context, const char *patientID)
Look for a patient.
Definition: OrthancCPlugin.h:2737
OrthancPluginErrorCode OrthancPluginRestApiDelete(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:2587
OrthancPluginErrorCode OrthancPluginRestApiDeleteAfterPlugins(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:2610
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:9032
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:5341
OrthancPluginErrorCode OrthancPluginGetDicomForInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *instanceId)
Retrieve a DICOM instance using its Orthanc identifier.
Definition: OrthancCPlugin.h:2423
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:2382
void OrthancPluginSendUnauthorized(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *realm)
Signal that a REST request is not authorized.
Definition: OrthancCPlugin.h:2945
void OrthancPluginSetHttpErrorDetails(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *details, uint8_t log)
Provide a detailed description for an HTTP error.
Definition: OrthancCPlugin.h:7191
void OrthancPluginSendMethodNotAllowed(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *allowedMethods)
Signal that this URI does not support this HTTP method.
Definition: OrthancCPlugin.h:2968
OrthancPluginErrorCode OrthancPluginSendStreamChunk(OrthancPluginContext *context, OrthancPluginRestOutput *output, const void *answer, uint32_t answerSize)
Send a chunk as a part of an HTTP stream answer.
Definition: OrthancCPlugin.h:9619
void OrthancPluginAnswerBuffer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const void *answer, uint32_t answerSize, const char *mimeType)
Answer to a REST request.
Definition: OrthancCPlugin.h:2325
void OrthancPluginSendHttpStatusCode(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status)
Send a HTTP status code.
Definition: OrthancCPlugin.h:2922
void OrthancPluginSetHttpHeader(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *key, const char *value)
Set some HTTP header.
Definition: OrthancCPlugin.h:3023
OrthancPluginErrorCode OrthancPluginStartStreamAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *contentType)
Start an HTTP stream answer.
Definition: OrthancCPlugin.h:9592
void OrthancPluginSetCookie(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *cookie, const char *value)
Set a cookie.
Definition: OrthancCPlugin.h:2998
void OrthancPluginRedirect(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *redirection)
Redirect a REST request.
Definition: OrthancCPlugin.h:2705
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:4492
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:3905
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:5938
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:4099
OrthancPluginErrorCode OrthancPluginStartMultipartAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *subType, const char *contentType)
Start an HTTP multipart answer.
Definition: OrthancCPlugin.h:3876
An entry in the dictionary of DICOM tags.
Definition: OrthancCPlugin.h:1939
uint32_t minMultiplicity
Definition: OrthancCPlugin.h:1943
uint32_t maxMultiplicity
Definition: OrthancCPlugin.h:1944
OrthancPluginValueRepresentation vr
Definition: OrthancCPlugin.h:1942
uint16_t element
Definition: OrthancCPlugin.h:1941
uint16_t group
Definition: OrthancCPlugin.h:1940
The parameters of a REST request.
Definition: OrthancCPlugin.h:360
const char *const * getValues
For a GET request, the values of the GET parameters.
Definition: OrthancCPlugin.h:389
const char *const * groups
The matched values for the groups of the regular expression.
Definition: OrthancCPlugin.h:374
uint32_t bodySize
For a PUT or POST request, the number of bytes of the body.
Definition: OrthancCPlugin.h:399
uint32_t groupsCount
The number of groups of the regular expression.
Definition: OrthancCPlugin.h:369
const char *const * headersKeys
The keys of the HTTP headers (always converted to low-case).
Definition: OrthancCPlugin.h:414
const void * body
For a PUT or POST request, the content of the body.
Definition: OrthancCPlugin.h:394
const char *const * getKeys
For a GET request, the keys of the GET parameters.
Definition: OrthancCPlugin.h:384
uint32_t headersCount
The number of HTTP headers.
Definition: OrthancCPlugin.h:409
OrthancPluginHttpMethod method
The HTTP method.
Definition: OrthancCPlugin.h:364
uint32_t getCount
For a GET request, the number of GET parameters.
Definition: OrthancCPlugin.h:379
const char *const * headersValues
The values of the HTTP headers.
Definition: OrthancCPlugin.h:419
A 64-bit memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:1162
uint64_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:1171
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:1166
A 32-bit memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:1140
uint32_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:1149
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:1144