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

Jump to bottom

Fix #1337, add docs to CFE_ES_RegisterCDS() regarding clearing #1376

Merged
merged 1 commit into from
Apr 22, 2021
Merged

Fix #1337, add docs to CFE_ES_RegisterCDS() regarding clearing #1376

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.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1021,7 +1021,13 @@ void CFE_ES_ProcessAsyncEvent(void);
** the calling Application. The memory can survive an Application restart as well as a Processor Reset.
**
** \par Assumptions, External Events, and Notes:
** None
** This function does _not_ clear or otherwise initialize/modify the data within the CDS block.
** If this function returns #CFE_ES_CDS_ALREADY_EXISTS the block may already have valid data in it.
**
** If a new CDS block is reserved (either because the name did not exist, or existed as a different
** size) it is the responsibility of the calling application to fill the CDS block with valid data.
** This is indicated by a #CFE_SUCCESS return code, and in this case the calling application should
** ensure that it also calls CFE_ES_CopyToCDS() to fill the block with valid data.
**
** \param[in, out] HandlePtr Pointer Application's variable that will contain the CDS Memory Block Handle.
** HandlePtr is the handle of the CDS block that can be used in
Expand Down