Skip to content

Commit

Permalink
Merge pull request #1384 from jphickey/fix-1340-delete-cds-doc
Browse files Browse the repository at this point in the history
Fix #1340, update documentation for CFE_ES_DeleteCDS
  • Loading branch information
astrogeco authored Apr 28, 2021
2 parents 069646d + 9ed820f commit 1b91d33
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion modules/core_api/fsw/inc/cfe_es_core_internal.h
Original file line number Diff line number Diff line change
Expand Up @@ -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").
Expand Down

0 comments on commit 1b91d33

Please sign in to comment.