beautypg.com

Retmemunlock, Syntax, Remarks – Rockwell Automation 6182 SDK User Manual

Page 91: Return value, Portability, See also, Retmemwrite

background image

RAC6182-Specific Extensions to the CE API

4–51

Publication 6182-UM002B-EN-P

RetMemUnlock

This function unlocks retentive memory. It is prototyped in
RetentiveMemAPI.h.

Syntax

#include
#include

BOOL RetMemUnlock (void)

Remarks
The application should always call this function to release a lock on
retentive memory before exiting.

Return Value
Returns TRUE if the lock is released. Returns FALSE on failure.

Portability
This function is specific to the RAC6182 hardware.

See Also
RetMemLock

RetMemWrite

This function writes to retentive memory. It is prototyped in
RetentiveMemAPI.h.

Syntax

#include

#include

DWORD RetMemWrite (DWORD dwOffset, DWORD dwLength, BYTE *pbtBuffer)

Remarks
This function copies dwLength bytes of data from a user data buffer to a
specific area in retentive memory. If less than dwLength bytes are
available to be written, the number of available bytes are copied. In this
case, the number of bytes returned will be less than dwLength. If
another process has the memory locked, no bytes will be written and the
return value will be 0.

The total amount of available memory is represented by the macro
RET_MEM_MEMORY_SIZE, defined in RetentiveMemAPI.h.

This manual is related to the following products: