video3d_close :: Quanser C Functions

navigation bar

video3d_close

Closes a video3d device.

Description

The video3d_close function closes a video3d device, releasing all its resources. The t_video3d handle cannot be used after it has been closed.

Prototype

t_error
video3d_close(t_video3d handle);

Parameters

t_video3d handle

The handle to the 3D video capture session returned by video3d_open.

Return value

The return value is 0 if the stream was 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.

QERR_OUT_OF_MEMORY

There is not enough memory to complete the operation.

Requirements

Include Files	Libraries
quanser_video3d.h	quanser_media.lib;quanser_communications.lib;quanser_runtime.lib;quanser_common.lib

Examples

t_video3d capture;
t_error result = video3d_open("0", &capture);
if (result >= 0) {
    ...
    video3d_close(capture);
} else {
    TCHAR message[512];
    msg_get_error_message(NULL, result, message, sizeof(message));
    _tprintf(_T("Failed to open video capture session. %s (error %d)\n"), message, -result);
}