hil_get_double_property :: Quanser C Functions

navigation bar

hil_get_double_property

Gets the value of double properties of the board.

Description

The hil_get_double_property function gets the values of a set of double properties from the board. There are currently no standard double properties defined, but the board may support product-specific double properties. This function can retrieve the value of more than one double property at the same time.

Prototype

t_error 
hil_get_double_property(t_card card, const t_hil_double_property properties[], t_uint32 num_properties, t_double buffer[]);

Parameters

t_card card

A handle to the board, as returned by hil_open

const t_hil_double_property [] properties

An array containing the property numbers of the properties to be retrieved. There are no standard double properties currently defined.

Select a board type from the list for board-specific details: .

t_uint32 num_properties

The number of properties specified in the properties array.

t_double [] buffer

An array for receiving the property values retrieved from the board. The array must contain num_properties elements. Each element in the returned buffer array will correspond to the same element in the properties array.

Return value

The return value is 0 if all the properties are retrieved 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_HIL_GET_DOUBLE_PROPERTY_NOT_SUPPORTED

This function is not supported by the board-specific HIL driver for this board type.

QERR_INVALID_CARD_HANDLE

An invalid card handle was passed as an argument. Once a card has been closed using hil_close the card handle is invalid.

QERR_MISSING_PROPERTIES

No properties were specified even though the number of properties is nonzero.

QERR_MISSING_PROPERTIES_BUFFER

Properties have been specified but no values have been provided for the operation.

QERR_PROPERTY_NOT_RECOGNIZED

One or more of the specified properties were not recognized by the board-specific driver.

QERR_DRIVER_INCOMPATIBLE_WITH_BOARD_DLL

The board-specific HIL driver passed an invalid parameter to the operating system specific kernel-level driver for the board. The board-specific HIL driver is likely not compatible with the operating system specific kernel-level driver for the board. Make sure both are up-to-date and compatible versions.

QERR_INTERNAL_BUFFER_TOO_SMALL

The board-specific HIL driver used an internal buffer that was too small for the operating system specific kernel-level driver for the board. The board-specific HIL driver is likely not compatible with the operating system specific kernel-level driver for the board. Make sure both are up-to-date and compatible versions.

QERR_OUT_OF_REQUIRED_SYSTEM_RESOURCES

There are not enough system resources to perform the requested operation. Try rebooting, requesting fewer samples, or adding more memory to your machine.

Requirements

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

Examples

t_hil_double_property properties[] = { PROPERTY_DOUBLE_PRODUCT_SPECIFIC + 5 };
t_double buffer[1];
t_error result = hil_get_double_property(board, properties, ARRAY_LENGTH(properties), buffer);

navigation bar