Rockwell Automation 6182 SDK - Manual (Page 73)

RAC6182-Specific Extensions to the CE API 4–33
Publication 6182-UM002B-EN-P
RM_PARAMETER_ENABLE_SERIAL_DEBUG_ON_BOOT
RM_PARAMETER_LCD_BRIGHTNESS
RM_PARAMETER_LCD_CONTRAST
RM_PARAMETER_CURSOR_ENABLED
RM_PARAMETER_ENABLE_SERIAL_DEBUG
RM_PARAMETER_PHYSICAL_ADDRESS (CE V3.0 only)
dwSize is a pointer to a caller allocated DWORD. *dwSize should be
evaluated with sizeof() or with the size in bytes of
the parameter type as indicated in the table at the beginning of this
section. When the function returns, the value of *dwSize will indicates
the actual number of bytes from pvData used to set the selected
parameter.
pvData is a pointer to a caller allocated buffer containing the setting data
to be applied to the selected parameter. The buffer must be sized and
aligned according to the type of the data. For example, if *pvData will
be filled with a DWORD value, it must be DWORD aligned. Please
refer to the table in the introduction to this section of the manual for
details.
Return Value
One of the following:
RM_ERROR_OK - Parameter valid, size large enough, succeeded
RM_ERROR_INVALID_PARAMETER - Bad dwParameter or
NULL dwSize or pvData
RM_ERROR_INVALID_BUFFER_SIZE - Buffer size too small for
requested parameter
Portability
The arguments to this function are specific to the RAC6182 hardware.
The hardware of the RAC6182 has provides a number of timers of
varying precision, flexibility, and range. Some of these timers may be
used for other operating-system level purposes such as reschedule timer
interrupts, PWM for LCD panels, RS485 implementation, etc. However,
at least one of these timers is guaranteed to be available for general
purpose use to application programs.
Since the number of timers is only guaranteed to be at least one and
RAC6182 supports the possibility of multiple applications executing,
applications should use the timer APIs along with a fallback to less
precise Sleep() or busy-wait timing if timers are not available for their
usage.
Functions for Accessing
System Timers