niRFSA_InitializeExternalAlignment
- Updated2025-02-03
- 2 minute(s) read
niRFSA_InitializeExternalAlignment
ViStatus niRFSA_InitializeExternalAlignment(ViRsrc resourceName, ViConstString optionString, ViSession* vi);
Purpose
Creates and initializes a special NI-RFSA external alignment session.
The ViSession returned is an NI-RFSA session that you can use to configure the device using normal attributes and functions. However, NI-RFSA sets flags that allow you to program an external alignment procedure using the external alignment attributes and functions.
Supported Devices: PXIe-5605 (PXIe-5665 only), PXIe-5606 (PXIe-5668 only)
Parameters
| Input | ||||||||||||||||
| Name | Type | Description | ||||||||||||||
| resourceName | ViRsrc | Specifies the resource name of the device to initialize. For NI-RFSA devices, the syntax is the device name specified in MAX. The typical default name for your device in MAX is PXI1Slot2. You can rename your device by right-clicking the name in MAX, selecting Rename from the drop-down menu, and entering a new name. You can also pass in the name of an IVI logical name configured with the IVI Configuration utility. For additional information, refer to the Installed Devices»IVI topic of the Measurement & Automation Explorer Help.
|
||||||||||||||
| optionString | ViConstString | Sets the initial value of certain attributes for the session. The attributes shown in the following table are used in this parameter.
The format of this string is "AttributeName=Value", where AttributeName is the name of the attribute and Value is the value to which the attribute will be set. To set multiple attributes, separate their assignments with a comma. |
||||||||||||||
| Output | ||||||||||||||||
| Name | Type | Description | ||||||||||||||
| vi | ViSession | Identifies your instrument session. | ||||||||||||||
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-RFSA function to determine if an error has occurred. To obtain a text description of the status code and additional information about the error condition, call the niRFSA_GetError function. To clear the error information from NI-RFSA, call the niRFSA_ClearError function. The general meaning of the status code is as follows:
|
||||||||