SetCustomSession(string, string, string, object)
- Updated2026-06-25
- 1 minute(s) read
Associates a session with an instrument and channel group.
Syntax
Namespace: NationalInstruments.TestStand.SemiconductorModule.CodeModuleAPI
public void SetCustomSession(string instrumentTypeId, string instrumentName, string channelGroupId, object sessionData)
Parameters
| Name | Type | Description |
|---|---|---|
| instrumentTypeId | string | The type of instrument for which you want to set the session. 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. The InstrumentTypeIdConstants class contains instrument type IDs for instrument types that TSM supports natively. For custom instruments, you must pass the type ID associated with the instrument in the pin map file. For model-based instruments, you can pass any string that does not start with "ni" for the type ID. |
| instrumentName | string | The instrument name in the pin map file for the corresponding session. The instrument must be of type instrumentTypeId . |
| channelGroupId | string | The channel group in the pin map file for the corresponding session. 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. |
| sessionData | object | The session for the corresponding instrumentName and channelGroupId . |