Rockwell Automation 6182 SDK - Manual (Page 93)

RAC6182-Specific Extensions to the CE API 4–53
Publication 6182-UM002B-EN-P
Return Value
Returns the number of bytes actually read.
Portability
This function is specific to the RAC6182 hardware.
See Also
RetMemWrite
RetMemVerifyMemory
This function verifies retentive memory. It is prototyped in
RetentiveMemAPI.h.
Syntax
#include
#include
BOOL RetMemVerifyMemory (void)
Remarks
This function calculates the checksum of retentive memory and
compares it to the master checksum. If the two values do not match, the
function returns FALSE, indicating the existence of corrupt data in the
memory. If the two values match, the function returns TRUE, indicating
that data are valid.
This function does not rewrite the master checksum; therefore,
successive calls to this function will return the same result.
Applications should call this function before reading from or writing to
the battery-backed RAM, to verify that its data are valid The caller must
hold a lock on the RAM in order to use this function.
Return Value
Returns TRUE if the calculated checksum matches the master checksum.
Returns FALSE if the checksums do not match or if another application
has locked memory.
Portability
This function is specific to the RAC6182 hardware.
See Also
RetMemCalculateChecksum