ar_initialize_api

short ar_initialize_api (short board);

Purpose

This function acquires the resources allocated by the operating system for the device and initializes API local variables. With the exception of the RAR-PCIE, it also downloads the device firmware, resetting the device to a power-up state.

Parameters

Input

Name

Type

Description

board

short

(input) Device Number for the product/resource to open, (valid range is 0-15).

Return Value

Name

Type

Description

status

short

status of the function call, with valid values of:
ARS_NORMAL         Success.
ARS_INVBOARD     The board parameter value was invalid.
ARS_BADLOAD       The device driver session was opened successfully but the device firmware download failed.

ARS_HW_DETECT   The device driver session was opened but the detected device is not recognized as a CEI-x30 product.

ARS_WINRTFAIL     The device driver failed to open a session with the device, either because the device is not properly installed in the host system or a resource conflict is inhibiting device driver initialization.

References

Initialization Functions
Alphabetical Function Index
Hierarchical Function Index

CEI-x30 API Description