diff options
| author | Abner Chang <abner.chang@amd.com> | 2024-01-11 16:47:55 +0800 |
|---|---|---|
| committer | mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> | 2024-01-16 09:13:03 +0000 |
| commit | 9971b99461e930008e3d35bc0a4a310b6afa57f6 (patch) | |
| tree | bc330e731b0e43818c5a4770831fbbd04ea6b7fa | |
| parent | 8f6d343ae639fba8e4b80e45257275e23083431f (diff) | |
| download | edk2-9971b99461e930008e3d35bc0a4a310b6afa57f6.tar.gz edk2-9971b99461e930008e3d35bc0a4a310b6afa57f6.tar.bz2 edk2-9971b99461e930008e3d35bc0a4a310b6afa57f6.zip | |
RedfishPkg/JsonLib: Add JSON delete object function
To support the deletion on a specified JSON object.
Signed-off-by: Abner Chang <abner.chang@amd.com>
Cc: Nickle Wang <nicklew@nvidia.com>
Cc: Igor Kulchytskyy <igork@ami.com>
Reviewed-by: Nickle Wang <nicklew@nvidia.com>
| -rw-r--r-- | RedfishPkg/Include/Library/JsonLib.h | 17 | ||||
| -rw-r--r-- | RedfishPkg/Library/JsonLib/JsonLib.c | 24 |
2 files changed, 41 insertions, 0 deletions
diff --git a/RedfishPkg/Include/Library/JsonLib.h b/RedfishPkg/Include/Library/JsonLib.h index 8f31d93414..ea252291a0 100644 --- a/RedfishPkg/Include/Library/JsonLib.h +++ b/RedfishPkg/Include/Library/JsonLib.h @@ -657,6 +657,23 @@ JsonObjectSetValue ( );
/**
+ The function is used to delete a JSON key from the given JSON bject,
+
+ @param[in] JsonObj The provided JSON object.
+ @param[in] Key The key of the JSON value to be deleted.
+
+ @retval EFI_ABORTED Some error occur and operation aborted.
+ @retval EFI_SUCCESS The JSON value has been deleted from this JSON object.
+
+**/
+EFI_STATUS
+EFIAPI
+JsonObjectDelete (
+ IN EDKII_JSON_OBJECT JsonObj,
+ IN CONST CHAR8 *Key
+ );
+
+/**
The function is used to get the number of elements in a JSON array. Returns or 0 if JsonArray
is NULL or not a JSON array.
diff --git a/RedfishPkg/Library/JsonLib/JsonLib.c b/RedfishPkg/Library/JsonLib/JsonLib.c index 6c3373d205..b7be4d6176 100644 --- a/RedfishPkg/Library/JsonLib/JsonLib.c +++ b/RedfishPkg/Library/JsonLib/JsonLib.c @@ -811,6 +811,30 @@ JsonObjectSetValue ( }
/**
+ The function is used to delete a JSON key from the given JSON bject
+
+ @param[in] JsonObj The provided JSON object.
+ @param[in] Key The key of the JSON value to be deleted.
+
+ @retval EFI_ABORTED Some error occur and operation aborted.
+ @retval EFI_SUCCESS The JSON value has been deleted from this JSON object.
+
+**/
+EFI_STATUS
+EFIAPI
+JsonObjectDelete (
+ IN EDKII_JSON_OBJECT JsonObj,
+ IN CONST CHAR8 *Key
+ )
+{
+ if (json_object_del ((json_t *)JsonObj, (const char *)Key) != 0) {
+ return EFI_ABORTED;
+ } else {
+ return EFI_SUCCESS;
+ }
+}
+
+/**
The function is used to get the number of elements in a JSON array. Returns or 0 if JsonArray
is NULL or not a JSON array.
|