From 9ed820fbc28703eae5068296d03bbeaee47132ae Mon Sep 17 00:00:00 2001 From: Joseph Hickey Date: Mon, 19 Apr 2021 17:43:34 -0400 Subject: [PATCH] Fix #1340, update documentation for CFE_ES_DeleteCDS Noted that this does not actually wipe or erase the block, it only returns resources to the pool for re-use. --- modules/core_api/fsw/inc/cfe_es_core_internal.h | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/modules/core_api/fsw/inc/cfe_es_core_internal.h b/modules/core_api/fsw/inc/cfe_es_core_internal.h index e9e38a4b3..257c7d24f 100644 --- a/modules/core_api/fsw/inc/cfe_es_core_internal.h +++ b/modules/core_api/fsw/inc/cfe_es_core_internal.h @@ -112,8 +112,14 @@ int32 CFE_ES_RegisterCDSEx(CFE_ES_CDSHandle_t *HandlePtr, size_t UserBlockSize, ** Removes the record of the specified CDS from the CDS Registry and ** frees the associated CDS memory for future use. ** +** This operation invalidates the registry entry and returns +** the underlying data storage back to the CDS pool for re-use. +** ** \par Assumptions, External Events, and Notes: -** None +** The actual data block is not modified by this call. Specifically, this does not +** "wipe" or otherwise overwrite the data block. If the application needs to ensure +** that the data is actually erased, it should explicitly do so (by e.g. writing all +** zeros or all ones) before deleting the block. ** ** \param[in] CDSName - Pointer to character string containing complete ** CDS Name (of the format "AppName.CDSName").