Read Functions

FPGA Interface C API Help

Edition Date: August 2014

Part Number: 372928H-01

»View Product Info
Download Help (Windows Only)

The FPGA Interface C API includes the following Read functions, which share similar parameters.

NiFpga_ReadBool

NiFpga_Status NiFpga_ReadBool(NiFpga_Session session, uint32_t indicator, NiFpga_Bool* value)

Reads a boolean value from a given indicator or control.

NiFpga_ReadI8

NiFpga_Status NiFpga_ReadI8(NiFpga_Session session, uint32_t indicator, int8_t* value)

Reads a signed 8-bit integer value from a given indicator or control.

NiFpga_ReadU8

NiFpga_Status NiFpga_ReadU8(NiFpga_Session session, uint32_t indicator, uint8_t* value)

Reads an unsigned 8-bit integer value from a given indicator or control.

NiFpga_ReadI16

NiFpga_Status NiFpga_ReadI16(NiFpga_Session session, uint32_t indicator, int16_t* value)

Reads a signed 16-bit integer value from a given indicator or control.

NiFpga_ReadU16

NiFpga_Status NiFpga_ReadU16(NiFpga_Session session, uint32_t indicator, uint16_t* value)

Reads an unsigned 16-bit integer value from a given indicator or control.

NiFpga_ReadI32

NiFpga_Status NiFpga_ReadI32(NiFpga_Session session, uint32_t indicator, int32_t* value)

Reads a signed 32-bit integer value from a given indicator or control.

NiFpga_ReadU32

NiFpga_Status NiFpga_ReadU32(NiFpga_Session session, uint32_t indicator, uint32_t* value)

Reads an unsigned 32-bit integer value from a given indicator or control.

NiFpga_ReadI64

NiFpga_Status NiFpga_ReadI64(NiFpga_Session session, uint32_t indicator, int64_t* value)

Reads a signed 64-bit integer value from a given indicator or control.

NiFpga_ReadU64

NiFpga_Status NiFpga_ReadU64(NiFpga_Session session, uint32_t indicator, uint64_t* value)

Reads an unsigned 64-bit integer value from a given indicator or control.

Parameters for All Read Functions

Name Type Description
session NiFpga_Session handle to a currently open session
indicator uint32_t indicator or control from which to read
value Varies by Read function outputs the value that was read

Return Value for All Read Functions

result of the call

WAS THIS ARTICLE HELPFUL?

Not Helpful