Status Functions

Functions
NAIBRDFUNC nai_status_t NAIAPI	naibrd_VR_GetChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_vr_chan_mapped_status_type_t statusType, nai_status_bit_t *p_outStatusBit)
	Retrieves the VR Status from the specified channel.
NAIBRDFUNC nai_status_t NAIAPI	naibrd_VR_ClearChanMappedStatus (int32_t cardIndex, int32_t module, int32_t channel, naibrd_vr_chan_mapped_status_type_t statusType)
	Clears the latched status for the specified VR channel and latched status type.

Detailed Description

Function Documentation

naibrd_VR_ClearChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_ClearChanMappedStatus	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_vr_chan_mapped_status_type_t	statusType )

Clears the latched status for the specified VR channel and latched status type.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
statusType	: (Input) Status Type: refer to naibrd_vr_chan_mapped_status_type_t definition.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
• NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
• NAI_ERROR_INVALID_VALUE when invalid statusType parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.

naibrd_VR_GetChanMappedStatus()

NAIBRDFUNC nai_status_t NAIAPI naibrd_VR_GetChanMappedStatus	(	int32_t	cardIndex,
		int32_t	module,
		int32_t	channel,
		naibrd_vr_chan_mapped_status_type_t	statusType,
		nai_status_bit_t *	p_outStatusBit )

Retrieves the VR Status from the specified channel.

Parameters

cardIndex	: (Input) Logical Card Index assigned to connection with the NAI_BOARD (0 - NAI_MAX_CARDS-1).
module	: (Input) Module Number of the module to access (1 - [max modules for board]).
channel	: (Input) Channel Number of the channel to access (1 - [max channels for module]).
statusType	: (Input) Status Type: refer to naibrd_vr_chan_mapped_status_type_t definition.
p_outStatusBit	: (Output) 0 for Normal, 1 for Failure.

Returns

• NAI_SUCCESS
• NAI_ERROR_INVALID_CARD when invalid card parameter is specified.
• NAI_ERROR_INVALID_MODULE when invalid module parameter is specified.
• NAI_ERROR_INVALID_CHANNEL when invalid channel parameter is specified.
• NAI_ERROR_INVALID_VALUE when invalid statusType parameter is specified.
• NAI_ERROR_NOT_SUPPORTED when function is not supported.