NI-RFSG Playback Library

niRFSGPlayback_RetrieveAutomaticSGSASharedLO

  • Updated2023-02-21
  • 1 minute(s) read

ViStatus __stdcall niRFSGPlayback_RetrieveAutomaticSGSASharedLO(ViSession rfsgSession, ViConstString channelName, ViInt32 *automaticSGSASharedLO);

Purpose

Returns the value of automaticSGSASharedLO parameter.

Parameters

Input
Name Type Description
rfsgSession ViSession Identifies the instrument session. rfsgSession is obtained from either the niRFSG_init function or the niRFSG_InitWithOptions function.
channelName ViConstString This parameter is reserved for future use.
Output
Name Type Description
automaticSGSASharedLO ViInt32* Returns the access control of NI-RFSG LO Out Export.

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 RFmx 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 niRFSGPlayback_GetError function.

The general meaning of the status code is as follows:

Value Meaning
0 Success
Positive Values Warnings
Negative Values Errors

Log in to get a better experience