Software Library API naibrd 2.24.0
See all documentation at naii.docs.com

Functions

NAIBRDFUNC const char *NAIAPI naibrd_GetStatusString (nai_status_t status)
 Returns the ASCII text string associated with the status code passed in.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_msDelay (int32_t delay_ms)
 Sleeps for the specified number of millisecond. Note, this process does relinquish control to the OS during the sleep.
 
NAIBRDFUNC nai_status_t NAIAPI naibrd_usWait (unsigned long wait_us)
 Waits the specified number of microseconds. Note, this is a "blocking" sleep - process is not relinquish control to the OS during the wait.
 

Detailed Description

Function Documentation

◆ naibrd_GetStatusString()

NAIBRDFUNC const char *NAIAPI naibrd_GetStatusString ( nai_status_t status)

Returns the ASCII text string associated with the status code passed in.

Parameters
status: (Input) Status Code
Returns
  • ASCII text string for the status code. If an invalid status code is passed in, the ASCII string returned is NAI_ERROR_UNKNOWN.

◆ naibrd_msDelay()

NAIBRDFUNC nai_status_t NAIAPI naibrd_msDelay ( int32_t delay_ms)

Sleeps for the specified number of millisecond. Note, this process does relinquish control to the OS during the sleep.

Parameters
delay_ms: (Input) Number of milliseconds to sleep.
Returns
  • NAI_SUCCESS

◆ naibrd_usWait()

NAIBRDFUNC nai_status_t NAIAPI naibrd_usWait ( unsigned long wait_us)

Waits the specified number of microseconds. Note, this is a "blocking" sleep - process is not relinquish control to the OS during the wait.

Parameters
wait_us: (Input) Number of microseconds to wait.
Returns
  • NAI_SUCCESS