beautypg.com

Return value, Portability, See also – Rockwell Automation 6182 SDK User Manual

Page 92: Retmemread, Syntax, Remarks

background image

4–52

RAC6182-Specific Extensions to the CE API

Publication 6182-UM002B-EN-P

Parameter

Description

dwOffset

Starting offset in RAM at which data will be written.
Offset 0 is the first byte of RAM.

dwLength

Number of bytes to be written.

pbtBuffer

Pointer to a buffer containing data to be written to
the RAM.

Return Value
Returns the total number of bytes actually written

Portability
This function is specific to the RAC6182 hardware.

See Also
RetMemRead

RetMemRead

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

Syntax

#include
#include

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

Remarks
This function copies dwLength bytes of data from an area of retentive
memory into a user data buffer. The number of bytes actually read is
returned. If fewer than dwLength bytes are available, the value returned
will be less than dwLength. If another process has the memory locked,
no bytes will be read and the return value will be 0.

The total amount of available memory (in bytes) is given by the macro
RET_MEM_MEMORY_SIZE, defined in RetentiveMemAPI.h.

Parameter

Description

dwOffset

Starting offset in RAM of data to be read. Offset 0 is
the first byte of RAM.

dwLength

Number of bytes to be read.

pbtBuffer

Pointer to the beginning of a buffer to be filled with
data from RAM.

This manual is related to the following products: