Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #1340, update documentation for CFE_ES_DeleteCDS #1384

Merged
merged 1 commit into from
Apr 28, 2021
Merged

Fix #1340, update documentation for CFE_ES_DeleteCDS #1384

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion modules/core_api/fsw/inc/cfe_es_core_internal.h
View file
Open in desktop
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