hil_is_valid :: Quanser C Functions

navigation bar

hil_is_valid

Determines whether an HIL board handle is valid.

Description

The hil_is_valid function returns a non-zero value if the given board handle is valid. A board handle is valid if it was returned by successful call to hil_open and has not been closed. If the board handle is invalid, this function returns zero.

Prototype

t_boolean 
hil_is_valid(t_card card);

Parameters

t_card card

A handle to the board, as returned by hil_open.

Return value

The return value is non-zero if the board handle is valid. Otherwise it is zero.

Error codes

This function does not return any error code.

Requirements

Include Files	Libraries
hil.h	hil.lib;quanser_runtime.lib;quanser_common.lib

Examples

if (!hil_is_valid(board))
{
    _tprintf(_T("Board handle is invalid.\n"));
    return;
}

navigation bar