Get Session Data (TSM)

NI TestStand 2017 Semiconductor Module Code Module VIs Help

Edition Date: July 2018

Part Number: 373951H-01

»View Product Info
Download Help (Windows Only)

Requires: TSM

Returns the session data, channel group IDs, and channel lists required to access one or more pins for a specified instrument type ID. You must manually select the polymorphic instance you want to use.

Use the pull-down menu to select an instance of this VI.

Multiple Pins - Multiple Sessions

Returns all sessions in the Semiconductor Module context associated with the pins.

GetSessionData.vi

/images/reference/en-XX/help/373951H-01/crn.gif Semiconductor Module Context is a valid ActiveX reference to a Semiconductor Module context object.
/images/reference/en-XX/help/373951H-01/c1dstr.gif Pins specifies the names of the pins or pin groups to translate to session data, channel group IDs, and channel lists.
/images/reference/en-XX/help/373951H-01/cstr.gif Instrument Type Id specifies the type ID for the instrument in the pin map file. When you add to the pin map file an instrument that TSM does not natively support, you must define a type ID for the instrument, such as the instrument driver name.
/images/reference/en-XX/help/373951H-01/cerrcodeclst.gif error in (no error) describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out.
/images/reference/en-XX/help/373951H-01/i102.gif Pin Query Context is the pin query context object that tracks the sessions and channels associated with a pin query. TSM uses this object to publish measurements, and extract data from a set of measurements.
/images/reference/en-XX/help/373951H-01/i1dstr.gif Channel Lists returns the channel lists that correspond to the pins associated with session data and channel group IDs. Each channel list is a comma-separated list of channels.
/images/reference/en-XX/help/373951H-01/irn.gif Semiconductor Module Context Out returns the Semiconductor Module Context parameter unchanged.
/images/reference/en-XX/help/373951H-01/i1dfxdt.gif Session Data returns an array of session data associated with channel group IDs.
/images/reference/en-XX/help/373951H-01/i1dstr.gif Channel Group Ids returns the IDs of the channel groups that contain the channels connected to the pins. For channels that do not belong to a channel group in the pin map, the Semiconductor Module creates a channel group with the same ID as the channel.
/images/reference/en-XX/help/373951H-01/ierrcodeclst.gif error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.

Single Pin - Multiple Sessions

Returns all sessions in the Semiconductor Module context associated with the pin.

GetSessionDataSinglePinMultipleInstr.vi

/images/reference/en-XX/help/373951H-01/crn.gif Semiconductor Module Context is a valid ActiveX reference to a Semiconductor Module context object.
/images/reference/en-XX/help/373951H-01/cstr.gif Pin specifies the name of the pin or pin group to translate to session data, channel group IDs, and channel lists.
/images/reference/en-XX/help/373951H-01/cstr.gif Instrument Type Id specifies the type ID for the instrument in the pin map file. When you add to the pin map file an instrument that TSM does not natively support, you must define a type ID for the instrument, such as the instrument driver name.
/images/reference/en-XX/help/373951H-01/cerrcodeclst.gif error in (no error) describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out.
/images/reference/en-XX/help/373951H-01/i102.gif Pin Query Context is the pin query context object that tracks the sessions and channels associated with a pin query. TSM uses this object to publish measurements, and extract data from a set of measurements.
/images/reference/en-XX/help/373951H-01/i1dstr.gif Channel Lists returns the channel lists that correspond to the pin associated with session data and channel group IDs. Each channel list is a comma-separated list of channels.
/images/reference/en-XX/help/373951H-01/irn.gif Semiconductor Module Context Out returns the Semiconductor Module Context parameter unchanged.
/images/reference/en-XX/help/373951H-01/i1dfxdt.gif Session Data returns an array of session data associated with channel group IDs.
/images/reference/en-XX/help/373951H-01/i1dstr.gif Channel Group Ids returns the IDs of the channel groups that contain the channels connected to the pin. For channels that do not belong to a channel group in the pin map, the Semiconductor Module creates a channel group with the same ID as the channel.
/images/reference/en-XX/help/373951H-01/ierrcodeclst.gif error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.

Multiple Pins - Single Session

Returns the session in the Semiconductor Module context associated with the pins.

GetSessionDataMultiplePinSingleInstr.vi

/images/reference/en-XX/help/373951H-01/crn.gif Semiconductor Module Context is a valid ActiveX reference to a Semiconductor Module context object.
/images/reference/en-XX/help/373951H-01/c1dstr.gif Pins specifies the names of the pins or pin groups to translate to session data, channel group IDs, and channel lists.
/images/reference/en-XX/help/373951H-01/cstr.gif Instrument Type Id specifies the type ID for the instrument in the pin map file. When you add to the pin map file an instrument that TSM does not natively support, you must define a type ID for the instrument, such as the instrument driver name.
/images/reference/en-XX/help/373951H-01/cerrcodeclst.gif error in (no error) describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out.
/images/reference/en-XX/help/373951H-01/i102.gif Pin Query Context is the pin query context object that tracks the sessions and channels associated with a pin query. TSM uses this object to publish measurements, and extract data from a set of measurements.
/images/reference/en-XX/help/373951H-01/istr.gif Channel List returns the channel list that corresponds to the pins associated with session data and channel group ID. The channel list is a comma-separated list of channels.
/images/reference/en-XX/help/373951H-01/irn.gif Semiconductor Module Context Out returns the Semiconductor Module Context parameter unchanged.
/images/reference/en-XX/help/373951H-01/ifxdt.gif Session Data returns the session data associated with the channel group ID.
/images/reference/en-XX/help/373951H-01/istr.gif Channel Group Id returns the ID of the channel groups that contain the channels connected to the pins. For channels that do not belong to a channel group in the pin map, the Semiconductor Module creates a channel group with the same ID as the channel.
/images/reference/en-XX/help/373951H-01/ierrcodeclst.gif error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.

Single Pin - Single Session

Returns the session in the Semiconductor Module context associated with the pin.

GetSessionDataSinglePinSingleInstr.vi

/images/reference/en-XX/help/373951H-01/crn.gif Semiconductor Module Context is a valid ActiveX reference to a Semiconductor Module context object.
/images/reference/en-XX/help/373951H-01/cstr.gif Pin specifies the name of the pin or pin group to translate to session data, channel group ID, and channel list
/images/reference/en-XX/help/373951H-01/cstr.gif Instrument Type Id specifies the type ID for the instrument in the pin map file. When you add to the pin map file an instrument that TSM does not natively support, you must define a type ID for the instrument, such as the instrument driver name.
/images/reference/en-XX/help/373951H-01/cerrcodeclst.gif error in (no error) describes error conditions that occur before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out.
/images/reference/en-XX/help/373951H-01/i102.gif Pin Query Context is the pin query context object that tracks the sessions and channels associated with a pin query. TSM uses this object to publish measurements, and extract data from a set of measurements.
/images/reference/en-XX/help/373951H-01/istr.gif Channel List returns the channel list that correspond to the pin associated with session data and channel group ID. The channel list is a comma-separated list of channels.
/images/reference/en-XX/help/373951H-01/irn.gif Semiconductor Module Context Out returns the Semiconductor Module Context parameter unchanged.
/images/reference/en-XX/help/373951H-01/ifxdt.gif Session Data returns the session data associated with the channel group ID.
/images/reference/en-XX/help/373951H-01/istr.gif Channel Group Id returns the ID of the channel group that contains the channels connected to the pin. For channels that do not belong to a channel group in the pin map, the Semiconductor Module creates a channel group with the same ID as the channel.
/images/reference/en-XX/help/373951H-01/ierrcodeclst.gif error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out front panel indicator and select Explain Error from the shortcut menu for more information about the error.

WAS THIS ARTICLE HELPFUL?

Not Helpful