ws0010_close
Closes a Surenoo WS0010 OLED display.
Description
The ws0010_close function closes the Surenoo WS0010 OLED display, releasing any allocated resources. Once the display has been closed, the display handle is no longer valid and may not be used.
Prototype
t_error ws0010_close(t_ws0010 display);
Parameters
t_ws0010 display
A handle to the display returned by the ws0010_open function.
Return value
The return value is 0 if the display is closed successfully. Otherwise a negative
error code is returned. Error codes are
defined in quanser_errors.h
. A suitable error message
may be retrieved using msg_get_error_message.
Error codes
QERR_INVALID_ARGUMENT
One of the arguments is invalid.
Requirements
Include Files |
Libraries |
---|---|
quanser_lcd_display.h |
quanser_devices.lib;quanser_communications.lib;quanser_runtime.lib;quanser_common.lib |
Examples
t_ws0010 display; t_error result = ws0010_open("lcd://qbot_platform:1", &display); if (result == 0) { ... ws0010_close(display); } else { TCHAR message[512]; msg_get_error_message(NULL, result, message, sizeof(message)); _tprintf(_T("Failed to open OLED display. %s (error %d)\n"), message, -result); }
See Also
Copyright ©2024 Quanser Inc. This page was generated 2024-04-16. Submit feedback to Quanser about this page.
Link to this page.