Returns the sample rate stored in the NI-RFSG waveform database. This method uses the waveformName parameter as the key to retrieve the waveform properties.

Syntax

Namespace: NationalInstruments.ModularInstruments.NIRfsgPlayback

public static int RetrieveWaveformSampleRate(IntPtr rfsgSession, string waveformName, out double sampleRate)

Parameters

NameTypeDescription
rfsgSessionIntPtr

Identifies the instrument session. The rfsgSession handle is obtained from the NIRfsg.DangerousGetInstrumentHandle method.

waveformNamestring

Specifies the name of the waveform for which you want to retrieve the sample rate value.

sampleRateout double

Returns the sampling rate stored in the NI-RFSG waveform database for the waveform you specified in the waveformName parameter. This value is expressed in samples per second (S/s).

Returns

Returns the status code of this method. The status code either indicates success or describes a warning condition.