view CodeGeneration/CustomFunctions.json @ 73:037a2b0d06ca OrthancJava-2.0

OrthancJava-2.0
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 22 Aug 2025 10:24:13 +0200
parents e673eadccf7d
children
line wrap: on
line source

[
  {
    "comment" : "New in release 2.0",
    "c_function" : "OrthancPluginCustom_GetQueueSize",
    "sdk_functions" : [ "OrthancPluginGetQueueSize" ],
    "documentation" : {
      "description" : [ "Get the number of elements in a queue." ],
      "args" : {
        "queueId" : "The identifier of the queue."
      },
      "return" : "The size of the queue."
    },
    "args" : [
      {
        "sdk_name" : "queueId",
        "sdk_type" : "const char *"
      }
    ],
    "return_sdk_type" : "uint64_t",
    "since_sdk" : [ 1, 12, 8 ]
  },

  {
    "comment" : "New in release 2.0",
    "c_function" : "OrthancPluginCustom_DequeueValue",
    "sdk_functions" : [ "OrthancPluginDequeueValue" ],
    "documentation" : {
      "description" : [ "Dequeue a value from a queue." ],
      "args" : {
        "queueId" : "The identifier of the queue.",
        "origin" : "The position from where the value is dequeued (back for LIFO, front for FIFO)."
      },
      "return" : "The dequeued value as a byte array, or null if the queue was empty."
    },
    "args" : [
      {
        "sdk_name" : "queueId",
        "sdk_type" : "const char *"
      },
      {
        "sdk_name" : "origin",
        "sdk_type" : "enumeration",
        "sdk_enumeration" : "OrthancPluginQueueOrigin"
      }
    ],
    "return_sdk_type" : "java_object",
    "return_sdk_class" : "byte[]",
    "return_sdk_signature" : "[B",
    "since_sdk" : [ 1, 12, 8 ]
  },

  {
    "comment" : "New in release 2.0",
    "c_function" : "OrthancPluginCustom_GetKeyValue",
    "sdk_functions" : [ "OrthancPluginGetKeyValue" ],
    "documentation" : {
      "description" : [ "Get the value associated with a key in the Orthanc key-value store." ],
      "args" : {
        "storeId" : "The key-value store.",
        "key" : "The key."
      },
      "return" : "The value as a byte array, or null if the key does not exist."
    },
    "args" : [
      {
        "sdk_name" : "storeId",
        "sdk_type" : "const char *"
      },
      {
        "sdk_name" : "key",
        "sdk_type" : "const char *"
      }
    ],
    "return_sdk_type" : "java_object",
    "return_sdk_class" : "byte[]",
    "return_sdk_signature" : "[B",
    "since_sdk" : [ 1, 12, 8 ]
  },

  {
    "comment" : "New in release 2.0",
    "c_function" : "OrthancPluginCustom_SetStableStatus",
    "sdk_functions" : [ "OrthancPluginSetStableStatus" ],
    "documentation" : {
      "description" : [ "Change the Stable status of a resource" ],
      "args" : {
        "resourceId" : "The identifier of the resource.",
        "stableStatus" : "The new stable status."
      },
      "return" : "A Boolean indicating whether the status has changed (true) or not (false) during the execution of this command."
    },
    "args" : [
      {
        "sdk_name" : "resourceId",
        "sdk_type" : "const char *"
      },
      {
        "sdk_name" : "stableStatus",
        "sdk_type" : "enumeration",
        "sdk_enumeration" : "OrthancPluginStableStatus"
      }
    ],
    "return_sdk_type" : "bool",
    "since_sdk" : [ 1, 12, 9 ]
  }

]