IviRFSigGen_GetLFGeneratorName
IviRFSigGenLFGenerator Capability Group
C Function Prototype
ViStatus IviRFSigGen_GetLFGeneratorName (ViSession vi, ViInt32 index, ViInt32 nameBufferSize, ViChar[] name);
Purpose
This function returns the specific driver defined LF generator source name that corresponds to the one-based index specified by the Index parameter. If you pass in a value for the Index parameter that is less than one or greater than the value of the IVIRFSIGGEN_ATTR_LF_GENERATOR_COUNT attribute, the function returns an empty string in the Name parameter and returns the Invalid Value error.
Note: For an instrument with only one LF generator source, i.e. the IVIRFSIGGEN_ATTR_LF_GENERATOR_COUNT attribute is one, the driver may return an empty string.
Parameters
| Name | Type | Description |
|---|---|---|
| vi | ViSession | The ViSession handle that you obtain from the IviRFSigGen_init or IviRFSigGen_InitWithOptions function. The handle identifies a particular instrument session. Default Value: None |
| index | ViInt32 | The index of the analog modulation source whose name is returned. The value must be greater than or equal to one and less than or equal to IVIRFSIGGEN_ATTR_LF_GENERATOR_COUNT. Note: Zero is not a legal value. Default Value: 0 |
| nameBufferSize | ViInt32 | Specify the buffer size for the Name parameter.
Default Value: 0 |
| name | ViChar[] | The LF generator source name that corresponds to the Index.
The Name buffer must contain at least as many elements as the value you specify with the Name Buffer Size parameter. Default Value: "" |