Method GetGlobalSiteData
- Assembly
- NationalInstruments.SemiconductorTestLibrary.Abstractions.dll
GetGlobalSiteData<T>(ISemiconductorModuleContext, string, bool)
Gets a SiteData object previously stored by the SetGlobalSiteData<T>(ISemiconductorModuleContext, string, SiteData<T>) method.
The global data item is filtered for sites in NationalInstruments.TestStand.SemiconductorModule.CodeModuleAPI.ISemiconductorModuleContext before return when filterForActiveSites
is set to true.
public static SiteData<T> GetGlobalSiteData<T>(this ISemiconductorModuleContext tsmContext, string dataId, bool filterForActiveSites = true)
Parameters
tsmContext
ISemiconductorModuleContextThe NationalInstruments.TestStand.SemiconductorModule.CodeModuleAPI.ISemiconductorModuleContext object.
dataId
stringA unique ID to distinguish the data. This parameter must match a value you specify in a call to the SetGlobalSiteData method.
filterForActiveSites
boolDetermines whether to filter the global data item for sites in NationalInstruments.TestStand.SemiconductorModule.CodeModuleAPI.ISemiconductorModuleContext.
Returns
- SiteData<T>
The global SiteData item that is previously stored.
Type Parameters
T
Data type of value to use with SiteData<T> object.
Exceptions
- NISemiconductorTestException
Thrown when the stored SiteData object does not contain value for a specific site in NationalInstruments.TestStand.SemiconductorModule.CodeModuleAPI.ISemiconductorModuleContext.