ni568x_ConfigureTimeSlotExclusion

RF Power Sensor Devices Help (NI-568x 18.0)

Edition Date: May 2018

Part Number: 373127F-01

»View Product Info
Download Help (Windows Only)

ni568x_ConfigureTimeSlotExclusion(ViSession vi, ViConstString channelName, ViBoolean exclusionEnabled, ViReal64 exclusionTimeForSlotStart, ViReal64 exclusionTimeForSlotEnd);

Purpose

Configures the exclusion period for each time slot. If you enable an exclusion period, a small amount of time at the start and end of each time slot is excluded from the power measurement calculation of each slot.

This function is only applicable if you have selected NI568X_VAL_TIME_SLOT as the mode parameter in the ni568x_ConfigureAcquisitionMode function.

Supported Devices: NI 5681/5683/5684

Parameters

Input
Name Type Description
vi ViSession Identifies your instrument session. vi is obtained from the ni568x_init or ni568x_InitWithOptions function and identifies a particular instrument session.
channelName ViConstString Specifies the name of the channel you want to configure.

The only valid value is "0".
exclusionEnabled ViBoolean Specifies if the exclusion period is used.

VI_TRUE (On) The exclusion period is used.
VI_FALSE (Off) The exclusion period is not used.
exclusionTimeForSlotStart ViReal64 Specifies the duration of time, in seconds, from the start of each time slot that should not be considered for the power measurement.

Valid Range: 0 to 0.010

exclusionTimeForSlotEnd ViReal64 Specifies the duration of time, in seconds, from the end of each time slot that should not be considered for the power measurement.
Note  The sum of exclusionTimeForSlotStart and exclusionTimeForSlotEnd must be less than slot width.


Valid Range: 0 to 0.010

Return Value

Name Type Description
Status ViStatus Returns the status code of this operation. The status code either indicates success or describes an error or warning condition. Examine the status code from each call to an NI-568x function to determine whether an error has occurred.

To obtain a text description of the status code, call the ni568x_error_message function. To obtain additional information about the error condition, call the ni568x_GetError function. To clear the error information from NI-568x, call the ni568x_ClearError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors


WAS THIS ARTICLE HELPFUL?

Not Helpful