video_display_get_attributes :: Quanser C Functions

navigation bar

video_display_get_attributes

Get the attributes of the window.

Description

The video_display_get_attributes function gets the attributes of the window, such as the position and size.

Prototype

t_error
video_display_get_attributes(t_video_window window, t_video_window_attributes * attributes);

Parameters

t_video_window window

The handle to the window returned by video_display_open.

t_video_window_attributes * attributes

The address of a t_video_window_attributes structure to receive the window attributes, such as the window position and size. The size field must be initialized to the size of the structure before calling this function. The fields of the structure are described below:

Field	Description
size	This field must be set to the size of the structure i.e., sizeof(t_video_window_attributes) for future compatibility.
x	The x-coordinate of the window in screen pixel coordinates.
y	The y-coordinate of the window in screen pixel coordinates.
cx	The width of the window in pixels.
cy	The height of the window in pixels.

Return value

The return value is 0 if the operation is 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_video.h	quanser_media.lib;quanser_communications.lib;quanser_runtime.lib;quanser_common.lib

Examples

t_video_window_attributes attributes;
attributes.size = sizeof(attributes);

result = video_display_get_attributes(window, &attributes);