86 #define ORTHANC_PLUGINS_API __declspec(dllexport)
88 #define ORTHANC_PLUGINS_API
91 #define ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER 0
92 #define ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER 9
93 #define ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER 1
111 #ifndef ORTHANC_PLUGIN_INLINE
112 # if __STDC_VERSION__ >= 199901L
114 # define ORTHANC_PLUGIN_INLINE static inline
115 # elif defined(__cplusplus)
117 # define ORTHANC_PLUGIN_INLINE static inline
118 # elif defined(__GNUC__)
120 # define ORTHANC_PLUGIN_INLINE static __inline
121 # elif defined(_MSC_VER)
123 # define ORTHANC_PLUGIN_INLINE static __inline
125 # error Your compiler is not known to support the "inline" keyword
161 ORTHANC_PLUGINS_API
const char* OrthancPluginGetName();
247 _OrthancPluginService_LogInfo = 1,
248 _OrthancPluginService_LogWarning = 2,
249 _OrthancPluginService_LogError = 3,
250 _OrthancPluginService_GetOrthancPath = 4,
251 _OrthancPluginService_GetOrthancDirectory = 5,
252 _OrthancPluginService_GetConfigurationPath = 6,
253 _OrthancPluginService_SetPluginProperty = 7,
254 _OrthancPluginService_GetGlobalProperty = 8,
255 _OrthancPluginService_SetGlobalProperty = 9,
256 _OrthancPluginService_GetCommandLineArgumentsCount = 10,
257 _OrthancPluginService_GetCommandLineArgument = 11,
258 _OrthancPluginService_GetExpectedDatabaseVersion = 12,
259 _OrthancPluginService_GetConfiguration = 13,
262 _OrthancPluginService_RegisterRestCallback = 1000,
263 _OrthancPluginService_RegisterOnStoredInstanceCallback = 1001,
264 _OrthancPluginService_RegisterStorageArea = 1002,
265 _OrthancPluginService_RegisterOnChangeCallback = 1003,
268 _OrthancPluginService_AnswerBuffer = 2000,
269 _OrthancPluginService_CompressAndAnswerPngImage = 2001,
270 _OrthancPluginService_Redirect = 2002,
271 _OrthancPluginService_SendHttpStatusCode = 2003,
272 _OrthancPluginService_SendUnauthorized = 2004,
273 _OrthancPluginService_SendMethodNotAllowed = 2005,
274 _OrthancPluginService_SetCookie = 2006,
275 _OrthancPluginService_SetHttpHeader = 2007,
276 _OrthancPluginService_StartMultipartAnswer = 2008,
277 _OrthancPluginService_SendMultipartItem = 2009,
280 _OrthancPluginService_GetDicomForInstance = 3000,
281 _OrthancPluginService_RestApiGet = 3001,
282 _OrthancPluginService_RestApiPost = 3002,
283 _OrthancPluginService_RestApiDelete = 3003,
284 _OrthancPluginService_RestApiPut = 3004,
285 _OrthancPluginService_LookupPatient = 3005,
286 _OrthancPluginService_LookupStudy = 3006,
287 _OrthancPluginService_LookupSeries = 3007,
288 _OrthancPluginService_LookupInstance = 3008,
289 _OrthancPluginService_LookupStudyWithAccessionNumber = 3009,
290 _OrthancPluginService_RestApiGetAfterPlugins = 3010,
291 _OrthancPluginService_RestApiPostAfterPlugins = 3011,
292 _OrthancPluginService_RestApiDeleteAfterPlugins = 3012,
293 _OrthancPluginService_RestApiPutAfterPlugins = 3013,
296 _OrthancPluginService_GetInstanceRemoteAet = 4000,
297 _OrthancPluginService_GetInstanceSize = 4001,
298 _OrthancPluginService_GetInstanceData = 4002,
299 _OrthancPluginService_GetInstanceJson = 4003,
300 _OrthancPluginService_GetInstanceSimplifiedJson = 4004,
301 _OrthancPluginService_HasInstanceMetadata = 4005,
302 _OrthancPluginService_GetInstanceMetadata = 4006,
305 _OrthancPluginService_RegisterDatabaseBackend = 5000,
306 _OrthancPluginService_DatabaseAnswer = 5001
308 } _OrthancPluginService;
313 _OrthancPluginProperty_Description = 1,
314 _OrthancPluginProperty_RootUri = 2,
315 _OrthancPluginProperty_OrthancExplorer = 3
316 } _OrthancPluginProperty;
464 const char* instanceId);
474 const char* resourceId);
541 typedef struct _OrthancPluginContext_t
543 void* pluginsManager;
544 const char* orthancVersion;
546 int32_t (*InvokeService) (
struct _OrthancPluginContext_t* context,
547 _OrthancPluginService service,
587 int major, minor, revision;
590 if (!strcmp(context->orthancVersion,
"mainline"))
602 (context->orthancVersion,
"%4d.%4d.%4d", &major, &minor, &revision) != 3)
609 if (major > ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
614 if (major < ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER)
621 if (minor > ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
626 if (minor < ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER)
633 if (revision >= ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER)
656 context->Free(buffer->
data);
672 context->InvokeService(context, _OrthancPluginService_LogError, message);
688 context->InvokeService(context, _OrthancPluginService_LogWarning, message);
704 context->InvokeService(context, _OrthancPluginService_LogInfo, message);
711 const char* pathRegularExpression;
713 } _OrthancPluginRestCallback;
729 const char* pathRegularExpression,
732 _OrthancPluginRestCallback params;
733 params.pathRegularExpression = pathRegularExpression;
734 params.callback = callback;
735 context->InvokeService(context, _OrthancPluginService_RegisterRestCallback, ¶ms);
743 } _OrthancPluginOnStoredInstanceCallback;
758 _OrthancPluginOnStoredInstanceCallback params;
759 params.callback = callback;
761 context->InvokeService(context, _OrthancPluginService_RegisterOnStoredInstanceCallback, ¶ms);
771 const char* mimeType;
772 } _OrthancPluginAnswerBuffer;
790 const char* mimeType)
792 _OrthancPluginAnswerBuffer params;
793 params.output = output;
794 params.answer = answer;
795 params.answerSize = answerSize;
796 params.mimeType = mimeType;
797 context->InvokeService(context, _OrthancPluginService_AnswerBuffer, ¶ms);
809 } _OrthancPluginCompressAndAnswerPngImage;
837 _OrthancPluginCompressAndAnswerPngImage params;
838 params.output = output;
839 params.format = format;
840 params.width = width;
841 params.height = height;
842 params.pitch = pitch;
843 params.buffer = buffer;
844 context->InvokeService(context, _OrthancPluginService_CompressAndAnswerPngImage, ¶ms);
852 const char* instanceId;
853 } _OrthancPluginGetDicomForInstance;
869 const char* instanceId)
871 _OrthancPluginGetDicomForInstance params;
872 params.target = target;
873 params.instanceId = instanceId;
874 return context->InvokeService(context, _OrthancPluginService_GetDicomForInstance, ¶ms);
883 } _OrthancPluginRestApiGet;
901 _OrthancPluginRestApiGet params;
902 params.target = target;
904 return context->InvokeService(context, _OrthancPluginService_RestApiGet, ¶ms);
928 _OrthancPluginRestApiGet params;
929 params.target = target;
931 return context->InvokeService(context, _OrthancPluginService_RestApiGetAfterPlugins, ¶ms);
942 } _OrthancPluginRestApiPostPut;
964 _OrthancPluginRestApiPostPut params;
965 params.target = target;
968 params.bodySize = bodySize;
969 return context->InvokeService(context, _OrthancPluginService_RestApiPost, ¶ms);
996 _OrthancPluginRestApiPostPut params;
997 params.target = target;
1000 params.bodySize = bodySize;
1001 return context->InvokeService(context, _OrthancPluginService_RestApiPostAfterPlugins, ¶ms);
1019 return context->InvokeService(context, _OrthancPluginService_RestApiDelete, uri);
1039 return context->InvokeService(context, _OrthancPluginService_RestApiDeleteAfterPlugins, uri);
1064 _OrthancPluginRestApiPostPut params;
1065 params.target = target;
1068 params.bodySize = bodySize;
1069 return context->InvokeService(context, _OrthancPluginService_RestApiPut, ¶ms);
1097 _OrthancPluginRestApiPostPut params;
1098 params.target = target;
1101 params.bodySize = bodySize;
1102 return context->InvokeService(context, _OrthancPluginService_RestApiPutAfterPlugins, ¶ms);
1110 const char* argument;
1111 } _OrthancPluginOutputPlusArgument;
1126 const char* redirection)
1128 _OrthancPluginOutputPlusArgument params;
1129 params.output = output;
1130 params.argument = redirection;
1131 context->InvokeService(context, _OrthancPluginService_Redirect, ¶ms);
1139 const char* argument;
1140 } _OrthancPluginRetrieveDynamicString;
1156 const char* patientID)
1160 _OrthancPluginRetrieveDynamicString params;
1161 params.result = &result;
1162 params.argument = patientID;
1164 if (context->InvokeService(context, _OrthancPluginService_LookupPatient, ¶ms))
1190 const char* studyUID)
1194 _OrthancPluginRetrieveDynamicString params;
1195 params.result = &result;
1196 params.argument = studyUID;
1198 if (context->InvokeService(context, _OrthancPluginService_LookupStudy, ¶ms))
1224 const char* accessionNumber)
1228 _OrthancPluginRetrieveDynamicString params;
1229 params.result = &result;
1230 params.argument = accessionNumber;
1232 if (context->InvokeService(context, _OrthancPluginService_LookupStudyWithAccessionNumber, ¶ms))
1258 const char* seriesUID)
1262 _OrthancPluginRetrieveDynamicString params;
1263 params.result = &result;
1264 params.argument = seriesUID;
1266 if (context->InvokeService(context, _OrthancPluginService_LookupSeries, ¶ms))
1292 const char* sopInstanceUID)
1296 _OrthancPluginRetrieveDynamicString params;
1297 params.result = &result;
1298 params.argument = sopInstanceUID;
1300 if (context->InvokeService(context, _OrthancPluginService_LookupInstance, ¶ms))
1317 } _OrthancPluginSendHttpStatusCode;
1338 _OrthancPluginSendHttpStatusCode params;
1339 params.output = output;
1340 params.status = status;
1341 context->InvokeService(context, _OrthancPluginService_SendHttpStatusCode, ¶ms);
1360 _OrthancPluginOutputPlusArgument params;
1361 params.output = output;
1362 params.argument = realm;
1363 context->InvokeService(context, _OrthancPluginService_SendUnauthorized, ¶ms);
1380 const char* allowedMethods)
1382 _OrthancPluginOutputPlusArgument params;
1383 params.output = output;
1384 params.argument = allowedMethods;
1385 context->InvokeService(context, _OrthancPluginService_SendMethodNotAllowed, ¶ms);
1394 } _OrthancPluginSetHttpHeader;
1412 _OrthancPluginSetHttpHeader params;
1413 params.output = output;
1414 params.key = cookie;
1415 params.value = value;
1416 context->InvokeService(context, _OrthancPluginService_SetCookie, ¶ms);
1436 _OrthancPluginSetHttpHeader params;
1437 params.output = output;
1439 params.value = value;
1440 context->InvokeService(context, _OrthancPluginService_SetHttpHeader, ¶ms);
1446 char** resultStringToFree;
1447 const char** resultString;
1448 int64_t* resultInt64;
1451 } _OrthancPluginAccessDicomInstance;
1470 _OrthancPluginAccessDicomInstance params;
1471 memset(¶ms, 0,
sizeof(params));
1472 params.resultString = &result;
1473 params.instance = instance;
1475 if (context->InvokeService(context, _OrthancPluginService_GetInstanceRemoteAet, ¶ms))
1502 _OrthancPluginAccessDicomInstance params;
1503 memset(¶ms, 0,
sizeof(params));
1504 params.resultInt64 = &size;
1505 params.instance = instance;
1507 if (context->InvokeService(context, _OrthancPluginService_GetInstanceSize, ¶ms))
1534 _OrthancPluginAccessDicomInstance params;
1535 memset(¶ms, 0,
sizeof(params));
1536 params.resultString = &result;
1537 params.instance = instance;
1539 if (context->InvokeService(context, _OrthancPluginService_GetInstanceData, ¶ms))
1569 _OrthancPluginAccessDicomInstance params;
1570 memset(¶ms, 0,
sizeof(params));
1571 params.resultStringToFree = &result;
1572 params.instance = instance;
1574 if (context->InvokeService(context, _OrthancPluginService_GetInstanceJson, ¶ms))
1606 _OrthancPluginAccessDicomInstance params;
1607 memset(¶ms, 0,
sizeof(params));
1608 params.resultStringToFree = &result;
1609 params.instance = instance;
1611 if (context->InvokeService(context, _OrthancPluginService_GetInstanceSimplifiedJson, ¶ms))
1641 const char* metadata)
1645 _OrthancPluginAccessDicomInstance params;
1646 memset(¶ms, 0,
sizeof(params));
1647 params.resultInt64 = &result;
1648 params.instance = instance;
1649 params.key = metadata;
1651 if (context->InvokeService(context, _OrthancPluginService_HasInstanceMetadata, ¶ms))
1658 return (result != 0);
1678 const char* metadata)
1682 _OrthancPluginAccessDicomInstance params;
1683 memset(¶ms, 0,
sizeof(params));
1684 params.resultString = &result;
1685 params.instance = instance;
1686 params.key = metadata;
1688 if (context->InvokeService(context, _OrthancPluginService_GetInstanceMetadata, ¶ms))
1707 } _OrthancPluginRegisterStorageArea;
1728 _OrthancPluginRegisterStorageArea params;
1729 params.create = create;
1731 params.remove =
remove;
1734 params.free = ::free;
1739 context->InvokeService(context, _OrthancPluginService_RegisterStorageArea, ¶ms);
1758 _OrthancPluginRetrieveDynamicString params;
1759 params.result = &result;
1760 params.argument = NULL;
1762 if (context->InvokeService(context, _OrthancPluginService_GetOrthancPath, ¶ms))
1788 _OrthancPluginRetrieveDynamicString params;
1789 params.result = &result;
1790 params.argument = NULL;
1792 if (context->InvokeService(context, _OrthancPluginService_GetOrthancDirectory, ¶ms))
1823 _OrthancPluginRetrieveDynamicString params;
1824 params.result = &result;
1825 params.argument = NULL;
1827 if (context->InvokeService(context, _OrthancPluginService_GetConfigurationPath, ¶ms))
1843 } _OrthancPluginOnChangeCallback;
1858 _OrthancPluginOnChangeCallback params;
1859 params.callback = callback;
1861 context->InvokeService(context, _OrthancPluginService_RegisterOnChangeCallback, ¶ms);
1869 _OrthancPluginProperty property;
1871 } _OrthancPluginSetPluginProperty;
1889 _OrthancPluginSetPluginProperty params;
1890 params.plugin = OrthancPluginGetName();
1891 params.property = _OrthancPluginProperty_RootUri;
1894 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
1909 const char* description)
1911 _OrthancPluginSetPluginProperty params;
1912 params.plugin = OrthancPluginGetName();
1913 params.property = _OrthancPluginProperty_Description;
1914 params.value = description;
1916 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
1931 const char* javascript)
1933 _OrthancPluginSetPluginProperty params;
1934 params.plugin = OrthancPluginGetName();
1935 params.property = _OrthancPluginProperty_OrthancExplorer;
1936 params.value = javascript;
1938 context->InvokeService(context, _OrthancPluginService_SetPluginProperty, ¶ms);
1947 } _OrthancPluginGlobalProperty;
1965 const char* defaultValue)
1969 _OrthancPluginGlobalProperty params;
1970 params.result = &result;
1971 params.property = property;
1972 params.value = defaultValue;
1974 if (context->InvokeService(context, _OrthancPluginService_GetGlobalProperty, ¶ms))
2005 _OrthancPluginGlobalProperty params;
2006 params.result = NULL;
2007 params.property = property;
2008 params.value = value;
2010 if (context->InvokeService(context, _OrthancPluginService_SetGlobalProperty, ¶ms))
2025 int32_t *resultInt32;
2026 uint32_t *resultUint32;
2027 int64_t *resultInt64;
2028 uint64_t *resultUint64;
2029 } _OrthancPluginReturnSingleValue;
2044 _OrthancPluginReturnSingleValue params;
2045 memset(¶ms, 0,
sizeof(params));
2046 params.resultUint32 = &count;
2048 if (context->InvokeService(context, _OrthancPluginService_GetCommandLineArgumentsCount, ¶ms))
2079 _OrthancPluginGlobalProperty params;
2080 params.result = &result;
2081 params.property = (int32_t) argument;
2082 params.value = NULL;
2084 if (context->InvokeService(context, _OrthancPluginService_GetCommandLineArgument, ¶ms))
2109 _OrthancPluginReturnSingleValue params;
2110 memset(¶ms, 0,
sizeof(params));
2111 params.resultUint32 = &count;
2113 if (context->InvokeService(context, _OrthancPluginService_GetExpectedDatabaseVersion, ¶ms))
2141 _OrthancPluginRetrieveDynamicString params;
2142 params.result = &result;
2143 params.argument = NULL;
2145 if (context->InvokeService(context, _OrthancPluginService_GetConfiguration, ¶ms))
2161 const char* subType;
2162 const char* contentType;
2163 } _OrthancPluginStartMultipartAnswer;
2180 const char* subType,
2181 const char* contentType)
2183 _OrthancPluginStartMultipartAnswer params;
2184 params.output = output;
2185 params.subType = subType;
2186 params.contentType = contentType;
2187 return context->InvokeService(context, _OrthancPluginService_StartMultipartAnswer, ¶ms);
2208 uint32_t answerSize)
2210 _OrthancPluginAnswerBuffer params;
2211 params.output = output;
2212 params.answer = answer;
2213 params.answerSize = answerSize;
2214 params.mimeType = NULL;
2215 return context->InvokeService(context, _OrthancPluginService_SendMultipartItem, ¶ms);
int32_t(* OrthancPluginStorageRemove)(const char *uuid, OrthancPluginContentType type)
Callback for removing a file from the storage area.
Definition: OrthancCPlugin.h:532
void OrthancPluginSendMethodNotAllowed(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *allowedMethods)
Signal that this URI does not support this HTTP method.
Definition: OrthancCPlugin.h:1377
char * OrthancPluginGetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *defaultValue)
Get the value of a global property.
Definition: OrthancCPlugin.h:1962
The parameters of a REST request.
Definition: OrthancCPlugin.h:179
void OrthancPluginRegisterOnChangeCallback(OrthancPluginContext *context, OrthancPluginOnChangeCallback callback)
Register a callback to monitor changes.
Definition: OrthancCPlugin.h:1854
Definition: OrthancCPlugin.h:374
void OrthancPluginRegisterOnStoredInstanceCallback(OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback)
Register a callback for received instances.
Definition: OrthancCPlugin.h:754
const char *const * headersValues
The values of the HTTP headers.
Definition: OrthancCPlugin.h:239
const char *const * headersKeys
The keys of the HTTP headers (always converted to low-case).
Definition: OrthancCPlugin.h:234
uint32_t getCount
For a GET request, the number of GET parameters.
Definition: OrthancCPlugin.h:199
void OrthancPluginRedirect(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *redirection)
Redirect a REST request.
Definition: OrthancCPlugin.h:1123
int32_t(* OrthancPluginStorageCreate)(const char *uuid, const void *content, int64_t size, OrthancPluginContentType type)
Callback for writing to the storage area.
Definition: OrthancCPlugin.h:496
int OrthancPluginRestApiPost(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, const char *body, uint32_t bodySize)
Make a POST call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:957
void OrthancPluginSendHttpStatusCode(OrthancPluginContext *context, OrthancPluginRestOutput *output, uint16_t status)
Send a HTTP status code.
Definition: OrthancCPlugin.h:1333
Definition: OrthancCPlugin.h:400
const char * OrthancPluginGetInstanceRemoteAet(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the AET of a DICOM instance.
Definition: OrthancCPlugin.h:1464
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:828
OrthancPluginContentType
Definition: OrthancCPlugin.h:371
Definition: OrthancCPlugin.h:403
void OrthancPluginLogInfo(OrthancPluginContext *context, const char *message)
Log an information.
Definition: OrthancCPlugin.h:700
int32_t(* OrthancPluginStorageRead)(void **content, int64_t *size, const char *uuid, OrthancPluginContentType type)
Callback for reading from the storage area.
Definition: OrthancCPlugin.h:515
Definition: OrthancCPlugin.h:169
void OrthancPluginLogError(OrthancPluginContext *context, const char *message)
Log an error.
Definition: OrthancCPlugin.h:668
char * OrthancPluginGetConfiguration(OrthancPluginContext *context)
Return the content of the configuration file(s).
Definition: OrthancCPlugin.h:2137
void OrthancPluginFreeMemoryBuffer(OrthancPluginContext *context, OrthancPluginMemoryBuffer *buffer)
Free a memory buffer.
Definition: OrthancCPlugin.h:652
char * OrthancPluginGetOrthancPath(OrthancPluginContext *context)
Return the path to the Orthanc executable.
Definition: OrthancCPlugin.h:1754
OrthancPluginResourceType
Definition: OrthancCPlugin.h:383
int32_t(* OrthancPluginRestCallback)(OrthancPluginRestOutput *output, const char *url, const OrthancPluginHttpRequest *request)
Signature of a callback function that answers to a REST request.
Definition: OrthancCPlugin.h:452
void OrthancPluginSendUnauthorized(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *realm)
Signal that a REST request is not authorized.
Definition: OrthancCPlugin.h:1355
OrthancPluginChangeType
Definition: OrthancCPlugin.h:396
int OrthancPluginRestApiDelete(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:1015
void OrthancPluginSetHttpHeader(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *key, const char *value)
Set some HTTP header.
Definition: OrthancCPlugin.h:1430
int OrthancPluginGetDicomForInstance(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *instanceId)
Retrieve a DICOM instance using its Orthanc identifier.
Definition: OrthancCPlugin.h:866
char * OrthancPluginGetOrthancDirectory(OrthancPluginContext *context)
Return the directory containing the Orthanc.
Definition: OrthancCPlugin.h:1784
Graylevel, unsigned 16bpp image.
Definition: OrthancCPlugin.h:339
int OrthancPluginRestApiDeleteAfterPlugins(OrthancPluginContext *context, const char *uri)
Make a DELETE call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:1035
char * OrthancPluginLookupStudyWithAccessionNumber(OrthancPluginContext *context, const char *accessionNumber)
Look for a study, using the accession number.
Definition: OrthancCPlugin.h:1222
int32_t OrthancPluginStartMultipartAnswer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *subType, const char *contentType)
Start an HTTP multipart answer.
Definition: OrthancCPlugin.h:2177
void OrthancPluginSetRootUri(OrthancPluginContext *context, const char *uri)
Set the URI where the plugin provides its Web interface.
Definition: OrthancCPlugin.h:1885
void * data
The content of the buffer.
Definition: OrthancCPlugin.h:424
Definition: OrthancCPlugin.h:401
Color image in RGB24 format.
Definition: OrthancCPlugin.h:355
int OrthancPluginHasInstanceMetadata(OrthancPluginContext *context, OrthancPluginDicomInstance *instance, const char *metadata)
Check whether a DICOM instance is associated with some metadata.
Definition: OrthancCPlugin.h:1638
uint32_t headersCount
The number of HTTP headers.
Definition: OrthancCPlugin.h:229
char * OrthancPluginGetInstanceSimplifiedJson(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file (with simplification).
Definition: OrthancCPlugin.h:1600
void OrthancPluginExtendOrthancExplorer(OrthancPluginContext *context, const char *javascript)
Extend the JavaScript code of Orthanc Explorer.
Definition: OrthancCPlugin.h:1929
OrthancPluginHttpMethod
Definition: OrthancCPlugin.h:167
struct _OrthancPluginDicomInstance_t OrthancPluginDicomInstance
Opaque structure that represents a DICOM instance received by Orthanc.
Definition: OrthancCPlugin.h:445
char * OrthancPluginGetCommandLineArgument(OrthancPluginContext *context, uint32_t argument)
Get the value of a command-line argument.
Definition: OrthancCPlugin.h:2073
Definition: OrthancCPlugin.h:407
struct _OrthancPluginContext_t OrthancPluginContext
Data structure that contains information about the Orthanc core.
Definition: OrthancCPlugin.h:399
Definition: OrthancCPlugin.h:385
struct _OrthancPluginRestOutput_t OrthancPluginRestOutput
Opaque structure that represents the HTTP connection to the client application.
Definition: OrthancCPlugin.h:438
int32_t OrthancPluginSetGlobalProperty(OrthancPluginContext *context, int32_t property, const char *value)
Set the value of a global property.
Definition: OrthancCPlugin.h:2000
int OrthancPluginRestApiPut(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, const char *body, uint32_t bodySize)
Make a PUT call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:1057
int OrthancPluginRestApiPutAfterPlugins(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, const char *body, uint32_t bodySize)
Make a PUT call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:1090
const char *const * getValues
For a GET request, the values of the GET parameters.
Definition: OrthancCPlugin.h:209
int OrthancPluginRestApiPostAfterPlugins(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri, const char *body, uint32_t bodySize)
Make a POST call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:989
Definition: OrthancCPlugin.h:171
char * OrthancPluginGetConfigurationPath(OrthancPluginContext *context)
Return the path to the configuration file(s).
Definition: OrthancCPlugin.h:1819
const char * body
For a PUT or POST request, the content of the body.
Definition: OrthancCPlugin.h:214
Definition: OrthancCPlugin.h:172
char * OrthancPluginLookupPatient(OrthancPluginContext *context, const char *patientID)
Look for a patient.
Definition: OrthancCPlugin.h:1154
Color image in RGBA32 format.
Definition: OrthancCPlugin.h:363
Definition: OrthancCPlugin.h:386
void OrthancPluginSetCookie(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *cookie, const char *value)
Set a cookie.
Definition: OrthancCPlugin.h:1406
const char *const * getKeys
For a GET request, the keys of the GET parameters.
Definition: OrthancCPlugin.h:204
Definition: OrthancCPlugin.h:398
const char *const * groups
The matched values for the groups of the regular expression.
Definition: OrthancCPlugin.h:194
uint32_t OrthancPluginGetCommandLineArgumentsCount(OrthancPluginContext *context)
Get the number of command-line arguments.
Definition: OrthancCPlugin.h:2039
uint32_t size
The number of bytes in the buffer.
Definition: OrthancCPlugin.h:429
int OrthancPluginRestApiGet(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the built-in Orthanc REST API.
Definition: OrthancCPlugin.h:896
uint32_t groupsCount
The number of groups of the regular expression.
Definition: OrthancCPlugin.h:189
int32_t(* OrthancPluginOnStoredInstanceCallback)(OrthancPluginDicomInstance *instance, const char *instanceId)
Signature of a callback function that is triggered when Orthanc receives a DICOM instance.
Definition: OrthancCPlugin.h:462
Definition: OrthancCPlugin.h:406
OrthancPluginPixelFormat
Definition: OrthancCPlugin.h:323
Definition: OrthancCPlugin.h:387
void OrthancPluginRegisterRestCallback(OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback)
Register a REST callback.
Definition: OrthancCPlugin.h:727
int32_t OrthancPluginSendMultipartItem(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *answer, uint32_t answerSize)
Send an item as a part of some HTTP multipart answer.
Definition: OrthancCPlugin.h:2204
Graylevel 8bpp image.
Definition: OrthancCPlugin.h:331
uint32_t bodySize
For a PUT or POST request, the number of bytes of the body.
Definition: OrthancCPlugin.h:219
void OrthancPluginAnswerBuffer(OrthancPluginContext *context, OrthancPluginRestOutput *output, const char *answer, uint32_t answerSize, const char *mimeType)
Answer to a REST request.
Definition: OrthancCPlugin.h:785
const char * OrthancPluginGetInstanceMetadata(OrthancPluginContext *context, OrthancPluginDicomInstance *instance, const char *metadata)
Get the value of some metadata associated with a given DICOM instance.
Definition: OrthancCPlugin.h:1675
uint32_t OrthancPluginGetExpectedDatabaseVersion(OrthancPluginContext *context)
Get the expected version of the database schema.
Definition: OrthancCPlugin.h:2104
Definition: OrthancCPlugin.h:405
void OrthancPluginRegisterStorageArea(OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove)
Register a custom storage area.
Definition: OrthancCPlugin.h:1722
void OrthancPluginFreeString(OrthancPluginContext *context, char *str)
Free a string.
Definition: OrthancCPlugin.h:561
void(* OrthancPluginFree)(void *buffer)
Signature of a function to free dynamic memory.
Definition: OrthancCPlugin.h:481
Definition: OrthancCPlugin.h:402
int64_t OrthancPluginGetInstanceSize(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the size of a DICOM file.
Definition: OrthancCPlugin.h:1496
Definition: OrthancCPlugin.h:388
char * OrthancPluginGetInstanceJson(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the DICOM tag hierarchy as a JSON file.
Definition: OrthancCPlugin.h:1563
Graylevel, signed 16bpp image.
Definition: OrthancCPlugin.h:347
OrthancPluginHttpMethod method
The HTTP method.
Definition: OrthancCPlugin.h:184
const char * OrthancPluginGetInstanceData(OrthancPluginContext *context, OrthancPluginDicomInstance *instance)
Get the data of a DICOM file.
Definition: OrthancCPlugin.h:1528
A memory buffer allocated by the core system of Orthanc.
Definition: OrthancCPlugin.h:419
void OrthancPluginSetDescription(OrthancPluginContext *context, const char *description)
Set a description for this plugin.
Definition: OrthancCPlugin.h:1907
int OrthancPluginCheckVersion(OrthancPluginContext *context)
Check the compatibility of the plugin wrt. the version of its hosting Orthanc.
Definition: OrthancCPlugin.h:584
void OrthancPluginLogWarning(OrthancPluginContext *context, const char *message)
Log a warning.
Definition: OrthancCPlugin.h:684
Definition: OrthancCPlugin.h:375
Definition: OrthancCPlugin.h:170
char * OrthancPluginLookupStudy(OrthancPluginContext *context, const char *studyUID)
Look for a study.
Definition: OrthancCPlugin.h:1188
char * OrthancPluginLookupSeries(OrthancPluginContext *context, const char *seriesUID)
Look for a series.
Definition: OrthancCPlugin.h:1256
Definition: OrthancCPlugin.h:373
Definition: OrthancCPlugin.h:404
int OrthancPluginRestApiGetAfterPlugins(OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, const char *uri)
Make a GET call to the REST API, as tainted by the plugins.
Definition: OrthancCPlugin.h:923
int32_t(* 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:471
char * OrthancPluginLookupInstance(OrthancPluginContext *context, const char *sopInstanceUID)
Look for an instance.
Definition: OrthancCPlugin.h:1290