Get Session Data (TSM)

Get Session Data (TSM)

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.

Multiple Pins - Multiple Sessions

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

	Semiconductor Module Context is a valid ActiveX reference to a Semiconductor Module context object.
	Pins specifies the names of the pins or pin groups to translate to session data, channel group IDs, and channel lists.
	Instrument Type Id specifies the type ID for the instrument in the pin map file. All custom instruments defined in the pin map specify an associated type ID. Typically, this type ID is an instrument driver name or other ID that is common for instruments that users program in a similar way. For custom instruments, you must pass the type ID associated with the instrument in the pin map file. For model-based instruments, pass the string you passed to the Set Custom Session VI to store sessions for the instruments.
	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.
	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.
	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. If any of the pins are connected to the same instrument channel for multiple sites, the channel appears only once in the list.
	Semiconductor Module Context Out returns the Semiconductor Module Context parameter unchanged.
	Session Data returns an array of session data associated with channel group IDs.
	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.
	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.

	Semiconductor Module Context is a valid ActiveX reference to a Semiconductor Module context object.
	Pin specifies the name of the pin or pin group to translate to session data, channel group IDs, and channel lists.
	Instrument Type Id specifies the type ID for the instrument in the pin map file. All custom instruments defined in the pin map specify an associated type ID. Typically, this type ID is an instrument driver name or other ID that is common for instruments that users program in a similar way. For custom instruments, you must pass the type ID associated with the instrument in the pin map file. For model-based instruments, pass the string you passed to the Set Custom Session VI to store sessions for the instruments.
	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.
	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.
	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. If the pin is connected to the same instrument channel for multiple sites, the channel appears only once in the list.
	Semiconductor Module Context Out returns the Semiconductor Module Context parameter unchanged.
	Session Data returns an array of session data associated with channel group IDs.
	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.
	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.

	Semiconductor Module Context is a valid ActiveX reference to a Semiconductor Module context object.
	Pins specifies the names of the pins or pin groups to translate to session data, channel group IDs, and channel lists.
	Instrument Type Id specifies the type ID for the instrument in the pin map file. All custom instruments defined in the pin map specify an associated type ID. Typically, this type ID is an instrument driver name or other ID that is common for instruments that users program in a similar way. For custom instruments, you must pass the type ID associated with the instrument in the pin map file. For model-based instruments, pass the string you passed to the Set Custom Session VI to store sessions for the instruments.
	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.
	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.
	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. If any of the pins are connected to the same instrument channel for multiple sites, the channel appears only once in the list.
	Semiconductor Module Context Out returns the Semiconductor Module Context parameter unchanged.
	Session Data returns the session data associated with the channel group ID.
	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.
	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.

	Semiconductor Module Context is a valid ActiveX reference to a Semiconductor Module context object.
	Pin specifies the name of the pin or pin group to translate to session data, channel group ID, and channel list
	Instrument Type Id specifies the type ID for the instrument in the pin map file. All custom instruments defined in the pin map specify an associated type ID. Typically, this type ID is an instrument driver name or other ID that is common for instruments that users program in a similar way. For custom instruments, you must pass the type ID associated with the instrument in the pin map file. For model-based instruments, pass the string you passed to the Set Custom Session VI to store sessions for the instruments.
	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.
	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.
	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. If the pin is connected to the same instrument channel for multiple sites, the channel appears only once in the list.
	Semiconductor Module Context Out returns the Semiconductor Module Context parameter unchanged.
	Session Data returns the session data associated with the channel group ID.
	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.
	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.