Rockwell Automation 2711P Software Development Kit User Manual - Manual (Page 43)

Publication 2711P-UM005A-EN-P - March 2007
PanelView Plus CE-Specific Extensions to the WinCE API 43
Remarks:
The functions use a model that is similar to device IOCTLs. Functions
take a parameter, the size of data, and a generic buffer. The contents
of the buffer depend on the parameter. The actual size of data that is
Set/Get is returned along with a return code and data.
DWORDrm_Get/SetParameter(DWORD dwParameter, DWORD
*dwSize,VOID *pvData);
The *dwSize parameter passed in indicates the space available in
pvData for a Get or the space of valid data to use for a Set. Upon
success, *dwSize is returned containing the actual amount of data
returned in the buffer for a Get, or the amount of data from the buffer
used for a Set.
The pvData must point to a buffer of large enough size and of correct
size. Parameters which use *pvData as aligned types (e.g. as pointing
to a DWORD or a pointer) must follow the alignment restrictions of
these types. For example, if getting a parameter where *pvData will be
filled with a DWORD value, pvData must be DWORD aligned.
• RM_PARAMETER_DISABLE_USER_INPUT
This parameter prohibits user input via the touchscreen,
keypad and keyboard. This parameter permits an application
to immediately disable user input when the display is lost due
to a back light failure.
Backlight Status RM_PARAMETER_BACKLIGHT_STATUS Get BOOL 4 PanelView Plus CE
Enable BBC E-Boot RM_PARAMETER_ENABLE_BBC_EBOOT Set BOOL 4 PanelView Plus CE
Enable EBC E-Boot RM_PARAMETER_ENABLE_EBC_EBOOT Set BOOL 4 PanelView Plus CE
CIP Serial Number RM_PARAMETER_CIP_SERIAL_NUMBER Get DWORD 4 PanelView Plus CE
Persistent Registry RM_PARAMETER_PERSISTENT_REGISTRY_
PRESENT
Both DWORD 4 PanelView Plus CE
Screensaver
Brightness RM_PARAMETER_SCREENSAVER_
BRIGHTNESS
Both DWORD 4 PanelView Plus CE
Temperature Sensor RM_PARAMETER_BEZEL_TEMPERATURE_
SENSOR_IS_WORKING
Get BOOL 4 PanelView Plus CE
Safe Mode Switch RM_PARAMETER_FACTORY_DEFAULTS Get BOOL 4 PanelView Plus CE
Logic Board Revision RM_PARAMETER_BOARD_REVISION Get DWORD 4 PanelView Plus CE
System Parameters
Parameter Macro Identifier Get or
Set Type Size
(Bytes)
Portability