Table of Contents
video_display_set_caption
Change the title of the video display window.
Description
The video_display_set_caption function changes the caption on the video display window.
Prototype
t_error video_display_set_caption(t_video_window window, const char * text);
Parameters
t_video_window window
The handle to the window returned by video_display_open.
const char * text
A string containing the text to use for the window caption.
Return value
The return value is 0 if the window caption is set 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.
QERR_NOT_SUPPORTED
This function is not supported on this platform.
QERR_OUT_OF_MEMORY
There is not enough memory to complete the operation.
Requirements
Include Files |
Libraries |
---|---|
quanser_video.h |
quanser_media.lib;quanser_communications.lib;quanser_runtime.lib;quanser_common.lib |
Examples
result = video_display_set_caption(window, "The Moment of Truth");
See Also
Copyright ©2024 Quanser Inc. This page was generated 2024-10-17. Submit feedback to Quanser about this page.
Link to this page.