Libs/CommonLibs.dllBinary files differ
Libs/ConfigManage.dllBinary files differ
Libs/DatabaseHelper.dll.config
New file @@ -0,0 +1,17 @@ <?xml version="1.0" encoding="utf-8"?> <configuration> <configSections> <!-- For more information on Entity Framework configuration, visit http://go.microsoft.com/fwlink/?LinkID=237468 --> <section name="entityFramework" type="System.Data.Entity.Internal.ConfigFile.EntityFrameworkSection, EntityFramework, Version=6.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" /> </configSections> <entityFramework> <providers> <provider invariantName="System.Data.SqlClient" type="System.Data.Entity.SqlServer.SqlProviderServices, EntityFramework.SqlServer" /> </providers> </entityFramework> <system.data> <DbProviderFactories> <remove invariant="System.Data.SQLite.EF6" /> <add name="SQLite Data Provider (Entity Framework 6)" invariant="System.Data.SQLite.EF6" description=".NET Framework Data Provider for SQLite (Entity Framework 6)" type="System.Data.SQLite.EF6.SQLiteProviderFactory, System.Data.SQLite.EF6" /> <remove invariant="System.Data.SQLite" /><add name="SQLite Data Provider" invariant="System.Data.SQLite" description=".NET Framework Data Provider for SQLite" type="System.Data.SQLite.SQLiteFactory, System.Data.SQLite" /></DbProviderFactories> </system.data></configuration> Libs/DatabaseHelper.xml
New file @@ -0,0 +1,215 @@ <?xml version="1.0"?> <doc> <assembly> <name>DatabaseHelper</name> </assembly> <members> <member name="T:DatabaseHelper.SQLiteHelper"> <summary> SQLite数据库操作类 </summary> </member> <member name="F:DatabaseHelper.SQLiteHelper.dataBaseFile"> <summary> 数据库文件 </summary> </member> <member name="F:DatabaseHelper.SQLiteHelper.connectString"> <summary> 数据库连接字符串 </summary> </member> <member name="F:DatabaseHelper.SQLiteHelper.conn"> <summary> 数据库连接对象 </summary> </member> <member name="F:DatabaseHelper.SQLiteHelper.cmd"> <summary> 数据库操作命令 </summary> </member> <member name="M:DatabaseHelper.SQLiteHelper.#ctor(System.String)"> <summary> 构造函数 </summary> <param name="DBFile">所使用的数据库文件</param> </member> <member name="M:DatabaseHelper.SQLiteHelper.ExecuteSql(System.String)"> <summary> 执行非查询类SQL语句 </summary> <param name="Sql">非查询类的SQL语句</param> </member> <member name="M:DatabaseHelper.SQLiteHelper.GetDataTable(System.String)"> <summary> 执行数据查询 </summary> <param name="Sql">执行查询的SQL语句</param> <returns>查询到的数据</returns> </member> <member name="M:DatabaseHelper.SQLiteHelper.GetDataTableToArray(System.String)"> <summary> 执行数据查询 </summary> <param name="Sql">执行查询的SQL语句</param> <returns>查询到的数据</returns> </member> <member name="M:DatabaseHelper.SQLiteHelper.Close"> <summary> 关闭数据库连接 </summary> </member> <member name="M:DatabaseHelper.SQLiteHelper.GetColumnNameFromTable(System.String)"> <summary> 从表中获取所有的字段名称 </summary> <param name="TableName">表名</param> <returns></returns> </member> <member name="M:DatabaseHelper.SQLiteHelper.GetAllTableInFile"> <summary> 获取数据文件中的所有表 </summary> <returns>数据文件中包含的表</returns> </member> <member name="M:DatabaseHelper.SQLiteHelper.Connect"> <summary> 连接数据库 </summary> </member> <member name="M:DatabaseHelper.SQLiteHelper.DisConnect"> <summary> 断开数据库连接 </summary> </member> <member name="F:DatabaseHelper.SqlServerHelper.connectstring"> <summary> SQL Server 数据库的操作类库。代码原创。 </summary> </member> <member name="P:DatabaseHelper.SqlServerHelper.ConnectString"> <summary> 数据库连接字符串 </summary> </member> <member name="M:DatabaseHelper.SqlServerHelper.#ctor(System.String,System.Int32)"> <summary> 构造函数，初始化 </summary> <param name="ConStr">正确的数据库连接字符串</param> <param name="TimeOut">超时时间</param> </member> <member name="M:DatabaseHelper.SqlServerHelper.#ctor(System.String)"> <summary> 构造函数，初始化 </summary> <param name="ConStr">正确的数据库连接字符串</param> </member> <member name="M:DatabaseHelper.SqlServerHelper.#ctor(System.String,System.String,System.String,System.String,System.Int32)"> <summary> 构造函数，初始化 </summary> <param name="DataServer">数据库服务器名称或地址</param> <param name="DataBase">访问的数据库</param> <param name="UserID">用户名</param> <param name="Pwd">密码</param> <param name="TimeOut">超时时间</param> </member> <member name="M:DatabaseHelper.SqlServerHelper.#ctor(System.String,System.String,System.String,System.String)"> <summary> 构造函数，初始化 </summary> <param name="DataServer">数据库服务器名称或地址</param> <param name="DataBase">访问的数据库</param> <param name="UserID">用户名</param> <param name="Pwd">密码</param> </member> <member name="M:DatabaseHelper.SqlServerHelper.#ctor(System.String,System.Boolean,System.Int32)"> <summary> 构造函数，初始化 </summary> <param name="database">访问的数据库</param> <param name="isLocal">是否为本地数据库？若False，则抛出异常</param> <param name="TimeOut">超时时间</param> </member> <member name="M:DatabaseHelper.SqlServerHelper.#ctor(System.String,System.Boolean)"> <summary> 构造函数，初始化 </summary> <param name="database">访问的数据库</param> <param name="isLocal">是否为本地数据库？若False，则抛出异常</param> </member> <member name="M:DatabaseHelper.SqlServerHelper.ConnectTest"> <summary> 测试是否能够连通 </summary> <returns>布尔值</returns> </member> <member name="M:DatabaseHelper.SqlServerHelper.ExecuteNonQuery(System.String)"> <summary> 执行无返回的Sql语句，如插入，删除，更新 </summary> <param name="sqlstr">SQL语句</param> <returns>受影响的条数</returns> </member> <member name="M:DatabaseHelper.SqlServerHelper.ReturnDataSet(System.String)"> <summary> 执行查询语句，返回DataSet </summary> <param name="sqlstr">Sql</param> <returns>DataSet数据集</returns> </member> <member name="M:DatabaseHelper.SqlServerHelper.ReturnDataTable(System.String)"> <summary> 执行查询语句，返回DataTable </summary> <param name="sqlstr">Sqk</param> <returns>DataTable数据表</returns> </member> <member name="M:DatabaseHelper.SqlServerHelper.ReturnDataReader(System.String)"> <summary> 执行查询语句，返回DataReader </summary> <param name="sqlstr">Sql</param> <returns>DataReader</returns> </member> <member name="M:DatabaseHelper.SqlServerHelper.ExecuteSqlTran(System.Collections.ArrayList)"> <summary> 执行事务 </summary> <param name="SQLStringList"></param> </member> <member name="M:DatabaseHelper.SqlServerHelper.GetServers"> <summary> 获取网内的数据库服务器名称(API方式) </summary> <returns>服务器名称数组</returns> </member> <member name="M:DatabaseHelper.SqlServerHelper.GetServersBySqlClientFactory"> <summary> 获取网内的数据库服务器名称(qlClientFactory方式) </summary> <returns>服务器名称数组</returns> </member> <member name="M:DatabaseHelper.SqlServerHelper.GetDataBases"> <summary> 根据不带数据库的连接字符串，遍历查找出所有数据库实例 </summary> <returns>指定服务器的所有数据库</returns> </member> <member name="M:DatabaseHelper.SqlServerHelper.GetTables"> <summary> 获取SqlServer指定数据库的所有表 </summary> <returns>表集合,出错则产生异常</returns> </member> <member name="M:DatabaseHelper.SqlServerHelper.GetColumns(System.String)"> <summary> 获取指定表的所有列 </summary> <param name="TableName">表名</param> <returns>列集合,出错则产生异常</returns> </member> </members> </doc> Libs/FTPTool.dllBinary files differ
Libs/FactoryControl.dllBinary files differ
Libs/FactoryControlX.dllBinary files differ
Libs/FactoryControlX.xml
New file @@ -0,0 +1,518 @@ <?xml version="1.0"?> <doc> <assembly> <name>FactoryControlX</name> </assembly> <members> <member name="F:FactoryControlX.FactoryLabelEx.lTSCADAApi"> <summary> 接口函数 </summary> </member> <member name="P:FactoryControlX.FactoryLabelEx.StrValue"> <summary> 标签值 </summary> </member> <member name="F:FactoryControlX.FactoryLabelEx.tag"> <summary> 标签 </summary> </member> <member name="P:FactoryControlX.FactoryLabelEx.StrTag"> <summary> 附属标签 </summary> </member> <member name="M:FactoryControlX.FactoryLabelEx.Init(System.String,OpcInterface.OpcInterface)"> <summary> 初始化控件 </summary> <param name="brntag">标签</param> <param name="ltsc">链接服务器</param> </member> <member name="M:FactoryControlX.FactoryLabelEx.GetLabelValue"> <summary> 获取控件值 </summary> </member> <member name="M:FactoryControlX.Form_NumberEditor.CreateNumericKeyboard"> <summary> 创建键盘 </summary> <returns></returns> </member> <member name="M:FactoryControlX.Form_NumberEditor.TextEditor_KeyPress(System.Object,System.Windows.Forms.KeyPressEventArgs)"> <summary> 键盘输入事件 </summary> <param name="sender">触发对象</param> <param name="e">携带参数</param> </member> <member name="F:FactoryControlX.Form_NumberEditor.components"> <summary> Required designer variable. </summary> </member> <member name="M:FactoryControlX.Form_NumberEditor.Dispose(System.Boolean)"> <summary> Clean up any resources being used. </summary> <param name="disposing">true if managed resources should be disposed; otherwise, false.</param> </member> <member name="M:FactoryControlX.Form_NumberEditor.InitializeComponent"> <summary> Required method for Designer support - do not modify the contents of this method with the code editor. </summary> </member> <member name="T:FactoryControlX.LabelControlEx"> <summary> 自定义Label控件 </summary> </member> <member name="P:FactoryControlX.LabelControlEx.Value"> <summary> 自定义控件值 </summary> </member> <member name="M:FactoryControlX.LabelControlEx.#ctor"> <summary> 无参构造函数 </summary> </member> <member name="P:FactoryControlX.LabelControlEx.BoolValue"> <summary> 控件bool值 </summary> </member> <member name="F:FactoryControlX.LabelControlEx.showText"> <summary> The lamp color </summary> </member> <member name="P:FactoryControlX.LabelControlEx.ShowText"> <summary> Gets or sets the color of the lamp. </summary> <value>The color of the lamp.</value> </member> <member name="F:FactoryControlX.LightManage.name"> <summary> 灯类显示名称 </summary> </member> <member name="F:FactoryControlX.LightManage.type"> <summary> 类型 </summary> </member> <member name="F:FactoryControlX.LightManage.Ltag"> <summary> 标签 </summary> </member> <member name="F:FactoryControlX.LightManage.Lcolor"> <summary> 颜色 </summary> </member> <member name="P:FactoryControlX.LightManage.LColor"> <summary> 颜色 </summary> </member> <member name="P:FactoryControlX.LightManage.LTag"> <summary> 标签 </summary> </member> <member name="P:FactoryControlX.LightManage.Name"> <summary> 灯类显示名称 </summary> </member> <member name="P:FactoryControlX.LightManage.Type"> <summary> 类型 </summary> </member> <member name="T:FactoryControlX.Resource"> <summary> 一个强类型的资源类，用于查找本地化的字符串等。 </summary> </member> <member name="P:FactoryControlX.Resource.ResourceManager"> <summary> 返回此类使用的缓存的 ResourceManager 实例。 </summary> </member> <member name="P:FactoryControlX.Resource.Culture"> <summary> 重写当前线程的 CurrentUICulture 属性 重写当前线程的 CurrentUICulture 属性。 </summary> </member> <member name="P:FactoryControlX.Resource.lightArrow"> <summary> 查找 System.Drawing.Bitmap 类型的本地化资源。 </summary> </member> <member name="P:FactoryControlX.Resource.Pass_False"> <summary> 查找 System.Drawing.Bitmap 类型的本地化资源。 </summary> </member> <member name="P:FactoryControlX.Resource.Pass_On"> <summary> 查找 System.Drawing.Bitmap 类型的本地化资源。 </summary> </member> <member name="T:FactoryControlX.UCSignalLamp"> <summary> Class UCSignalLamp. Implements the <see cref="T:System.Windows.Forms.UserControl" /> </summary> <seealso cref="T:System.Windows.Forms.UserControl" /> </member> <member name="F:FactoryControlX.UCSignalLamp.isShowBorder"> <summary> The is show border </summary> </member> <member name="F:FactoryControlX.UCSignalLamp.isValue"> <summary> 控件值 </summary> </member> <member name="F:FactoryControlX.UCSignalLamp.lTSCADAApi"> <summary> 接口函数 </summary> </member> <member name="P:FactoryControlX.UCSignalLamp.IsShowBorder"> <summary> Gets or sets a value indicating whether this instance is show border. </summary> <value><c>true</c> if this instance is show border; otherwise, <c>false</c>.</value> </member> <member name="P:FactoryControlX.UCSignalLamp.IsValue"> <summary> 控件值，false为颜色0，true为颜色1 </summary> </member> <member name="F:FactoryControlX.UCSignalLamp.lampColor"> <summary> The lamp color </summary> </member> <member name="P:FactoryControlX.UCSignalLamp.LampColor"> <summary> Gets or sets the color of the lamp. </summary> <value>The color of the lamp.</value> </member> <member name="F:FactoryControlX.UCSignalLamp.isHighlight"> <summary> The is highlight </summary> </member> <member name="P:FactoryControlX.UCSignalLamp.IsHighlight"> <summary> Gets or sets a value indicating whether this instance is highlight. </summary> <value><c>true</c> if this instance is highlight; otherwise, <c>false</c>.</value> </member> <member name="F:FactoryControlX.UCSignalLamp.twinkleSpeed"> <summary> The twinkle speed </summary> </member> <member name="P:FactoryControlX.UCSignalLamp.TwinkleSpeed"> <summary> Gets or sets the twinkle speed. </summary> <value>The twinkle speed.</value> </member> <member name="F:FactoryControlX.UCSignalLamp.timer"> <summary> The timer </summary> </member> <member name="F:FactoryControlX.UCSignalLamp.intColorIndex"> <summary> The int color index </summary> </member> <member name="M:FactoryControlX.UCSignalLamp.#ctor"> <summary> Initializes a new instance of the <see cref="T:FactoryControlX.UCSignalLamp" /> class. </summary> </member> <member name="M:FactoryControlX.UCSignalLamp.timer_Tick(System.Object,System.EventArgs)"> <summary> Handles the Tick event of the timer control. </summary> <param name="sender">The source of the event.</param> <param name="e">The <see cref="T:System.EventArgs" /> instance containing the event data.</param> </member> <member name="M:FactoryControlX.UCSignalLamp.UCSignalLamp_SizeChanged(System.Object,System.EventArgs)"> <summary> Handles the SizeChanged event of the UCSignalLamp control. </summary> <param name="sender">The source of the event.</param> <param name="e">The <see cref="T:System.EventArgs" /> instance containing the event data.</param> </member> <member name="M:FactoryControlX.UCSignalLamp.OnPaint(System.Windows.Forms.PaintEventArgs)"> <summary> 引发 <see cref="E:System.Windows.Forms.Control.Paint" /> 事件。 </summary> <param name="e">包含事件数据的 <see cref="T:System.Windows.Forms.PaintEventArgs" />。</param> </member> <member name="F:FactoryControlX.UCSignalLamp.tag"> <summary> 标签 </summary> </member> <member name="P:FactoryControlX.UCSignalLamp.StrTag"> <summary> 附属标签 </summary> </member> <member name="M:FactoryControlX.UCSignalLamp.Init(System.String,OpcInterface.OpcInterface)"> <summary> 初始化控件 </summary> <param name="brntag">标签</param> <param name="ltsc">链接服务器</param> </member> <member name="M:FactoryControlX.UCSignalLamp.GetLampValue"> <summary> 获取控件值 </summary> </member> <member name="T:FactoryControlX.UCSignalLampX.FactoryButtonX"> <summary> 通过标签进行读写上升下降沿的自定义按钮 </summary> </member> <member name="F:FactoryControlX.UCSignalLampX.FactoryButtonX.lTSCADAApi"> <summary> 接口函数 </summary> </member> <member name="M:FactoryControlX.UCSignalLampX.FactoryButtonX.#ctor"> <summary> 构造函数 </summary> </member> <member name="F:FactoryControlX.UCSignalLampX.FactoryButtonX.tag"> <summary> 标签 </summary> </member> <member name="P:FactoryControlX.UCSignalLampX.FactoryButtonX.StrTag"> <summary> 附属标签 </summary> </member> <member name="F:FactoryControlX.UCSignalLampX.FactoryButtonX.text"> <summary> 控件值 </summary> </member> <member name="P:FactoryControlX.UCSignalLampX.FactoryButtonX.BtnText"> <summary> Gets or sets a value indicating whether this instance is show border. </summary> <value><c>true</c> if this instance is show border; otherwise, <c>false</c>.</value> </member> <member name="M:FactoryControlX.UCSignalLampX.FactoryButtonX.Init(System.String,OpcInterface.OpcInterface)"> <summary> 初始化控件 </summary> <param name="brntag">标签</param> <param name="ltsc">链接服务器</param> </member> <member name="M:FactoryControlX.UCSignalLampX.FactoryButtonX.GetButtonValue"> <summary> 获取按钮状态 </summary> </member> <member name="F:FactoryControlX.UCSignalLampX.FactoryButtonX.components"> <summary> 必需的设计器变量。 </summary> </member> <member name="M:FactoryControlX.UCSignalLampX.FactoryButtonX.Dispose(System.Boolean)"> <summary> 清理所有正在使用的资源。 </summary> <param name="disposing">如果应释放托管资源，为 true；否则为 false。</param> </member> <member name="M:FactoryControlX.UCSignalLampX.FactoryButtonX.InitializeComponent"> <summary> 设计器支持所需的方法 - 不要修改 使用代码编辑器修改此方法的内容。 </summary> </member> <member name="F:FactoryControlX.UCSignalLampX.UCSignalLampX.lTSCADAApi"> <summary> 接口函数 </summary> </member> <member name="M:FactoryControlX.UCSignalLampX.UCSignalLampX.#ctor"> <summary> 构造函数 </summary> </member> <member name="F:FactoryControlX.UCSignalLampX.UCSignalLampX.isvalue"> <summary> 灯值 </summary> </member> <member name="P:FactoryControlX.UCSignalLampX.UCSignalLampX.LightValue"> <summary> 指示灯状态 </summary> </member> <member name="F:FactoryControlX.UCSignalLampX.UCSignalLampX.text"> <summary> 控件值 </summary> </member> <member name="P:FactoryControlX.UCSignalLampX.UCSignalLampX.LabText"> <summary> Gets or sets a value indicating whether this instance is show border. </summary> <value><c>true</c> if this instance is show border; otherwise, <c>false</c>.</value> </member> <member name="F:FactoryControlX.UCSignalLampX.UCSignalLampX.tag"> <summary> 附属标签 </summary> </member> <member name="P:FactoryControlX.UCSignalLampX.UCSignalLampX.LabTag"> <summary> 附属标签 </summary> </member> <member name="M:FactoryControlX.UCSignalLampX.UCSignalLampX.UCSignalLampX_Load(System.Object,System.EventArgs)"> <summary> 界面加载 </summary> <param name="sender">事件触发者</param> <param name="e">事件触发参数</param> </member> <member name="M:FactoryControlX.UCSignalLampX.UCSignalLampX.Init(System.String,OpcInterface.OpcInterface)"> <summary> 控件初始化 </summary> <param name="latag">控件标签</param> <param name="ltsc">链接服务器</param> </member> <member name="M:FactoryControlX.UCSignalLampX.UCSignalLampX.GetLampValue"> <summary> 获取控件值 </summary> </member> <member name="F:FactoryControlX.UCSignalLampX.UCSignalLampX.components"> <summary> 必需的设计器变量。 </summary> </member> <member name="M:FactoryControlX.UCSignalLampX.UCSignalLampX.Dispose(System.Boolean)"> <summary> 清理所有正在使用的资源。 </summary> <param name="disposing">如果应释放托管资源，为 true；否则为 false。</param> </member> <member name="M:FactoryControlX.UCSignalLampX.UCSignalLampX.InitializeComponent"> <summary> 设计器支持所需的方法 - 不要修改 使用代码编辑器修改此方法的内容。 </summary> </member> <member name="F:FactoryControlX.FactoryButton.lTSCADAApi"> <summary> 接口函数 </summary> </member> <member name="F:FactoryControlX.FactoryButton.diVar"> <summary> 控制变量信息 </summary> </member> <member name="F:FactoryControlX.FactoryButton.imageBool"> <summary> 支持换图变量 </summary> </member> <member name="F:FactoryControlX.FactoryButton.buttonColor"> <summary> The button color </summary> </member> <member name="P:FactoryControlX.FactoryButton.ButtonColor"> <summary> Gets or sets the color of the button. </summary> <value>The color of the lamp.</value> </member> <member name="P:FactoryControlX.FactoryButton.DiVar"> <summary> 按钮的值 </summary> </member> <member name="F:FactoryControlX.FactoryButton.tag"> <summary> 标签 </summary> </member> <member name="P:FactoryControlX.FactoryButton.StrTag"> <summary> 附属标签 </summary> </member> <member name="F:FactoryControlX.FactoryButton.text"> <summary> 控件值 </summary> </member> <member name="P:FactoryControlX.FactoryButton.BtnText"> <summary> Gets or sets a value indicating whether this instance is show border. </summary> <value><c>true</c> if this instance is show border; otherwise, <c>false</c>.</value> </member> <member name="M:FactoryControlX.FactoryButton.Init(System.String,OpcInterface.OpcInterface)"> <summary> 初始化控件 </summary> <param name="brntag">标签</param> <param name="ltsc">链接服务器</param> </member> <member name="M:FactoryControlX.FactoryButton.GetButtonValue"> <summary> 获取按钮状态 </summary> </member> <member name="F:FactoryControlX.FactoryButton.components"> <summary> 必需的设计器变量。 </summary> </member> <member name="M:FactoryControlX.FactoryButton.Dispose(System.Boolean)"> <summary> 清理所有正在使用的资源。 </summary> <param name="disposing">如果应释放托管资源，为 true；否则为 false。</param> </member> <member name="M:FactoryControlX.FactoryButton.InitializeComponent"> <summary> 设计器支持所需的方法 - 不要修改 使用代码编辑器修改此方法的内容。 </summary> </member> </members> </doc> Libs/GetMD5Value.dllBinary files differ
Libs/HMI.Framework.Logger.dllBinary files differ
Libs/ICSharpCode.SharpZipLib.dllBinary files differ
Libs/KeyGenDlls.dllBinary files differ
Libs/KeyboardControl.dllBinary files differ
Libs/KeyboardControl.xml
New file @@ -0,0 +1,141 @@ <?xml version="1.0"?> <doc> <assembly> <name>KeyboardControl</name> </assembly> <members> <member name="T:KeyboardControl.Form_Keyboard"> <summary> 悬浮键盘 </summary> </member> <member name="M:KeyboardControl.Form_Keyboard.SendMessage(System.IntPtr,System.Int32,System.Int32,System.Int32)"> <summary> win32 API给指定窗体发送消息 </summary> <param name="hwnd">窗体句柄</param> <param name="wMsg"></param> <param name="wParam"></param> <param name="lParam"></param> <returns></returns> </member> <member name="F:KeyboardControl.Form_Keyboard.form"> <summary> 父窗体 </summary> </member> <member name="F:KeyboardControl.Form_Keyboard.control"> <summary> 父控件 </summary> </member> <member name="M:KeyboardControl.Form_Keyboard.#ctor"> <summary> 空构造函数，用于可拖动造悬浮框 </summary> </member> <member name="M:KeyboardControl.Form_Keyboard.#ctor(System.Windows.Forms.Form,System.Windows.Forms.Control,System.Drawing.Color)"> <summary> 构造函数 </summary> <param name="_form">父窗体</param> <param name="_control">父控件</param> <param name="KeyColor">键盘颜色</param> </member> <member name="M:KeyboardControl.Form_Keyboard.keyBoard_Click(System.Object,System.EventArgs)"> <summary> 调出键盘事件 </summary> <param name="sender"></param> <param name="e"></param> </member> <member name="M:KeyboardControl.Form_Keyboard.ShowInputPanel"> <summary> //显示屏幕键盘 </summary> <returns></returns> </member> <member name="M:KeyboardControl.Form_Keyboard.Control_Move(System.Object,System.EventArgs)"> <summary> 父控件位置改变事件 </summary> <param name="sender">触发对象</param> <param name="e">参数</param> </member> <member name="M:KeyboardControl.Form_Keyboard.Form_Keyboard_Load(System.Object,System.EventArgs)"> <summary> 键盘窗体登录事件 </summary> <param name="sender">触发对象</param> <param name="e">触发参数</param> </member> <member name="M:KeyboardControl.Form_Keyboard.Form_Keyboard_Close(System.Object,System.EventArgs)"> <summary> 键盘窗体关闭事件 </summary> <param name="sender">触发对象</param> <param name="e">触发参数</param> </member> <member name="M:KeyboardControl.Form_Keyboard.LocationOnClient(System.Windows.Forms.Control)"> <summary> 获得控件相对于屏幕的坐标 </summary> <param name="c">控件</param> <returns>相对于屏幕坐标</returns> </member> <member name="M:KeyboardControl.Form_Keyboard.Form_Keyboard_Shown(System.Object,System.EventArgs)"> <summary> 键盘窗体显示事件 </summary> <param name="sender">触发对象</param> <param name="e">触发参数</param> </member> <member name="M:KeyboardControl.Form_Keyboard.key_MouseDown(System.Object,System.EventArgs)"> <summary> 键盘按下事件 </summary> <param name="sender">触发对象</param> <param name="e"></param> </member> <member name="M:KeyboardControl.Form_Keyboard.key_MouseMove(System.Object,System.Windows.Forms.MouseEventArgs)"> <summary> 键盘拖动事件 </summary> <param name="sender">触发对象</param> <param name="e">触发参数</param> </member> <member name="F:KeyboardControl.Form_Keyboard.components"> <summary> Required designer variable. </summary> </member> <member name="M:KeyboardControl.Form_Keyboard.Dispose(System.Boolean)"> <summary> Clean up any resources being used. </summary> <param name="disposing">true if managed resources should be disposed; otherwise, false.</param> </member> <member name="M:KeyboardControl.Form_Keyboard.InitializeComponent"> <summary> Required method for Designer support - do not modify the contents of this method with the code editor. </summary> </member> <member name="T:KeyboardControl.Properties.Resources"> <summary> 一个强类型的资源类，用于查找本地化的字符串等。 </summary> </member> <member name="P:KeyboardControl.Properties.Resources.ResourceManager"> <summary> 返回此类使用的缓存的 ResourceManager 实例。 </summary> </member> <member name="P:KeyboardControl.Properties.Resources.Culture"> <summary> 重写当前线程的 CurrentUICulture 属性 重写当前线程的 CurrentUICulture 属性。 </summary> </member> </members> </doc> Libs/LSMSInterface.dllBinary files differ
Libs/LSMSInterface.xml
New file @@ -0,0 +1,343 @@ <?xml version="1.0"?> <doc> <assembly> <name>LSMSInterface</name> </assembly> <members> <member name="T:LSMSInterface.LSMSApi"> <summary> LSMS接口模块 </summary> <summary> LSMS接口模块 </summary> </member> <member name="F:LSMSInterface.LSMSApi.clientSocket"> <summary> Socket通讯句柄 </summary> </member> <member name="M:LSMSInterface.LSMSApi.Connect(System.String,System.Int32,System.String@)"> <summary> 连接服务器 </summary> <param name="ServerIP">服务器IP地址</param> <param name="ServerPort">服务器端口号</param> <param name="ErrMsg">错误信息</param> <returns>是否连接成功</returns> </member> <member name="M:LSMSInterface.LSMSApi.DisConnect(System.String@)"> <summary> 断开服务器连接 </summary> <param name="ErrMsg">错误信息</param> <returns>是否断开连接</returns> </member> <member name="M:LSMSInterface.LSMSApi.IsConnect(System.String@)"> <summary> 检查服务器是否已连接 </summary> <param name="ErrMsg">错误信息</param> <returns>是否连接成功</returns> </member> <member name="M:LSMSInterface.LSMSApi.GetAllLine"> <summary> 获取产线列表 </summary> <returns> "ProductLines":"{Line1,Line2,Line3,Line4,Line5….}" </returns> </member> <member name="M:LSMSInterface.LSMSApi.GetAllStationByCurrentLine(System.String,System.String@)"> <summary> 通过产线获取产线下的所有工站 </summary> <param name="productline"> 产线名称 </param> <param name="ErrMsg"></param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.GetAllExceptions"> <summary> 获取异常种类 </summary> <returns> "Exceptions":"{Exception1,Exception2,Exception3….}" </returns> </member> <member name="M:LSMSInterface.LSMSApi.GetAllExceptionByCurrentException(System.String,System.String@)"> <summary> 通过异常种类获取异常code和异常描述 </summary> <param name="exception"> 异常种类 </param> <param name="ErrMsg"></param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.GetAllExceptionsTriggerException(System.String,System.String,System.String,System.String,System.String,System.String@)"> <summary> 触发异常 </summary> <param name="productline"> 产线名称 </param> <param name="workstation"> 工站名称 </param> <param name="exceptioncode"> 异常code </param> <param name="id"> 唯一标志 </param> <param name="checkpeople"> 签到人 </param> <param name="ErrMsg"></param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.GetAllExceptionsSignIn(System.String,System.String,System.String,System.String,System.String,System.String@)"> <summary> 签到 </summary> <param name="productline"> 产线名称 </param> <param name="workstation"> 工站名称 </param> <param name="exceptioncode"> 异常code </param> <param name="id"> 唯一标志 </param> <param name="checkpeople"> 签到人 </param> <param name="ErrMsg"></param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.GetAllExceptionsRelieveException(System.String,System.String,System.String,System.String,System.String,System.String@)"> <summary> 解除异常 </summary> <param name="productline"> 产线名称 </param> <param name="workstation"> 工站名称 </param> <param name="exceptioncode"> 异常code </param> <param name="id"> 唯一标志 </param> <param name="checkpeople"> 签到人 </param> <param name="ErrMsg"></param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.GetAllExceptionsProductionConfirmation(System.String,System.String,System.String,System.String,System.String,System.String@)"> <summary> 生产确认 </summary> <param name="productline"> 产线名称 </param> <param name="workstation"> 工站名称 </param> <param name="exceptioncode"> 异常code </param> <param name="id"> 唯一标志 </param> <param name="checkpeople"> 签到人 </param> <param name="ErrMsg"></param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.GetAllProduct(System.String,System.String@)"> <summary> 通过产线获取产线下所有的产品型号 </summary> <param name="productline"></param> <param name="ErrMsg"></param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.GetRoleNameByUserid(System.String,System.String,System.String,System.String,System.String@)"> <summary> 通过userid获取 </summary> <param name="userid"></param> <param name="productline"></param> <param name="alarmcode"></param> <param name="buttoncode"> 安灯触发索引 </param> <param name="ErrMsg"></param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.GetChildCodeByParentCode(System.String,System.String@)"> <summary> 通过父code获取所有的子code </summary> <param name="Parentcode"></param> <param name="ErrMsg"></param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.GetAllExceptionByCurrentExceptions(System.String,System.String@)"> <summary> 通过异常种类获取异常code和异常描述 </summary> <param name="exception"> 异常种类 </param> <param name="ErrMsg"></param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.GetAllCodeByCurrentLine(System.String,System.String@)"> <summary> 通过该产线获取产线下的所有异常 </summary> <param name="currentlinename"> 当前产线 </param> <param name="ErrMsg"> 错误信息 </param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.GetCurrentCodeLevel(System.String,System.String@)"> <summary> 获取当前code的等级 </summary> <param name="currentcode"> 当前code </param> <param name="ErrMsg"> 报错信息 </param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.SetCountInfoToSQL(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String@)"> <summary> 产量统计 </summary> <param name="productline"> 产线名称 </param> <param name="model"> 产品型号 </param> <param name="shift"> 班次 </param> <param name="workorder"> 工单号 </param> <param name="project"> 项目 </param> <param name="okcount"> 良品数 </param> <param name="ngcount">不良品数</param> <param name="time"> 日期(格式为YYYY-MM-DD) </param> <param name="ErrMsg"></param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.SetPeopleHourToSQL(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String@)"> <summary> 人员工时统计 </summary> <param name="productline"> 产线名称 </param> <param name="model"> 产品型号 </param> <param name="shift"> 班次 </param> <param name="actualnumber"> 实到人数 </param> <param name="absenteeism"> 缺勤人数 </param> <param name="workhours"> 工作时间 </param> <param name="overtime"> 加班时间 </param> <param name="losstime"> 损失时间 </param> <param name="ErrMsg"></param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.SetExeptionLossToSQL(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String@)"> <summary> 异常损失统计 </summary> <param name="productline"> 产线名称 </param> <param name="model"> 产品型号 </param> <param name="shift"> 班次 </param> <param name="actualnumber"> 异常损失数量 </param> <param name="abnormalcode"> 异常损失代码 </param> <param name="causeOfloss"> 损失原因 </param> <param name="time"> 时间(格式为YYYY-MM-DD) </param> <param name="workstationname"> 工站名称 </param> <param name="andoid"> andoid </param> <param name="ErrMsg"></param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.SetProductionEfficiencyToSQL(System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String,System.String@)"> <summary> 生产效率统计 </summary> <param name="productline"> 产线名称 </param> <param name="model"> 产品型号 </param> <param name="shift"> 班次 </param> <param name="totaltime"> 总工作时间 </param> <param name="scheduleddowntime"> 计划停机时间 </param> <param name="usetime"> 设备有效利用时间 </param> <param name="unscheduleddowntime"> 非计划停机时间 </param> <param name="optime"> 操作时间 </param> <param name="okcount"> 产品ok数 </param> <param name="ngcount"> 产品ng数 </param> <param name="cttime"> ct时间 </param> <param name="ErrMsg"></param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.Test(System.String[0:,0:],System.String@)"> <summary> LV测试程序 </summary> <param name="info"> 测试信息 </param> <param name="ErrMsg"> 报错信息 </param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.GetNewPackage(System.String,System.String,System.String@)"> <summary> 获取包装箱条码 </summary> <param name="productline"> 产线 </param> <param name="model"> 产品型号 </param> <param name="ErrMsg"></param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.BookProduct(System.String,System.String,System.String,System.String,System.String@)"> <summary> 绑定产品到包装箱内 </summary> <param name="serialnum"> 成品条码 </param> <param name="packagenum"> 包装箱条码 </param> <param name="model"> 产品型号 </param> <param name="line"> 产线名称 </param> <param name="ErrMsg"></param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.UnbookPackage(System.String,System.String,System.String@)"> <summary> 补包 </summary> <param name="serialnum"> 成品条码 </param> <param name="packagenum"> 包装箱条码 </param> <param name="ErrMsg"></param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.Tiltingpackage(System.String,System.String,System.String,System.String,System.String@)"> <summary> 翻包 </summary> <param name="serialnum"> 成品条码 </param> <param name="packagenum"> 包装箱条码 </param> <param name="model"> 产品型号 </param> <param name="line"> 产线名称 </param> <param name="ErrMsg"></param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.SendSocketMessage(System.String)"> <summary> 发送Socket命令 </summary> <param name="Cmd"> 处理后要发的字符串 </param> <returns>返回值为接收到的字符串信息</returns> </member> <member name="M:LSMSInterface.LSMSApi.ConvertUnicodeToUtf8(System.String)"> <summary> 把unicode转化为utf-8 </summary> <param name="unicode"></param> <returns></returns> </member> <member name="M:LSMSInterface.LSMSApi.SendSocketMessages(System.String)"> <summary> 发送Socket命令 </summary> <param name="Cmd"> 处理后要发的字符串 </param> <returns>返回值为接收到的字符串信息</returns> </member> <member name="M:LSMSInterface.LSMSApi.Phonenumber(System.String[0:,0:],System.String@)"> <summary> 异常解除 </summary> <param name="info"> {"ProductLine:""Line1","WorkStation":"WorkStation","Excetpion":"Excetpion1","ExceptionCode":"ExceptionCode"} </param> <param name="ErrMsg"> 报错信息 </param> <returns> "ExceptionCodes":"{ExceptionCode1,ExceptionCode2,ExceptionCode3….}" </returns> </member> <member name="T:LSMSInterface.Commond"> <summary> 公用接口类 </summary> </member> <member name="F:LSMSInterface.Commond.Cmd_STX"> <summary> 消息起始符 </summary> </member> <member name="F:LSMSInterface.Commond.Cmd_End"> <summary> 消息结束符 </summary> </member> <member name="M:LSMSInterface.Commond.BuildCmd(System.String,System.Collections.Generic.Dictionary{System.String,System.Object})"> <summary> 生成命令 </summary> <param name="Code">代码</param> <param name="Parameters">输入参数</param> <returns>生成的消息命令</returns> </member> <member name="M:LSMSInterface.Commond.BuildCmds(System.String,System.Collections.Generic.Dictionary{System.String,System.Object})"> <summary> </summary> <param name="Code"></param> <param name="Parameters"></param> <returns></returns> </member> </members> </doc> Libs/LTMES.dllBinary files differ
Libs/LTSCADA.dllBinary files differ
Libs/LTSCADAApi.dllBinary files differ
Libs/LTSqlHelper.dllBinary files differ
Libs/LTSqlHelper.dll.config
New file @@ -0,0 +1,12 @@ <?xml version="1.0" encoding="utf-8"?> <configuration> <configSections> <section name="entityFramework" type="System.Data.Entity.Internal.ConfigFile.EntityFrameworkSection, EntityFramework, Version=6.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" requirePermission="false" /> </configSections> <entityFramework> <providers> <provider invariantName="System.Data.SqlClient" type="System.Data.Entity.SqlServer.SqlProviderServices, EntityFramework.SqlServer" /> </providers> </entityFramework> </configuration> Libs/LV2CSharp.dllBinary files differ
Libs/LV2CSharp.xml
New file @@ -0,0 +1,108 @@ <?xml version="1.0"?> <doc> <assembly> <name>LV2CSharp</name> </assembly> <members> <member name="M:LV2CSharp.LV2CSharp.IsWindow(System.IntPtr)"> <summary> 判断是否是窗体 </summary> <param name="hWnd">句柄</param> <returns></returns> </member> <member name="M:LV2CSharp.LV2CSharp.IsWindowVisible(System.IntPtr)"> <summary> 判断是否可见 </summary> <param name="hWnd"></param> <returns></returns> </member> <member name="M:LV2CSharp.LV2CSharp.IsWindowEnabled(System.IntPtr)"> <summary> 判断是否 </summary> <param name="hWnd"></param> <returns></returns> </member> <member name="F:LV2CSharp.LV2CSharp.WS_SYSMENU"> <summary> 系统菜单 </summary> </member> <member name="F:LV2CSharp.LV2CSharp.WS_THICKFRAME"> <summary> 设置调整窗口大小的厚的结构的窗口。 </summary> </member> <member name="F:LV2CSharp.LV2CSharp.WS_SIZEBOX"> <summary> 创建一个可调边框的窗口，与 WS_THICKFRAME 风格相同 </summary> </member> <member name="F:LV2CSharp.LV2CSharp.viPath"> <summary> VI路径 </summary> </member> <member name="F:LV2CSharp.LV2CSharp.viName"> <summary> VI名称 </summary> </member> <member name="F:LV2CSharp.LV2CSharp.viWindowHandle"> <summary> LV窗口句柄 </summary> </member> <member name="M:LV2CSharp.LV2CSharp.#ctor(System.String)"> <summary> 构造函数 </summary> <param name="VIPath"></param> </member> <member name="M:LV2CSharp.LV2CSharp.UpdateWindowVI"> <summary> 刷新界面 </summary> <param name="VIPath"></param> </member> <member name="P:LV2CSharp.LV2CSharp.VIPath"> <summary> VI路径 </summary> </member> <member name="P:LV2CSharp.LV2CSharp.VIName"> <summary> VI名称 </summary> </member> <member name="P:LV2CSharp.LV2CSharp.VIWindowHandle"> <summary> LV窗体句柄 </summary> </member> <member name="M:LV2CSharp.LV2CSharp.AddVI2Panel(System.Windows.Forms.Panel)"> <summary> 将打开的VI加载到WinForm的面板中 </summary> <param name="CSharpPanelHandle">WinForm面板句柄</param> </member> <member name="M:LV2CSharp.LV2CSharp.ResizeControl(System.Windows.Forms.Panel)"> <summary> 缩放控件 </summary> <param name="CSharpPanel">显示的父面板</param> </member> <member name="M:LV2CSharp.LV2CSharp.CloseVI"> <summary> 关闭正在执行的VI </summary> </member> <member name="M:LV2CSharp.LV2CSharp.OpenVI"> <summary> 打开VI </summary> </member> </members> </doc> Libs/LampHelper.dllBinary files differ
Libs/MenuHelper.dllBinary files differ
Libs/Microsoft.Practices.Unity.Configuration.dllBinary files differ
Libs/Microsoft.Practices.Unity.RegistrationByConvention.dllBinary files differ
Libs/Microsoft.Practices.Unity.dllBinary files differ
Libs/NPOI.OOXML.dllBinary files differ
Libs/NPOI.OpenXml4Net.dllBinary files differ
Libs/NPOI.OpenXmlFormats.dllBinary files differ
Libs/NPOI.dllBinary files differ
Libs/NationalInstruments.TestStand.Interop.API.dllBinary files differ
Libs/NationalInstruments.TestStand.Interop.API.xml
New file Diff too large Libs/NationalInstruments.TestStand.Interop.AdapterAPI.dllBinary files differ
Libs/NationalInstruments.TestStand.Interop.AdapterAPI.xml
New file Diff too large Libs/NationalInstruments.TestStand.Interop.SequenceAnalyzer.dllBinary files differ
Libs/NationalInstruments.TestStand.Interop.UI.AxControls.dllBinary files differ
Libs/NationalInstruments.TestStand.Interop.UI.Support.dllBinary files differ
Libs/NationalInstruments.TestStand.Interop.UI.Support.xml
New file @@ -0,0 +1,1277 @@ <?xml version="1.0"?><doc><members> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.MRUFiles"> <summary>A collection of the most recently used (MRU) files. Each item in the collection is a filename.</summary> <seealso cref=""ApplicationMgr.MRUFiles"ApplicationMgr_MRUFiles_P.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.MRUFiles.Item(System.Int32)"> <summary>Returns a reference to an item at the specified index in the collection.</summary> <returns>Filename of the most recently used file at the specified index.</returns> <param name="itemIndex">Specifies the index of the item to retrieve.</param> <seealso cref="MRUFiles.Count" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.MRUFiles.Count"> <summary>Returns the number of items in the collection.</summary> <seealso cref="MRUFiles.Max" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.MRUFiles.Max"> <summary>Specifies the maximum size of the collection.</summary> <remarks>The MRUFiles collection cannot become larger than the size this property specifies. When the collection reaches the maximum size, new items you add to the beginning of the collection replace the oldest items at the end of the collection. The Application Manager control persists the value this property specifies.</remarks> <seealso cref=""Application Manager"ApplicationMgr.htm" /> <seealso cref="MRUFiles.Add" /> <seealso cref="MRUFiles.Count" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.MRUFiles.Clear"> <summary>Removes all items from the collection.</summary> <seealso cref="MRUFiles.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.MRUFiles.Remove(System.String)"> <summary>Removes the specified item from this collection, if it exists.</summary> <returns>Returns <c>True</c> when the item is removed from the collection. Returns <c>False</c> when the item is not found.</returns> <param name="fileNameVal">Specifies the filename to remove from the collection.</param> <seealso cref="MRUFiles.Add" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.MRUFiles.GetDisplayName(System.Int32,System.Int32)"> <summary>Returns a string that you can display in a menu used for opening the most recently used files.</summary> <returns>The display name of the filename at the index.</returns> <param name="itemIndex">Specifies the index of an item.</param> <param name="maxWidth">Specifies the maximum width, in pixels, of the display name string. The width of the string is measured using the system menu font.</param> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.MRUFiles.Add(System.String)"> <summary>Adds a filename to the beginning of the collection.</summary> <param name="fileNameVal">Specifies the filename to add to the collection.</param> <seealso cref="MRUFiles.Max" /> <seealso cref="MRUFiles.Remove" /> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.SelectedSteps"> <summary>A collection of selected steps. You can obtain a reference to the collection from the SequenceFileViewMgr.SelectedSteps and ExecutionViewMgr.SelectedSteps properties.</summary> <seealso cref=""ExecutionViewMgr.SelectedSteps"ExecutionViewMgr_SelectedSteps_P.htm" /> <seealso cref=""SequenceFileViewMgr.SelectedSteps"SequenceFileViewMgr_SelectedSteps_P.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SelectedSteps.Item(System.Int32)"> <summary>Returns a reference to an item at the specified index in the collection.</summary> <returns>The step at the specified index in the collection. </returns> <param name="itemIndex">Specifies the index of the item to retrieve.</param> <seealso cref=""Step"javascript:APILink('/RefTopics/Step.htm')" /> <seealso cref="SelectedSteps.Count" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SelectedSteps.Count"> <summary>Returns the number of items in the collection.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SelectedSteps.Clear"> <summary>Removes all items from the collection.</summary> <seealso cref="SelectedSteps.AddStep" /> <seealso cref="SelectedSteps.AddStepIndex" /> <seealso cref="SelectedSteps.AddSteps" /> <seealso cref="SelectedSteps.EndSelected" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SelectedSteps.AddStepIndex(System.Int32)"> <summary>Adds a step to the collection.</summary> <remarks>When the SequenceFileViewMgr.StepGroupMode property is <c>StepGroupMode_AllGroups</c>, call the SelectedSteps.AddStep method instead of this method.</remarks> <param name="stepIndex">Specifies the index in the current step group of the step to add.</param> <seealso cref="SelectedSteps.AddStep" /> <seealso cref="SelectedSteps.EndSelected" /> <seealso cref="SequenceFileViewMgr.StepGroup" /> <seealso cref="SequenceFileViewMgr.StepGroupMode" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SelectedSteps.EndSelected"> <summary>Specifies whether the End step is selected.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SelectedSteps.GetStepIndex(System.Int32)"> <summary>Retrieves the step index within a step group of a selected step.</summary> <returns>The step index of the step in the collection.</returns> <param name="nthSelectedStep">Specifies the index of a step in the collection.</param> <seealso cref="SelectedSteps.EndSelected" /> <seealso cref="SelectedSteps.GetStepGroup" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SelectedSteps.GetStepGroup(System.Int32)"> <summary>Returns the step group of the specified step in the collection.</summary> <param name="nthSelectedStep">Specifies the index of a step in the collection.</param> <seealso cref="SelectedSteps.GetStepIndex" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SelectedSteps.AddStep(NationalInstruments.TestStand.Interop.API.Step)"> <summary>Adds a step to the collection.</summary> <param name="val">Specifies the step to add.</param> <seealso cref="SelectedSteps.AddStepIndex" /> <seealso cref="SelectedSteps.AddSteps" /> <seealso cref="SelectedSteps.Clear" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SelectedSteps.AddSteps(System.Object[])"> <summary>Adds an array of steps to the collection.</summary> <param name="val">Specifies the steps to add.</param> <seealso cref="SelectedSteps.AddStepIndex" /> <seealso cref="SelectedSteps.AddSteps" /> <seealso cref="SelectedSteps.Clear" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SelectedSteps.SelectionFlags"> <summary>When the SequenceFileViewMgr.StepGroupMode property is <c>StepGroupMode_AllGroups</c>, this property indicates whether the selection includes the step group start and end markers. The property also indicates whether each step group is expanded or collapsed. The value of this property is a bitwise-OR combination of the SelectionFlags constants.</summary> <seealso cref="SelectionFlags" /> <seealso cref="SequenceFileViewMgr.StepGroupMode" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SelectedSteps.BeginUpdate"> <summary>Call this method before making multiple changes to the SelectedSteps collection. When you finish changing the collection, call the SelectedSteps.EndUpdate method to update the TestStand User Interface (UI) Controls according to the changes.</summary> <remarks>Use this method to minimize redrawing in the TestStand UI Controls when you programmatically change the selection.</remarks> <seealso cref="SelectedSteps.EndUpdate" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SelectedSteps.EndUpdate"> <summary>Updates the user interface according to all changes to the SelectedSteps collection you made after the previous call to the SelectedSteps.BeginUpdate method.</summary> <seealso cref="SelectedSteps.BeginUpdate" /> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.Strings"> <summary>A collection of strings. You can obtain a reference to the collection from the ApplicationMgr.CommandLineArguments property, the ExpressionEdit.GetValidEvaluationTypes, and ExpressionEdit.SetValidEvaluationTypes methods, and the ApplicationMgr.ProcessUserCommandLineArguments event.</summary> <seealso cref=""ApplicationMgr.CommandLineArguments"ApplicationMgr_CommandLineArguments_P.htm" /> <seealso cref=""ApplicationMgr.ProcessUserCommandLineArguments"ApplicationMgr_ProcessUserCommandLineArguments_E.htm" /> <seealso cref=""EvaluationTypes.AllowedArrayRepresentations"javascript:APILink('/RefTopics/EvaluationTypes_AllowedArrayRepresentations_P.htm')" /> <seealso cref=""EvaluationTypes.AllowedRepresentations"javascript:APILink('/RefTopics/EvaluationTypes_AllowedRepresentations_P.htm')" /> <seealso cref=""ExpressionEdit.GetValidEvaluationTypes"ExpressionEdit_GetValidEvaluationTypes_M.htm" /> <seealso cref=""ExpressionEdit.SetValidEvaluationTypes"ExpressionEdit_SetValidEvaluationTypes_M.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.Strings.Item(System.Int32)"> <summary>Returns a reference to an item at the specified index in the collection.</summary> <returns>The item at the specified index.</returns> <param name="itemIndex">Specifies the index of the item to retrieve.</param> <seealso cref="Strings.Count" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.Strings.Count"> <summary>Returns the number of items in the collection.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.Strings.Clear"> <summary>Removes all items from the collection.</summary> <seealso cref="Strings.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.Strings.Add(System.String)"> <summary>Adds a string to the end of the collection.</summary> <param name="val">Specifies the string to be added.</param> <seealso cref="Strings.Insert" /> <seealso cref="Strings.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.Strings.Insert(System.Int32,System.String)"> <summary>Adds a new item to the collection at the specified index.</summary> <param name="itemIndex">Specifies the index of the item to insert.</param> <param name="val">Specifies the string to be added.</param> <seealso cref="Strings.Add" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.Strings.Remove(System.Int32)"> <summary>Removes the specified item from this collection, if it exists.</summary> <param name="itemIndex">Specifies the index of the item to remove.</param> <seealso cref="Strings.Add" /> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.NumericConnection"> <summary>Represents a connection to a numeric source.</summary> <seealso cref="NumericConnections" /> <seealso cref=""NumericSources"NumericSources.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.NumericConnection.Source"> <summary>NumericSource of the connection.</summary> <seealso cref="ExecutionViewMgr" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.NumericConnection.Refresh"> <summary>Refreshes the connected control with the current value of the NumericSource.</summary> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.NumericConnections"> <summary>A collection of NumericConnection objects.</summary> <seealso cref=""ExecutionViewMgr.ConnectNumeric"ExecutionViewMgr_ConnectNumeric_M.htm" /> <seealso cref="NumericConnection" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.NumericConnections.Item(System.Int32)"> <summary>Returns a reference to an item at the specified index in the collection.</summary> <returns>Item located at the specified index.</returns> <param name="itemIndex">Specifies the index of the item to retrieve.</param> <seealso cref="NumericConnection" /> <seealso cref="NumericConnections.Count" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.NumericConnections.Count"> <summary>Returns the number of items in the collection.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.NumericConnections.Add(System.Object)"> <summary>Creates and adds a new NumericConnection to the collection.</summary> <returns>New NumericConnection.</returns> <param name="uiObj">Specifies the user interface object to connect.</param> <seealso cref=""ExecutionViewMgr.ConnectNumeric"ExecutionViewMgr_ConnectNumeric_M.htm" /> <seealso cref="NumericConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.NumericConnections.Remove(System.Object)"> <summary>Removes the specified item from this collection, if it exists.</summary> <returns>Returns <c>True</c> when the NumericConnection is removed. Returns <c>False</c> when the NumericConnection is not found.</returns> <param name="uiObj">Specifies the user interface object to disconnect.</param> <seealso cref="NumericConnections.Add" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.NumericConnections.Clear"> <summary>Removes all items from the collection.</summary> <seealso cref="NumericConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.NumericConnections.FromControl(System.Object)"> <summary>Returns the NumericConnection connected to the uiObj parameter.</summary> <returns>NumericConnection connected to the uiObj parameter. When no NumericConnection exists for this control, this method returns <c>NULL</c>.</returns> <param name="uiObj">Specifies the connected user interface object.</param> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.ImageConnection"> <summary>Represents a connection to an image source.</summary> <seealso cref="ImageConnections" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ImageConnection.Source"> <summary>Specifies the type of ImageConnection to obtain an image from.</summary> <seealso cref="ExecutionViewMgr" /> <seealso cref="SequenceFileViewMgr" /> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.ImageConnections"> <summary>A collection of ImageConnection objects.</summary> <seealso cref=""ExecutionViewMgr.ConnectImage"ExecutionViewMgr_ConnectImage_M.htm" /> <seealso cref="ImageConnection" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ImageConnections.Item(System.Int32)"> <summary>Returns a reference to an item at the specified index in the collection.</summary> <returns>Item located at the specified index.</returns> <param name="itemIndex">Specifies the index of the item to retrieve.</param> <seealso cref="ImageConnection" /> <seealso cref="ImageConnections.Count" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ImageConnections.Count"> <summary>Returns the number of items in the collection.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.ImageConnections.Add(System.Object)"> <summary>Creates and adds a new ImageConnection to the collection.</summary> <returns>New ImageConnection.</returns> <param name="uiObj">Specifies the user interface object to connect.</param> <seealso cref=""ExecutionViewMgr.ConnectImage"ExecutionViewMgr_ConnectImage_M.htm" /> <seealso cref="ImageConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.ImageConnections.Remove(System.Object)"> <summary>Removes the specified item from this collection, if it exists.</summary> <returns>Returns <c>True</c> when the ImageConnection is removed. Returns <c>False</c> when the ImageConnection is not found.</returns> <param name="uiObj">Specifies the user interface object to disconnect.</param> <seealso cref="ImageConnections.Add" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.ImageConnections.Clear"> <summary>Removes all items from the collection.</summary> <seealso cref="ImageConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.ImageConnections.FromControl(System.Object)"> <summary>Returns the ImageConnection connected to the uiObj parameter.</summary> <returns>ImageConnection connected to the uiObj parameter. When no ImageConnection exists for this control, this method returns <c>NULL</c>.</returns> <param name="uiObj">Specifies the connected user interface object.</param> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.CaptionConnection"> <summary>Represents a connection to a caption source.</summary> <seealso cref="CaptionConnections" /> <seealso cref=""CaptionSources"CaptionSources.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.CaptionConnection.Source"> <summary>Specifies the type of caption source to obtain the text from.</summary> <seealso cref=""CaptionSources"CaptionSources.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.CaptionConnection.LongName"> <summary>For certain caption sources, this property specifies whether to return a long or short version of the caption text. Refer to the CaptionSources enumeration for more information about determining when this option affects the text and for more information about the long and short versions of the text.</summary> <seealso cref=""CaptionSources"CaptionSources.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.CaptionConnection.FormatExpression"> <summary>Specifies a format expression to evaluate when generating the caption text.</summary> <remarks>For CaptionSource_MacroExpression, specify a format expression that evaluates to a string value that contains macros that specify other caption sources. For all other caption sources, specify a format expression that evaluates to a string value that contains the characters <c>%1</c>. This method replaces the <c>%1</c> characters with the text from the caption source. Pass an empty string to use the default format for the caption source.</remarks> <seealso cref=""CaptionSource_MacroExpression"CaptionSources.htm" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.CaptionConnection.Refresh"> <summary>Refreshes the user interface control connected to this CaptionConnection with the most recent text from the CaptionSource.</summary> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.CaptionConnections"> <summary>A collection of CaptionConnection objects.</summary> <seealso cref="CaptionConnection" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.CaptionConnections.Item(System.Int32)"> <summary>Returns a reference to an item at the specified index in the collection.</summary> <returns>Item located at the specified index.</returns> <param name="itemIndex">Specifies the index of the item to retrieve.</param> <seealso cref="CaptionConnection" /> <seealso cref="CaptionConnections.Count" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.CaptionConnections.Count"> <summary>Returns the number of items in the collection.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.CaptionConnections.Add(System.Object)"> <summary>Creates and adds a new CaptionConnection to the collection.</summary> <returns>New CaptionConnection.</returns> <param name="uiObj">Specifies the user interface object to connect.</param> <seealso cref=""ApplicationMgr.ConnectCaption"ApplicationMgr_ConnectCaption_M.htm" /> <seealso cref="CaptionConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.CaptionConnections.Remove(System.Object)"> <summary>Removes the specified item from this collection, if it exists.</summary> <returns>Returns <c>True</c> when the CaptionConnection is removed. Returns <c>False</c> when the CaptionConnection is not found.</returns> <param name="uiObj">Specifies the user interface object to disconnect.</param> <seealso cref="CaptionConnections.Add" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.CaptionConnections.Clear"> <summary>Removes all items from the collection.</summary> <seealso cref="CaptionConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.CaptionConnections.FromControl(System.Object)"> <summary>Returns the CaptionConnection connected to the uiObj parameter.</summary> <returns>CaptionConnection connected to the uiObj parameter. When no CaptionConnection exists for this control, this method returns <c>NULL</c>.</returns> <param name="uiObj">Specifies the connected user interface object.</param> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.CommandConnection"> <summary>Represents a connection to a CommandKind.</summary> <seealso cref=""CommandConnectionOptions"CommandConnectionOptions.htm" /> <seealso cref="CommandConnections" /> <seealso cref=""CommandKinds"CommandKinds.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.CommandConnection.Kind"> <summary>Specifies the type of Command to which this CommandConnection connects.</summary> <seealso cref=""CommandKinds"CommandKinds.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.CommandConnection.Index"> <summary>Specifies which command in the set of commands to use.</summary> <remarks><para>Note: Use this on sets of commands. Refer to the CommandKinds enumeration for more information about supported command sets.</para></remarks> <seealso cref=""CommandKinds"CommandKinds.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.CommandConnection.Options"> <summary>Specifies the behavior of the CommandConnection.</summary> <remarks>The value of this property is a bitwise-OR combination of the CommandConnectionOptions constants.</remarks> <seealso cref=""CommandConnectionOptions"CommandConnectionOptions.htm" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.CommandConnection.Refresh"> <summary>Refreshes the state of the user interface control connected to the CommandConnection.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.CommandConnection.FreezeRefresh(System.Boolean)"> <summary>Specifies to freeze the CommandConnection when setting the properties to avoid flicker on the connected control.</summary> <remarks><c>FreezeRefresh</c> calls must be balanced. For example, each time you call this method with a value of <c>True</c>, you must also call it with a value of <c>False</c>.</remarks> <param name="frz">When this parameter is <c>True</c>, the CommandConnection does not refresh the control. When this parameter is <c>False</c>, the CommandConnection refreshes the control.</param> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.CommandConnections"> <summary>A collection of CommandConnection objects.</summary> <seealso cref="CommandConnection" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.CommandConnections.Item(System.Int32)"> <summary>Returns a reference to an item at the specified index in the collection.</summary> <returns>Item located at the specified index.</returns> <param name="itemIndex">Specifies the index of the item to retrieve.</param> <seealso cref="CommandConnection" /> <seealso cref="CommandConnections.Count" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.CommandConnections.Count"> <summary>Returns the number of items in the collection.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.CommandConnections.Add(System.Object)"> <summary>Creates and adds a new CommandConnection to the collection.</summary> <returns>New CommandConnection.</returns> <param name="uiObj">Specifies the user interface object to connect.</param> <seealso cref=""ApplicationMgr.ConnectCommand"ApplicationMgr_ConnectCommand_M.htm" /> <seealso cref="CommandConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.CommandConnections.Remove(System.Object)"> <summary>Removes the specified item from this collection, if it exists.</summary> <returns>Returns <c>True</c> when the CommandConnection is removed. Returns <c>False</c> when the CommandConnection is not found.</returns> <param name="uiObj">Specifies the user interface object to disconnect.</param> <seealso cref="CommandConnections.Add" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.CommandConnections.Clear"> <summary>Removes all items from the collection.</summary> <seealso cref="CommandConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.CommandConnections.FromControl(System.Object)"> <summary>Returns the CommandConnection connected to the uiObj parameter.</summary> <returns>CommandConnection connected to the uiObj parameter. When no CommandConnection exists for this control, this method returns <c>NULL</c>.</returns> <param name="uiObj">Specifies the connected user interface object.</param> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.SequenceViewConnection"> <summary>Represents a connection from a SequenceFileView Manager control to a SequenceView control. The SequenceView control shows the contents of the current sequence in the SequenceFileView Manager control. Use the SequenceFileViewMgr.Connections property to obtain a collection of SequenceViewConnection objects.</summary> <seealso cref=""SequenceFileView Manager"SequenceFileViewMgr.htm" /> <seealso cref=""SequenceFileViewMgr.Connections"SequenceFileViewMgr_Connections_P.htm" /> <seealso cref=""SequenceView"SequenceView.htm" /> <seealso cref="SequenceViewConnections" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SequenceViewConnection.UIControl"> <summary>Returns the user interface control the connection connects to a SequenceFileView Manager control.</summary> <seealso cref=""SequenceFileView Manager"SequenceFileViewMgr.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SequenceViewConnection.DoubleClickEditsStepProperties"> <summary>Specifies whether the connected SequenceView control displays the Step Properties dialog box when editing is enabled and the user double-clicks a step. This property defaults to <c>True</c>. Set the property to <c>False</c> if you implement an alternate behavior for double-clicking a step in a sequence file.</summary> <seealso cref=""SequenceView"SequenceView.htm" /> <seealso cref=""Step Properties dialog box"javascript:RefLink('/InfoTopics/DB_Step_Prop.htm')" /> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.SequenceViewConnections"> <summary>A collection of SequenceViewConnection objects you obtain by calling the SequenceFileViewMgr.Connections property.</summary> <seealso cref=""SequenceFileViewMgr.ConnectSequenceView"SequenceFileViewMgr_ConnectSequenceView_M.htm" /> <seealso cref=""SequenceFileViewMgr.Connections"SequenceFileViewMgr_Connections_P.htm" /> <seealso cref="SequenceViewConnection" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SequenceViewConnections.Item(System.Int32)"> <summary>Returns a reference to an item at the specified index in the collection.</summary> <returns>Item located at the specified index.</returns> <param name="itemIndex">Specifies the index of the item to retrieve.</param> <seealso cref="SequenceViewConnection" /> <seealso cref="SequenceViewConnections.Count" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SequenceViewConnections.Count"> <summary>Returns the number of items in the collection.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SequenceViewConnections.Add(System.Object)"> <summary>Creates and adds a new SequenceViewConnection to the collection.</summary> <returns>New SequenceViewConnection.</returns> <param name="uiObj">Specifies the user interface object to connect.</param> <seealso cref=""SequenceFileViewMgr.ConnectSequenceView"SequenceFileViewMgr_ConnectSequenceView_M.htm" /> <seealso cref="SequenceViewConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SequenceViewConnections.Remove(System.Object)"> <summary>Removes the specified item from this collection, if it exists.</summary> <returns>Returns <c>True</c> when the SequenceViewConnection is removed. Returns <c>False</c> when the SequenceViewConnection is not found.</returns> <param name="uiObj">Specifies the user interface object to disconnect.</param> <seealso cref="SequenceViewConnections.Add" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SequenceViewConnections.Clear"> <summary>Removes all items from the collection.</summary> <seealso cref="SequenceViewConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SequenceViewConnections.FromControl(System.Object)"> <summary>Returns the SequenceViewConnection connected to the uiObj parameter.</summary> <returns>SequenceViewConnection connected to the uiObj parameter. When no SequenceViewConnection exists for this control, this method returns <c>NULL</c>.</returns> <param name="uiObj">Specifies the connected user interface object.</param> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.SequenceFileListConnection"> <summary>Represents a connection from a SequenceFileView Manager control to a control that displays a list of open sequence files. Use the connected control to select a sequence file to open in the SequenceFileView Manager control from the list of sequence files.</summary> <seealso cref="SequenceFileListConnections" /> <seealso cref="
"SequenceFileView Manager"SequenceFileViewMgr.htm" /> <seealso cref="
"SequenceFileViewMgr.ConnectSequenceFileList"SequenceFileViewMgr_ConnectSequenceFileList_M.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SequenceFileListConnection.ShowFullPath"> <summary>When this property is <c>True</c>, the connected control displays the full path for all sequence files. Otherwise, the connected control displays only filenames.</summary> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SequenceFileListConnection.ShowCommentInTip"> <summary>Specifies whether the item tooltip includes the sequence file comment in controls you connect to display the list of loaded sequence files.</summary> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.SequenceFileListConnections"> <summary>A collection of SequenceFileListConnection objects.</summary> <seealso cref="SequenceFileListConnection" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SequenceFileListConnections.Item(System.Int32)"> <summary>Returns a reference to an item at the specified index in the collection.</summary> <returns>Item located at the specified index.</returns> <param name="itemIndex">Specifies the index of the item to retrieve.</param> <seealso cref="SequenceFileListConnection" /> <seealso cref="SequenceFileListConnections.Count" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SequenceFileListConnections.Count"> <summary>Returns the number of items in the collection.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SequenceFileListConnections.Add(System.Object)"> <summary>Creates and adds a new SequenceFileListConnection to the collection.</summary> <returns>New SequenceFileListConnection.</returns> <param name="uiObj">Specifies the user interface object to connect.</param> <seealso cref="SequenceFileListConnections.Remove" /> <seealso cref=""SequenceFileViewMgr.ConnectSequenceFileList"SequenceFileViewMgr_ConnectSequenceFileList_M.htm" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SequenceFileListConnections.Remove(System.Object)"> <summary>Removes the specified item from this collection, if it exists.</summary> <returns>Returns <c>True</c> when the SequenceFileListConnection is removed. Returns <c>False</c> when the SequenceFileListConnection is not found.</returns> <param name="uiObj">Specifies the user interface object to disconnect.</param> <seealso cref="SequenceFileListConnections.Add" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SequenceFileListConnections.Clear"> <summary>Removes all items from the collection.</summary> <seealso cref="SequenceFileListConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SequenceFileListConnections.FromControl(System.Object)"> <summary>Returns the SequenceFileListConnection connected to the uiObj parameter.</summary> <returns>SequenceFileListConnection connected to the uiObj parameter. When no SequenceFileListConnection exists for this control, this method returns <c>NULL</c>.</returns> <param name="uiObj">Specifies the connected user interface object.</param> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.SequenceListConnection"> <summary>Represents a connection from a SequenceFileView Manager control to a control that displays a list of sequences for the current sequence file. Use the connected control to select the sequence to display.</summary> <seealso cref="SequenceListConnections" /> <seealso cref=""SequenceFileView Manager"SequenceFileViewMgr.htm" /> <seealso cref=""SequenceFileViewMgr.ConnectSequenceList"SequenceFileViewMgr_ConnectSequenceList_M.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SequenceListConnection.UIControl"> <summary>Returns the user interface control the connection connects to a SequenceFileView Manager control.</summary> <seealso cref=""SequenceFileView Manager"SequenceFileViewMgr.htm" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SequenceListConnection.GetColumnVisible(NationalInstruments.TestStand.Interop.UI.Support.SeqListConnectionColumns)"> <summary>Returns a Boolean value that indicates whether the column is visible.</summary> <param name="column">Specifies the column to select.</param> <seealso cref="SequenceListConnection.SetColumnVisible" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SequenceListConnection.SetColumnVisible(NationalInstruments.TestStand.Interop.UI.Support.SeqListConnectionColumns,System.Boolean)"> <summary>Specifies whether the column is visible.</summary> <remarks>You cannot hide the <c>SeqListConnectionColumn_Label</c> column.</remarks> <param name="column">Specifies the column to select.</param> <param name="val">Pass <c>False</c> to hide the column. Otherwise, the column is visible. </param> <seealso cref="SequenceListConnection.GetColumnVisible" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SequenceListConnection.ShowCommentInTip"> <summary>Specifies whether the item tooltip includes the sequence comment in controls you connect to display the list of sequences in the selected sequence file.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SequenceListConnection.GetColumnIndex(NationalInstruments.TestStand.Interop.UI.Support.SeqListConnectionColumns)"> <summary>When the specified column is visible, this method returns the index of the column within the ListBoxColumns collection. Otherwise, this method returns <c>-1</c>.</summary> <remarks>Use this index in the ListBoxColumns.Item property to return the ListBoxColumn for a specific column.</remarks> <param name="column">Specifies the column to select.</param> <seealso cref=""ListBox.ColumnSet"ListBox_ColumnSet_P.htm" /> <seealso cref=""ListBoxColumn"ListBoxColumn.htm" /> <seealso cref=""ListBoxColumns"ListBoxColumns.htm" /> <seealso cref=""ListBoxColumns.Item"ListBoxColumns_Item_P.htm" /> <seealso cref="SequenceListConnection.GetColumnVisible" /> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.SequenceListConnections"> <summary>A collection of SequenceListConnection objects.</summary> <seealso cref=""SequenceFileViewMgr.ConnectSequenceList"SequenceFileViewMgr_ConnectSequenceList_M.htm" /> <seealso cref="SequenceListConnection" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SequenceListConnections.Item(System.Int32)"> <summary>Returns a reference to an item at the specified index in the collection.</summary> <returns>Item located at the specified index.</returns> <param name="itemIndex">Specifies the index of the item to retrieve.</param> <seealso cref="SequenceListConnection" /> <seealso cref="SequenceListConnections.Count" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SequenceListConnections.Count"> <summary>Returns the number of items in the collection.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SequenceListConnections.Add(System.Object)"> <summary>Creates and adds a new SequenceListConnection to the collection.</summary> <returns>New SequenceListConnection.</returns> <param name="uiObj">Specifies the user interface object to connect.</param> <seealso cref=""SequenceFileViewMgr.ConnectSequenceList"SequenceFileViewMgr_ConnectSequenceList_M.htm" /> <seealso cref="SequenceListConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SequenceListConnections.Remove(System.Object)"> <summary>Removes the specified item from this collection, if it exists.</summary> <returns>Returns <c>True</c> when the SequenceListConnection is removed. Returns <c>False</c> when the SequenceListConnection is not found.</returns> <param name="uiObj">Specifies the user interface object to disconnect.</param> <seealso cref="SequenceListConnections.Add" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SequenceListConnections.Clear"> <summary>Removes all items from the collection.</summary> <seealso cref="SequenceListConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SequenceListConnections.FromControl(System.Object)"> <summary>Returns the SequenceListConnection connected to the uiObj parameter.</summary> <returns>SequenceListConnection connected to the uiObj parameter. When no SequenceListConnection exists for this control, this method returns <c>NULL</c>.</returns> <param name="uiObj">Specifies the connected user interface object.</param> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.StepGroupListConnection"> <summary>Represents a connection from a SequenceFileView Manager control to a control that displays the list of step groups. Use the connected control to select the step group for the current sequence. <para>Note: This class currently contains no properties or methods. Properties or methods might be added to this class in future versions of TestStand.</para></summary> <seealso cref=""SequenceFileView Manager"SequenceFileViewMgr.htm" /> <seealso cref="StepGroupListConnections" /> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.StepGroupListConnections"> <summary>A collection of StepGroupListConnection objects.</summary> <seealso cref=""SequenceFileViewMgr.ConnectStepGroupList"SequenceFileViewMgr_ConnectStepGroupList_M.htm" /> <seealso cref="StepGroupListConnection" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.StepGroupListConnections.Item(System.Int32)"> <summary>Returns a reference to an item at the specified index in the collection.</summary> <returns>Item located at the specified index.</returns> <param name="itemIndex">Specifies the index of the item to retrieve.</param> <seealso cref="StepGroupListConnection" /> <seealso cref="StepGroupListConnections.Count" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.StepGroupListConnections.Count"> <summary>Returns the number of items in the collection.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.StepGroupListConnections.Add(System.Object)"> <summary>Creates and adds a new StepGroupListConnection to the collection.</summary> <returns>New StepGroupListConnection.</returns> <param name="uiObj">Specifies the user interface object to connect.</param> <seealso cref=""SequenceFileViewMgr.ConnectStepGroupList"SequenceFileViewMgr_ConnectStepGroupList_M.htm" /> <seealso cref="StepGroupListConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.StepGroupListConnections.Remove(System.Object)"> <summary>Removes the specified item from this collection, if it exists.</summary> <returns>Returns <c>True</c> when the StepGroupListConnection is removed. Returns <c>False</c> when the StepGroupListConnection is not found.</returns> <param name="uiObj">Specifies the user interface object to disconnect.</param> <seealso cref="StepGroupListConnections.Add" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.StepGroupListConnections.Clear"> <summary>Removes all items from the collection.</summary> <seealso cref="StepGroupListConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.StepGroupListConnections.FromControl(System.Object)"> <summary>Returns the StepGroupListConnection connected to the uiObj parameter.</summary> <returns>StepGroupListConnection connected to the uiObj parameter. When no StepGroupListConnection exists for this control, this method returns <c>NULL</c>.</returns> <param name="uiObj">Specifies the connected user interface object.</param> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.SequenceFileViewMgrConnections"> <summary>Contains the connections for the SequenceFileView Manager control.</summary> <seealso cref="ApplicationMgrConnections" /> <seealso cref="ExecutionViewMgrConnections" /> <seealso cref=""SequenceFileView Manager"SequenceFileViewMgr.htm" /> <seealso cref=""SequenceFileViewMgr.Connections"SequenceFileViewMgr_Connections_P.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SequenceFileViewMgrConnections.Variables"> <summary>Collection of VariablesConnection objects.</summary> <seealso cref="SequenceFileViewMgr.ConnectVariables" /> <seealso cref="VariablesConnection" /> <seealso cref="VariablesConnections" /> <seealso cref="
" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SequenceFileViewMgrConnections.SequenceFileList"> <summary>Collection of SequenceFileListConnection objects.</summary> <seealso cref="SequenceFileListConnection" /> <seealso cref="SequenceFileListConnections" /> <seealso cref=""SequenceFileViewMgr.ConnectSequenceFileList"SequenceFileViewMgr_ConnectSequenceFileList_M.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SequenceFileViewMgrConnections.SequenceList"> <summary>Collection of SequenceListConnection objects.</summary> <seealso cref=""SequenceFileViewMgr.ConnectSequenceList"SequenceFileViewMgr_ConnectSequenceList_M.htm" /> <seealso cref="SequenceListConnection" /> <seealso cref="SequenceListConnections" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SequenceFileViewMgrConnections.StepGroupList"> <summary>Collection of StepGroupListConnection objects.</summary> <seealso cref=""SequenceFileViewMgr.ConnectStepGroupList"SequenceFileViewMgr_ConnectStepGroupList_M.htm" /> <seealso cref="StepGroupListConnection" /> <seealso cref="StepGroupListConnections" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SequenceFileViewMgrConnections.SequenceView"> <summary>Collection of SequenceViewConnection objects.</summary> <seealso cref=""SequenceFileViewMgr.ConnectSequenceView"SequenceFileViewMgr_ConnectSequenceView_M.htm" /> <seealso cref="SequenceViewConnection" /> <seealso cref="SequenceViewConnections" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SequenceFileViewMgrConnections.Command"> <summary>Collection of CommandConnection objects.</summary> <seealso cref="CommandConnection" /> <seealso cref="CommandConnections" /> <seealso cref=""SequenceFileViewMgr.ConnectCommand"SequenceFileViewMgr_ConnectCommand_M.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SequenceFileViewMgrConnections.Caption"> <summary>Collection of CaptionConnection objects.</summary> <seealso cref="CaptionConnection" /> <seealso cref="CaptionConnections" /> <seealso cref=""SequenceFileViewMgr.ConnectCaption"SequenceFileViewMgr_ConnectCaption_M.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SequenceFileViewMgrConnections.Image"> <summary>Collection of ImageConnection objects.</summary> <seealso cref="ImageConnection" /> <seealso cref="ImageConnections" /> <seealso cref=""SequenceFileViewMgr.ConnectImage"SequenceFileViewMgr_ConnectImage_M.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SequenceFileViewMgrConnections.InsertionPalettes"> <summary>Collection of InsertionPaletteConnection objects.</summary> <seealso cref="InsertionPaletteConnection" /> <seealso cref="InsertionPaletteConnections" /> <seealso cref="SequenceFileViewMgr.ConnectInsertionPalette" /> <seealso cref="
" /> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewConnection"> <summary>Represents a connection from an ExecutionView Manager control to an ExecutionViewMgrConnections.ExecutionView property. When tracing is enabled, the connected control shows the steps of the execution as they are executing. Use the ExecutionViewMgr.Connections property to obtain a collection of ExecutionViewConnection objects.</summary> <seealso cref=""ExecutionViewMgrConnections.ExecutionView"ExecutionViewMgrConnections_ExecutionView_P.htm" /> <seealso cref=""ExecutionView Manager"ExecutionViewMgr.htm" /> <seealso cref="ExecutionViewConnections" /> <seealso cref=""ExecutionViewMgr.Connections"ExecutionViewMgr_Connections_P.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewConnection.ColorRunning"> <summary>Specifies the background color of the control when the execution in the ExecutionView Manager control is running. This setting is ignored when the value of the ExecutionViewConnection.Options property is <c>ExecutionViewConnection_IgnoreColors</c>.</summary> <seealso cref="ExecutionViewConnection.Options" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewConnection.ColorPaused"> <summary>Specifies the background color of the control when the execution in the ExecutionView Manager control is paused. This setting is ignored when the value of the ExecutionViewConnection.Options property is <c>ExecutionViewConnection_IgnoreColors</c>.</summary> <seealso cref="ExecutionViewConnection.Options" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewConnection.ColorStopped"> <summary>Specifies the background color of the control when the execution in the ExecutionView Manager control is stopped. This setting is ignored when the value of the ExecutionViewConnection.Options property is <c>ExecutionViewConnection_IgnoreColors</c>.</summary> <seealso cref="ExecutionViewConnection.Options" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewConnection.Options"> <summary>Specifies the behavior of the ExecutionViewConnection. The value of this property is a bitwise-OR combination of the ExecutionViewOptions constants.</summary> <seealso cref=""ExecutionViewOptions"ExecutionViewOptions.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewConnection.UIControl"> <summary>Returns the user interface control the connection connects to an ExecutionView Manager control.</summary> <seealso cref=""ExecutionView Manager"ExecutionViewMgr.htm" /> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewConnections"> <summary>A collection of ExecutionViewConnection objects you obtain by calling the ExecutionViewMgr.Connections property.</summary> <seealso cref="ExecutionViewConnection" /> <seealso cref=""ExecutionViewMgr.Connections"ExecutionViewMgr_Connections_P.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewConnections.Item(System.Int32)"> <summary>Returns a reference to an item at the specified index in the collection.</summary> <returns>Item located at the specified index.</returns> <param name="itemIndex">Specifies the index of the item to retrieve.</param> <seealso cref="ExecutionViewConnection" /> <seealso cref="ExecutionViewConnections.Count" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewConnections.Count"> <summary>Returns the number of items in the collection.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewConnections.Add(System.Object)"> <summary>Creates and adds a new ExecutionViewConnection to the collection.</summary> <returns>New ExecutionViewConnection.</returns> <param name="uiObj">Specifies the user interface object to connect.</param> <seealso cref="ExecutionViewConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewConnections.Remove(System.Object)"> <summary>Removes the specified item from this collection, if it exists.</summary> <returns>Returns <c>True</c> when the ExecutionViewConnection is removed. Returns <c>False</c> when the ExecutionViewConnection is not found.</returns> <param name="uiObj">Specifies the user interface object to disconnect.</param> <seealso cref="ExecutionViewConnections.Add" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewConnections.Clear"> <summary>Removes all items from the collection.</summary> <seealso cref="ExecutionViewConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewConnections.FromControl(System.Object)"> <summary>Returns the ExecutionViewConnection that is connected to the uiObj parameter.</summary> <returns>ExecutionViewConnection connected to the uiObj parameter. When no ExecutionViewConnection exists for this control, this method returns <c>NULL</c>.</returns> <param name="uiObj">Specifies the connected user interface object.</param> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.CallStackConnection"> <summary>Represents a connection from the ExecutionView Manager control to a control that displays the callstack. You can use the connected control to change the selected sequence context when the execution is paused. <para>Note: This class currently contains no properties or methods. Properties or methods might be added to this class in future versions of TestStand.</para></summary> <seealso cref="CallStackConnections" /> <seealso cref="
"ExecutionView Manager"ExecutionViewMgr.htm" /> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.CallStackConnections"> <summary>A collection of CallStackConnection objects.</summary> <seealso cref="CallStackConnection" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.CallStackConnections.Item(System.Int32)"> <summary>Returns a reference to an item at the specified index in the collection.</summary> <returns>Item located at the specified index.</returns> <param name="itemIndex">Specifies the index of the item to retrieve.</param> <seealso cref="CallStackConnection" /> <seealso cref="CallStackConnections.Count" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.CallStackConnections.Count"> <summary>Returns the number of items in the collection.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.CallStackConnections.Add(System.Object)"> <summary>Creates and adds a new CallStackConnection to the collection.</summary> <returns>New CallStackConnection.</returns> <param name="uiObj">Specifies the user interface object to connect.</param> <seealso cref="CallStackConnections.Remove" /> <seealso cref=""ExecutionViewMgr.ConnectCallStack"ExecutionViewMgr_ConnectCallStack_M.htm" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.CallStackConnections.Remove(System.Object)"> <summary>Removes the specified item from this collection, if it exists.</summary> <returns>Returns <c>True</c> when the CallStackConnection is removed. Returns <c>False</c> when the CallStackConnection is not found.</returns> <param name="uiObj">Specifies the user interface object to disconnect.</param> <seealso cref="CallStackConnection" /> <seealso cref="CallStackConnections.Add" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.CallStackConnections.Clear"> <summary>Removes all items from the collection.</summary> <seealso cref="CallStackConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.CallStackConnections.FromControl(System.Object)"> <summary>Returns the CallStackConnection connected to the UI object.</summary> <returns>CallStackConnection connected to this user interface object. When no CallStackConnection exists for this control, this method returns <c>NULL</c>.</returns> <param name="uiObj">Specifies the connected user interface object.</param> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.ThreadListConnection"> <summary>Represents a connection from the ExecutionView Manager control to a control that displays the list of threads in the execution. You can use the connected control to display the foreground thread and to change the foreground thread when the execution is paused. <para>Note: This class currently contains no properties or methods. Properties or methods might be added to this class in future versions of TestStand.</para></summary> <seealso cref=""ExecutionView Manager"ExecutionViewMgr.htm" /> <seealso cref="ThreadListConnections" /> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.ThreadListConnections"> <summary>A collection of ThreadListConnection objects.</summary> <seealso cref=""ExecutionViewMgr.ConnectThreadList"ExecutionViewMgr_ConnectThreadList_M.htm" /> <seealso cref="ThreadListConnection" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ThreadListConnections.Item(System.Int32)"> <summary>Returns a reference to an item at the specified index in the collection.</summary> <returns>Item located at the specified index.</returns> <param name="itemIndex">Specifies the index of the item to retrieve.</param> <seealso cref="ThreadListConnection" /> <seealso cref="ThreadListConnections.Count" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ThreadListConnections.Count"> <summary>Returns the number of items in the collection.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.ThreadListConnections.Add(System.Object)"> <summary>Creates and adds a new ThreadListConnection to the collection.</summary> <returns>New ThreadListConnection.</returns> <param name="uiObj">Specifies the user interface object to connect.</param> <seealso cref=""ExecutionViewMgr.ConnectThreadList"ExecutionViewMgr_ConnectThreadList_M.htm" /> <seealso cref="ThreadListConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.ThreadListConnections.Remove(System.Object)"> <summary>Removes the specified item from this collection, if it exists.</summary> <returns>Returns <c>True</c> when the ThreadListConnection is removed. Returns <c>False</c> when the ThreadListConnection is not found.</returns> <param name="uiObj">Specifies the user interface object to disconnect.</param> <seealso cref="ThreadListConnections.Add" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.ThreadListConnections.Clear"> <summary>Removes all items from the collection.</summary> <seealso cref="ThreadListConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.ThreadListConnections.FromControl(System.Object)"> <summary>Returns the ThreadListConnection connected to the uiObj parameter.</summary> <returns>ThreadListConnection connected to the uiObj parameter. When no ThreadListConnection exists for this control, this method returns <c>NULL</c>.</returns> <param name="uiObj">Specifies the connected user interface object.</param> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.ExecutionListConnection"> <summary>Represents a connection from the ExecutionView Manager control to a control that displays the list of currently running executions. You can use the connected control to select an execution from the list of executions.</summary> <seealso cref="ExecutionListConnections" /> <seealso cref="
"ExecutionView Manager"ExecutionViewMgr.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ExecutionListConnection.ShowHiddenExecutions"> <summary>When this property is <c>True</c>, the execution list shows executions created with the <c>ExecTypeMask_InitiallyHidden</c> flag.</summary> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ExecutionListConnection.DisplayExpression"> <summary>Specifies how to display executions in the execution list using a format expression. By default, the value of this property is <c>"%CurrentExecution%"</c>. Refer to the CaptionSource_MacroExpression enumeration value for more information about types of caption sources.</summary> <seealso cref=""CaptionSource_MacroExpression"CaptionSources.htm" /> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.ExecutionListConnections"> <summary>A collection of ExecutionListConnection objects.</summary> <seealso cref="ExecutionListConnection" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ExecutionListConnections.Item(System.Int32)"> <summary>Returns a reference to an item at the specified index in the collection.</summary> <returns>Item located at the specified index.</returns> <param name="itemIndex">Specifies the index of the item to retrieve.</param> <seealso cref="ExecutionListConnection" /> <seealso cref="ExecutionListConnections.Count" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ExecutionListConnections.Count"> <summary>Returns the number of items in the collection.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.ExecutionListConnections.Add(System.Object)"> <summary>Creates and adds a new ExecutionListConnection to the collection.</summary> <returns>New ExecutionListConnection.</returns> <param name="uiObj">Specifies the user interface object to connect.</param> <seealso cref="ExecutionListConnections.Remove" /> <seealso cref=""ExecutionViewMgr.ConnectExecutionList"ExecutionViewMgr_ConnectExecutionList_M.htm" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.ExecutionListConnections.Remove(System.Object)"> <summary>Removes the specified item from this collection, if it exists.</summary> <returns>Returns <c>True</c> when the ExecutionListConnection is removed. Returns <c>False</c> when the <c>ExecutionListConnection</c> is not found.</returns> <param name="uiObj">Specifies the user interface object to disconnect.</param> <seealso cref="ExecutionListConnection" /> <seealso cref="ExecutionListConnections.Add" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.ExecutionListConnections.Clear"> <summary>Removes all items from the collection.</summary> <seealso cref="ExecutionListConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.ExecutionListConnections.FromControl(System.Object)"> <summary>Returns the ExecutionListConnection connected to the uiObj parameter.</summary> <returns>ExecutionListConnection connected to the uiObj parameter. When no ExecutionListConnection exists for this control, this method returns <c>NULL</c>.</returns> <param name="uiObj">Specifies the connected user interface object.</param> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.ReportViewConnection"> <summary>Represents a connection from the ExecutionView Manager control to a control that displays a report associated with an execution. <para>Note: This class currently contains no properties or methods. Properties or methods might be added to this class in future versions of TestStand.</para></summary> <seealso cref=""ExecutionView Manager"ExecutionViewMgr.htm" /> <seealso cref="ReportViewConnections" /> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.ReportViewConnections"> <summary>A collection of ReportViewConnection objects.</summary> <seealso cref="ReportViewConnection" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ReportViewConnections.Item(System.Int32)"> <summary>Returns a reference to an item at the specified index in the collection.</summary> <returns>Item located at the specified index.</returns> <param name="itemIndex">Specifies the index of the item to retrieve.</param> <seealso cref="ReportViewConnection" /> <seealso cref="ReportViewConnections.Count" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ReportViewConnections.Count"> <summary>Returns the number of items in the collection.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.ReportViewConnections.Add(System.Object)"> <summary>Creates and adds a new ReportViewConnection to the collection.</summary> <returns>New ReportViewConnection.</returns> <param name="uiObj">Specifies the user interface object to connect.</param> <seealso cref=""ExecutionViewMgr.ConnectReportView"ExecutionViewMgr_ConnectReportView_M.htm" /> <seealso cref="ReportViewConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.ReportViewConnections.Remove(System.Object)"> <summary>Removes the specified item from this collection, if it exists.</summary> <returns>Returns <c>True</c> when the ReportViewConnection is removed. Returns <c>False</c> when the ReportViewConnection is not found.</returns> <param name="uiObj">Specifies the user interface object to disconnect.</param> <seealso cref="ReportViewConnections.Add" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.ReportViewConnections.Clear"> <summary>Removes all items from the collection.</summary> <seealso cref="ReportViewConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.ReportViewConnections.FromControl(System.Object)"> <summary>Returns the ReportViewConnection connected to the uiObj parameter.</summary> <returns>ReportViewConnection connected to the uiObj parameter. When no ReportViewConnection exists for this control, this method returns <c>NULL</c>.</returns> <param name="uiObj">Specifies the connected user interface object.</param> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewMgrConnections"> <summary>Contains the connections for an ExecutionView Manager control.</summary> <seealso cref="ApplicationMgrConnections" /> <seealso cref="
"ExecutionView Manager"ExecutionViewMgr.htm" /> <seealso cref="SequenceFileViewMgrConnections" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewMgrConnections.Variables"> <summary>Collection of VariablesConnection objects.</summary> <seealso cref="ExecutionViewMgr.ConnectVariables" /> <seealso cref="VariablesConnection" /> <seealso cref="VariablesConnections" /> <seealso cref="

" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewMgrConnections.ExecutionView"> <summary>Collection of ExecutionViewConnection objects.</summary> <seealso cref="ExecutionViewConnection" /> <seealso cref="ExecutionViewConnections" /> <seealso cref=""ExecutionViewMgr.ConnectExecutionView"ExecutionViewMgr_ConnectExecutionView_M.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewMgrConnections.ReportView"> <summary>Collection of ReportViewConnection objects.</summary> <seealso cref=""ExecutionViewMgr.ConnectReportView"ExecutionViewMgr_ConnectReportView_M.htm" /> <seealso cref="ReportViewConnection" /> <seealso cref="ReportViewConnections" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewMgrConnections.ExecutionList"> <summary>Collection of ExecutionListConnection objects.</summary> <seealso cref="ExecutionListConnection" /> <seealso cref="ExecutionListConnections" /> <seealso cref=""ExecutionViewMgr.ConnectExecutionList"ExecutionViewMgr_ConnectExecutionList_M.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewMgrConnections.Command"> <summary>Collection of CommandConnection objects.</summary> <seealso cref="CommandConnection" /> <seealso cref="CommandConnections" /> <seealso cref=""ExecutionViewMgr.ConnectCommand"ExecutionViewMgr_ConnectCommand_M.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewMgrConnections.Caption"> <summary>Collection of CaptionConnection objects.</summary> <seealso cref="CaptionConnection" /> <seealso cref="CaptionConnections" /> <seealso cref=""ExecutionViewMgr.ConnectCaption"ExecutionViewMgr_ConnectCaption_M.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewMgrConnections.CallStack"> <summary>Collection of CallStackConnection objects.</summary> <seealso cref="CallStackConnection" /> <seealso cref="CallStackConnections" /> <seealso cref=""ExecutionViewMgr.ConnectCallStack"ExecutionViewMgr_ConnectCallStack_M.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewMgrConnections.ThreadList"> <summary>Collection of ThreadListConnection objects.</summary> <seealso cref=""ExecutionViewMgr.ConnectThreadList"ExecutionViewMgr_ConnectThreadList_M.htm" /> <seealso cref="ThreadListConnection" /> <seealso cref="ThreadListConnections" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewMgrConnections.Image"> <summary>Collection of ImageConnection objects.</summary> <seealso cref=""ExecutionViewMgr.ConnectImage"ExecutionViewMgr_ConnectImage_M.htm" /> <seealso cref="ImageConnection" /> <seealso cref="ImageConnections" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ExecutionViewMgrConnections.Numeric"> <summary>Collection of NumericConnection objects.</summary> <seealso cref=""ExecutionViewMgr.ConnectNumeric"ExecutionViewMgr_ConnectNumeric_M.htm" /> <seealso cref="NumericConnection" /> <seealso cref="NumericConnections" /> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.ApplicationMgrConnections"> <summary>Contains the connections for an Application Manager control. Use the ApplicationMgr.Connections property to obtain a collection of ApplicationMgrConnections objects.</summary> <seealso cref=""Application Manager"ApplicationMgr.htm" /> <seealso cref=""ApplicationMgr.Connections"ApplicationMgr_Connections_P.htm" /> <seealso cref="ExecutionViewMgrConnections" /> <seealso cref="SequenceFileViewMgrConnections" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ApplicationMgrConnections.Command"> <summary>Collection of CommandConnection objects.</summary> <seealso cref=""ApplicationMgr.ConnectCommand"ApplicationMgr_ConnectCommand_M.htm" /> <seealso cref="CommandConnection" /> <seealso cref="CommandConnections" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ApplicationMgrConnections.Caption"> <summary>Collection of CaptionConnection objects.</summary> <seealso cref=""ApplicationMgr.ConnectCaption"ApplicationMgr_ConnectCaption_M.htm" /> <seealso cref="CaptionConnection" /> <seealso cref="CaptionConnections" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.ApplicationMgrConnections.AdapterList"> <summary>Collection of AdapterListConnection objects.</summary> <seealso cref="AdapterListConnection" /> <seealso cref="AdapterListConnections" /> <seealso cref="ApplicationMgr.ConnectAdapterList" /> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.AdapterListConnection"> <summary>Represents a connection from an Application Manager control to a control that displays the list of adapters. Use the connected control to select an adapter to which to set the Engine.DefaultAdapter property. <para>Note: This class currently contains no properties or methods. Properties or methods might be added to this class in future versions of TestStand.</para></summary> <seealso cref=""Application Manager"ApplicationMgr.htm" /> <seealso cref="AdapterListConnections" /> <seealso cref=""Engine.DefaultAdapter"javascript:APILink('/RefTopics/Engine_DefaultAdapter_P.htm')" /> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.AdapterListConnections"> <summary>A collection of AdapterListConnection objects.</summary> <seealso cref="AdapterListConnection" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.AdapterListConnections.Item(System.Int32)"> <summary>Returns a reference to an item at the specified index in the collection.</summary> <param name="itemIndex">Specifies the zero-based index of the item to retrieve.</param> <seealso cref="AdapterListConnection" /> <seealso cref="AdapterListConnections.Count" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.AdapterListConnections.Count"> <summary>Returns the number of items in the collection.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.AdapterListConnections.Add(System.Object)"> <summary>Creates and adds a new AdapterListConnection to the collection.</summary> <returns>The AdapterListConnection this method creates.</returns> <param name="uiObj">Specifies the user interface object to connect.</param> <seealso cref="AdapterListConnection" /> <seealso cref="AdapterListConnections.Remove" /> <seealso cref="ApplicationMgr.ConnectAdapterList" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.AdapterListConnections.Remove(System.Object)"> <summary>Removes the specified item from this collection, if it exists.</summary> <returns>Returns <c>True</c> when the AdapterListConnection is removed. Returns <c>False</c> when the AdapterListConnection is not found.</returns> <param name="uiObj">Specifies the user interface object to disconnect.</param> <seealso cref="AdapterListConnection" /> <seealso cref="AdapterListConnections.Add" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.AdapterListConnections.Clear"> <summary>Removes all items from the collection.</summary> <seealso cref="AdapterListConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.AdapterListConnections.FromControl(System.Object)"> <summary>Returns the AdapterListConnection connected to the uiObj parameter. When no AdapterListConnection is connected to the user interface object the parameter specifies, this method returns <c>NULL</c>.</summary> <param name="uiObj">Specifies a connected user interface object.</param> <seealso cref="AdapterListConnection" /> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.VariablesConnection"> <summary>Represents a connection from a SequenceFileView Manager or ExecutionView Manager control to a VariablesView control.</summary> <seealso cref=""ExecutionView Manager"ExecutionViewMgr.htm" /> <seealso cref=""SequenceFileView Manager"SequenceFileViewMgr.htm" /> <seealso cref=""VariablesView"VariablesView.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.VariablesConnection.UIControl"> <summary>Returns the user interface control that the connection connects to a SequenceFileView Manager or ExecutionView Manager control.</summary> <seealso cref="ExecutionViewMgr" /> <seealso cref="SequenceFileViewMgr" /> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.VariablesConnections"> <summary>A collection of VariablesConnection objects.</summary> <seealso cref="ExecutionViewMgr.ConnectVariables" /> <seealso cref="SequenceFileViewMgr.ConnectVariables" /> <seealso cref="VariablesConnection" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.VariablesConnections.Item(System.Int32)"> <summary>Returns a reference to an item at the specified index in the collection.</summary> <returns>Item located at the specified index.</returns> <param name="itemIndex">Specifies a zero-based index of the item to retrieve.</param> <seealso cref="VariablesConnection" /> <seealso cref="VariablesConnections.Count" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.VariablesConnections.Count"> <summary>Returns the number of items in the collection.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.VariablesConnections.Add(System.Object)"> <summary>Creates and adds a new VariablesConnection to the collection.</summary> <returns>New VariablesConnection object.</returns> <param name="uiObj">Specifies the user interface object to connect.</param> <seealso cref="ExecutionViewMgr.ConnectVariables" /> <seealso cref="SequenceFileViewMgr.ConnectVariables" /> <seealso cref="VariablesConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.VariablesConnections.Remove(System.Object)"> <summary>Removes the specified item from this collection, if it exists.</summary> <returns>Returns <c>True</c> when the VariablesConnection is removed. Returns <c>False</c> when the VariablesConnection is not found.</returns> <param name="uiObj">Specifies the user interface object to disconnect.</param> <seealso cref="VariablesConnection" /> <seealso cref="VariablesConnections.Add" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.VariablesConnections.Clear"> <summary>Removes all items from the collection.</summary> <seealso cref="VariablesConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.VariablesConnections.FromControl(System.Object)"> <summary>Returns the VariablesConnection connected to the uiObj parameter.</summary> <returns>VariablesConnection connected to the uiObj parameter. When no VariablesConnection exists for this control, this method returns <c>NULL</c>.</returns> <param name="uiObj">Specifies the connected user interface object.</param> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.SelectedSequences"> <summary>A collection of selected sequences. You can obtain a reference to the collection from the SequenceFileViewMgr.SelectedSequences property.</summary> <seealso cref=""SequenceFileViewMgr.SelectedSequences"SequenceFileViewMgr_SelectedSequences_P.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SelectedSequences.Item(System.Int32)"> <summary>Returns a reference to an item at the specified index in the collection.</summary> <returns>The sequence at the specified index in the collection.</returns> <param name="itemIndex">Specifies the index of the item to retrieve.</param> <seealso cref=""Sequence"javascript:APILink('/RefTopics/Sequence.htm')" /> <seealso cref="SelectedSequences.Count" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SelectedSequences.Count"> <summary>Returns the number of items in the collection.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SelectedSequences.Clear"> <summary>Removes all items from the collection.</summary> <seealso cref="SelectedSequences.AddSequence" /> <seealso cref="SelectedSequences.AddSequences" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SelectedSequences.AddSequence(NationalInstruments.TestStand.Interop.API.Sequence)"> <summary>Adds a sequence to the SelectedSequences collection.</summary> <param name="val">Specifies the sequence to add.</param> <seealso cref="SelectedSequences.AddSequences" /> <seealso cref="SelectedSequences.Clear" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SelectedSequences.AddSequences(System.Object[])"> <summary>Adds an array of sequences to the SelectedSequences collection.</summary> <param name="val">Specifies the array of sequences to add.</param> <seealso cref="SelectedSequences.AddSequence" /> <seealso cref="SelectedSequences.Clear" /> <seealso cref="
" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SelectedSequences.BeginUpdate"> <summary>Call this method before making multiple changes to the SelectedSequences collection. When you finish changing the collection, call the SelectedSequences.EndUpdate method to update the TestStand User Interface (UI) Controls according to the changes.</summary> <remarks>Use this method to minimize redrawing in the TestStand UI Controls when you programmatically change the selection.</remarks> <seealso cref="SelectedSequences.EndUpdate" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SelectedSequences.EndUpdate"> <summary>Updates the user interface according to all changes to the SelectedSequences collection you make after a previous call to the SelectedSequences.BeginUpdate method.</summary> <seealso cref="SelectedSequences.BeginUpdate" /> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.InsertionPaletteConnection"> <summary>Represents a connection from a SequenceFileView Manager control to an InsertionPalette control. The InsertionPalette control displays a list of step types and a list of user defined template steps, sequences, and variables. Use the connected control to insert a step, sequence, or variable into a sequence file.</summary> <seealso cref=""InsertionPalette"InsertionPalette.htm" /> <seealso cref=""SequenceFileView Manager"SequenceFileViewMgr.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.InsertionPaletteConnection.UIControl"> <summary>Returns the user interface control the connection connects to a SequenceFileView Manager control.</summary> <seealso cref="SequenceFileViewMgr" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.InsertionPaletteConnection.StepTypesPage"> <summary>Specifies the index of the Step Types page in the InsertionPalettePages collection.</summary> <seealso cref="InsertionPaletteConnection.TemplatesPage" /> <seealso cref=""InsertionPalettePage"InsertionPalettePage.htm" /> <seealso cref=""InsertionPalettePages"InsertionPalettePages.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.InsertionPaletteConnection.TemplatesPage"> <summary>Specifies the index of the Templates page in the InsertionPalettePages collection.</summary> <seealso cref="InsertionPaletteConnection.StepTypesPage" /> <seealso cref=""InsertionPalettePage"InsertionPalettePage.htm" /> <seealso cref=""InsertionPalettePages"InsertionPalettePages.htm" /> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.InsertionPaletteConnections"> <summary>A collection of InsertionPaletteConnection objects.</summary> <seealso cref="InsertionPaletteConnection" /> <seealso cref=""SequenceFileViewMgr.ConnectInsertionPalette"SequenceFileViewMgr_ConnectInsertionPalette_M.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.InsertionPaletteConnections.Item(System.Int32)"> <summary>Returns a reference to an item at the specified index in the collection.</summary> <returns>Item located at the specified index.</returns> <param name="itemIndex">Specifies the zero-based index of the item to retrieve.</param> <seealso cref="InsertionPaletteConnection" /> <seealso cref="InsertionPaletteConnections.Count" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.InsertionPaletteConnections.Count"> <summary>Returns the number of items in the collection.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.InsertionPaletteConnections.Add(System.Object)"> <summary>Creates and adds a new InsertionPaletteConnection to the collection.</summary> <returns>New InsertionPaletteConnection object.</returns> <param name="uiObj">Specifies the user interface object to connect.</param> <seealso cref="ExecutionViewMgr.ConnectVariables" /> <seealso cref="InsertionPaletteConnections.Remove" /> <seealso cref="SequenceFileViewMgr.ConnectVariables" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.InsertionPaletteConnections.Remove(System.Object)"> <summary>Removes the specified item from this collection, if it exists.</summary> <returns>Returns <c>True</c> when the InsertionPaletteConnection is removed. Returns <c>False</c> when the InsertionPaletteConnection is not found.</returns> <param name="uiObj">Specifies the user interface object to disconnect.</param> <seealso cref="InsertionPaletteConnections.Add" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.InsertionPaletteConnections.Clear"> <summary>Removes all items from the collection.</summary> <seealso cref="InsertionPaletteConnections.Remove" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.InsertionPaletteConnections.FromControl(System.Object)"> <summary>Returns the InsertionPaletteConnection connected to the uiObj parameter.</summary> <returns>InsertionPaletteConnection connected to this user interface object. When no InsertionPaletteConnection exists for this control, this method returns <c>NULL</c>.</returns> <param name="uiObj">Specifies the connected user interface object.</param> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.SelectedPropertyObjects"> <summary>A collection of selected property objects. Controls connected to the SequenceFileView Manager and ExecutionView Manager controls, such as the VariablesView, automatically update the collection while active. You can obtain a reference to the collection from the SequenceFileViewMgr.SelectedPropertyObjects and ExecutionViewMgr.SelectedPropertyObjects properties.</summary> <seealso cref=""ExecutionViewMgr"ExecutionViewMgr.htm" /> <seealso cref=""ExecutionViewMgr.SelectedPropertyObjects"ExecutionViewMgr_SelectedPropertyObjects_P.htm" /> <seealso cref=""SequenceFileViewMgr"SequenceFileViewMgr.htm" /> <seealso cref=""SequenceFileViewMgr.SelectedPropertyObjects"SequenceFileViewMgr_SelectedPropertyObjects_P.htm" /> <seealso cref=""VariablesView"VariablesView.htm" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SelectedPropertyObjects.Item(System.Int32)"> <summary>Returns a reference to an item at the specified index in the collection.</summary> <param name="itemIndex">Specifies a zero-based index of the item to retrieve.</param> <seealso cref=""PropertyObject"javascript:APILink('/RefTopics/PropertyObject.htm')" /> <seealso cref="SelectedPropertyObjects.Count" /> </member> <member name="P:NationalInstruments.TestStand.Interop.UI.Support.SelectedPropertyObjects.Count"> <summary>Returns the number of items in the collection.</summary> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SelectedPropertyObjects.Clear"> <summary>Removes all items from the collection.</summary> <seealso cref="SelectedPropertyObjects.AddPropertyObject" /> <seealso cref="SelectedPropertyObjects.AddPropertyObjects" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SelectedPropertyObjects.AddPropertyObject(NationalInstruments.TestStand.Interop.API.PropertyObject)"> <summary>Adds a property object to the collection.</summary> <param name="val">Specifies the property object to add.</param> <seealso cref="SelectedPropertyObjects.Clear" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SelectedPropertyObjects.AddPropertyObjects(System.Object[])"> <summary>Adds an array of property objects to the collection.</summary> <param name="val">Specifies the property objects to add.</param> <seealso cref="SelectedPropertyObjects.Clear" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SelectedPropertyObjects.BeginUpdate"> <summary>Call this method before you make multiple changes to the SelectedPropertyObjects collection. When you finish changing the collection, call the SelectedPropertyObjects.EndUpdate method to update the TestStand User Interface (UI) Controls according to the changes.</summary> <remarks>Use this method to minimize redrawing in the TestStand UI Controls when you programmatically change the selection.</remarks> <seealso cref="SelectedPropertyObjects.EndUpdate" /> </member> <member name="M:NationalInstruments.TestStand.Interop.UI.Support.SelectedPropertyObjects.EndUpdate"> <summary>Updates the TestStand User Interface Controls according to the SelectedPropertyObjects collection changes you make after you call the SelectedPropertyObjects.BeginUpdate method.</summary> <seealso cref="SelectedPropertyObjects.BeginUpdate" /> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.SeqListConnectionColumns"> <summary>These constants represent the column type you can use with the column parameter of the SequenceListConnection.SetColumnVisible and SequenceListConnection.GetColumnVisible methods.</summary> <seealso cref="SequenceListConnection.GetColumnVisible" /> <seealso cref="SequenceListConnection.SetColumnVisible" /> </member> <member name="F:NationalInstruments.TestStand.Interop.UI.Support.SeqListConnectionColumns.SeqListConnectionColumn_Label"> <summary>(Value: 0) Specifies the column that contains the name of the sequence.</summary> </member> <member name="F:NationalInstruments.TestStand.Interop.UI.Support.SeqListConnectionColumns.SeqListConnectionColumn_Comments"> <summary>(Value: 1) Specifies the column that contains the comment of the sequence.</summary> </member> <member name="F:NationalInstruments.TestStand.Interop.UI.Support.SeqListConnectionColumns.SeqListConnectionColumn_Requirements"> <summary>(Value: 2) Specifies the column that contains the requirements of the sequence.</summary> </member> <member name="T:NationalInstruments.TestStand.Interop.UI.Support.SelectionFlags"> <summary>Use these constants to select step group start or end markers and to expand or collapse step groups. These constants apply only when the application displays more than one step group at a time. You cannot select step group start and end markers when steps are selected. You cannot select steps and step group end markers in collapsed step groups. </summary> <seealso cref="ExecutionViewMgr.SelectedSteps" /> <seealso cref="ExecutionViewMgr.StepGroupMode" /> <seealso cref="SelectedSteps.SelectionFlags" /> <seealso cref="SequenceFileViewMgr.SelectedSteps" /> <seealso cref="SequenceFileViewMgr.StepGroupMode" /> </member> <member name="F:NationalInstruments.TestStand.Interop.UI.Support.SelectionFlags.SelectionFlag_NoFlags"> <summary>(Value: 0) No collapsed step group and no selected step group markers.</summary> </member> <member name="F:NationalInstruments.TestStand.Interop.UI.Support.SelectionFlags.SelectionFlag_SetupStartSelected"> <summary>(Value: 1) Selects the start marker for the Setup step group.</summary> </member> <member name="F:NationalInstruments.TestStand.Interop.UI.Support.SelectionFlags.SelectionFlag_MainStartSelected"> <summary>(Value: 2) Selects the start marker for the Main step group.</summary> </member> <member name="F:NationalInstruments.TestStand.Interop.UI.Support.SelectionFlags.SelectionFlag_CleanupStartSelected"> <summary>(Value: 4) Selects the start marker for the Cleanup step group.</summary> </member> <member name="F:NationalInstruments.TestStand.Interop.UI.Support.SelectionFlags.SelectionFlag_SetupEndSelected"> <summary>(Value: 8) Selects the end marker for the Setup step group.</summary> </member> <member name="F:NationalInstruments.TestStand.Interop.UI.Support.SelectionFlags.SelectionFlag_MainEndSelected"> <summary>(Value: 16) Selects the end marker for the Main step group.</summary> </member> <member name="F:NationalInstruments.TestStand.Interop.UI.Support.SelectionFlags.SelectionFlag_CleanupEndSelected"> <summary>(Value: 32) Selects the end marker for the Cleanup step group.</summary> </member> <member name="F:NationalInstruments.TestStand.Interop.UI.Support.SelectionFlags.SelectionFlag_SetupCollapsed"> <summary>(Value: 64) Collapses the Setup step group.</summary> </member> <member name="F:NationalInstruments.TestStand.Interop.UI.Support.SelectionFlags.SelectionFlag_MainCollapsed"> <summary>(Value: 128) Collapses the Main step group.</summary> </member> <member name="F:NationalInstruments.TestStand.Interop.UI.Support.SelectionFlags.SelectionFlag_CleanupCollapsed"> <summary>(Value: 256) Collapses the Cleanup step group.</summary> </member> </members> </doc> Libs/NationalInstruments.TestStand.Interop.UI.dllBinary files differ
Libs/NationalInstruments.TestStand.Interop.UI.xml
New file Diff too large Libs/NationalInstruments.TestStand.Utility.dllBinary files differ
Libs/NationalInstruments.TestStand.Utility.xml
New file @@ -0,0 +1,2303 @@ <?xml version="1.0"?> <doc> <assembly> <name>NationalInstruments.TestStand.Utility</name> </assembly> <members> <member name="T:NationalInstruments.TestStand.Utility.TSHelper"> <summary> This class contains various methods that can be useful when you use the TestStand API or the TestStand UI Controls API from a .NET language </summary> <lastupdated>9/29/2011 1:54:18 PM</lastupdated> </member> <member name="M:NationalInstruments.TestStand.Utility.TSHelper.GetTestStandSplashImage"> <summary> Returns the standard image used as the background TestStand splash screens. </summary> <returns>The splash screen image.</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.TSHelper.GetTestStandAnimatedSplashImage"> <summary> Returns the standard animated image used as the background TestStand splash screens. </summary> <returns>The animated splash screen image.</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.TSHelper.DoSynchronousGCForCOMObjectDestruction"> <summary> This method ensures than any COM objects pending for garbage collection are released before it returns. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.TSHelper.MakePath(System.String,System.String,System.String)"> <summary> Creates a path with the <paramref name="directory"/>, <paramref name="fileName"/> and <paramref name="extension"/> specified by combining the three. </summary> <param name="directory">The directory part of the path</param> <param name="fileName">The file name part of the path</param> <param name="extension"> The extension part of the path. The extension can be passed with or without the dot. </param> <returns> The combined path <paramref name="directory"/>\<paramref name="fileName"/>.<paramref name="extension"/> </returns> </member> <member name="M:NationalInstruments.TestStand.Utility.TSHelper.NumericSuffixStartingIndex(System.String)"> <summary> Returns the index of the underscore in the numeric suffix at the end of <paramref name="fileName"/>. The numeric suffix is defined as an underscore followed by one or more digits. </summary> <param name="fileName">The file name to get a numeric index from.</param> <returns>The index of the underscore in the numeric suffix.</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.TSHelper.GetFileNameWithCountSuffix(System.String,System.Int32)"> <summary> Creates a new file name from the base <paramref name="fileName"/> with a numeric suffix with an integer part <paramref name="count"/> </summary> <example> GetFileNameWithCountSuffix("abc", 3) --> "abc_3" </example> <param name="fileName">The base part of the file name to generate</param> <param name="count">The integer part of the suffix of th file name to generate</param> <returns>A string with the file name generated from the base and count specified</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.TSHelper.LongCreateUniqueFile(System.String,System.String,System.String)"> <summary> Returns the path of a unique file name in <paramref name="directory"/> with the base <paramref name="fileName"/> specified and <paramref name="extension"/>. The method will return the result of calling <see cref="M:System.IO.Path.Combine(System.String,System.String)"/> with <paramref name="directory"/> and <paramref name="fileName"/> if no file with that name already exists in <paramref name="directory"/> or it will create a new unique file name with a numeric suffix. </summary> <param name="directory">The directory where the unique file name will be created</param> <param name="fileName">The base part of the file name which will be generated</param> <param name="extension">The extension to add to the file name</param> <returns>A path guaranteed to be unique in the directory specified.</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.TSHelper.CreateUniqueFile(System.String,System.String,System.String)"> <summary> Returns the path of a unique file name in <paramref name="directory"/> with the base <paramref name="fileName"/> specified and <paramref name="extension"/>. The method will return the result of calling <see cref="M:System.IO.Path.Combine(System.String,System.String)"/> with <paramref name="directory"/> and <paramref name="fileName"/> if no file with that name already exists in <paramref name="directory"/> or it will create a new unique file name with a numeric suffix. </summary> <param name="directory">The directory where the unique file name will be created</param> <param name="fileName">The base part of the file name which will be generated</param> <param name="extension">The extension to add to the file name</param> <returns>A path guaranteed to be unique in the directory specified.</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.TSHelper.CreateUniqueFileInternal(System.String,System.String,System.String,System.Boolean)"> <summary> <see cref="M:NationalInstruments.TestStand.Utility.TSHelper.CreateUniqueFile(System.String,System.String,System.String)"/> </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.TSHelper.ParseEnvironmentPathFromArgs(System.String[]@,System.Boolean,System.String)"> <summary>This is a helper function that command line applications that accept an engine environment argument on the command line can use to parse out the environment argument. The environment must be passed with the syntax: /env {PATH} or, for example, /env d:\MyEnv.tsenv The argument can appear anywhere on the command line. If found, the path is returned and the environment argument is removed from the array. If no environment argument is present, <paramref name="defaultEnvironment"/> is returned and args is left unchanged. If multiple environments are specified, only the first is removed from the list and returned. It is up to the command line parsing logic of the application to ignore or error if additional /env arguments are present.</summary> <param name="args">The command line arguments. If an environment is found, it will be removed from the array.</param> <param name="allowExceptions">Pass true to allow this function to generate an exception if the arguments are invalid. Pass false if you are handling command line exceptions elsewhere. If you use the TestStand Application Manager in your application, pass false.</param> <param name="defaultEnvironment">if no environment is found, the method returns this value.</param> <returns>The environment path if one was passed, null otherwise.</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.TSHelper.MakeEnvironmentArg(System.String)"> <summary>Create a command line argument to specify the TestStand environment to an application that uses the /env "{PATH}" syntax.</summary> <param name="path">The path to the environment.</param> <returns>An empty string if path is null or empty. Otherwise, returns /env + "{PATH}" enclosed in quotes and preceded by a space. This is to fascilitate construction of a command line.</returns> </member> <member name="F:NationalInstruments.TestStand.Utility.TSHelper.TE_ROOT_KEY"> <summary>The path to TestStand related keys in the registry relative to HKEY_LOCAL_MACHINE.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.TSHelper.HKLM_TE_ROOT_KEY"> <summary>The path to TestStand related keys in the registry including HKEY_LOCAL_MACHINE.</summary> </member> <member name="T:NationalInstruments.TestStand.Utility.Menus"> <summary> This class contains various methods that can be useful when you use the TestStand API or the TestStand UI Controls API from a .NET language </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Menus.TranslateShortcutKeyToDotNet(NationalInstruments.TestStand.Interop.UI.ShortcutKeys,System.Int32)"> <summary> <para>This method converts a ShortcutKeys and ShortcutModifiers into a .NET Shortcut key value. If no equivalent .NET Shortcut value exists, the method returns Shortcut.None.</para> <para>Typically, you call a higher level method, such as TSUtil.InsertCommandsInMenu, to create .NET menu items that execute TestStand commands. In that case, the higher level method calls this method for you to determine the correct menu shortcut values.</para> </summary> <param name="key">a ShortcutKeys value </param> <param name="modifier">a ShortcutModifiers value </param> <returns>the .NET Shortcut value that corresponds to the key and modifier value you specify </returns> </member> <member name="M:NationalInstruments.TestStand.Utility.Menus.InsertCommandObjectInMenu(NationalInstruments.TestStand.Interop.UI.Command,System.Windows.Forms.Menu,System.Windows.Forms.MenuItem,System.Boolean)"> <summary> Typically, you call InsertCommandsInMenu instead of this method. However, if you have a TestStand.Interop.UI.Command object for which you want to create a menu item, you can call this method directly. </summary> <param name="command"> Pass the TestStand.Interop.UI.Command object that represent the action the menu item takes when the user selects it. </param> <param name="parentMenu"> Pass the menu into which to insert the menu item. </param> <param name="menuItemToInsertBefore"> The MenuItem before which the method inserts the new menu item. To insert at the end of the menu, pass Nothing (VB) or null (C#) </param> <param name="useShortCutKeys"> Pass false to prevent menu items from having shortcut keys. </param> </member> <member name="M:NationalInstruments.TestStand.Utility.Menus.InsertCommandsInMenu(System.Collections.IList,System.Windows.Forms.Menu,System.Windows.Forms.MenuItem,System.Object,System.Boolean)"> <summary> <para>Use this overload of InsertCommandsInMenu when you do not need to know the actual number of menu items the method inserts.<br></br></para> <para>Refer to the other overload of this method for more information.</para> </summary> <param name="commandTypes">A list in which each element is a TestStand.Interop.UI.CommandKinds value. For each element in the list, the method inserts the corresponding menu item(s) into the menu. </param> <param name="parentMenu">The menu into which the method inserts the menu items </param> <param name="menuItemToInsertBefore"> The MenuItem before which the method inserts the new menu items. To insert at the end of the menu, pass Nothing (VB) or null (C#) </param> <param name="managerControl">Pass the TestStand.Interop.UI.SequenceFileViewMgr or TestStand.Interop.UI.ExecutionViewMgr control, if any, to which the new menu item(s) apply. If the commands do not apply to a view manager control, pass the TestStand.Interop.UI.ApplicationMgr control that you placed on one of your application forms. </param> <param name="useShortCutKeys"> Pass false to prevent menu items from having shortcut keys. </param> </member> <member name="M:NationalInstruments.TestStand.Utility.Menus.RemoveInvalidShortcutKeys(NationalInstruments.TestStand.Interop.UI.Commands)"> <summary> .NET does not support certain keys as menu shortcuts. Call this method to remove shortcuts that .NET does not support from a Commands collection before calling Commands.InsertIntoWin32Menu </summary> <param name="commands"> Pass the TestStand.Interop.UI.Commands object that represent the actions that populate a context menu. </param> </member> <member name="M:NationalInstruments.TestStand.Utility.Menus.InsertCommandsInMenu(System.Collections.IList,System.Windows.Forms.Menu,System.Windows.Forms.MenuItem,System.Object,System.Int32@,System.Boolean)"> <summary> <para>As an alternative to manually writing menu handler code for common TestStand commands, you can use this method to create new menu items that execute the commands you specify without requiring any additional code.</para> <para>To create the menu items, you specify a list of TestStand.Interop.UI.CommandKinds elements. Each element specifies a menu item or group of menu items to insert. To each menu item this method inserts, it attaches a TestStand.Interop.UI.Command object that represents the action the menu item takes. The method installs an event handler for the menu item that automatically invokes the associated command object when the user selects the menu item.</para> <para>Typically, you call this method in response to the MenuStart event to populate the menu with the commands that apply to the current state of the application. Before you call this method, you can call RemoveMenuCommands to remove any menu items you previously inserted.</para> </summary> <param name="commandTypes">A list in which each element is a TestStand.Interop.UI.CommandKinds value. For each element in the list, the method inserts the corresponding menu item(s) into the menu. </param> <param name="parentMenu">The menu into which the method inserts the menu items </param> <param name="menuItemToInsertBefore"> The MenuItem before which the method inserts the new menu items. To insert at the end of the menu, pass Nothing (VB) or null (C#) </param> <param name="managerControl">Pass the TestStand.Interop.UI.SequenceFileViewMgr or TestStand.Interop.UI.ExecutionViewMgr control, if any, to which the new menu item(s) apply. If the commands do not apply to a view manager control, pass the TestStand.Interop.UI.ApplicationMgr control that you placed on one of your application forms. </param> <param name="numInserted">This out parameter returns the number of menu items the method inserts. The number of menu items does not necessarily equal the number of TestStand.Interop.UI.CommandKinds elements you specify because, depending on the CommandType and the state of the application, a single CommandType element might create several menu items or none at all. The parameter counts only items the method adds to the menu you pass. The parameter does not count items the method inserts into submenus the method creates. </param> <param name="useShortCutKeys"> Pass false to prevent menu items from having shortcut keys. </param> </member> <member name="M:NationalInstruments.TestStand.Utility.Menus.InsertCommandCollectionInMenu(NationalInstruments.TestStand.Interop.UI.Commands,System.Windows.Forms.Menu,System.Windows.Forms.MenuItem,System.Boolean)"> <summary>Typically, you call InsertCommandsInMenu instead of this method. However, if you have a TestStand.Interop.UI.CommandCollection object for which you want to create menu items, you can call this method directly. </summary> <param name="commandCollection">A TestStand.Interop.UI.CommandCollection that contains the Commands to place in the menu. </param> <param name="parentMenu"> The menu into which to insert the menu item. </param> <param name="menuItemToInsertBefore"> The MenuItem before which the method inserts the new menu item. To insert at the end of the menu, pass Nothing (VB) or null (C#) </param> <param name="useShortCutKeys"> Pass false to prevent menu items from having shortcut keys. </param> </member> <member name="M:NationalInstruments.TestStand.Utility.Menus.RemoveMenuCommands(System.Windows.Forms.Menu,System.Boolean,System.Boolean)"> <summary> <para>Call this method to remove menus and menu items that you insert with TSUtil methods such as InsertCommandsInMenu. Optionally, you can also remove menu and menu items that you insert by other means.</para> <para>Typically, you call this method when handling a MenuStart event in order to clear the menu so that you can then call InsertCommandsInMenu to populate the menu with items that are appropriate for the current state of the application. </para> </summary> <param name="menu">The method removes any menus or menu items that TSUtil methods create under this menu, including the menu itself. To remove items from all menus, pass the Menu that is the menubar. </param> <param name="removeNonTSMenus"> Pass true to also remove menus that you did not insert by calling a TSUtil method. </param> <param name="removeNonTSItems"> Pass true to also remove menu items that you did not insert by calling a TSUtil method. </param> </member> <member name="M:NationalInstruments.TestStand.Utility.Menus.BeginUpdate(System.Windows.Forms.Form)"> <summary> <para>This method prevents edits made by the Menus class from affecting the visual state of the form's menu.</para> <para>Call this method prior to making changes to a form's menu with the Menu class.</para> <para>After edits are made, call EndUpdate to present the modified menu.</para> </summary> <param name="form">Pass the form which contains the menu being modified. </param> </member> <member name="M:NationalInstruments.TestStand.Utility.Menus.EndUpdate"> <summary> <para>This method restores a form's modified menu and resumes updates.</para> <para>Call this method after making changes to a form's menu using the Menus class.</para> <para>Ensure that each call to EndUpdate is preceded by a call to BeginUpdate</para> <para>(Note: These calls can not be nested).</para> </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Menus.CleanupMenu(System.Windows.Forms.Menu)"> <summary> <para>This method removes any duplicate menu shortcut keys or redundant menu separator bars.</para> <para>If you make multiple calls to InsertCommandsInMenu or if call InsertCommandsInMenu to add to an existing menu, it can be difficult to prevent duplicate shortcut keys and separator bars because the inserted menus item may vary based on the state of the application. Rather than trying to prevent duplicate shortcuts and separators, it is simpler to remove them with this method after you update the menu bar.</para> <para>Typically you call this method on the entire menu bar after you update a menu in response to a MenuStart event.</para> </summary> <param name="menu">Pass the menu to recursively search for duplicate shortcut keys and separator bars. Typically you pass the menu object that represents the menubar for a form. </param> </member> <member name="T:NationalInstruments.TestStand.Utility.Win32"> <summary> Exposes selected Win32 SDK Functions. Typically, you only uses these functions in .NET code when necessary to implement a work-around for a .NET limitation or bug. </summary> </member> <member name="T:NationalInstruments.TestStand.Utility.Win32.CopyDataStruct"> <summary> Data structure for send message </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.CopyDataStruct.SetMessage(System.String)"> <summary> Sets the message of this structure and stores it in global memory in order to be able to send it to another process. If you are calling this method you will need to call the DisposeMessage() method to clean up the used memory. </summary> <param name="message"></param> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.CopyDataStruct.GetMessage"> <summary> Converts the message pointer into a string </summary> <returns>The string in the messages data</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.CopyDataStruct.DisposeMessage"> <summary> Cleans the global memory used in the message </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.PostMessage(System.Runtime.InteropServices.HandleRef,System.UInt32,System.IntPtr,System.IntPtr)"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.SendMessage(System.Runtime.InteropServices.HandleRef,System.UInt32,System.IntPtr,System.IntPtr)"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.GetMenu(System.Runtime.InteropServices.HandleRef)"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.GetKeyState(System.Int32)"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.GetParent(System.Runtime.InteropServices.HandleRef)"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.GetWindowThreadProcessId(System.Runtime.InteropServices.HandleRef,System.UInt32@)"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.LockWindowUpdate(System.Runtime.InteropServices.HandleRef)"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.GetFileTime(System.IntPtr,System.Runtime.InteropServices.ComTypes.FILETIME@,System.Runtime.InteropServices.ComTypes.FILETIME@,System.Runtime.InteropServices.ComTypes.FILETIME@)"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.GetLongPathNameW(System.String,System.Text.StringBuilder,System.Int32)"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.GetFileAttributesW(System.String)"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.SetFileAttributesW(System.String,NationalInstruments.TestStand.Utility.Win32.FileAttributes)"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.FindFirstFileW(System.String,NationalInstruments.TestStand.Utility.Win32.WIN32_FIND_DATAW@)"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.FindNextFileW(System.IntPtr,NationalInstruments.TestStand.Utility.Win32.WIN32_FIND_DATAW@)"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.CreateFileW(System.String,NationalInstruments.TestStand.Utility.Win32.FileAccess,NationalInstruments.TestStand.Utility.Win32.FileShare,System.IntPtr,NationalInstruments.TestStand.Utility.Win32.CreationDisposition,NationalInstruments.TestStand.Utility.Win32.FileAttributes,System.IntPtr)"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.CreateDirectoryW(System.String,System.IntPtr)"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.MoveFileExW(System.String,System.String,NationalInstruments.TestStand.Utility.Win32.MoveFileExFlags)"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.CopyFileW(System.String,System.String,System.Boolean)"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.DeleteFileW(System.String)"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.RemoveDirectoryW(System.String)"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.FindClose(System.IntPtr)"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.GetFileSize(System.IntPtr,System.UInt32@)"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.GetFileSizeEx(System.IntPtr,System.Int64@)"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.WriteFile(System.IntPtr,System.Byte[],System.UInt32,System.UInt32@,System.IntPtr)"> <summary>Refer to Microsoft Win32 SDK Help. We use IntPtr for lpOverLapped here beacuse it is easier to pass null that way. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.GlobalAlloc(System.UInt32,System.UIntPtr)"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.GlobalFree(System.IntPtr)"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.SendStringMessage(System.Runtime.InteropServices.HandleRef,System.UInt32,System.IntPtr,NationalInstruments.TestStand.Utility.Win32.CopyDataStruct@)"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.FindWindow(System.IntPtr,System.String)"> <summary> Refer to Microsoft Win32 SDK Help. Note: Pass IntPtr.Zero for the first parameter. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.FindWindowEx(System.Runtime.InteropServices.HandleRef,System.Runtime.InteropServices.HandleRef,System.String,System.String)"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.SetForegroundWindow(System.Runtime.InteropServices.HandleRef)"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.GetActiveWindow"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.OpenIcon(System.Runtime.InteropServices.HandleRef)"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.IsIconic(System.Runtime.InteropServices.HandleRef)"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.CreateMutex(System.IntPtr,System.Boolean,System.String)"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.WaitForSingleObject(System.IntPtr,System.UInt32)"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.ReleaseMutex(System.IntPtr)"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.CloseHandle(System.IntPtr)"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.LoadLibrary(System.String)"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.FreeLibrary(System.IntPtr)"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.INFINITE"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.WAIT_ABANDONED"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.WAIT_OBJECT_0"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.WAIT_TIMEOUT"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.WAIT_FAILED"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.MAX_PATH"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.WM_QUERYENDSESSION"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.WM_COPYDATA"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.WM_SYSKEYDOWN"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.WM_KEYDOWN"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.WM_ENTERMENULOOP"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.WM_INITMENU"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.WM_EXITMENULOOP"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.BCM_SETSHIELD"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_F1"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_F4"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_F24"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_BACK"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_TAB"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_SHIFT"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_CONTROL"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_PAUSE"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_SPACE"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_PRIOR"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_NEXT"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_END"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_HOME"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_LEFT"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_UP"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_RIGHT"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_DOWN"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_INSERT"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_DELETE"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_NUMPAD0"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_NUMPAD1"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_NUMPAD2"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_NUMPAD3"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_NUMPAD4"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_NUMPAD5"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_NUMPAD6"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_NUMPAD7"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_NUMPAD8"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_NUMPAD9"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_MULTIPLY"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_ADD"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_SUBTRACT"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_DECIMAL"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.VK_DIVIDE"> <summary> Refer to Microsoft Win32 SDK Help. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.ERROR_SUCCESS"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.ERROR_FILE_NOT_FOUND"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.ERROR_PATH_NOT_FOUND"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.ERROR_ACCESS_DENIED"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.ERROR_INVALID_DRIVE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.ERROR_NO_MORE_FILES"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.ERROR_SHARING_VIOLATION"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.ERROR_FILE_EXISTS"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.ERROR_INVALID_NAME"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.ERROR_DIR_NOT_EMPTY"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.ERROR_ALREADY_EXISTS"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.ERROR_FILENAME_EXCED_RANGE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.ERROR_OPERATION_ABORTED"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.REGDB_E_CLASSNOTREG"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="P:NationalInstruments.TestStand.Utility.Win32.INVALID_HANDLE_VALUE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.INVALID_FILE_SIZE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="T:NationalInstruments.TestStand.Utility.Win32.FileAttributes"> <summary>Refer to Microsoft Win32 SDK Help for SetFileAttributes() and GetFileAttributes() functions.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.INVALID_FILE_ATTRIBUTES"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.FILE_ATTRIBUTE_ARCHIVE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.FILE_ATTRIBUTE_COMPRESSED"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.FILE_ATTRIBUTE_DEVICE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.FILE_ATTRIBUTE_DIRECTORY"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.FILE_ATTRIBUTE_ENCRYPTED"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.FILE_ATTRIBUTE_HIDDEN"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.FILE_ATTRIBUTE_NORMAL"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.FILE_ATTRIBUTE_NOT_CONTENT_INDEXED"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.FILE_ATTRIBUTE_OFFLINE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.FILE_ATTRIBUTE_READONLY"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.FILE_ATTRIBUTE_REPARSE_POINT"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.FILE_ATTRIBUTE_SPARSE_FILE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.FILE_ATTRIBUTE_SYSTEM"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.FILE_ATTRIBUTE_TEMPORARY"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.FILE_ATTRIBUTE_VIRTUAL"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.ReadOnly"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.Hidden"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.System"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.Directory"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.Archive"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.Device"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.Normal"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.Temporary"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.SparseFile"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.ReparsePoint"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.Compressed"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.Offline"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.NotContentIndexed"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAttributes.Encrypted"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="T:NationalInstruments.TestStand.Utility.Win32.FileAccess"> <summary>Refer to Microsoft Win32 SDK Help for "File Security and Access Rights," "Generic Access Rights," "File Access Rights Constants," as well as the WinNT.h header file.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.GENERIC_READ"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.GENERIC_WRITE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.GENERIC_EXECUTE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.GENERIC_ALL"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.DELETE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.READ_CONTROL"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.WRITE_DAC"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.WRITE_OWNER"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.SYNCHRONIZE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.STANDARD_RIGHTS_REQUIRED"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.STANDARD_RIGHTS_READ"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.STANDARD_RIGHTS_WRITE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.STANDARD_RIGHTS_EXECUTE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.STANDARD_RIGHTS_ALL"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.SPECIFIC_RIGHTS_ALL"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.FILE_READ_DATA"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.FILE_LIST_DIRECTORY"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.FILE_WRITE_DATA"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.FILE_ADD_FILE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.FILE_APPEND_DATA"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.FILE_ADD_SUBDIRECTORY"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.FILE_CREATE_PIPE_INSTANCE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.FILE_READ_EA"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.FILE_WRITE_EA"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.FILE_EXECUTE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.FILE_TRAVERSE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.FILE_DELETE_CHILD"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.FILE_READ_ATTRIBUTES"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.FILE_WRITE_ATTRIBUTES"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.FILE_ALL_ACCESS"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.FILE_GENERIC_READ"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.FILE_GENERIC_WRITE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileAccess.FILE_GENERIC_EXECUTE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="T:NationalInstruments.TestStand.Utility.Win32.FileShare"> <summary>Refer to Microsoft Win32 SDK Help for the CreateFile() function, "Creating and Opening Files" as well as the WinNT.h header file.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileShare.FILE_SHARE_READ"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileShare.FILE_SHARE_WRITE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.FileShare.FILE_SHARE_DELETE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="T:NationalInstruments.TestStand.Utility.Win32.CreationDisposition"> <summary>Refer to Microsoft Win32 SDK Help for the CreateFile() function.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.CreationDisposition.CREATE_NEW"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.CreationDisposition.CREATE_ALWAYS"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.CreationDisposition.OPEN_EXISTING"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.CreationDisposition.OPEN_ALWAYS"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.CreationDisposition.TRUNCATE_EXISTING"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="T:NationalInstruments.TestStand.Utility.Win32.MoveFileExFlags"> <summary>Refer to Microsoft Win32 SDK Help for MoveFileEx() function.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.MoveFileExFlags.MOVEFILE_REPLACE_EXISTING"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.MoveFileExFlags.MOVEFILE_COPY_ALLOWED"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.MoveFileExFlags.MOVEFILE_DELAY_UNTIL_REBOOT"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.MoveFileExFlags.MOVEFILE_WRITE_THROUGH"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.MoveFileExFlags.MOVEFILE_CREATE_HARDLINK"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.MoveFileExFlags.MOVEFILE_FAIL_IF_NOT_TRACKABLE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="T:NationalInstruments.TestStand.Utility.Win32.WIN32_FIND_DATAW"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.WIN32_FIND_DATAW.dwFileAttributes"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.WIN32_FIND_DATAW.ftCreationTime"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.WIN32_FIND_DATAW.ftLastAccessTime"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.WIN32_FIND_DATAW.ftLastWriteTime"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.WIN32_FIND_DATAW.nFileSizeHigh"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.WIN32_FIND_DATAW.nFileSizeLow"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.WIN32_FIND_DATAW.dwReserved0"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.WIN32_FIND_DATAW.dwReserved1"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.WIN32_FIND_DATAW.cFileName"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.WIN32_FIND_DATAW.cAlternateFileName"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="T:NationalInstruments.TestStand.Utility.Win32.AppBarMessage"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.AppBarMessage.ABM_NEW"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.AppBarMessage.ABM_REMOVE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.AppBarMessage.ABM_QUERYPOS"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.AppBarMessage.ABM_SETPOS"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.AppBarMessage.ABM_GETSTATE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.AppBarMessage.ABM_GETTASKBARPOS"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.AppBarMessage.ABM_ACTIVATE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.AppBarMessage.ABM_GETAUTOHIDEBAR"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.AppBarMessage.ABM_SETAUTOHIDEBAR"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.AppBarMessage.ABM_WINDOWPOSCHANGED"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.AppBarMessage.ABM_SETSTATE"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="T:NationalInstruments.TestStand.Utility.Win32.APPBARDATA"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.APPBARDATA.cbSize"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.APPBARDATA.hWnd"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.APPBARDATA.uCallbackMessage"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.APPBARDATA.uEdge"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.APPBARDATA.rc"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32.APPBARDATA.lParam"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.APPBARDATA.GetNewInstance"> <summary> Create a new instance of <see cref="T:NationalInstruments.TestStand.Utility.Win32.APPBARDATA"/> with <see cref="F:NationalInstruments.TestStand.Utility.Win32.APPBARDATA.cbSize"/> correctly set for the size of the type. </summary> <returns>A new instance of <see cref="T:NationalInstruments.TestStand.Utility.Win32.APPBARDATA"/></returns> </member> <member name="T:NationalInstruments.TestStand.Utility.Win32.RECT"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="P:NationalInstruments.TestStand.Utility.Win32.RECT.Left"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="P:NationalInstruments.TestStand.Utility.Win32.RECT.Top"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="P:NationalInstruments.TestStand.Utility.Win32.RECT.Right"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="P:NationalInstruments.TestStand.Utility.Win32.RECT.Bottom"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="P:NationalInstruments.TestStand.Utility.Win32.RECT.Width"> <summary> Returns the width of the rectangle </summary> </member> <member name="P:NationalInstruments.TestStand.Utility.Win32.RECT.Height"> <summary> Returns the height of the rectangle </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32.SHAppBarMessage(System.UInt32,NationalInstruments.TestStand.Utility.Win32.APPBARDATA@)"> <summary>Refer to Microsoft Win32 SDK Help.</summary> </member> <member name="T:NationalInstruments.TestStand.Utility.Win32Wrap"> <summary> Win32Wrap contains methods that wrap some of the P/Invoke defined calls in the Win32 class. The idea is to shield consumers from detail of calling Win32 methods directly. Win32Wrap methods handle things like buffer sizing, translating Win32 error codes to appropriate exceptions, etc. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.SendSetShieldMessage(System.Runtime.InteropServices.HandleRef,System.Boolean)"> <summary> Call the SendMessage function with the message type <see cref="F:NationalInstruments.TestStand.Utility.Win32.BCM_SETSHIELD"/> to set or unset the UAC shield in the control <paramref name="controlReference"/> </summary> <param name="controlReference"> A <see cref="T:System.Runtime.InteropServices.HandleRef"/> to the control which should display the UAC shield. </param> <param name="setShield">Whether to show or hide the UAC shield.</param> <returns></returns> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.FindWindow(System.String)"> <summary> Call the FindWindow Win API function. This method will return a pointer with a handle to the window if it was found or a null pointer if not found. </summary> <param name="windowTitle"> The window title to match, if empty string or not specified then match all. The window name must be localized by the caller of this method. </param> <returns>A pointer to a window handle which matches the values passed in or a null pointer if no window matches.</returns> <exception cref="T:System.Runtime.InteropServices.COMException">If the FindWindow method returns an error</exception> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.SendStringMessage(System.Runtime.InteropServices.HandleRef,System.UInt32,System.String)"> <summary> Sends the specified message string with the specified code (or WM_USER if not defined) to the window handle specified. In order to get a window handle call FindWindow </summary> <param name="windowHandle">The window handle received from FindWindow</param> <param name="messageCode">The message code to send</param> <param name="messageString">The message string to send</param> <returns>A pointer with information, depends on the message sent</returns> <exception cref="T:System.Runtime.InteropServices.COMException">If the SendMessage method returns an error</exception> <exception cref="T:System.ArgumentNullException">If window handle is null</exception> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.CreateMutex(System.String,System.Boolean)"> <summary> Creates or opens a named or unnamed mutex object. </summary> <param name="mutexName">The name of the mutex object. The name is limited to MAX_PATH characters. Name comparison is case sensitive.</param> <param name="initialOwner"> If this value is true and the caller created the mutex, the calling thread obtains initial ownership of the mutex object. Otherwise, the calling thread does not obtain ownership of the mutex.</param> <returns>A handle to a mutex object.</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.CreateMutex(System.String,System.Boolean@,System.Boolean)"> <summary> Creates a mutex with the name specified and returns a handle to it. </summary> <param name="mutexName">The name of the mutex object. The name is case sensitive.</param> <param name="initialOwner">If the value is true the calling thread obtains initial ownership of the mutex object.</param> <param name="alreadyExists">Returns true if the mutex already existed, false otherwise</param> <returns>A handle to a mutex object.</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.WaitForSingleObject(System.IntPtr,System.UInt32)"> <summary> Waits for the specified mutex and returns true if the mutex was signaled. </summary> <param name="mutex">The mutex reference to wait on, call CallCreateMutex to get it.</param> <param name="timeout">The time out in milliseconds to wait, if not specified wait forever.</param> <returns> True if the mutex was signaled, false if a timeout occurred or if the thread which owned this mutex released it. </returns> <exception cref="T:System.Runtime.InteropServices.COMException">If the function fails</exception> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.ReleaseMutex(System.IntPtr)"> <summary> Releases ownership of the specified mutex object. </summary> <param name="mutex">A handle to a mutex object.</param> <returns>True if the mutex was successfully closed.</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.CloseHandle(System.IntPtr)"> <summary>CloseHandle() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.CloseHandle(System.IntPtr)"/>. It differs in two ways. First, it takes care of checking the return value of Win32.CloseHandle() and throws an appropriate exception. This means that CloseHandle() will generally either return true or throw and exception. The one exception to this rule is if <see cref="P:NationalInstruments.TestStand.Utility.Win32.INVALID_HANDLE_VALUE"/> is passed as the argument. In this case, the wrapper function returns false immediately without ever invoking the Win32 method. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.GetLongPathNameW(System.String)"> <summary>GetLongPathNameW() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.GetLongPathNameW(System.String,System.Text.StringBuilder,System.Int32)"/> that takes care of buffer sizing and converting Win32 error codes to exceptions.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.GetLongPathNameW_Long(System.String)"> <summary>GetLongPathNameW_Long() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.GetLongPathNameW(System.String,System.Text.StringBuilder,System.Int32)"/> that takes care of all of the escaping for paths longer than MAX_PATH, as well as buffer sizing, and converting Win32 error codes to exceptions.</summary> </member> <member name="T:NationalInstruments.TestStand.Utility.Win32Wrap.FindFirstFileW_Wrapper"> <summary>FindFirstFileW_Wrapper is a wrapper around the Win32 FindFirstFileW() / FindNextFileW() / FindClose() functions. It manages the find handle returned by FindFirstFileW(), providing final clean-up via the IDisposable interface. Also, most error scenarios are mapped to appropriate .Net exceptions. (ERROR_FILE_NOT_FOUND for FindFirstFileW() and ERROR_NO_MORE_FILES for FindNextFileW() are treated as status causing false to be returned. These cases do not lead to exceptions.) To use FindFirstFileW_Wrapper, instantiate an empty instance using the no-arg constructor. Initialize the wrapper by calling FindFirstFileW() on it, just as you would normally call FindFirstFileW(). Iterate through the found files by calling FindNextFileW() on the wrapper, just as you would normally call FindNextFileW(). When you are done, you should call Dispose() to clean up. FindClose() has also been provided should you want to keep the wrapper around for later use without holding on to the current find handle. The wrapper can be reused as needed by calling FindFirstFileW(). This will release the current find handle before reinitializing the wrapper.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.FindFirstFileW_Wrapper.IsDots(System.String)"> <summary>Tests if a directory is "." (the current directory) or ".." (the parent directory). This is handy because FindFirstFileW() includes "." and ".." in its returned files when you ask for all files in a directory using the "*" pattern.</summary> <param name="fileName">The file name to test. This is the simple file name, not the full path.</param> <returns>true if fileName is "." or "..", false otherwise.</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.FindFirstFileW_Wrapper.Finalize"> <summary>Finalizer for FindFirstFileW_Wrapper.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.FindFirstFileW_Wrapper.Dispose(System.Boolean)"> <summary>Dispose helper method for disposable pattern described at http://msdn.microsoft.com/en-us/library/system.idisposable.dispose.aspx. </summary> <param name="disposing">true if Dispose(bool) is called from IDisposable.Dispose(), false if Dispose(bool) is called from the finalizer.</param> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.FindFirstFileW_Wrapper.FindClose"> <summary>Close the current find handle, if any, associated with this wrapper. Normally you will not need to invoke FindClose(). You can call FindFirstFileW() to reinitialize the wrapper with a new set of files or Dispose() when you are done. FindClose() will throw an exception if it fails for any reason other than the current handle being INVALID_HANDLE_VALUE.</summary> <returns>true if the current handle was successfully closed, or false if the current handle is invalid.</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.FindFirstFileW_Wrapper.FindFirstFileW(System.String,NationalInstruments.TestStand.Utility.Win32.WIN32_FIND_DATAW@)"> <summary>Closes the existing find handle, if any, and searches a directory for a file or subdirectory with a name that matches a specific name (or partial name if wildcards are used). For paths longer than MAX_PATH, see FindFirstFileW_Long(). FindFirstFileW() will throw an appropriate exception if there is a problem closing the existing find handle (if present) or the underlying Win32 FindFirstFileW() call fails for any reason other than ERROR_FILE_NOT_FOUND. </summary> <param name="fileName">The directory or path, and the file name, which can include wildcard characters, for example, an asterisk (*) or a question mark (?). This parameter should not end in a trailing backslash (\). If the string ends with a wildcard, period (.), or directory name, the user must have access permissions to the root and all subdirectories on the path. To extend the path name limit beyond MAX_PATH to 32,767 wide characters, prepend "\\?\" to the path, or use FindFirstFileW_Long().</param> <param name="findFileData">A WIN32_FIND_DATAW structure that receives information about a found file or directory.</param> <returns>If the function succeeds, the return value is true and the findFileData parameter contains information about the next file or directory found. If no files are found, findFileData is left unchanged and false is returned. </returns> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.FindFirstFileW_Wrapper.FindNextFileW(NationalInstruments.TestStand.Utility.Win32.WIN32_FIND_DATAW@)"> <summary>Continues a file search from a previous call to the FindFirstFileW() or FindFirstFileW_Long() methods.</summary> <param name="findFileData">A WIN32_FIND_DATAW structure that receives information about the found file or subdirectory. FindNextFileW() throws an exception if it encounters an error other than reaching the end of the list. </param> <returns>If the function succeeds, the return value is true and the findFileData parameter contains information about the next file or directory found. If there are no more files, findFileData is left unchanged and false is returned.</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.FindFirstFileW_Wrapper.FindFirstFileW_Long(System.String,NationalInstruments.TestStand.Utility.Win32.WIN32_FIND_DATAW@)"> <summary>This function mimics the behavior of FindFirstFileW(), but works for paths longer than MAX_PATH. Note that paths longer than MAX_PATH cannot be relative and cannot contain wild cards, so we cannot truly duplicate the behavior of FindFirstFileW() for arbitrary paths. Note: This method will escape any path you give it with "\\?\" (or "\\?\UNC\" if appropriate). You should not prepend the "\\?\" to the path yourself.</summary> <param name="fileName">The directory or path, and the file name. The path must be absolute. It cannot use forward slashes to represent path separators, a period to represent the current directory, or double dots to represent the parent directory.</param> <param name="findFileData">A WIN32_FIND_DATAW structure that receives information about a found file or directory.</param> <returns>true if at least one file was found, false if no files were found</returns> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32Wrap.FindFirstFileW_Wrapper.disposed"> <summary>Set to true once Dispose() has been executed once.</summary> </member> <member name="F:NationalInstruments.TestStand.Utility.Win32Wrap.FindFirstFileW_Wrapper.mFindHandle"> <summary>The current find handle we are iterating over.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.CreateFileW(System.String,NationalInstruments.TestStand.Utility.Win32.FileAccess,NationalInstruments.TestStand.Utility.Win32.FileShare,System.IntPtr,NationalInstruments.TestStand.Utility.Win32.CreationDisposition,NationalInstruments.TestStand.Utility.Win32.FileAttributes,System.IntPtr)"> <summary>CreateFileW() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.CreateFileW(System.String,NationalInstruments.TestStand.Utility.Win32.FileAccess,NationalInstruments.TestStand.Utility.Win32.FileShare,System.IntPtr,NationalInstruments.TestStand.Utility.Win32.CreationDisposition,NationalInstruments.TestStand.Utility.Win32.FileAttributes,System.IntPtr)"/> that takes care of converting Win32 error codes to exceptions. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.CreateDirectoryW(System.String,System.IntPtr)"> <summary>CreateDirectoryW() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.CreateDirectoryW(System.String,System.IntPtr)"/> that takes care of converting Win32 error codes to exceptions. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.CreateFileW_Long(System.String,NationalInstruments.TestStand.Utility.Win32.FileAccess,NationalInstruments.TestStand.Utility.Win32.FileShare,System.IntPtr,NationalInstruments.TestStand.Utility.Win32.CreationDisposition,NationalInstruments.TestStand.Utility.Win32.FileAttributes,System.IntPtr)"> <summary>CreateFileW_Long() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.CreateFileW(System.String,NationalInstruments.TestStand.Utility.Win32.FileAccess,NationalInstruments.TestStand.Utility.Win32.FileShare,System.IntPtr,NationalInstruments.TestStand.Utility.Win32.CreationDisposition,NationalInstruments.TestStand.Utility.Win32.FileAttributes,System.IntPtr)"/> that takes care of converting Win32 error codes to exceptions. It also escapes the fileName argument with the appropriate long path prefix (\\?\ or \\?\UNC\).</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.CreateDirectoryW_Long(System.String,System.IntPtr)"> <summary>CreateDirectoryW_Long() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.CreateDirectoryW(System.String,System.IntPtr)"/> that takes care of converting Win32 error codes to exceptions. It also escapes the fileName argument with the appropriate long path prefix (\\?\ or \\?\UNC\).</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.GetFileSizeEx(System.IntPtr)"> <summary>GetFileSizeEx() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.GetFileSizeEx(System.IntPtr,System.Int64@)"/> that takes care of converting Win32 error codes to exceptions. </summary> <returns>The 64-bit file size.</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.WriteFile(System.IntPtr,System.Byte[])"> <summary>WriteFile() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.WriteFile(System.IntPtr,System.Byte[],System.UInt32,System.UInt32@,System.IntPtr)"/> that takes care of converting Win32 error codes to exceptions. It also converts the output numberOfBytesWritten parameter to a return value and passes null for lpOverLapped for convenience. </summary> <param name="hFile">A handle to the file or I/O device (e.g. file, file stream, physical disk, etc.)</param> <param name="lpBuffer">A buffer containing the data to be written to the file or device.</param> <returns>The number of bytes to be written to the file or device.</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.GetFileSize(System.IntPtr)"> <summary>GetFileSize() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.GetFileSize(System.IntPtr,System.UInt32@)"/> that takes care of converting Win32 error codes to exceptions. It also handles the conversion of the 32-bit low and high sizes to a single 64-bit ulong return value.</summary> <returns>The 64-bit file size.</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.MoveFileExW(System.String,System.String,NationalInstruments.TestStand.Utility.Win32.MoveFileExFlags)"> <summary>MoveFileExW() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.MoveFileExW(System.String,System.String,NationalInstruments.TestStand.Utility.Win32.MoveFileExFlags)"/> that takes care of converting Win32 error codes to exceptions. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.MoveFileExW_Long(System.String,System.String,NationalInstruments.TestStand.Utility.Win32.MoveFileExFlags)"> <summary>MoveFileExW_Long() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.MoveFileExW(System.String,System.String,NationalInstruments.TestStand.Utility.Win32.MoveFileExFlags)"/> that takes care of converting Win32 error codes to exceptions. It also escapes the existingFileName and newFileName arguments with the appropriate long path prefix (\\?\ or \\?\UNC\).</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.CopyFileW(System.String,System.String,System.Boolean)"> <summary>CopyFileW() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.CopyFileW(System.String,System.String,System.Boolean)"/> that takes care of converting Win32 error codes to exceptions. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.CopyFileW_Long(System.String,System.String,System.Boolean)"> <summary>CopyFileW_Long() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.CopyFileW(System.String,System.String,System.Boolean)"/> that takes care of converting Win32 error codes to exceptions. It also escapes the existingFileName and newFileName arguments with the appropriate long path prefix (\\?\ or \\?\UNC\).</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.DeleteFileW(System.String)"> <summary>DeleteFileW() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.DeleteFileW(System.String)"/> that takes care of converting Win32 error codes to exceptions. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.RemoveDirectoryW(System.String)"> <summary>RemoveDirectoryW() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.RemoveDirectoryW(System.String)"/> that takes care of converting Win32 error codes to exceptions. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.DeleteFileW_Long(System.String)"> <summary>DeleteFileW_Long() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.DeleteFileW(System.String)"/> that takes care of converting Win32 error codes to exceptions. It also escapes the fileName argument with the appropriate long path prefix (\\?\ or \\?\UNC\).</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.RemoveDirectoryW_Long(System.String)"> <summary>RemoveDirectoryW_Long() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.RemoveDirectoryW(System.String)"/> that takes care of converting Win32 error codes to exceptions. It also escapes the fileName argument with the appropriate long path prefix (\\?\ or \\?\UNC\).</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.GetFileAttributesW(System.String)"> <summary> GetFileAttributesW() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.GetFileAttributesW(System.String)"/> that takes care of converting Win32 error codes to exceptions. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.GetFileAttributesW_Long(System.String)"> <summary> GetFileAttributesW_Long() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.GetFileAttributesW(System.String)"/> that takes care of converting Win32 error codes to exceptions. It also escapes the path argument with the appropriate long path prefix (\\?\ or \\?\UNC\). </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.SetFileAttributesW(System.String,NationalInstruments.TestStand.Utility.Win32.FileAttributes)"> <summary> SetFileAttributesW() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.SetFileAttributesW(System.String,NationalInstruments.TestStand.Utility.Win32.FileAttributes)"/> that takes care of converting Win32 error codes to exceptions. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.SetFileAttributesW_Long(System.String,NationalInstruments.TestStand.Utility.Win32.FileAttributes)"> <summary> SetFileAttributesW_Long() is a wrapper for <see cref="M:NationalInstruments.TestStand.Utility.Win32.SetFileAttributesW(System.String,NationalInstruments.TestStand.Utility.Win32.FileAttributes)"/> that takes care of converting Win32 error codes to exceptions. It also escapes the path argument with the appropriate long path prefix (\\?\ or \\?\UNC\). </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Win32Wrap.ThrowExceptionForLastError"> <summary>This method calls <see cref="M:NationalInstruments.TestStand.Utility.Win32Wrap.ThrowExceptionForWin32Error(System.Int32)"/> on the return value of <see cref="M:System.Runtime.InteropServices.Marshal.GetLastWin32Error"/>.</summary> </member> <member name="T:NationalInstruments.TestStand.Utility.ITestStandLocalizable"> <summary> Use the ITestStandLocalizable to allow a custom user control to be localizable. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.ITestStandLocalizable.Localize(NationalInstruments.TestStand.Interop.API.Engine,System.String)"> <summary> When called, this method will localize the control that it is called in using the <paramref name="engine"/> and <paramref name="category"/>. </summary> <param name="engine">The engine used to localize</param> <param name="category">The category used to localize</param> </member> <member name="T:NationalInstruments.TestStand.Utility.Localizer"> <summary> Use a localizer to localize the Text property of .net menu items or controls. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Localizer.#ctor(NationalInstruments.TestStand.Interop.API.Engine)"> <summary> Creates a new Localizer object. Localizers created with this constructor do not localize all TestStand UI Controls when LocalizeForm is called. </summary> <param name="engine"> The Localizer uses the TestStand engine you pass to obtain the localized text for menu items and controls. </param> </member> <member name="M:NationalInstruments.TestStand.Utility.Localizer.#ctor(NationalInstruments.TestStand.Interop.UI.Ax.AxApplicationMgr)"> <summary> Creates a new Localizer object. </summary> <param name="applicationMgr"> The Localizer uses the TestStand ApplicationMgr you pass to obtain the localized text for menu items and controls. </param> </member> <member name="M:NationalInstruments.TestStand.Utility.Localizer.#ctor(NationalInstruments.TestStand.Interop.UI.ApplicationMgr)"> <summary> Creates a new Localizer object. </summary> <param name="applicationMgr"> The Localizer uses the TestStand ApplicationMgr you pass to obtain the localized text for menu items and controls. </param> </member> <member name="M:NationalInstruments.TestStand.Utility.Localizer.#ctor(NationalInstruments.TestStand.Interop.API.Engine,NationalInstruments.TestStand.Interop.UI.Ax.AxApplicationMgr)"> <summary> Creates a new Localizer object. </summary> <param name="engine"> The Localizer uses the TestStand engine you pass to obtain the localized text for menu items and controls. </param> <param name="applicationMgr"> The Localizer uses the ApplicationMgr you pass to localize text for the TestStand User Interface controls. You can pass null to this parameter if you do not wish to localize UI controls. </param> </member> <member name="P:NationalInstruments.TestStand.Utility.Localizer.Engine"> <remarks> Returns the Engine with which the Localize was constructed. </remarks> </member> <member name="P:NationalInstruments.TestStand.Utility.Localizer.ApplicationMgr"> <remarks> Returns the ApplicationMgr with which the Localizer was constructed. Obsolete, use GetApplicationMgr instead. </remarks> </member> <member name="M:NationalInstruments.TestStand.Utility.Localizer.GetApplicationMgr"> <remarks> Returns the ApplicationMgr with which the Localizer was constructed. </remarks> </member> <member name="M:NationalInstruments.TestStand.Utility.Localizer.LocalizeControls(System.Windows.Forms.Control.ControlCollection,System.String)"> <summary> Localize the collection of controls in <paramref name="controls"/> with the string in <paramref name="category"/> </summary> <param name="controls">The controls collection to localize</param> <param name="category">The category to localize with</param> </member> <member name="M:NationalInstruments.TestStand.Utility.Localizer.LocalizeForm(System.Windows.Forms.Form,System.String,System.Boolean)"> <summary><para>This method localizes the text on a form to the current language the TestStand language setting selects.</para> <para>For each control on a form, this method uses the value of the Control.Text property as a tag to obtain a localized string from the TestStand string resource category you specify. If a localized string with that tag exists, the method replaces the value of the Control.Text property with the localized string. If the tag does not exist, the method does not alter the control text.</para> <para>The method also localizes controls that reside within other controls or tab pages.</para> </summary> <param name="form">Pass the form to localize. </param> <param name="category">Pass the category name of the TestStand string resource section that contains the localized strings for the form. </param> <param name="localizeMenu">Pass true to localize the menu item text for the items in the menu bar of the form. </param> </member> <member name="M:NationalInstruments.TestStand.Utility.Localizer.LocalizeMenu(System.Windows.Forms.Menu,System.String)"> <summary> <para>This method localizes the menu item text to the current language the TestStand language setting selects.</para> <para>For each item in a menu, this method uses the value of the MenuItem.Text property as a tag to obtain a localized string from the TestStand string resource category you specify. If a localized string with that tag exists, the method replaces the value of the MenuItem.Text property with the localized string. If the tag does not exist, the method does not alter the menu item text.</para> <para>The method also localizes menu items that reside within sub-menus.</para> </summary> <param name="menu">Pass the menu to localize. </param> <param name="category">Pass the category name of the TestStand string resource section that contains the localized strings for the menu. </param> </member> <member name="M:NationalInstruments.TestStand.Utility.Localizer.LocalizeContextMenu(System.Windows.Forms.ContextMenuStrip,System.String)"> <summary> Localizes the text in all menu items for a context menu strip to the current language the TestStand language setting selects. For each menu item this method uses the value of the menu item Text property as a tag to obtain a localized string from the string from the TestStand string resource category you specify. If a localized string with that tag exists, the method replaces the value of the Control.Text property with the localized string; if the tag does not exist, the method does not alter the control text. </summary> <param name="menu">Pass the context menu strip to localize</param> <param name="category"> Pass the category name of the TestStand string resource section that contains the localized strings for the form. </param> </member> <member name="M:NationalInstruments.TestStand.Utility.Localizer.LocalizeNotifyIcon(System.Windows.Forms.NotifyIcon,System.String)"> <summary> Localizes the text in a notify icon for a context menu strip to the current language the TestStand language setting selects. For each menu item in the context menu strip this method uses the value of the menu item Text property as a tag to obtain a localized string from the string from the TestStand string resource category you specify. If a localized string with that tag exists, the method replaces the value of the Control.Text property with the localized string; if the tag does not exist, the method does not alter the control text. </summary> <param name="icon">Pass the notify icon to localize</param> <param name="category"> Pass the category name of the TestStand string resource section that contains the localized strings for the form. </param> </member> <member name="T:NationalInstruments.TestStand.Utility.Tiler"> <remarks> You can use this class for tiling forms or other objects when the Form.LayoutMdi method is not adequate or applicable </remarks> </member> <member name="M:NationalInstruments.TestStand.Utility.Tiler.#ctor"> <summary> Use a Tiler object to layout windows or other objects in a square or nearly square grid </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.Tiler.SetNumTiles(System.Int32)"> <summary> Specificies the number of tiles to partition into a square or nearly square grid </summary> <param name="numTiles">The number of tiles to layout in a grid</param> </member> <member name="M:NationalInstruments.TestStand.Utility.Tiler.GetTilePosition(System.Int32,System.Int32@,System.Int32@)"> <summary> Returns the tile coordinates of a specified tile in the grid of tiles </summary> <param name="tileIndex">the index of a tile, from 0 to (number-of-tiles - 1)</param> <param name="x">returns the x position of the tile, from 0 to (max-number-of-tiles-in-a-row - 1)</param> <param name="y">returns the y position of the tile, from 0 to (max-number-of-tiles-in-a-column - 1)</param> </member> <member name="M:NationalInstruments.TestStand.Utility.Tiler.TileWindows(System.Collections.ICollection,System.Drawing.Rectangle)"> <summary> Lays out a collection of forms in a grid within the specified bounds </summary> <param name="forms">a collection of forms</param> <param name="bounds">the rectangle within which to layout the forms</param> </member> <member name="T:NationalInstruments.TestStand.Utility.LayoutPersister"> <remarks> You can use this class for saving and loading control bounds or sizes to/from a TestStand application's configuration file. </remarks> </member> <member name="M:NationalInstruments.TestStand.Utility.LayoutPersister.SaveSizes(NationalInstruments.TestStand.Interop.UI.Ax.AxApplicationMgr,System.Windows.Forms.Control[])"> <summary> Saves the height and width for each of the specified controls into a TestStand application's configuration file. </summary> <param name="applicationMgr">Pass the ApplicationMgr control for the application</param> <param name="controls">Pass any number of controls</param> </member> <member name="M:NationalInstruments.TestStand.Utility.LayoutPersister.SaveSizes(NationalInstruments.TestStand.Interop.UI.Ax.AxApplicationMgr,System.String,System.Windows.Forms.Control[])"> <summary> Saves the height and width for each of the specified controls into a TestStand application's configuration file. This overload let you specify the name of the configuration file property that stores the information. </summary> <param name="applicationMgr">Pass the ApplicationMgr control for the application</param> <param name="configurationPropertyName">Pass the name of the configuration file subproperty that stores the information</param> <param name="controls">Pass any number of controls</param> </member> <member name="M:NationalInstruments.TestStand.Utility.LayoutPersister.SaveBounds(NationalInstruments.TestStand.Interop.UI.Ax.AxApplicationMgr,System.Windows.Forms.Control[])"> <summary> Saves the bounds for each of the specified controls into a TestStand application's configuration file. </summary> <param name="applicationMgr">Pass the ApplicationMgr control for the application</param> <param name="controls">Pass any number of controls</param> </member> <member name="M:NationalInstruments.TestStand.Utility.LayoutPersister.SaveBounds(NationalInstruments.TestStand.Interop.UI.Ax.AxApplicationMgr,System.String,System.Windows.Forms.Control[])"> <summary> Saves the bounds for each of the specified controls into a TestStand application's configuration file. This overload let you specify the name of the configuration file property that stores the information. </summary> <param name="applicationMgr">Pass the ApplicationMgr control for the application</param> <param name="configurationPropertyName">Pass the name of the configuration file subproperty that stores the information</param> <param name="controls">Pass any number of controls</param> </member> <member name="M:NationalInstruments.TestStand.Utility.LayoutPersister.LoadSizes(NationalInstruments.TestStand.Interop.UI.Ax.AxApplicationMgr,System.Windows.Forms.Control[])"> <summary> Loads the height and width for each of the specified controls into a TestStand application's configuration file. You must call LoadSizes and SaveSizes with the same set of controls in the same order. </summary> <param name="applicationMgr">Pass the ApplicationMgr control for the application</param> <param name="controls">Pass any number of controls</param> </member> <member name="M:NationalInstruments.TestStand.Utility.LayoutPersister.LoadSizes(NationalInstruments.TestStand.Interop.UI.Ax.AxApplicationMgr,System.String,System.Windows.Forms.Control[])"> <summary> Loads the height and width for each of the specified controls into a TestStand application's configuration file. You must call LoadSizes and SaveSizes with the same set of controls in the same order. This overload let you specify the name of the configuration file property that stores the information. </summary> <param name="applicationMgr">Pass the ApplicationMgr control for the application</param> <param name="configurationPropertyName">Pass the name of the configuration file subproperty that stores the information</param> <param name="controls">Pass any number of controls</param> </member> <member name="M:NationalInstruments.TestStand.Utility.LayoutPersister.LoadBounds(NationalInstruments.TestStand.Interop.UI.Ax.AxApplicationMgr,System.Windows.Forms.Control[])"> <summary> Loads the bounds for each of the specified controls into a TestStand application's configuration file. You must call LoadBounds and SaveBounds with the same set of controls in the same order. </summary> <param name="applicationMgr">Pass the ApplicationMgr control for the application</param> <param name="controls">Pass any number of controls</param> </member> <member name="M:NationalInstruments.TestStand.Utility.LayoutPersister.LoadBounds(NationalInstruments.TestStand.Interop.UI.Ax.AxApplicationMgr,System.String,System.Windows.Forms.Control[])"> <summary> Loads the bounds for each of the specified controls into a TestStand application's configuration file. You must call LoadBounds and SaveBounds with the same set of controls in the same order. This overload let you specify the name of the configuration file property that stores the information. </summary> <param name="applicationMgr">Pass the ApplicationMgr control for the application</param> <param name="configurationPropertyName">Pass the name of the configuration file subproperty that stores the information</param> <param name="controls">Pass any number of controls</param> </member> <member name="T:NationalInstruments.TestStand.Utility.Splitters"> <remarks> You can use this class to simplify the implementation of splitter bars when using the border properties of TestStand UI Controls. </remarks> </member> <member name="M:NationalInstruments.TestStand.Utility.Splitters.DragSplitter(System.Windows.Forms.Control,System.Windows.Forms.Control,System.Int32,System.Int32,System.Int32,System.Int32,System.Int64)"> <summary> Call this method from the BorderDragged event for a TestStand control that has a drag border enabled in order to resize the control that owns the drag border and the control that shares the area split by the border. This method has been tested only with one or fewer borders per control. It may require modification for use with more than one border per control. /// </summary> <param name="master">Pass the control that receives the BorderDragged event.</param> <param name="slave">Pass the control that shares the area split by the drag border of the master control.</param> <param name="newX">Pass the value of newX received in the BorderDragged event handler.</param> <param name="newY">Pass the value of newY received in the BorderDragged event handler.</param> <param name="newWidth">Pass the value of newWidth received in the BorderDragged event handler.</param> <param name="newHeight">Pass the value of newHeight received in the BorderDragged event handler.</param> <param name="bordersChanged">Pass the value of bordersChanged received in the BorderDragged event handler.</param> </member> <member name="M:NationalInstruments.TestStand.Utility.Splitters.DivideSpaceBetweenPanes(System.Boolean,System.Int32,System.Int32,System.Windows.Forms.Control[])"> <summary> Call this method to divide an area between two or more panes. If the area is larger or smaller than the current sum of the pane sizes, the available area is distributed among the open panes in proportion to their current relative sizes. This method has been tested only with one or fewer borders per control. It may require modification for use with more than one border per control. /// </summary> <param name="verticalSplitter">Pass true if the controls are separated by vertical drag borders that divide a horizontal space. Pass false if the controls are separated by horizontal drag borders that divide a vertical space.</param> <param name="spaceStart">Pass the start of area that the panes share. If the splitters are vertical, pass the X coordinate for the start of the area. If the splitters are horizontal, pass the Y coordinate for the start of the area.</param> <param name="spaceEnd">Pass the end of area that the panes share. If the splitters are vertical, pass the X coordinate for the end of the area. If the splitters are horizontal, pass the Y coordinate for the end of the area.</param> <param name="panes">Pass the controls that share the specified area. For vertical splitters, pass the controls in order from left to right. For horizontal splitters, pass the controls in order from top to bottom.</param> </member> <member name="T:NationalInstruments.TestStand.Utility.ErrorMessage"> <remarks> Use this class to help format error messages </remarks> </member> <member name="M:NationalInstruments.TestStand.Utility.ErrorMessage.AppendCodeAndDescription(NationalInstruments.TestStand.Interop.UI.Ax.AxApplicationMgr,System.String,System.Int64)"> <summary> Returns the errorString with the error code and code description appended to it if the code is a TestStand error code. </summary> <param name="applicationMgr">Pass the ApplicationMgr control for the application</param> <param name="errorMessage">Pass the error message</param> <param name="errorCode">Pass the error code</param> </member> <member name="T:NationalInstruments.TestStand.Utility.ApplicationWrapper"> <remarks> This class exists to provide an exception suppressing wrapper around System.Windows.Forms.Application.Run </remarks> </member> <member name="M:NationalInstruments.TestStand.Utility.ApplicationWrapper.Run(System.Windows.Forms.Form)"> <remarks> This method is identical to System.Windows.Forms.Application.Run() except that it suppresses a harmless exception that can occur during dll unloading if the application exited while a menu is open. The error occurs only in a very specific interaction between Windows forms, Windows timer messages, and COM components. This is a simple workaround. </remarks> </member> <member name="M:NationalInstruments.TestStand.Utility.ApplicationWrapper.Run(System.Windows.Forms.ApplicationContext)"> <remarks> This method is identical to System.Windows.Forms.Application.Run() except that it suppresses a harmless exception that can occur during dll unloading if the application exited while a menu is open. The error occurs only in a very specific interaction between Windows forms, Windows timer messages, and COM components. This is a simple workaround. </remarks> </member> <member name="T:NationalInstruments.TestStand.Utility.LaunchTestStandApplicationInNewDomain"> <remarks> You can use this class to launch the application in a separate AppDomain. This class ensures that the TestStand Engine is destructed after the application exits so that the Engine does not report incorrect object leaks. </remarks> </member> <member name="T:NationalInstruments.TestStand.Utility.LaunchTestStandApplicationInNewDomain.MainEntryPointDelegate"> <summary> Delegate for the main entry point to the application. </summary> </member> <member name="T:NationalInstruments.TestStand.Utility.LaunchTestStandApplicationInNewDomain.MainEntryPointDelegateWithArgs"> <summary> Delegate for the main entry point to the application with command-line arguments </summary> </member> <member name="T:NationalInstruments.TestStand.Utility.LaunchTestStandApplicationInNewDomain.MainEntryPointDelegateWithArgsReturnCode"> <summary> Delegate for the main entry point to the application with command-line arguments and a return code. </summary> <returns></returns> </member> <member name="T:NationalInstruments.TestStand.Utility.LaunchTestStandApplicationInNewDomain.DisplayErrorMessageDelegate"> <summary> Delegate for displaying error messages from the LaunchProtected method </summary> <param name="caption">Receives the caption that should be displayed in the message</param> <param name="message">Receives the error message to display</param> </member> <member name="M:NationalInstruments.TestStand.Utility.LaunchTestStandApplicationInNewDomain.Launch(NationalInstruments.TestStand.Utility.LaunchTestStandApplicationInNewDomain.MainEntryPointDelegateWithArgs,System.String[])"> <summary> Launches the application in a new AppDomain. This method can throw exceptions when using an old 32-bit Engine. Use LaunchProtected instead. </summary> <param name="entryPoint">Pass the main entry point to the application</param> <param name="args">Command-line arguments</param> </member> <member name="M:NationalInstruments.TestStand.Utility.LaunchTestStandApplicationInNewDomain.Launch(NationalInstruments.TestStand.Utility.LaunchTestStandApplicationInNewDomain.MainEntryPointDelegate)"> <summary> Launches the application in a new AppDomain. This method can throw exceptions when using an old 32-bit Engine. Use LaunchProtected instead. </summary> <param name="entryPoint">Pass the main entry point to the application</param> </member> <member name="M:NationalInstruments.TestStand.Utility.LaunchTestStandApplicationInNewDomain.LaunchProtected(NationalInstruments.TestStand.Utility.LaunchTestStandApplicationInNewDomain.MainEntryPointDelegateWithArgs,System.String[],System.String,NationalInstruments.TestStand.Utility.LaunchTestStandApplicationInNewDomain.DisplayErrorMessageDelegate,System.Boolean)"> <summary> Launches the application in a new AppDomain. If the engine cannot be created displays an error message. Handles the specific case that the engine cannot be created in process because a version of TestStand that is only 32-bit is active and this application is 64-bit. </summary> <param name="entryPoint">Pass the main entry point to the application</param> <param name="applicationName">The name of the application to display in an error message in case of errors.</param> <param name="args">Pass the arguments expected by the <paramref name="entryPoint"/> method.</param> <param name="displayErrorMessage">Pass the method to use if an error message needs to be displayed</param> <param name="parseArgs">Pass true to enable the application to parse TestStand specific arguments, such as the "/env" flag, from the command line. Pass false if your application handles all command line arguments manually</param> </member> <member name="M:NationalInstruments.TestStand.Utility.LaunchTestStandApplicationInNewDomain.LaunchProtected(NationalInstruments.TestStand.Utility.LaunchTestStandApplicationInNewDomain.MainEntryPointDelegate,System.String,NationalInstruments.TestStand.Utility.LaunchTestStandApplicationInNewDomain.DisplayErrorMessageDelegate)"> <summary> Launches the application in a new AppDomain. If the engine cannot be created displays an error message. Handles the specific case that the engine cannot be created in process because a version of TestStand that is only 32-bit is active and this application is 64-bit. </summary> <param name="entryPoint">Pass the main entry point to the application</param> <param name="applicationName">The name of the application to display in an error message in case of errors.</param> <param name="displayErrorMessage">Pass the method to use if an error message needs to be displayed</param> </member> <member name="M:NationalInstruments.TestStand.Utility.LaunchTestStandApplicationInNewDomain.LaunchProtectedReturnCode(NationalInstruments.TestStand.Utility.LaunchTestStandApplicationInNewDomain.MainEntryPointDelegateWithArgsReturnCode,System.String[],System.String,NationalInstruments.TestStand.Utility.LaunchTestStandApplicationInNewDomain.DisplayErrorMessageDelegate,System.Boolean)"> <summary> Launches the application in a new AppDomain. If the engine cannot be created displays an error message. Handles the specific case that the engine cannot be created in process because a version of TestStand that is only 32-bit is active and this application is 64-bit. Will return the return code given by entryPoint. If the Application cannot be run or unloaded appropriately, this method will return the code -1000. </summary> <param name="entryPoint"></param> <param name="args"></param> <param name="applicationName"></param> <param name="displayErrorMessage"></param> <param name="parseArgs">Pass true to enable the application to parse TestStand specific arguments, such as the "/env" flag, from the command line. Pass false if your application handles all command line arguments manually</param> <returns></returns> </member> <member name="M:NationalInstruments.TestStand.Utility.LaunchTestStandApplicationInNewDomain.SetEngineEnvironment(System.String)"> <summary> Initialize the environment using the provided path. This method must be called before creating an instance of the TestStand engine. </summary> <param name="engineEnvironmentPath"></param> </member> <member name="T:NationalInstruments.TestStand.Utility.LongPath"> <summary> This is a utilitiy class to help work with path names greater than MAX_PATH. </summary> </member> <member name="F:NationalInstruments.TestStand.Utility.LongPath.DirectorySeparatorChar"> <summary>Provided for convenience. <see cref="F:System.IO.Path.DirectorySeparatorChar"/></summary> </member> <member name="F:NationalInstruments.TestStand.Utility.LongPath.AltDirectorySeparatorChar"> <summary>Provided for convenience. <see cref="F:System.IO.Path.AltDirectorySeparatorChar"/></summary> </member> <member name="F:NationalInstruments.TestStand.Utility.LongPath.VolumeSeparatorChar"> <summary>Provided for convenience. <see cref="F:System.IO.Path.VolumeSeparatorChar"/></summary> </member> <member name="M:NationalInstruments.TestStand.Utility.LongPath.IsPathRooted(System.String)"> <summary>Provided for convenience. <see cref="M:System.IO.Path.IsPathRooted(System.String)"/></summary> </member> <member name="M:NationalInstruments.TestStand.Utility.LongPath.UsesDriveLetter(System.String)"> <summary>Very simple check to see if the path begins with a drive letter (e.g. "C:"). Because UsesDriveLetter() is an internal helper function, it does not normalize the path. You must do that if you want to.</summary> <param name="path">The path to evaluate.</param> <returns>true if path begins with a drive letter; false otherwise.</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.LongPath.IsAbsolute(System.String)"> <summary>Checks if the path is absolute. Because InAbsolute() is an internal helper function, it does not normalize the path. You must do that if you want to.</summary> <param name="path">The path to evaluate.</param> <returns>true if path is absolute; false otherwise.</returns> </member> <member name="T:NationalInstruments.TestStand.Utility.LongPath.PathNotAbsoluteException"> <summary>Long paths cannot be relative. This exception is thrown when one of our path functions encounters a relative path. See also http://msdn.microsoft.com/en-us/library/windows/desktop/aa365247.aspx </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.LongPath.PathNotAbsoluteException.#ctor"> <summary>Construct a new PathNotAbsoluteException.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.LongPath.CheckAndNormalizePath(System.String,System.String,System.Boolean)"> <summary>This is a helper function for methods such as <see cref="M:NationalInstruments.TestStand.Utility.LongPath.GetPathRoot(System.String)"/> and <see cref="M:NationalInstruments.TestStand.Utility.LongPath.GetDirectoryName(System.String)"/>. It checks for conditions that the C# documentation specifies lead to argument exceptions. It also performs normalization. I found when reverse engineering some of the C# path methods that they were implicitly normalizing path arguments in multiple ways: 1. They trim leading and trailing whitespace. 2. They replace all slashes with backslashes. 3. Runs of consecutive directory separators are coalesced. This method performs said normalization. In addition, this method will optionally evaluate "." and ".." chacters. Note that doing so requires path be absolute. If collapseDots is true and path is relative, a PathNotAbsoluteException is thrown. Checking and normalization are combined because some of the checking needs to happen before and some after normalization.</summary> <param name="path">The path to normalize.</param> <param name="paramName">The name of the paramter (to use with exceptions.)</param> <param name="collapseDots">Evaluate the ".." and "." chacters in the specified path.</param> <returns>A normalized version of the path.</returns> <exception cref="T:System.ArgumentException">If the path is empty, contains invalid path characters, or is not of legal form.</exception> </member> <member name="M:NationalInstruments.TestStand.Utility.LongPath.GetDirectoryName(System.String)"> <summary>This function mimics the behavior of <see cref="M:System.IO.Path.GetDirectoryName(System.String)"/> but works on paths longer than MAX_PATH. NOTE: Every attempt was made to make this method match the behavior of Path.GetDirectoryName() as closely as possible, but the actual behavior of Path.GetDirectoryName() is more complex than documented at MSDN. We had to reverse engineer the actual behavior for many cases. Our implementation may miss some corner cases, particularly of the normalization process. This implementation was tested and works for most reasonable cases.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.LongPath.GetFullPath(System.String)"> <summary>This function mimics the behavior of <see cref="M:System.IO.Path.GetFullPath(System.String)"/> but works for paths longer than MAX_PATH. Note that paths longer than MAX_PATH cannot be relative, so we cannot truly duplicate the behavior of Path.GetFullPath() for arbitrary paths. Note: This method will escape any path you give it with "\\?\" (or "\\?\UNC\" if appropriate). You should not prepend the "\\?\" to the path yourself.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.LongPath.GetPathRoot(System.String)"> <summary>This function mimics the behavior of <see cref="M:System.IO.Path.GetPathRoot(System.String)"/> but works on paths longer than MAX_PATH. NOTE: Every attempt was made to make this method match the behavior of Path.GetPathRoot() as closely as possible, but the actual behavior of Path.GetPathRoot() is more complex than documented at MSDN. We had to reverse engineer the actual behavior for many cases. Our implementation may miss some corner cases, particularly of the normalization process. This implementation was tested and works for most reasonable cases.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.LongPath.GetFileName(System.String)"> <summary> Convenience method which calls into <see cref="M:System.IO.Path.GetFileName(System.String)"/> </summary> <param name="path">The path to get the file name for</param> <returns>The file name of the path passed as a parameter.</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.LongPath.Combine(System.String,System.String)"> <summary> Convenience method which calls <see cref="M:System.IO.Path.Combine(System.String,System.String)"/> </summary> <param name="path1">The first path to combine. </param> <param name="path2">The second path to combine. </param> <returns> The combined paths. If one of the specified paths is a zero-length string, this method returns the other path. If <paramref name="path2"/> contains an absolute path, this method returns <paramref name="path2"/>. </returns> </member> <member name="M:NationalInstruments.TestStand.Utility.LongPath.Combine(System.String[])"> <summary> Convenience method which calls <see cref="M:System.IO.Path.Combine(System.String[])"/>. </summary> <param name="paths">An array of parts of the path.</param> <returns>The combined paths.</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.LongPath.GetFileNameWithoutExtension(System.String)"> <summary> Convenience method that calls <see cref="M:System.IO.Path.GetFileNameWithoutExtension(System.String)"/> </summary> <param name="path">The path of the file. </param> <returns> The string returned by <see cref="M:NationalInstruments.TestStand.Utility.LongPath.GetFileName(System.String)"/>, minus the last period (.) and all characters following it. </returns> </member> <member name="M:NationalInstruments.TestStand.Utility.LongPath.GetExtension(System.String)"> <summary> Convenience method that calls <see cref="M:System.IO.Path.GetExtension(System.String)"/> </summary> <param name="path">The path of the file. </param> <returns> The extension of the specified path (including the period "."), or null, or String.Empty. If <paramref name="path"/> is null, GetExtension returns null. If <paramref name="path"/> does not have extension information, GetExtension returns <see cref="F:System.String.Empty"/>. </returns> </member> <member name="M:NationalInstruments.TestStand.Utility.LongPath.GetInvalidFileNameChars"> <summary> Convenience method that calls <see cref="M:System.IO.Path.GetInvalidFileNameChars"/> </summary> <returns>An array containing the characters that are not allowed in file names.</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.LongPath.GetInvalidPathChars"> <summary> Convenience method that calls <see cref="M:System.IO.Path.GetInvalidPathChars"/> </summary> <returns>An array containing the characters that are not allowed in path names.</returns> </member> <member name="T:NationalInstruments.TestStand.Utility.LongFileInfo"> <summary> This is a utility class to help work with path names greater than MAX_PATH </summary> </member> <member name="P:NationalInstruments.TestStand.Utility.LongFileInfo.FullName"> <summary> The full path of the file </summary> </member> <member name="P:NationalInstruments.TestStand.Utility.LongFileInfo.Initialized"> <summary> Whether the values have been initialized. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.LongFileInfo.Refresh"> <summary> Refreshes the information in the long file info structure. </summary> </member> <member name="P:NationalInstruments.TestStand.Utility.LongFileInfo.Length"> <summary> Gets the size, in bytes, of the current file. </summary> <returns>The size of the current file in bytes.</returns> </member> <member name="P:NationalInstruments.TestStand.Utility.LongFileInfo.CreationTime"> <summary> The creation time of the file. Note that this value is initialized the first time it is read and it will not be refreshed unless you manually call refresh. </summary> </member> <member name="P:NationalInstruments.TestStand.Utility.LongFileInfo.LastAccessTime"> <summary> The last time the file was accessed. Note that this value is initialized the first time it is read and it will not be refreshed unless you manually call refresh. </summary> </member> <member name="P:NationalInstruments.TestStand.Utility.LongFileInfo.LastWriteTime"> <summary> The modification time of the file. Note that this value is initialized the first time it is read and it will not be refreshed unless you manually call refresh. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.LongFileInfo.#ctor(System.String)"> <summary> Creates a new instance of LongFileInfo with the file specified by <paramref name="fileName"/> </summary> <param name="fileName">The path of the file</param> </member> <member name="M:NationalInstruments.TestStand.Utility.LongFileInfo.#ctor(System.String,NationalInstruments.TestStand.Utility.Win32.WIN32_FIND_DATAW)"> <summary> Creates a new instance of LongFileInfo using the information contained in <paramref name="fileData"/> to get the date information. </summary> <param name="fullName">The path of the file</param> <param name="fileData">The data structure which contains the dates for the files</param> </member> <member name="T:NationalInstruments.TestStand.Utility.LongFile"> <summary>This is a utilitiy class to help work with path names greater than MAX_PATH.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.LongFile.Exists(System.String)"> <summary> This function mimics the behavior of <see cref="M:System.IO.File.Exists(System.String)"/> but works on paths longer than MAX_PATH. Note that paths longer than MAX_PATH cannot be relative, so we cannot duplicate the behavior of File.Exists() exactly. This Exists() method requires an absolute path (even for short paths). Note: This method will escape any path you give it with "\\?\" (or "\\?\UNC\" if appropriate). You should not prepend the "\\?\" to the path yourself.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.LongFile.Move(System.String,System.String)"> <summary> This function mimics the behavior of <see cref="M:System.IO.File.Move(System.String,System.String)"/> but works on paths longer than MAX_PATH. Note that paths longer than MAX_PATH cannot be relative, so we cannot duplicate the behavior of File.Move() exactly. This Move() method requires an absolute path (even for short paths). Also, the exception behavior is not identical to that specified in File.Move(). You may get different types of <see cref="T:System.IO.IOException"/> than specified. You may also get <see cref="T:System.ComponentModel.Win32Exception"/>. Note: This method will escape any path you give it with "\\?\" (or "\\?\UNC\" if appropriate). You should not prepend the "\\?\" to the paths yourself.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.LongFile.Copy(System.String,System.String)"> <summary> This function mimics the behavior of <see cref="M:System.IO.File.Copy(System.String,System.String)"/> but works on paths longer than MAX_PATH. Note that paths longer than MAX_PATH cannot be relative, so we cannot duplicate the behavior of File.Copy() exactly. This Copy() method requires an absolute path (even for short paths). Also, the exception behavior is not identical to that specified in File.Copy(). You may get different types of <see cref="T:System.IO.IOException"/> than specified. You may also get <see cref="T:System.ComponentModel.Win32Exception"/>. Note: This method will escape any path you give it with "\\?\" (or "\\?\UNC\" if appropriate). You should not prepend the "\\?\" to the paths yourself.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.LongFile.Copy(System.String,System.String,System.Boolean)"> <summary> This function mimics the behavior of <see cref="M:System.IO.File.Copy(System.String,System.String,System.Boolean)"/> but works on paths longer than MAX_PATH. Note that paths longer than MAX_PATH cannot be relative, so we cannot duplicate the behavior of File.Copy() exactly. This Copy() method requires an absolute path (even for short paths). Also, the exception behavior is not identical to that specified in File.Copy(). You may get different types of <see cref="T:System.IO.IOException"/> than specified. You may also get <see cref="T:System.ComponentModel.Win32Exception"/>. Note: This method will escape any path you give it with "\\?\" (or "\\?\UNC\" if appropriate). You should not prepend the "\\?\" to the paths yourself.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.LongFile.Delete(System.String)"> <summary> This function mimics the behavior of <see cref="M:System.IO.File.Delete(System.String)"/> but works on paths longer than MAX_PATH. Note that paths longer than MAX_PATH cannot be relative, so we cannot duplicate the behavior of File.Delete() exactly. This Delete() method requires an absolute path (even for short paths). Also, the exception behavior is not identical to that specified in File.Delete(). You may get different types of <see cref="T:System.IO.IOException"/> than specified. You may also get <see cref="T:System.ComponentModel.Win32Exception"/>. Note: This method will escape any path you give it with "\\?\" (or "\\?\UNC\" if appropriate). You should not prepend the "\\?\" to the path yourself.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.LongFile.GetAttributes(System.String)"> <summary> Gets the FileAttributes of the file on the <paramref name="path"/>. </summary> <param name="path">The path to the file.</param> <returns>The FileAttributes of the file on the path.</returns> </member> <member name="M:NationalInstruments.TestStand.Utility.LongFile.SetAttributes(System.String,NationalInstruments.TestStand.Utility.Win32.FileAttributes)"> <summary> Sets the specified <paramref name="fileAttributes"/> of the file on the specified <paramref name="path"/>. </summary> <param name="path">The path to the file.</param> <param name="fileAttributes">A bitwise combination of the enumeration values.</param> </member> <member name="M:NationalInstruments.TestStand.Utility.LongFile.WriteAllText(System.String,System.String)"> <summary> Creates a new file, writes the specified string to the file, and then closes the file. If the target file already exists, it is overwritten. </summary> <param name="path">The file to write to.</param> <param name="contents">The string to write to the file.</param> </member> <member name="T:NationalInstruments.TestStand.Utility.LongDirectory"> <summary> This is a utilitiy class to help work with path names greater than MAX_PATH. </summary> </member> <member name="M:NationalInstruments.TestStand.Utility.LongDirectory.Exists(System.String)"> <summary> This function mimics the behavior of <see cref="M:System.IO.Directory.Exists(System.String)"/> but works on paths longer than MAX_PATH. Note that paths longer than MAX_PATH cannot be relative, so we cannot duplicate the behavior of Directory.Exists() exactly. This Exists() method requires an absolute path (even for short paths). Note: This method will escape any path you give it with "\\?\" (or "\\?\UNC\" if appropriate). You should not prepend the "\\?\" to the paths yourself.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.LongDirectory.Delete(System.String,System.Boolean)"> <summary> This function mimics the behavior of <see cref="M:System.IO.Directory.Delete(System.String,System.Boolean)"/> but works on paths longer than MAX_PATH. Note that paths longer than MAX_PATH cannot be relative, so we cannot duplicate the behavior of Directory.Delete() exactly. This Delete() method requires an absolute path (even for short paths). Note: This method will escape any path you give it with "\\?\" (or "\\?\UNC\" if appropriate). You should not prepend the "\\?\" to the paths yourself.</summary> </member> <member name="M:NationalInstruments.TestStand.Utility.LongDirectory.CreateDirectory(System.String)"> <summary>This function mimics the behavior of <see cref="M:System.IO.Directory.CreateDirectory(System.String)"/> but works on paths longer than MAX_PATH. Note that paths longer than MAX_PATH cannot be relative, so we cannot duplicate the behavior of Directory.CreateDirectory() exactly. This method requires an absolute path (even for short paths). Note: This method will escape any path you give it with "\\?\" (or "\\?\UNC\" if appropriate). You should not prepend the "\\?\" to the paths yourself. </summary> <param name="path">The directory path to create.</param> </member> <member name="M:NationalInstruments.TestStand.Utility.LongDirectory.GetFiles(System.String)"> <summary>This function mimics the behavior of <see cref="M:System.IO.Directory.GetFiles(System.String)"/> but works on paths longer than MAX_PATH. Note that paths longer than MAX_PATH cannot be relative, so we cannot duplicate the behavior of Directory.GetFiles() exactly. This method requires an absolute path (even for short paths). Note: This method will escape any path you give it with "\\?\" (or "\\?\UNC\" if appropriate). You should not prepend the "\\?\" to the paths yourself. </summary> <param name="path">The full path name of the directory to get files from.</param> </member> <member name="M:NationalInstruments.TestStand.Utility.LongDirectory.GetDirectories(System.String)"> <summary>This function mimics the behavior of <see cref="M:System.IO.Directory.GetDirectories(System.String)"/> but works on paths longer than MAX_PATH. Note that paths longer than MAX_PATH cannot be relative, so we cannot duplicate the behavior of Directory.GetDirectories() exactly. This method requires an absolute path (even for short paths). Note: This method will escape any path you give it with "\\?\" (or "\\?\UNC\" if appropriate). You should not prepend the "\\?\" to the paths yourself. </summary> <param name="path">The full path name of the directory to get directories from.</param> </member> </members> </doc> Libs/Newtonsoft.Json.dllBinary files differ
Libs/Newtonsoft.Json.xml
New file Diff too large Libs/OfficeNpoiHelper.dllBinary files differ
Libs/OfficeNpoiHelper.xml
New file @@ -0,0 +1,68 @@ <?xml version="1.0"?> <doc> <assembly> <name>OfficeNpoiHelper</name> </assembly> <members> <member name="T:OfficeNpoiHelper.ExeclNpoiHelper"> <summary> execl 操作类 </summary> </member> <member name="M:OfficeNpoiHelper.ExeclNpoiHelper.Import(System.String,System.String,System.Int32,System.Int32)"> <summary>读取excel， 默认第一行为表头 </summary> <param name="strFileName">excel文档绝对路径</param> <param name="sheetName">sheet名</param> <param name="HeaderIndex">行头偏移号</param> <param name="rowIndex">内容行偏移量，第一行为表头，内容行从第二行开始则为1</param> <returns>DataTable</returns> </member> <member name="M:OfficeNpoiHelper.ExeclNpoiHelper.Export(System.Data.DataTable,System.String,System.String)"> <summary> DataTable导出到Excel文件 </summary> <param name="dtSource">源DataTable</param> <param name="strHeaderText">表头文本</param> <param name="strFileName">保存位置</param> </member> <member name="M:OfficeNpoiHelper.ExeclNpoiHelper.Export(System.Data.DataTable,System.String)"> <summary> DataTable导出到Excel的MemoryStream </summary> <param name="dtSource">源DataTable</param> <param name="strHeaderText">表头文本</param> </member> <member name="M:OfficeNpoiHelper.ExeclNpoiHelper.ExportByWeb(System.Data.DataTable,System.String,System.String)"> <summary> 用于Web导出 </summary> <param name="dtSource">源DataTable</param> <param name="strHeaderText">表头文本</param> <param name="strFileName">文件名</param> </member> <member name="M:OfficeNpoiHelper.ExeclNpoiHelper.Import(System.String)"> <summary>读取excel 默认第一行为标头 </summary> <param name="strFileName">excel文档路径</param> <returns></returns> </member> <member name="M:OfficeNpoiHelper.OfferHelperExt.ListToDt``1(System.Collections.Generic.IEnumerable{``0})"> <summary> list to datatable </summary> <typeparam name="T"></typeparam> <param name="collection"></param> <returns></returns> </member> <member name="M:OfficeNpoiHelper.DtToList`1.ConvertToModel(System.Data.DataTable)"> <summary> datatable to list </summary> <param name="dt"></param> <returns></returns> </member> </members> </doc> Libs/ParameterHelper.dllBinary files differ
Libs/PathHelper.dllBinary files differ
Libs/PictureHelper.dllBinary files differ
Libs/Plugin.Keygen.dllBinary files differ
Libs/Plugin.dllBinary files differ
Libs/SuperSocket.Common.XML
New file @@ -0,0 +1,1346 @@ <?xml version="1.0"?> <doc> <assembly> <name>SuperSocket.Common</name> </assembly> <members> <member name="P:SuperSocket.Common.ArraySegmentEx`1.Array"> <summary> Gets the array. </summary> </member> <member name="P:SuperSocket.Common.ArraySegmentEx`1.Count"> <summary> Gets the count. </summary> </member> <member name="P:SuperSocket.Common.ArraySegmentEx`1.Offset"> <summary> Gets the offset. </summary> </member> <member name="T:SuperSocket.Common.ArraySegmentList`1"> <summary> ArraySegmentList </summary> <typeparam name="T"></typeparam> </member> <member name="M:SuperSocket.Common.ArraySegmentList`1.#ctor"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Common.ArraySegmentList`1"/> class. </summary> </member> <member name="M:SuperSocket.Common.ArraySegmentList`1.IndexOf(`0)"> <summary> Determines the index of a specific item in the <see cref="T:System.Collections.Generic.IList`1"/>. </summary> <param name="item">The object to locate in the <see cref="T:System.Collections.Generic.IList`1"/>.</param> <returns> The index of <paramref name="item"/> if found in the list; otherwise, -1. </returns> </member> <member name="M:SuperSocket.Common.ArraySegmentList`1.Insert(System.Int32,`0)"> <summary> NotSupported </summary> </member> <member name="M:SuperSocket.Common.ArraySegmentList`1.RemoveAt(System.Int32)"> <summary> NotSupported </summary> </member> <member name="M:SuperSocket.Common.ArraySegmentList`1.Add(`0)"> <summary> NotSupported </summary> </member> <member name="M:SuperSocket.Common.ArraySegmentList`1.Clear"> <summary> NotSupported </summary> </member> <member name="M:SuperSocket.Common.ArraySegmentList`1.Contains(`0)"> <summary> NotSupported </summary> </member> <member name="M:SuperSocket.Common.ArraySegmentList`1.CopyTo(`0[],System.Int32)"> <summary> Copies to. </summary> <param name="array">The array.</param> <param name="arrayIndex">Index of the array.</param> </member> <member name="M:SuperSocket.Common.ArraySegmentList`1.Remove(`0)"> <summary> NotSupported </summary> </member> <member name="M:SuperSocket.Common.ArraySegmentList`1.GetEnumerator"> <summary> NotSupported </summary> </member> <member name="M:SuperSocket.Common.ArraySegmentList`1.System#Collections#IEnumerable#GetEnumerator"> <summary> NotSupported </summary> </member> <member name="M:SuperSocket.Common.ArraySegmentList`1.RemoveSegmentAt(System.Int32)"> <summary> Removes the segment at. </summary> <param name="index">The index.</param> </member> <member name="M:SuperSocket.Common.ArraySegmentList`1.AddSegment(`0[],System.Int32,System.Int32)"> <summary> Adds the segment to the list. </summary> <param name="array">The array.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> </member> <member name="M:SuperSocket.Common.ArraySegmentList`1.AddSegment(`0[],System.Int32,System.Int32,System.Boolean)"> <summary> Adds the segment to the list. </summary> <param name="array">The array.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <param name="toBeCopied">if set to <c>true</c> [to be copied].</param> </member> <member name="M:SuperSocket.Common.ArraySegmentList`1.ClearSegements"> <summary> Clears all the segements. </summary> </member> <member name="M:SuperSocket.Common.ArraySegmentList`1.ToArrayData"> <summary> Read all data in this list to the array data. </summary> <returns></returns> </member> <member name="M:SuperSocket.Common.ArraySegmentList`1.ToArrayData(System.Int32,System.Int32)"> <summary> Read the data in specific range to the array data. </summary> <param name="startIndex">The start index.</param> <param name="length">The length.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.ArraySegmentList`1.TrimEnd(System.Int32)"> <summary> Trims the end. </summary> <param name="trimSize">Size of the trim.</param> </member> <member name="M:SuperSocket.Common.ArraySegmentList`1.SearchLastSegment(SuperSocket.Common.SearchMarkState{`0})"> <summary> Searches the last segment. </summary> <param name="state">The state.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.ArraySegmentList`1.CopyTo(`0[])"> <summary> Copies to. </summary> <param name="to">To.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.ArraySegmentList`1.CopyTo(`0[],System.Int32,System.Int32,System.Int32)"> <summary> Copies to. </summary> <param name="to">To.</param> <param name="srcIndex">Index of the SRC.</param> <param name="toIndex">To index.</param> <param name="length">The length.</param> <returns></returns> </member> <member name="P:SuperSocket.Common.ArraySegmentList`1.Item(System.Int32)"> <summary> Gets or sets the element at the specified index. </summary> <returns> The element at the specified index. </returns> <exception cref="T:System.ArgumentOutOfRangeException"><paramref name="index"/> is not a valid index in the <see cref="T:System.Collections.Generic.IList`1"/>. </exception> <exception cref="T:System.NotSupportedException"> The property is set and the <see cref="T:System.Collections.Generic.IList`1"/> is read-only. </exception> </member> <member name="P:SuperSocket.Common.ArraySegmentList`1.Count"> <summary> Gets the number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1"/>. </summary> <returns> The number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1"/>. </returns> </member> <member name="P:SuperSocket.Common.ArraySegmentList`1.IsReadOnly"> <summary> Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only. </summary> <returns>true if the <see cref="T:System.Collections.Generic.ICollection`1"/> is read-only; otherwise, false. </returns> </member> <member name="P:SuperSocket.Common.ArraySegmentList`1.SegmentCount"> <summary> Gets the segment count. </summary> </member> <member name="T:SuperSocket.Common.ArraySegmentList"> <summary> ArraySegmentList </summary> </member> <member name="M:SuperSocket.Common.ArraySegmentList.Decode(System.Text.Encoding)"> <summary> Decodes bytes to string by the specified encoding. </summary> <param name="encoding">The encoding.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.ArraySegmentList.Decode(System.Text.Encoding,System.Int32,System.Int32)"> <summary> Decodes bytes to string by the specified encoding. </summary> <param name="encoding">The encoding.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.ArraySegmentList.DecodeMask(System.Byte[],System.Int32,System.Int32)"> <summary> Decodes data by the mask. </summary> <param name="mask">The mask.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> </member> <member name="T:SuperSocket.Common.AssemblyUtil"> <summary> Assembly Util Class </summary> </member> <member name="M:SuperSocket.Common.AssemblyUtil.CreateInstance``1(System.String)"> <summary> Creates the instance from type name. </summary> <typeparam name="T"></typeparam> <param name="type">The type.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.AssemblyUtil.CreateInstance``1(System.String,System.Object[])"> <summary> Creates the instance from type name and parameters. </summary> <typeparam name="T"></typeparam> <param name="type">The type.</param> <param name="parameters">The parameters.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.AssemblyUtil.GetType(System.String,System.Boolean,System.Boolean)"> <summary> Gets the type by the full name, also return matched generic type without checking generic type parameters in the name. </summary> <param name="fullTypeName">Full name of the type.</param> <param name="throwOnError">if set to <c>true</c> [throw on error].</param> <param name="ignoreCase">if set to <c>true</c> [ignore case].</param> <returns></returns> </member> <member name="M:SuperSocket.Common.AssemblyUtil.GetImplementTypes``1(System.Reflection.Assembly)"> <summary> Gets the implement types from assembly. </summary> <typeparam name="TBaseType">The type of the base type.</typeparam> <param name="assembly">The assembly.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.AssemblyUtil.GetImplementedObjectsByInterface``1(System.Reflection.Assembly)"> <summary> Gets the implemented objects by interface. </summary> <typeparam name="TBaseInterface">The type of the base interface.</typeparam> <param name="assembly">The assembly.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.AssemblyUtil.GetImplementedObjectsByInterface``1(System.Reflection.Assembly,System.Type)"> <summary> Gets the implemented objects by interface. </summary> <typeparam name="TBaseInterface">The type of the base interface.</typeparam> <param name="assembly">The assembly.</param> <param name="targetType">Type of the target.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.AssemblyUtil.BinaryClone``1(``0)"> <summary> Clone object in binary format. </summary> <typeparam name="T"></typeparam> <param name="target">The target.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.AssemblyUtil.CopyPropertiesTo``1(``0,``0)"> <summary> Copies the properties of one object to another object. </summary> <typeparam name="T"></typeparam> <param name="source">The source.</param> <param name="target">The target.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.AssemblyUtil.CopyPropertiesTo``1(``0,System.Predicate{System.Reflection.PropertyInfo},``0)"> <summary> Copies the properties of one object to another object. </summary> <typeparam name="T"></typeparam> <param name="source">The source.</param> <param name="predict">The properties predict.</param> <param name="target">The target.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.AssemblyUtil.GetAssembliesFromString(System.String)"> <summary> Gets the assemblies from string. </summary> <param name="assemblyDef">The assembly def.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.AssemblyUtil.GetAssembliesFromStrings(System.String[])"> <summary> Gets the assemblies from strings. </summary> <param name="assemblies">The assemblies.</param> <returns></returns> </member> <member name="T:SuperSocket.Common.BinaryUtil"> <summary> Binary util class </summary> </member> <member name="M:SuperSocket.Common.BinaryUtil.IndexOf``1(System.Collections.Generic.IList{``0},``0,System.Int32,System.Int32)"> <summary> Search target from source. </summary> <typeparam name="T"></typeparam> <param name="source">The source.</param> <param name="target">The target.</param> <param name="pos">The pos.</param> <param name="length">The length.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.BinaryUtil.SearchMark``1(System.Collections.Generic.IList{``0},``0[],System.Int32@)"> <summary> Searches the mark from source. </summary> <typeparam name="T"></typeparam> <param name="source">The source.</param> <param name="mark">The mark.</param> <param name="parsedLength">Length of the parsed.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.BinaryUtil.SearchMark``1(System.Collections.Generic.IList{``0},``0[])"> <summary> Searches the mark from source. </summary> <typeparam name="T"></typeparam> <param name="source">The source.</param> <param name="mark">The mark.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.BinaryUtil.SearchMark``1(System.Collections.Generic.IList{``0},System.Int32,System.Int32,``0[])"> <summary> Searches the mark from source. </summary> <typeparam name="T"></typeparam> <param name="source">The source.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <param name="mark">The mark.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.BinaryUtil.SearchMark``1(System.Collections.Generic.IList{``0},System.Int32,System.Int32,``0[],System.Int32@)"> <summary> Searches the mark from source. </summary> <typeparam name="T"></typeparam> <param name="source">The source.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <param name="mark">The mark.</param> <param name="parsedLength">Length of the parsed.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.BinaryUtil.SearchMark``1(System.Collections.Generic.IList{``0},System.Int32,System.Int32,``0[],System.Int32)"> <summary> Searches the mark from source. </summary> <typeparam name="T"></typeparam> <param name="source">The source.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <param name="mark">The mark.</param> <param name="matched">The matched.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.BinaryUtil.SearchMark``1(System.Collections.Generic.IList{``0},System.Int32,System.Int32,``0[],System.Int32,System.Int32@)"> <summary> Searches the mark from source. </summary> <typeparam name="T"></typeparam> <param name="source">The source.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <param name="mark">The mark.</param> <param name="matched">The matched.</param> <param name="parsedLength">Length of the parsed.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.BinaryUtil.SearchMark``1(System.Collections.Generic.IList{``0},System.Int32,System.Int32,SuperSocket.Common.SearchMarkState{``0},System.Int32@)"> <summary> Searches the mark from source. </summary> <typeparam name="T"></typeparam> <param name="source">The source.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <param name="searchState">State of the search.</param> <param name="parsedLength">Length of the parsed.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.BinaryUtil.SearchMark``1(System.Collections.Generic.IList{``0},System.Int32,System.Int32,SuperSocket.Common.SearchMarkState{``0})"> <summary> Searches the mark from source. </summary> <typeparam name="T"></typeparam> <param name="source">The source.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <param name="searchState">State of the search.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.BinaryUtil.StartsWith``1(System.Collections.Generic.IList{``0},``0[])"> <summary> Startses the with. </summary> <typeparam name="T"></typeparam> <param name="source">The source.</param> <param name="mark">The mark.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.BinaryUtil.StartsWith``1(System.Collections.Generic.IList{``0},System.Int32,System.Int32,``0[])"> <summary> Startses the with. </summary> <typeparam name="T"></typeparam> <param name="source">The source.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <param name="mark">The mark.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.BinaryUtil.EndsWith``1(System.Collections.Generic.IList{``0},``0[])"> <summary> Endses the with. </summary> <typeparam name="T"></typeparam> <param name="source">The source.</param> <param name="mark">The mark.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.BinaryUtil.EndsWith``1(System.Collections.Generic.IList{``0},System.Int32,System.Int32,``0[])"> <summary> Endses the with. </summary> <typeparam name="T"></typeparam> <param name="source">The source.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <param name="mark">The mark.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.BinaryUtil.CloneRange``1(System.Collections.Generic.IList{``0},System.Int32,System.Int32)"> <summary> Clones the elements in the specific range. </summary> <typeparam name="T"></typeparam> <param name="source">The source.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <returns></returns> </member> <member name="T:SuperSocket.Common.BufferManager"> <summary> This class creates a single large buffer which can be divided up and assigned to SocketAsyncEventArgs objects for use with each socket I/O operation. This enables bufffers to be easily reused and gaurds against fragmenting heap memory. The operations exposed on the BufferManager class are not thread safe. </summary> </member> <member name="M:SuperSocket.Common.BufferManager.#ctor(System.Int32,System.Int32)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Common.BufferManager"/> class. </summary> <param name="totalBytes">The total bytes.</param> <param name="bufferSize">Size of the buffer.</param> </member> <member name="M:SuperSocket.Common.BufferManager.InitBuffer"> <summary> Allocates buffer space used by the buffer pool </summary> </member> <member name="M:SuperSocket.Common.BufferManager.SetBuffer(System.Net.Sockets.SocketAsyncEventArgs)"> <summary> Assigns a buffer from the buffer pool to the specified SocketAsyncEventArgs object </summary> <returns>true if the buffer was successfully set, else false</returns> </member> <member name="M:SuperSocket.Common.BufferManager.FreeBuffer(System.Net.Sockets.SocketAsyncEventArgs)"> <summary> Removes the buffer from a SocketAsyncEventArg object. This frees the buffer back to the buffer pool </summary> </member> <member name="T:SuperSocket.Common.ConfigurationElementBase"> <summary> ConfigurationElementBase </summary> </member> <member name="M:SuperSocket.Common.ConfigurationElementBase.#ctor"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Common.ConfigurationElementBase"/> class. </summary> </member> <member name="M:SuperSocket.Common.ConfigurationElementBase.#ctor(System.Boolean)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Common.ConfigurationElementBase"/> class. </summary> <param name="nameRequired">if set to <c>true</c> [name required].</param> </member> <member name="M:SuperSocket.Common.ConfigurationElementBase.DeserializeElement(System.Xml.XmlReader,System.Boolean)"> <summary> Reads XML from the configuration file. </summary> <param name="reader">The <see cref="T:System.Xml.XmlReader"/> that reads from the configuration file.</param> <param name="serializeCollectionKey">true to serialize only the collection key properties; otherwise, false.</param> <exception cref="T:System.Configuration.ConfigurationErrorsException">The element to read is locked.- or -An attribute of the current node is not recognized.- or -The lock status of the current node cannot be determined. </exception> </member> <member name="M:SuperSocket.Common.ConfigurationElementBase.OnDeserializeUnrecognizedAttribute(System.String,System.String)"> <summary> Gets a value indicating whether an unknown attribute is encountered during deserialization. </summary> <param name="name">The name of the unrecognized attribute.</param> <param name="value">The value of the unrecognized attribute.</param> <returns> true when an unknown attribute is encountered while deserializing; otherwise, false. </returns> </member> <member name="M:SuperSocket.Common.ConfigurationElementBase.Unmerge(System.Configuration.ConfigurationElement,System.Configuration.ConfigurationElement,System.Configuration.ConfigurationSaveMode)"> <summary> Modifies the <see cref="T:System.Configuration.ConfigurationElement" /> object to remove all values that should not be saved. </summary> <param name="sourceElement">A <see cref="T:System.Configuration.ConfigurationElement" /> at the current level containing a merged view of the properties.</param> <param name="parentElement">The parent <see cref="T:System.Configuration.ConfigurationElement" />, or null if this is the top level.</param> <param name="saveMode">A <see cref="T:System.Configuration.ConfigurationSaveMode" /> that determines which property values to include.</param> </member> <member name="M:SuperSocket.Common.ConfigurationElementBase.SerializeElement(System.Xml.XmlWriter,System.Boolean)"> <summary> Writes the contents of this configuration element to the configuration file when implemented in a derived class. </summary> <param name="writer">The <see cref="T:System.Xml.XmlWriter" /> that writes to the configuration file.</param> <param name="serializeCollectionKey">true to serialize only the collection key properties; otherwise, false.</param> <returns> true if any data was actually serialized; otherwise, false. </returns> </member> <member name="M:SuperSocket.Common.ConfigurationElementBase.OnDeserializeUnrecognizedElement(System.String,System.Xml.XmlReader)"> <summary> Gets a value indicating whether an unknown element is encountered during deserialization. </summary> <param name="elementName">The name of the unknown subelement.</param> <param name="reader">The <see cref="T:System.Xml.XmlReader"/> being used for deserialization.</param> <returns> true when an unknown element is encountered while deserializing; otherwise, false. </returns> <exception cref="T:System.Configuration.ConfigurationErrorsException">The element identified by <paramref name="elementName"/> is locked.- or -One or more of the element's attributes is locked.- or -<paramref name="elementName"/> is unrecognized, or the element has an unrecognized attribute.- or -The element has a Boolean attribute with an invalid value.- or -An attempt was made to deserialize a property more than once.- or -An attempt was made to deserialize a property that is not a valid member of the element.- or -The element cannot contain a CDATA or text element.</exception> </member> <member name="P:SuperSocket.Common.ConfigurationElementBase.Name"> <summary> Gets the name. </summary> </member> <member name="P:SuperSocket.Common.ConfigurationElementBase.Options"> <summary> Gets the options. </summary> </member> <member name="P:SuperSocket.Common.ConfigurationElementBase.OptionElements"> <summary> Gets the option elements. </summary> </member> <member name="T:SuperSocket.Common.ConfigurationExtension"> <summary> Configuration extension class </summary> </member> <member name="M:SuperSocket.Common.ConfigurationExtension.GetValue(System.Collections.Specialized.NameValueCollection,System.String)"> <summary> Gets the value from namevalue collection by key. </summary> <param name="collection">The collection.</param> <param name="key">The key.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.ConfigurationExtension.GetValue(System.Collections.Specialized.NameValueCollection,System.String,System.String)"> <summary> Gets the value from namevalue collection by key. </summary> <param name="collection">The collection.</param> <param name="key">The key.</param> <param name="defaultValue">The default value.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.ConfigurationExtension.Deserialize``1(``0,System.Xml.XmlReader)"> <summary> Deserializes the specified configuration section. </summary> <typeparam name="TElement">The type of the element.</typeparam> <param name="section">The section.</param> <param name="reader">The reader.</param> </member> <member name="M:SuperSocket.Common.ConfigurationExtension.DeserializeChildConfig``1(System.String)"> <summary> Deserializes the child configuration. </summary> <typeparam name="TConfig">The type of the configuration.</typeparam> <param name="childConfig">The child configuration string.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.ConfigurationExtension.GetChildConfig``1(System.Collections.Specialized.NameValueCollection,System.String)"> <summary> Gets the child config. </summary> <typeparam name="TConfig">The type of the config.</typeparam> <param name="childElements">The child elements.</param> <param name="childConfigName">Name of the child config.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.ConfigurationExtension.GetConfigSource(System.Configuration.ConfigurationElement)"> <summary> Gets the config source path. </summary> <param name="config">The config.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.ConfigurationExtension.LoadFrom(System.Configuration.ConfigurationElement,System.Object)"> <summary> Loads configuration element's node information from a model. </summary> <param name="configElement">The config element.</param> <param name="source">The source.</param> <exception cref="T:System.Exception">Cannot find expected property 'Item' from the type 'ConfigurationElement'.</exception> </member> <member name="M:SuperSocket.Common.ConfigurationExtension.GetCurrentConfiguration(System.Configuration.ConfigurationElement)"> <summary> Gets the current configuration of the configuration element. </summary> <returns>The current configuration.</returns> <param name="configElement">Configuration element.</param> </member> <member name="M:SuperSocket.Common.ConfigurationExtension.ResetConfiguration(System.AppDomain,System.String)"> <summary> Reset application's configuration to a another config file </summary> <param name="appDomain">the assosiated AppDomain</param> <param name="configFilePath">the config file path want to reset to</param> </member> <member name="T:SuperSocket.Common.DictionaryExtension"> <summary> Extension class for IDictionary </summary> </member> <member name="M:SuperSocket.Common.DictionaryExtension.GetValue``1(System.Collections.Generic.IDictionary{System.Object,System.Object},System.Object)"> <summary> Gets the value by key. </summary> <typeparam name="T"></typeparam> <param name="dictionary">The dictionary.</param> <param name="key">The key.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.DictionaryExtension.GetValue``1(System.Collections.Generic.IDictionary{System.Object,System.Object},System.Object,``0)"> <summary> Gets the value by key and default value. </summary> <typeparam name="T"></typeparam> <param name="dictionary">The dictionary.</param> <param name="key">The key.</param> <param name="defaultValue">The default value.</param> <returns></returns> </member> <member name="T:SuperSocket.Common.ErrorEventArgs"> <summary> EventArgs for error and exception </summary> </member> <member name="M:SuperSocket.Common.ErrorEventArgs.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Common.ErrorEventArgs"/> class. </summary> <param name="message">The message.</param> </member> <member name="M:SuperSocket.Common.ErrorEventArgs.#ctor(System.Exception)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Common.ErrorEventArgs"/> class. </summary> <param name="exception">The exception.</param> </member> <member name="P:SuperSocket.Common.ErrorEventArgs.Exception"> <summary> Gets the exception. </summary> </member> <member name="T:SuperSocket.Common.GenericConfigurationElementCollectionBase`2"> <summary> GenericConfigurationElementCollectionBase </summary> <typeparam name="TConfigElement">The type of the config element.</typeparam> <typeparam name="TConfigInterface">The type of the config interface.</typeparam> </member> <member name="M:SuperSocket.Common.GenericConfigurationElementCollectionBase`2.CreateNewElement"> <summary> When overridden in a derived class, creates a new <see cref="T:System.Configuration.ConfigurationElement"/>. </summary> <returns> A new <see cref="T:System.Configuration.ConfigurationElement"/>. </returns> </member> <member name="M:SuperSocket.Common.GenericConfigurationElementCollectionBase`2.GetElementKey(System.Configuration.ConfigurationElement)"> <summary> Gets the element key for a specified configuration element when overridden in a derived class. </summary> <param name="element">The <see cref="T:System.Configuration.ConfigurationElement"/> to return the key for.</param> <returns> An <see cref="T:System.Object"/> that acts as the key for the specified <see cref="T:System.Configuration.ConfigurationElement"/>. </returns> </member> <member name="M:SuperSocket.Common.GenericConfigurationElementCollectionBase`2.GetEnumerator"> <summary> Returns an enumerator that iterates through the collection. </summary> <returns> A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection. </returns> </member> <member name="P:SuperSocket.Common.GenericConfigurationElementCollectionBase`2.Item(System.Int32)"> <summary> Gets or sets a property, attribute, or child element of this configuration element. </summary> <returns>The specified property, attribute, or child element</returns> </member> <member name="T:SuperSocket.Common.GenericConfigurationElementCollection`2"> <summary> GenericConfigurationElementCollection </summary> <typeparam name="TConfigElement">The type of the config element.</typeparam> <typeparam name="TConfigInterface">The type of the config interface.</typeparam> </member> <member name="M:SuperSocket.Common.GenericConfigurationElementCollection`2.GetElementKey(System.Configuration.ConfigurationElement)"> <summary> Gets the element key. </summary> <param name="element">The element.</param> <returns></returns> </member> <member name="T:SuperSocket.Common.Platform"> <summary> This class is designed for detect platform attribute in runtime </summary> </member> <member name="P:SuperSocket.Common.Platform.SupportSocketIOControlByCodeEnum"> <summary> Gets a value indicating whether [support socket IO control by code enum]. </summary> <value> <c>true</c> if [support socket IO control by code enum]; otherwise, <c>false</c>. </value> </member> <member name="P:SuperSocket.Common.Platform.IsMono"> <summary> Gets a value indicating whether this instance is mono. </summary> <value> <c>true</c> if this instance is mono; otherwise, <c>false</c>. </value> </member> <member name="T:SuperSocket.Common.SearchMarkState`1"> <summary> SearchMarkState </summary> <typeparam name="T"></typeparam> </member> <member name="M:SuperSocket.Common.SearchMarkState`1.#ctor(`0[])"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Common.SearchMarkState`1"/> class. </summary> <param name="mark">The mark.</param> </member> <member name="P:SuperSocket.Common.SearchMarkState`1.Mark"> <summary> Gets the mark. </summary> </member> <member name="P:SuperSocket.Common.SearchMarkState`1.Matched"> <summary> Gets or sets whether matched already. </summary> <value> The matched. </value> </member> <member name="T:SuperSocket.Common.SendingQueue"> <summary> SendingQueue </summary> </member> <member name="M:SuperSocket.Common.SendingQueue.#ctor(System.ArraySegment{System.Byte}[],System.Int32,System.Int32)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Common.SendingQueue"/> class. </summary> <param name="globalQueue">The global queue.</param> <param name="offset">The offset.</param> <param name="capacity">The capacity.</param> </member> <member name="M:SuperSocket.Common.SendingQueue.Enqueue(System.ArraySegment{System.Byte},System.UInt16)"> <summary> Enqueues the specified item. </summary> <param name="item">The item.</param> <param name="trackID">The track ID.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.SendingQueue.Enqueue(System.Collections.Generic.IList{System.ArraySegment{System.Byte}},System.UInt16)"> <summary> Enqueues the specified items. </summary> <param name="items">The items.</param> <param name="trackID">The track ID.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.SendingQueue.StopEnqueue"> <summary> Stops the enqueue, and then wait all current excueting enqueu threads exit. </summary> </member> <member name="M:SuperSocket.Common.SendingQueue.StartEnqueue"> <summary> Starts to allow enqueue. </summary> </member> <member name="M:SuperSocket.Common.SendingQueue.IndexOf(System.ArraySegment{System.Byte})"> <summary> Determines the index of a specific item in the <see cref="T:System.Collections.Generic.IList`1"/>. </summary> <param name="item">The object to locate in the <see cref="T:System.Collections.Generic.IList`1"/>.</param> <returns> The index of <paramref name="item"/> if found in the list; otherwise, -1. </returns> <exception cref="T:System.NotSupportedException"></exception> </member> <member name="M:SuperSocket.Common.SendingQueue.Insert(System.Int32,System.ArraySegment{System.Byte})"> <summary> Inserts an item to the <see cref="T:System.Collections.Generic.IList`1"/> at the specified index. </summary> <param name="index">The zero-based index at which <paramref name="item"/> should be inserted.</param> <param name="item">The object to insert into the <see cref="T:System.Collections.Generic.IList`1"/>.</param> <exception cref="T:System.NotSupportedException"></exception> </member> <member name="M:SuperSocket.Common.SendingQueue.RemoveAt(System.Int32)"> <summary> Removes the <see cref="T:System.Collections.Generic.IList`1"/> item at the specified index. </summary> <param name="index">The zero-based index of the item to remove.</param> <exception cref="T:System.NotSupportedException"></exception> </member> <member name="M:SuperSocket.Common.SendingQueue.Add(System.ArraySegment{System.Byte})"> <summary> Adds an item to the <see cref="T:System.Collections.Generic.ICollection`1"/>. </summary> <param name="item">The object to add to the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param> <exception cref="T:System.NotSupportedException"></exception> </member> <member name="M:SuperSocket.Common.SendingQueue.Clear"> <summary> Removes all items from the <see cref="T:System.Collections.Generic.ICollection`1"/>. </summary> <exception cref="T:System.NotSupportedException"></exception> </member> <member name="M:SuperSocket.Common.SendingQueue.Contains(System.ArraySegment{System.Byte})"> <summary> Determines whether the <see cref="T:System.Collections.Generic.ICollection`1"/> contains a specific value. </summary> <param name="item">The object to locate in the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param> <returns> true if <paramref name="item"/> is found in the <see cref="T:System.Collections.Generic.ICollection`1"/>; otherwise, false. </returns> <exception cref="T:System.NotSupportedException"></exception> </member> <member name="M:SuperSocket.Common.SendingQueue.CopyTo(System.ArraySegment{System.Byte}[],System.Int32)"> <summary> Copies to. </summary> <param name="array">The array.</param> <param name="arrayIndex">Index of the array.</param> </member> <member name="M:SuperSocket.Common.SendingQueue.Remove(System.ArraySegment{System.Byte})"> <summary> Removes the first occurrence of a specific object from the <see cref="T:System.Collections.Generic.ICollection`1"/>. </summary> <param name="item">The object to remove from the <see cref="T:System.Collections.Generic.ICollection`1"/>.</param> <returns> true if <paramref name="item"/> was successfully removed from the <see cref="T:System.Collections.Generic.ICollection`1"/>; otherwise, false. This method also returns false if <paramref name="item"/> is not found in the original <see cref="T:System.Collections.Generic.ICollection`1"/>. </returns> <exception cref="T:System.NotSupportedException"></exception> </member> <member name="M:SuperSocket.Common.SendingQueue.GetEnumerator"> <summary> Returns an enumerator that iterates through the collection. </summary> <returns> A <see cref="T:System.Collections.Generic.IEnumerator`1"/> that can be used to iterate through the collection. </returns> <exception cref="T:System.NotSupportedException"></exception> </member> <member name="M:SuperSocket.Common.SendingQueue.System#Collections#IEnumerable#GetEnumerator"> <summary> Returns an enumerator that iterates through a collection. </summary> <returns> An <see cref="T:System.Collections.IEnumerator"/> object that can be used to iterate through the collection. </returns> <exception cref="T:System.NotSupportedException"></exception> </member> <member name="M:SuperSocket.Common.SendingQueue.InternalTrim(System.Int32)"> <summary> Trim the internal segments at the begining by the binary data size. </summary> <param name="offset">The binary data size should be trimed at the begining.</param> </member> <member name="P:SuperSocket.Common.SendingQueue.TrackID"> <summary> Gets the track ID. </summary> <value> The track ID. </value> </member> <member name="P:SuperSocket.Common.SendingQueue.GlobalQueue"> <summary> Gets the global queue. </summary> <value> The global queue. </value> </member> <member name="P:SuperSocket.Common.SendingQueue.Offset"> <summary> Gets the offset. </summary> <value> The offset. </value> </member> <member name="P:SuperSocket.Common.SendingQueue.Capacity"> <summary> Gets the capacity. </summary> <value> The capacity. </value> </member> <member name="P:SuperSocket.Common.SendingQueue.Count"> <summary> Gets the number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1" />. </summary> <returns>The number of elements contained in the <see cref="T:System.Collections.Generic.ICollection`1" />.</returns> </member> <member name="P:SuperSocket.Common.SendingQueue.Position"> <summary> Gets or sets the position. </summary> <value> The position. </value> </member> <member name="P:SuperSocket.Common.SendingQueue.Item(System.Int32)"> <summary> Gets or sets the element at the specified index. </summary> <param name="index">The index.</param> <returns></returns> <exception cref="T:System.NotSupportedException"></exception> </member> <member name="P:SuperSocket.Common.SendingQueue.IsReadOnly"> <summary> Gets a value indicating whether the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only. </summary> <returns>true if the <see cref="T:System.Collections.Generic.ICollection`1" /> is read-only; otherwise, false.</returns> </member> <member name="T:SuperSocket.Common.SendingQueueSourceCreator"> <summary> SendingQueueSourceCreator </summary> </member> <member name="T:SuperSocket.Common.ISmartPoolSourceCreator`1"> <summary> ISmartPoolSourceCreator </summary> <typeparam name="T"></typeparam> </member> <member name="M:SuperSocket.Common.ISmartPoolSourceCreator`1.Create(System.Int32,`0[]@)"> <summary> Creates the specified size. </summary> <param name="size">The size.</param> <param name="poolItems">The pool items.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.SendingQueueSourceCreator.#ctor(System.Int32)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Common.SendingQueueSourceCreator"/> class. </summary> <param name="sendingQueueSize">Size of the sending queue.</param> </member> <member name="M:SuperSocket.Common.SendingQueueSourceCreator.Create(System.Int32,SuperSocket.Common.SendingQueue[]@)"> <summary> Creates the specified size. </summary> <param name="size">The size.</param> <param name="poolItems">The pool items.</param> <returns></returns> </member> <member name="T:SuperSocket.Common.IPoolInfo"> <summary> The pool information class </summary> </member> <member name="P:SuperSocket.Common.IPoolInfo.MinPoolSize"> <summary> Gets the min size of the pool. </summary> <value> The min size of the pool. </value> </member> <member name="P:SuperSocket.Common.IPoolInfo.MaxPoolSize"> <summary> Gets the max size of the pool. </summary> <value> The max size of the pool. </value> </member> <member name="P:SuperSocket.Common.IPoolInfo.AvialableItemsCount"> <summary> Gets the avialable items count. </summary> <value> The avialable items count. </value> </member> <member name="P:SuperSocket.Common.IPoolInfo.TotalItemsCount"> <summary> Gets the total items count, include items in the pool and outside the pool. </summary> <value> The total items count. </value> </member> <member name="T:SuperSocket.Common.ISmartPool`1"> <summary> The basic interface of smart pool </summary> <typeparam name="T"></typeparam> </member> <member name="M:SuperSocket.Common.ISmartPool`1.Initialize(System.Int32,System.Int32,SuperSocket.Common.ISmartPoolSourceCreator{`0})"> <summary> Initializes the specified min pool size. </summary> <param name="minPoolSize">The min size of the pool.</param> <param name="maxPoolSize">The max size of the pool.</param> <param name="sourceCreator">The source creator.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.ISmartPool`1.Push(`0)"> <summary> Pushes the specified item into the pool. </summary> <param name="item">The item.</param> </member> <member name="M:SuperSocket.Common.ISmartPool`1.TryGet(`0@)"> <summary> Tries to get one item from the pool. </summary> <param name="item">The item.</param> <returns></returns> </member> <member name="T:SuperSocket.Common.ISmartPoolSource"> <summary> ISmartPoolSource </summary> </member> <member name="P:SuperSocket.Common.ISmartPoolSource.Count"> <summary> Gets the count. </summary> <value> The count. </value> </member> <member name="T:SuperSocket.Common.SmartPoolSource"> <summary> SmartPoolSource </summary> </member> <member name="M:SuperSocket.Common.SmartPoolSource.#ctor(System.Object,System.Int32)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Common.SmartPoolSource"/> class. </summary> <param name="source">The source.</param> <param name="itemsCount">The items count.</param> </member> <member name="P:SuperSocket.Common.SmartPoolSource.Source"> <summary> Gets the source. </summary> <value> The source. </value> </member> <member name="P:SuperSocket.Common.SmartPoolSource.Count"> <summary> Gets the count. </summary> <value> The count. </value> </member> <member name="T:SuperSocket.Common.SmartPool`1"> <summary> The smart pool </summary> <typeparam name="T"></typeparam> </member> <member name="M:SuperSocket.Common.SmartPool`1.Initialize(System.Int32,System.Int32,SuperSocket.Common.ISmartPoolSourceCreator{`0})"> <summary> Initializes the specified min and max pool size. </summary> <param name="minPoolSize">The min size of the pool.</param> <param name="maxPoolSize">The max size of the pool.</param> <param name="sourceCreator">The source creator.</param> </member> <member name="M:SuperSocket.Common.SmartPool`1.Push(`0)"> <summary> Pushes the specified item into the pool. </summary> <param name="item">The item.</param> </member> <member name="M:SuperSocket.Common.SmartPool`1.TryGet(`0@)"> <summary> Tries to get one item from the pool. </summary> <param name="item">The item.</param> <returns></returns> <exception cref="T:System.NotImplementedException"></exception> </member> <member name="P:SuperSocket.Common.SmartPool`1.MinPoolSize"> <summary> Gets the size of the min pool. </summary> <value> The size of the min pool. </value> </member> <member name="P:SuperSocket.Common.SmartPool`1.MaxPoolSize"> <summary> Gets the size of the max pool. </summary> <value> The size of the max pool. </value> </member> <member name="P:SuperSocket.Common.SmartPool`1.AvialableItemsCount"> <summary> Gets the avialable items count. </summary> <value> The avialable items count. </value> </member> <member name="P:SuperSocket.Common.SmartPool`1.TotalItemsCount"> <summary> Gets the total items count, include items in the pool and outside the pool. </summary> <value> The total items count. </value> </member> <member name="T:SuperSocket.Common.SocketEx"> <summary> Socket extension class </summary> </member> <member name="M:SuperSocket.Common.SocketEx.SafeClose(System.Net.Sockets.Socket)"> <summary> Close the socket safely. </summary> <param name="socket">The socket.</param> </member> <member name="M:SuperSocket.Common.SocketEx.SendData(System.Net.Sockets.Socket,System.Byte[])"> <summary> Sends the data. </summary> <param name="client">The client.</param> <param name="data">The data.</param> </member> <member name="M:SuperSocket.Common.SocketEx.SendData(System.Net.Sockets.Socket,System.Byte[],System.Int32,System.Int32)"> <summary> Sends the data. </summary> <param name="client">The client.</param> <param name="data">The data.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> </member> <member name="T:SuperSocket.Common.StringExtension"> <summary> String extension class </summary> <summary> String extension </summary> </member> <member name="M:SuperSocket.Common.StringExtension.ToInt32(System.String)"> <summary> Convert string to int32. </summary> <param name="source">The source.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.StringExtension.ToInt32(System.String,System.Int32)"> <summary> Convert string to int32. </summary> <param name="source">The source.</param> <param name="defaultValue">The default value.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.StringExtension.ToLong(System.String)"> <summary> Convert string to long. </summary> <param name="source">The source.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.StringExtension.ToLong(System.String,System.Int64)"> <summary> Convert string to long. </summary> <param name="source">The source.</param> <param name="defaultValue">The default value.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.StringExtension.ToShort(System.String)"> <summary> Convert string to short. </summary> <param name="source">The source.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.StringExtension.ToShort(System.String,System.Int16)"> <summary> Convert string to short. </summary> <param name="source">The source.</param> <param name="defaultValue">The default value.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.StringExtension.ToDecimal(System.String)"> <summary> Convert string to decimal. </summary> <param name="source">The source.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.StringExtension.ToDecimal(System.String,System.Decimal)"> <summary> Convert string to decimal. </summary> <param name="source">The source.</param> <param name="defaultValue">The default value.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.StringExtension.ToDateTime(System.String)"> <summary> Convert string to date time. </summary> <param name="source">The source.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.StringExtension.ToDateTime(System.String,System.DateTime)"> <summary> Convert string to date time. </summary> <param name="source">The source.</param> <param name="defaultValue">The default value.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.StringExtension.ToBoolean(System.String)"> <summary> Convert string to boolean. </summary> <param name="source">The source.</param> <returns></returns> </member> <member name="M:SuperSocket.Common.StringExtension.ToBoolean(System.String,System.Boolean)"> <summary> Convert string tp boolean. </summary> <param name="source">The source.</param> <param name="defaultValue">if set to <c>true</c> [default value].</param> <returns></returns> </member> <member name="M:SuperSocket.Common.StringExtension.TryParseEnum``1(System.String,System.Boolean,``0@)"> <summary> Tries parse string to enum. </summary> <typeparam name="T">the enum type</typeparam> <param name="value">The value.</param> <param name="ignoreCase">if set to <c>true</c> [ignore case].</param> <param name="enumValue">The enum value.</param> <returns></returns> </member> <member name="T:SuperSocket.Common.TheadPoolEx"> <summary> Thread pool extension class </summary> </member> <member name="M:SuperSocket.Common.TheadPoolEx.ResetThreadPool(System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32},System.Nullable{System.Int32})"> <summary> Resets the thread pool. </summary> <param name="maxWorkingThreads">The max working threads.</param> <param name="maxCompletionPortThreads">The max completion port threads.</param> <param name="minWorkingThreads">The min working threads.</param> <param name="minCompletionPortThreads">The min completion port threads.</param> <returns></returns> </member> </members> </doc> Libs/SuperSocket.Common.dllBinary files differ
Libs/SuperSocket.Facility.XML
New file @@ -0,0 +1,601 @@ <?xml version="1.0"?> <doc> <assembly> <name>SuperSocket.Facility</name> </assembly> <members> <member name="T:SuperSocket.Facility.PolicyServer.FlashPolicyServer"> <summary> Flash policy AppServer </summary> </member> <member name="T:SuperSocket.Facility.PolicyServer.PolicyServer"> <summary> PolicyServer base class </summary> </member> <member name="M:SuperSocket.Facility.PolicyServer.PolicyServer.#ctor"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Facility.PolicyServer.PolicyServer"/> class. </summary> </member> <member name="M:SuperSocket.Facility.PolicyServer.PolicyServer.Setup(SuperSocket.SocketBase.Config.IRootConfig,SuperSocket.SocketBase.Config.IServerConfig)"> <summary> Setups the specified root config. </summary> <param name="rootConfig">The root config.</param> <param name="config">The config.</param> <returns></returns> </member> <member name="M:SuperSocket.Facility.PolicyServer.PolicyServer.SetupPolicyResponse(System.Byte[])"> <summary> Setups the policy response. </summary> <param name="policyFileData">The policy file data.</param> <returns></returns> </member> <member name="M:SuperSocket.Facility.PolicyServer.PolicyServer.GetPolicyFileResponse(System.Net.IPEndPoint)"> <summary> Gets the policy file response. </summary> <param name="clientEndPoint">The client end point.</param> <returns></returns> </member> <member name="M:SuperSocket.Facility.PolicyServer.PolicyServer.ProcessRequest(SuperSocket.Facility.PolicyServer.PolicySession,System.Byte[])"> <summary> Processes the request. </summary> <param name="session">The session.</param> <param name="data">The data.</param> </member> <member name="P:SuperSocket.Facility.PolicyServer.PolicyServer.PolicyResponse"> <summary> Gets the policy response. </summary> </member> <member name="M:SuperSocket.Facility.PolicyServer.FlashPolicyServer.#ctor"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Facility.PolicyServer.FlashPolicyServer"/> class. </summary> </member> <member name="M:SuperSocket.Facility.PolicyServer.FlashPolicyServer.SetupPolicyResponse(System.Byte[])"> <summary> Setups the policy response. </summary> <param name="policyFileData">The policy file data.</param> <returns></returns> </member> <member name="T:SuperSocket.Facility.PolicyServer.PolicyReceiveFilter"> <summary> PolicyReceiveFilter </summary> </member> <member name="T:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1"> <summary> FixedSizeReceiveFilter </summary> <typeparam name="TRequestInfo">The type of the request info.</typeparam> </member> <member name="F:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1.NullRequestInfo"> <summary> Null RequestInfo </summary> </member> <member name="M:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1.#ctor(System.Int32)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1"/> class. </summary> <param name="size">The size.</param> </member> <member name="M:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1.Filter(System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)"> <summary> Filters the specified session. </summary> <param name="readBuffer">The read buffer.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <param name="toBeCopied">if set to <c>true</c> [to be copied].</param> <param name="rest">The rest.</param> <returns></returns> </member> <member name="M:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1.ProcessMatchedRequest(System.Byte[],System.Int32,System.Int32,System.Boolean)"> <summary> Filters the buffer after the server receive the enough size of data. </summary> <param name="buffer">The buffer.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <param name="toBeCopied">if set to <c>true</c> [to be copied].</param> <returns></returns> </member> <member name="M:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1.Reset"> <summary> Resets this instance. </summary> </member> <member name="P:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1.Size"> <summary> Gets the size of the fixed size Receive filter. </summary> </member> <member name="P:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1.LeftBufferSize"> <summary> Gets the size of the rest buffer. </summary> <value> The size of the rest buffer. </value> </member> <member name="P:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1.NextReceiveFilter"> <summary> Gets the next Receive filter. </summary> </member> <member name="P:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1.SuperSocket#SocketBase#Protocol#IOffsetAdapter#OffsetDelta"> <summary> Gets the offset delta. </summary> </member> <member name="P:SuperSocket.Facility.Protocol.FixedSizeReceiveFilter`1.State"> <summary> Gets the filter state. </summary> <value> The filter state. </value> </member> <member name="M:SuperSocket.Facility.PolicyServer.PolicyReceiveFilter.#ctor(System.Int32)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Facility.PolicyServer.PolicyReceiveFilter"/> class. </summary> <param name="size">The size.</param> </member> <member name="M:SuperSocket.Facility.PolicyServer.PolicyReceiveFilter.ProcessMatchedRequest(System.Byte[],System.Int32,System.Int32,System.Boolean)"> <summary> Filters the buffer after the server receive the enough size of data. </summary> <param name="buffer">The buffer.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <param name="toBeCopied">if set to <c>true</c> [to be copied].</param> <returns></returns> </member> <member name="M:SuperSocket.Facility.PolicyServer.PolicyReceiveFilterFactory.#ctor(System.Int32)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Facility.PolicyServer.PolicyReceiveFilterFactory"/> class. </summary> <param name="fixRequestSize">Size of the fix request.</param> </member> <member name="M:SuperSocket.Facility.PolicyServer.PolicyReceiveFilterFactory.CreateFilter(SuperSocket.SocketBase.IAppServer,SuperSocket.SocketBase.IAppSession,System.Net.IPEndPoint)"> <summary> Creates the filter. </summary> <param name="appServer">The app server.</param> <param name="appSession">The app session.</param> <param name="remoteEndPoint">The remote end point.</param> <returns></returns> </member> <member name="P:SuperSocket.Facility.PolicyServer.PolicyReceiveFilterFactory.FixRequestSize"> <summary> Gets the size of the fix request. </summary> <value> The size of the fix request. </value> </member> <member name="T:SuperSocket.Facility.PolicyServer.PolicySession"> <summary> PolicySession </summary> </member> <member name="T:SuperSocket.Facility.PolicyServer.SilverlightPolicyServer"> <summary> Silverlight policy AppServer </summary> </member> <member name="M:SuperSocket.Facility.PolicyServer.SilverlightPolicyServer.#ctor"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Facility.PolicyServer.SilverlightPolicyServer"/> class. </summary> </member> <member name="M:SuperSocket.Facility.PolicyServer.SilverlightPolicyServer.ProcessRequest(SuperSocket.Facility.PolicyServer.PolicySession,System.Byte[])"> <summary> Processes the request. </summary> <param name="session">The session.</param> <param name="data">The data.</param> </member> <member name="T:SuperSocket.Facility.Protocol.BeginEndMarkReceiveFilter`1"> <summary> ReceiveFilter for the protocol that each request has bengin and end mark </summary> <typeparam name="TRequestInfo">The type of the request info.</typeparam> </member> <member name="F:SuperSocket.Facility.Protocol.BeginEndMarkReceiveFilter`1.NullRequestInfo"> <summary> Null request info </summary> </member> <member name="M:SuperSocket.Facility.Protocol.BeginEndMarkReceiveFilter`1.#ctor(System.Byte[],System.Byte[])"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.BeginEndMarkReceiveFilter`1"/> class. </summary> <param name="beginMark">The begin mark.</param> <param name="endMark">The end mark.</param> </member> <member name="M:SuperSocket.Facility.Protocol.BeginEndMarkReceiveFilter`1.Filter(System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)"> <summary> Filters the specified session. </summary> <param name="readBuffer">The read buffer.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <param name="toBeCopied">if set to <c>true</c> [to be copied].</param> <param name="rest">The rest.</param> <returns></returns> </member> <member name="M:SuperSocket.Facility.Protocol.BeginEndMarkReceiveFilter`1.ProcessMatchedRequest(System.Byte[],System.Int32,System.Int32)"> <summary> Processes the matched request. </summary> <param name="readBuffer">The read buffer.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <returns></returns> </member> <member name="M:SuperSocket.Facility.Protocol.BeginEndMarkReceiveFilter`1.Reset"> <summary> Resets this instance. </summary> </member> <member name="T:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1"> <summary> This Receive filter is designed for this kind protocol: each request has fixed count part which splited by a char(byte) for instance, request is defined like this "#12122#23343#4545456565#343435446#", because this request is splited into many parts by 5 '#', we can create a Receive filter by CountSpliterRequestFilter((byte)'#', 5) </summary> <typeparam name="TRequestInfo">The type of the request info.</typeparam> </member> <member name="F:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1.NullRequestInfo"> <summary> Null request info instance </summary> </member> <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1.#ctor(System.Byte,System.Int32)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1"/> class. </summary> <param name="spliter">The spliter.</param> <param name="spliterCount">The spliter count.</param> </member> <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1.Filter(System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)"> <summary> Filters the specified session. </summary> <param name="readBuffer">The read buffer.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <param name="toBeCopied">if set to <c>true</c> [to be copied].</param> <param name="rest">The rest.</param> <returns></returns> </member> <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1.ProcessMatchedRequest(System.Byte[],System.Int32,System.Int32)"> <summary> Processes the matched request. </summary> <param name="readBuffer">The read buffer.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <returns></returns> </member> <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1.Reset"> <summary> Resets this instance. </summary> </member> <member name="P:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1.LeftBufferSize"> <summary> Gets the size of the rest buffer. </summary> <value> The size of the rest buffer. </value> </member> <member name="P:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1.NextReceiveFilter"> <summary> Gets the next Receive filter. </summary> </member> <member name="P:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1.OffsetDelta"> <summary> Gets the offset delta relative original receiving offset which will be used for next round receiving. </summary> </member> <member name="P:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter`1.State"> <summary> Gets the filter state. </summary> <value> The filter state. </value> </member> <member name="T:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter"> <summary> This Receive filter is designed for this kind protocol: each request has fixed count part which splited by a char(byte) for instance, request is defined like this "#12122#23343#4545456565#343435446#", because this request is splited into many parts by 5 '#', we can create a Receive filter by CountSpliterRequestFilter((byte)'#', 5) </summary> </member> <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter.#ctor(System.Byte,System.Int32)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter"/> class. </summary> <param name="spliter">The spliter.</param> <param name="spliterCount">The spliter count.</param> </member> <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter.#ctor(System.Byte,System.Int32,System.Text.Encoding)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter"/> class. </summary> <param name="spliter">The spliter.</param> <param name="spliterCount">The spliter count.</param> <param name="encoding">The encoding.</param> </member> <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter.#ctor(System.Byte,System.Int32,System.Text.Encoding,System.Int32)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter"/> class. </summary> <param name="spliter">The spliter.</param> <param name="spliterCount">The spliter count.</param> <param name="encoding">The encoding.</param> <param name="keyIndex">Index of the key.</param> </member> <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilter.ProcessMatchedRequest(System.Byte[],System.Int32,System.Int32)"> <summary> Processes the matched request. </summary> <param name="readBuffer">The read buffer.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <returns></returns> </member> <member name="T:SuperSocket.Facility.Protocol.CountSpliterReceiveFilterFactory`2"> <summary> ReceiveFilterFactory for CountSpliterReceiveFilter </summary> <typeparam name="TRequestFilter">The type of the Receive filter.</typeparam> <typeparam name="TRequestInfo">The type of the request info.</typeparam> </member> <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilterFactory`2.CreateFilter(SuperSocket.SocketBase.IAppServer,SuperSocket.SocketBase.IAppSession,System.Net.IPEndPoint)"> <summary> Creates the filter. </summary> <param name="appServer">The app server.</param> <param name="appSession">The app session.</param> <param name="remoteEndPoint">The remote end point.</param> <returns></returns> </member> <member name="T:SuperSocket.Facility.Protocol.CountSpliterReceiveFilterFactory`1"> <summary> ReceiveFilterFactory for CountSpliterReceiveFilter </summary> <typeparam name="TRequestFilter">The type of the Receive filter.</typeparam> </member> <member name="T:SuperSocket.Facility.Protocol.CountSpliterReceiveFilterFactory"> <summary> receiveFilterFactory for CountSpliterRequestFilter </summary> </member> <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilterFactory.#ctor(System.Byte,System.Int32)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.CountSpliterReceiveFilterFactory"/> class. </summary> <param name="spliter">The spliter.</param> <param name="count">The count.</param> </member> <member name="M:SuperSocket.Facility.Protocol.CountSpliterReceiveFilterFactory.CreateFilter(SuperSocket.SocketBase.IAppServer,SuperSocket.SocketBase.IAppSession,System.Net.IPEndPoint)"> <summary> Creates the filter. </summary> <param name="appServer">The app server.</param> <param name="appSession">The app session.</param> <param name="remoteEndPoint">The remote end point.</param> <returns></returns> </member> <member name="T:SuperSocket.Facility.Protocol.FixedHeaderReceiveFilter`1"> <summary> FixedHeaderReceiveFilter, it is the Receive filter base for the protocol which define fixed length header and the header contains the request body length, you can implement your own Receive filter for this kind protocol easily by inheriting this class </summary> <typeparam name="TRequestInfo">The type of the request info.</typeparam> </member> <member name="M:SuperSocket.Facility.Protocol.FixedHeaderReceiveFilter`1.#ctor(System.Int32)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.FixedHeaderReceiveFilter`1"/> class. </summary> <param name="headerSize">Size of the header.</param> </member> <member name="M:SuperSocket.Facility.Protocol.FixedHeaderReceiveFilter`1.Filter(System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)"> <summary> Filters the specified session. </summary> <param name="readBuffer">The read buffer.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <param name="toBeCopied">if set to <c>true</c> [to be copied].</param> <param name="rest">The rest.</param> <returns></returns> </member> <member name="M:SuperSocket.Facility.Protocol.FixedHeaderReceiveFilter`1.ProcessMatchedRequest(System.Byte[],System.Int32,System.Int32,System.Boolean)"> <summary> Processes the fix size request. </summary> <param name="buffer">The buffer.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <param name="toBeCopied">if set to <c>true</c> [to be copied].</param> <returns></returns> </member> <member name="M:SuperSocket.Facility.Protocol.FixedHeaderReceiveFilter`1.GetBodyLengthFromHeader(System.Byte[],System.Int32,System.Int32)"> <summary> Gets the body length from header. </summary> <param name="header">The header.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <returns></returns> </member> <member name="M:SuperSocket.Facility.Protocol.FixedHeaderReceiveFilter`1.ResolveRequestInfo(System.ArraySegment{System.Byte},System.Byte[],System.Int32,System.Int32)"> <summary> Resolves the request data. </summary> <param name="header">The header.</param> <param name="bodyBuffer">The body buffer.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <returns></returns> </member> <member name="M:SuperSocket.Facility.Protocol.FixedHeaderReceiveFilter`1.Reset"> <summary> Resets this instance. </summary> </member> <member name="T:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1"> <summary> HttpReceiveFilterBase </summary> <typeparam name="TRequestInfo">The type of the request info.</typeparam> </member> <member name="F:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1.NewLine"> <summary> Http header terminator </summary> </member> <member name="F:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1.m_HeaderParsed"> <summary> indicate whether the header has been parsed </summary> </member> <member name="M:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1.#ctor"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1"/> class. </summary> </member> <member name="M:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1.Filter(System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)"> <summary> Filters the specified session. </summary> <param name="readBuffer">The read buffer.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <param name="toBeCopied">if set to <c>true</c> [to be copied].</param> <param name="rest">The rest.</param> <returns></returns> </member> <member name="M:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1.FilterRequestBody(System.Byte[],System.Int32,System.Int32,System.Boolean,System.Int32@)"> <summary> Filters the request body. </summary> <param name="readBuffer">The read buffer.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <param name="toBeCopied">if set to <c>true</c> [to be copied].</param> <param name="rest">The rest data size.</param> <returns></returns> </member> <member name="M:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1.ProcessMatchedRequest(System.Byte[],System.Int32,System.Int32)"> <summary> Resolves the specified data. </summary> <param name="data">The data.</param> <param name="offset">The offset.</param> <param name="length">The length.</param> <returns></returns> </member> <member name="M:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1.FilterRequestHeader(System.Collections.Specialized.NameValueCollection)"> <summary> Filters the request header. </summary> <param name="header">The header.</param> <returns> return the parsed request info from header; if the request has body, this method should return null </returns> </member> <member name="M:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1.Reset"> <summary> Resets this instance to inital state. </summary> </member> <member name="P:SuperSocket.Facility.Protocol.HttpReceiveFilterBase`1.HeaderItems"> <summary> Gets the header items. </summary> </member> <member name="T:SuperSocket.Facility.Protocol.IHttpRequestInfo"> <summary> IHttpRequestInfo </summary> </member> <member name="P:SuperSocket.Facility.Protocol.IHttpRequestInfo.Header"> <summary> Gets the http header. </summary> </member> <member name="T:SuperSocket.Facility.Protocol.HttpRequestInfoBase"> <summary> HttpRequestInfoBase </summary> </member> <member name="M:SuperSocket.Facility.Protocol.HttpRequestInfoBase.#ctor(System.String,System.Collections.Specialized.NameValueCollection)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.HttpRequestInfoBase"/> class. </summary> <param name="key">The key.</param> <param name="header">The header.</param> </member> <member name="P:SuperSocket.Facility.Protocol.HttpRequestInfoBase.Key"> <summary> Gets the key of this request. </summary> </member> <member name="P:SuperSocket.Facility.Protocol.HttpRequestInfoBase.Header"> <summary> Gets the http header. </summary> </member> <member name="T:SuperSocket.Facility.Protocol.HttpRequestInfoBase`1"> <summary> HttpRequestInfoBase </summary> <typeparam name="TRequestBody">The type of the request body.</typeparam> </member> <member name="M:SuperSocket.Facility.Protocol.HttpRequestInfoBase`1.#ctor(System.String,System.Collections.Specialized.NameValueCollection,`0)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.Facility.Protocol.HttpRequestInfoBase`1"/> class. </summary> <param name="key">The key.</param> <param name="header">The header.</param> <param name="body">The body.</param> </member> <member name="P:SuperSocket.Facility.Protocol.HttpRequestInfoBase`1.Body"> <summary> Gets the body. </summary> </member> <member name="T:SuperSocket.Facility.Protocol.MimeHeaderHelper"> <summary> MimeHeader Helper class </summary> </member> <member name="M:SuperSocket.Facility.Protocol.MimeHeaderHelper.ParseHttpHeader(System.String,System.Collections.Specialized.NameValueCollection)"> <summary> Parses the HTTP header. </summary> <param name="headerData">The header data.</param> <param name="header">The header.</param> </member> </members> </doc> Libs/SuperSocket.Facility.dllBinary files differ
Libs/SuperSocket.SocketBase.XML
New file Diff too large Libs/SuperSocket.SocketBase.dllBinary files differ
Libs/SuperSocket.SocketEngine.XML
New file @@ -0,0 +1,1291 @@ <?xml version="1.0"?> <doc> <assembly> <name>SuperSocket.SocketEngine</name> </assembly> <members> <member name="T:SuperSocket.SocketEngine.AppDomainAppServer"> <summary> AppDomainAppServer </summary> </member> <member name="M:SuperSocket.SocketEngine.IsolationAppServer.InitializeLifetimeService"> <summary> Obtains a lifetime service object to control the lifetime policy for this instance. Return null, never expired </summary> <returns> An object of type <see cref="T:System.Runtime.Remoting.Lifetime.ILease" /> used to control the lifetime policy for this instance. This is the current lifetime service object for this instance if one exists; otherwise, a new lifetime service object initialized to the value of the <see cref="P:System.Runtime.Remoting.Lifetime.LifetimeServices.LeaseManagerPollTime" /> property. </returns> <PermissionSet> <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="RemotingConfiguration, Infrastructure" /> </PermissionSet> </member> <member name="P:SuperSocket.SocketEngine.IsolationAppServer.StatusMetadataExtended"> <summary> Gets a value indicating whether [status metadata extended]. </summary> <value> <c>true</c> if [status metadata extended]; otherwise, <c>false</c>. </value> </member> <member name="M:SuperSocket.SocketEngine.AppDomainAppServer.#ctor(System.String,SuperSocket.SocketBase.Metadata.StatusInfoAttribute[])"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.AppDomainAppServer"/> class. </summary> <param name="serverTypeName">Name of the server type.</param> <param name="serverStatusMetadata">The server status metadata.</param> </member> <member name="M:SuperSocket.SocketEngine.AppDomainAppServer.Start"> <summary> Starts this server instance. </summary> <returns> return true if start successfull, else false </returns> </member> <member name="M:SuperSocket.SocketEngine.WorkItemFactoryInfoLoader.ValidateProviderType(System.String)"> <summary> Validates the type of the provider, needn't validate in default mode, because it will be validate later when initializing. </summary> <param name="typeName">Name of the type.</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.WorkItemFactoryInfoLoader.GetServerTypeMetadata(System.String)"> <summary> Gets the app server type's metadata, the return value is not required in this mode. </summary> <param name="typeName">Name of the type.</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.WorkItemFactoryInfoLoader.Dispose"> <summary> Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. </summary> </member> <member name="T:SuperSocket.SocketEngine.DefaultBootstrap"> <summary> SuperSocket default bootstrap </summary> </member> <member name="F:SuperSocket.SocketEngine.DefaultBootstrap.m_Initialized"> <summary> Indicates whether the bootstrap is initialized </summary> </member> <member name="F:SuperSocket.SocketEngine.DefaultBootstrap.m_Config"> <summary> Global configuration </summary> </member> <member name="F:SuperSocket.SocketEngine.DefaultBootstrap.m_GlobalLog"> <summary> Global log </summary> </member> <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.#ctor(System.Collections.Generic.IEnumerable{SuperSocket.SocketBase.IWorkItem})"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.DefaultBootstrap"/> class. </summary> <param name="appServers">The app servers.</param> </member> <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.#ctor(SuperSocket.SocketBase.Config.IRootConfig,System.Collections.Generic.IEnumerable{SuperSocket.SocketBase.IWorkItem})"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.DefaultBootstrap"/> class. </summary> <param name="rootConfig">The root config.</param> <param name="appServers">The app servers.</param> </member> <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.#ctor(SuperSocket.SocketBase.Config.IRootConfig,System.Collections.Generic.IEnumerable{SuperSocket.SocketBase.IWorkItem},SuperSocket.SocketBase.Logging.ILogFactory)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.DefaultBootstrap"/> class. </summary> <param name="rootConfig">The root config.</param> <param name="appServers">The app servers.</param> <param name="logFactory">The log factory.</param> </member> <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.#ctor(SuperSocket.SocketBase.Config.IConfigurationSource)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.DefaultBootstrap"/> class. </summary> <param name="config">The config.</param> </member> <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.#ctor(SuperSocket.SocketBase.Config.IConfigurationSource,System.String)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.DefaultBootstrap"/> class. </summary> <param name="config">The config.</param> <param name="startupConfigFile">The startup config file.</param> </member> <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.CreateWorkItemInstance(System.String,SuperSocket.SocketBase.Metadata.StatusInfoAttribute[])"> <summary> Creates the work item instance. </summary> <param name="serviceTypeName">Name of the service type.</param> <param name="serverStatusMetadata">The server status metadata.</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.GetWorkItemFactoryInfoLoader(SuperSocket.SocketBase.Config.IConfigurationSource,SuperSocket.SocketBase.Logging.ILogFactory)"> <summary> Gets the work item factory info loader. </summary> <param name="config">The config.</param> <param name="logFactory">The log factory.</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.Initialize(System.Collections.Generic.IDictionary{System.String,System.Net.IPEndPoint})"> <summary> Initializes the bootstrap with a listen endpoint replacement dictionary </summary> <param name="listenEndPointReplacement">The listen end point replacement.</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.Initialize(System.Func{SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.Config.IServerConfig},SuperSocket.SocketBase.Logging.ILogFactory)"> <summary> Initializes the bootstrap with the configuration, config resolver and log factory. </summary> <param name="serverConfigResolver">The server config resolver.</param> <param name="logFactory">The log factory.</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.Initialize(System.Func{SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.Config.IServerConfig})"> <summary> Initializes the bootstrap with the configuration and config resolver. </summary> <param name="serverConfigResolver">The server config resolver.</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.Initialize(SuperSocket.SocketBase.Logging.ILogFactory)"> <summary> Initializes the bootstrap with the configuration </summary> <param name="logFactory">The log factory.</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.Initialize"> <summary> Initializes the bootstrap with the configuration </summary> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.Start"> <summary> Starts this bootstrap. </summary> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.Stop"> <summary> Stops this bootstrap. </summary> </member> <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.RegisterRemotingService"> <summary> Registers the bootstrap remoting access service. </summary> </member> <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.Dispose(System.Boolean)"> <summary> Releases unmanaged and - optionally - managed resources. </summary> <param name="disposing"><c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param> </member> <member name="M:SuperSocket.SocketEngine.DefaultBootstrap.Dispose"> <summary> Releases unmanaged and - optionally - managed resources. </summary> </member> <member name="P:SuperSocket.SocketEngine.DefaultBootstrap.SuperSocket#SocketBase#ILoggerProvider#Logger"> <summary> Gets the bootstrap logger. </summary> </member> <member name="P:SuperSocket.SocketEngine.DefaultBootstrap.LogFactory"> <summary> Gets the log factory. </summary> </member> <member name="P:SuperSocket.SocketEngine.DefaultBootstrap.AppServers"> <summary> Gets all the app servers running in this bootstrap </summary> </member> <member name="P:SuperSocket.SocketEngine.DefaultBootstrap.Config"> <summary> Gets the config. </summary> </member> <member name="P:SuperSocket.SocketEngine.DefaultBootstrap.StartupConfigFile"> <summary> Gets the startup config file. </summary> </member> <member name="P:SuperSocket.SocketEngine.DefaultBootstrap.PerfMonitor"> <summary> Gets the <see cref="T:SuperSocket.SocketEngine.PerformanceMonitor"/> class. </summary> </member> <member name="P:SuperSocket.SocketEngine.DefaultBootstrap.BaseDirectory"> <summary> Gets the base directory. </summary> <value> The base directory. </value> </member> <member name="T:SuperSocket.SocketEngine.AppDomainBootstrap"> <summary> AppDomainBootstrap </summary> </member> <member name="M:SuperSocket.SocketEngine.AppDomainBootstrap.#ctor(SuperSocket.SocketBase.Config.IConfigurationSource)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.AppDomainBootstrap"/> class. </summary> </member> <member name="M:SuperSocket.SocketEngine.AppDomainBootstrap.Initialize"> <summary> Initializes the bootstrap with the configuration </summary> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.AppDomainBootstrap.Initialize(System.Func{SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.Config.IServerConfig})"> <summary> Initializes the bootstrap with the configuration and config resolver. </summary> <param name="serverConfigResolver">The server config resolver.</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.AppDomainBootstrap.Initialize(SuperSocket.SocketBase.Logging.ILogFactory)"> <summary> Initializes the bootstrap with the configuration and config resolver. </summary> <param name="logFactory">The log factory.</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.AppDomainBootstrap.Initialize(System.Collections.Generic.IDictionary{System.String,System.Net.IPEndPoint})"> <summary> Initializes the bootstrap with a listen endpoint replacement dictionary </summary> <param name="listenEndPointReplacement">The listen end point replacement.</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.AppDomainBootstrap.Initialize(System.Func{SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.Config.IServerConfig},SuperSocket.SocketBase.Logging.ILogFactory)"> <summary> Initializes the bootstrap with the configuration </summary> <param name="serverConfigResolver">The server config resolver.</param> <param name="logFactory">The log factory.</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.AppDomainBootstrap.Start"> <summary> Starts this bootstrap. </summary> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.AppDomainBootstrap.Stop"> <summary> Stops this bootstrap. </summary> </member> <member name="P:SuperSocket.SocketEngine.AppDomainBootstrap.AppServers"> <summary> Gets all the app servers running in this bootstrap </summary> </member> <member name="P:SuperSocket.SocketEngine.AppDomainBootstrap.Config"> <summary> Gets the config. </summary> </member> <member name="P:SuperSocket.SocketEngine.AppDomainBootstrap.SuperSocket#SocketBase#ILoggerProvider#Logger"> <summary> Gets the bootstrap logger. </summary> </member> <member name="P:SuperSocket.SocketEngine.AppDomainBootstrap.StartupConfigFile"> <summary> Gets the startup config file. </summary> </member> <member name="T:SuperSocket.SocketEngine.AssemblyImport"> <summary> AssemblyImport, used for importing assembly to the current AppDomain </summary> </member> <member name="M:SuperSocket.SocketEngine.AssemblyImport.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.AssemblyImport"/> class. </summary> </member> <member name="T:SuperSocket.SocketEngine.BootstrapFactory"> <summary> Bootstrap Factory </summary> </member> <member name="M:SuperSocket.SocketEngine.BootstrapFactory.CreateBootstrap(SuperSocket.SocketBase.Config.IConfigurationSource)"> <summary> Creates the bootstrap. </summary> <param name="config">The config.</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.BootstrapFactory.CreateBootstrap"> <summary> Creates the bootstrap from app configuration's socketServer section. </summary> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.BootstrapFactory.CreateBootstrap(System.String)"> <summary> Creates the bootstrap. </summary> <param name="configSectionName">Name of the config section.</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.BootstrapFactory.CreateBootstrapFromConfigFile(System.String)"> <summary> Creates the bootstrap from configuration file. </summary> <param name="configFile">The configuration file.</param> <returns></returns> </member> <member name="T:SuperSocket.SocketEngine.ConfigurationWatcher"> <summary> The configuration file watcher, it is used for hot configuration updating </summary> </member> <member name="M:SuperSocket.SocketEngine.ConfigurationWatcher.Watch(System.Configuration.ConfigurationSection,SuperSocket.SocketBase.IBootstrap)"> <summary> Watches the specified configuration section. </summary> <param name="configSection">The configuration section.</param> <param name="bootstrap">The bootstrap.</param> </member> <member name="T:SuperSocket.SocketEngine.Configuration.CommandAssembly"> <summary> Command assembly configuration element </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.CommandAssembly.Assembly"> <summary> Gets the assembly name. </summary> <value> The assembly. </value> </member> <member name="T:SuperSocket.SocketEngine.Configuration.CommandAssemblyCollection"> <summary> Command assembly configuation collection </summary> </member> <member name="T:SuperSocket.SocketEngine.Configuration.Server"> <summary> Server, the port which is compatible with .Net 4.5 or higher </summary> <summary> Server configuration </summary> </member> <member name="M:SuperSocket.SocketEngine.Configuration.Server.GetChildConfig``1(System.String)"> <summary> Gets the child config. </summary> <typeparam name="TConfig">The type of the config.</typeparam> <param name="childConfigName">Name of the child config.</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.Configuration.Server.OnDeserializeUnrecognizedAttribute(System.String,System.String)"> <summary> Gets a value indicating whether an unknown attribute is encountered during deserialization. To keep compatible with old configuration </summary> <param name="name">The name of the unrecognized attribute.</param> <param name="value">The value of the unrecognized attribute.</param> <returns> true when an unknown attribute is encountered while deserializing; otherwise, false. </returns> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.DefaultCulture"> <summary> Gets/sets the default culture for this server. </summary> <value> The default culture. </value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.ServerTypeName"> <summary> Gets the name of the server type this appServer want to use. </summary> <value> The name of the server type. </value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.ServerType"> <summary> Gets the type definition of the appserver. </summary> <value> The type of the server. </value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.ReceiveFilterFactory"> <summary> Gets the Receive filter factory. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.Ip"> <summary> Gets the ip. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.Port"> <summary> Gets the port. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.Mode"> <summary> Gets the mode. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.Disabled"> <summary> Gets a value indicating whether this <see cref="T:SuperSocket.SocketBase.Config.IServerConfig"/> is disabled. </summary> <value> <c>true</c> if disabled; otherwise, <c>false</c>. </value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.SendTimeOut"> <summary> Gets the send time out. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.MaxConnectionNumber"> <summary> Gets the max connection number. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.ReceiveBufferSize"> <summary> Gets the size of the receive buffer. </summary> <value> The size of the receive buffer. </value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.SendBufferSize"> <summary> Gets the size of the send buffer. </summary> <value> The size of the send buffer. </value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.SyncSend"> <summary> Gets a value indicating whether sending is in synchronous mode. </summary> <value> <c>true</c> if [sync send]; otherwise, <c>false</c>. </value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.LogCommand"> <summary> Gets a value indicating whether log command in log file. </summary> <value><c>true</c> if log command; otherwise, <c>false</c>.</value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.LogBasicSessionActivity"> <summary> Gets a value indicating whether [log basic session activity like connected and disconnected]. </summary> <value> <c>true</c> if [log basic session activity]; otherwise, <c>false</c>. </value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.LogAllSocketException"> <summary> Gets a value indicating whether [log all socket exception]. </summary> <value> <c>true</c> if [log all socket exception]; otherwise, <c>false</c>. </value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.ClearIdleSession"> <summary> Gets a value indicating whether clear idle session. </summary> <value><c>true</c> if clear idle session; otherwise, <c>false</c>.</value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.ClearIdleSessionInterval"> <summary> Gets the clear idle session interval, in seconds. </summary> <value>The clear idle session interval.</value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.IdleSessionTimeOut"> <summary> Gets the idle session timeout time length, in seconds. </summary> <value>The idle session time out.</value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.CertificateConfig"> <summary> Gets the certificate config. </summary> <value>The certificate config.</value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.Certificate"> <summary> Gets X509Certificate configuration. </summary> <value> X509Certificate configuration. </value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.Security"> <summary> Gets the security protocol, X509 certificate. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.MaxRequestLength"> <summary> Gets the max allowed length of request. </summary> <value> The max allowed length of request. </value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.DisableSessionSnapshot"> <summary> Gets a value indicating whether [disable session snapshot] </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.SessionSnapshotInterval"> <summary> Gets the interval to taking snapshot for all live sessions. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.ConnectionFilter"> <summary> Gets the connection filters used by this server instance. </summary> <value> The connection filters's name list, seperated by comma </value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.CommandLoader"> <summary> Gets the command loader, multiple values should be separated by comma. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.KeepAliveTime"> <summary> Gets the start keep alive time, in seconds </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.KeepAliveInterval"> <summary> Gets the keep alive interval, in seconds. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.ListenBacklog"> <summary> Gets the backlog size of socket listening. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.StartupOrder"> <summary> Gets the startup order of the server instance. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.SendingQueueSize"> <summary> Gets/sets the size of the sending queue. </summary> <value> The size of the sending queue. </value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.LogFactory"> <summary> Gets the logfactory name of the server instance. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.TextEncoding"> <summary> Gets the default text encoding. </summary> <value> The text encoding. </value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.Listeners"> <summary> Gets the listeners' configuration. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.SuperSocket#SocketBase#Config#IServerConfig#Listeners"> <summary> Gets the listeners' configuration. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Server.CommandAssemblies"> <summary> Gets the command assemblies configuration. </summary> <value> The command assemblies. </value> </member> <member name="T:SuperSocket.SocketEngine.Configuration.SocketServiceConfig"> <summary> SocketServiceConfig, the part which is compatible with .Net 4.5 or higher </summary> <summary> SuperSocket's root configuration node </summary> </member> <member name="M:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.OnDeserializeUnrecognizedElement(System.String,System.Xml.XmlReader)"> <summary> Gets a value indicating whether an unknown element is encountered during deserialization. To keep compatible with old configuration </summary> <param name="elementName">The name of the unknown subelement.</param> <param name="reader">The <see cref="T:System.Xml.XmlReader"/> being used for deserialization.</param> <returns> true when an unknown element is encountered while deserializing; otherwise, false. </returns> <exception cref="T:System.Configuration.ConfigurationErrorsException">The element identified by <paramref name="elementName"/> is locked.- or -One or more of the element's attributes is locked.- or -<paramref name="elementName"/> is unrecognized, or the element has an unrecognized attribute.- or -The element has a Boolean attribute with an invalid value.- or -An attempt was made to deserialize a property more than once.- or -An attempt was made to deserialize a property that is not a valid member of the element.- or -The element cannot contain a CDATA or text element.</exception> </member> <member name="M:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.OnDeserializeUnrecognizedAttribute(System.String,System.String)"> <summary> Gets a value indicating whether an unknown attribute is encountered during deserialization. </summary> <param name="name">The name of the unrecognized attribute.</param> <param name="value">The value of the unrecognized attribute.</param> <returns> true when an unknown attribute is encountered while deserializing; otherwise, false. </returns> </member> <member name="M:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.GetChildConfig``1(System.String)"> <summary> Gets the child config. </summary> <typeparam name="TConfig">The type of the config.</typeparam> <param name="childConfigName">Name of the child config.</param> <returns></returns> </member> <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.DefaultCulture"> <summary> Gets/sets the default culture for all server instances. </summary> <value> The default culture. </value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.Servers"> <summary> Gets all the server configurations </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.ServerTypes"> <summary> Gets the service configurations </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.ConnectionFilters"> <summary> Gets all the connection filter configurations. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.LogFactories"> <summary> Gets the defined log factory types. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.ReceiveFilterFactories"> <summary> Gets the logfactory name of the bootstrap. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.CommandLoaders"> <summary> Gets the command loaders definition. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.MaxWorkingThreads"> <summary> Gets the max working threads. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.MinWorkingThreads"> <summary> Gets the min working threads. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.MaxCompletionPortThreads"> <summary> Gets the max completion port threads. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.MinCompletionPortThreads"> <summary> Gets the min completion port threads. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.PerformanceDataCollectInterval"> <summary> Gets the performance data collect interval, in seconds. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.DisablePerformanceDataCollector"> <summary> Gets a value indicating whether [disable performance data collector]. </summary> <value> <c>true</c> if [disable performance data collector]; otherwise, <c>false</c>. </value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.Isolation"> <summary> Gets the isolation mode. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.LogFactory"> <summary> Gets the logfactory name of the bootstrap. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.SocketServiceConfig.OptionElements"> <summary> Gets the option elements. </summary> </member> <member name="T:SuperSocket.SocketEngine.IPerformanceMonitor"> <summary> Interface of IPerformanceMonitor </summary> </member> <member name="M:SuperSocket.SocketEngine.IPerformanceMonitor.Start"> <summary> Start PerformanceMonitor. </summary> </member> <member name="M:SuperSocket.SocketEngine.IPerformanceMonitor.Stop"> <summary> Stop PerformanceMonitor. </summary> </member> <member name="E:SuperSocket.SocketEngine.IPerformanceMonitor.OnStatusUpdate"> <summary> Invokes when status update. </summary> </member> <member name="P:SuperSocket.SocketEngine.IPerformanceMonitor.StatusUpdateInterval"> <summary> Get or Set status update time in seconds. </summary> </member> <member name="T:SuperSocket.SocketEngine.IProcessServer"> <summary> the interface for server instance which works as a process </summary> </member> <member name="P:SuperSocket.SocketEngine.IProcessServer.ProcessId"> <summary> Gets the process id. </summary> <value> The process id. If the process id is zero, the server instance is not running </value> </member> <member name="T:SuperSocket.SocketEngine.IRemoteWorkItem"> <summary> IRemoteWorkItem </summary> </member> <member name="M:SuperSocket.SocketEngine.IRemoteWorkItem.Setup(System.String,System.String,System.String,SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.Provider.ProviderFactoryInfo[],System.String)"> <summary> Setups the specified config. </summary> <param name="serverType">Type of the server.</param> <param name="bootstrapUri">The bootstrap URI.</param> <param name="assemblyImportRoot">The assembly import root.</param> <param name="config">The config.</param> <param name="factories">The factories.</param> <param name="startupConfigFile">The startup configuration file path</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.ProcessAppServer.#ctor(System.String,SuperSocket.SocketBase.Metadata.StatusInfoAttribute[])"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.ProcessAppServer"/> class. </summary> <param name="serverTypeName">Name of the server type.</param> <param name="serverStatusMetadata">The server status metadata.</param> </member> <member name="P:SuperSocket.SocketEngine.ProcessAppServer.ProcessId"> <summary> Gets the process id. </summary> <value> The process id. If the process id is zero, the server instance is not running </value> </member> <member name="M:SuperSocket.SocketEngine.ProcessBootstrap.#ctor(SuperSocket.SocketBase.Config.IConfigurationSource)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.ProcessBootstrap"/> class. </summary> <param name="config">The config.</param> </member> <member name="T:SuperSocket.SocketEngine.SocketSession"> <summary> Socket Session, all application session should base on this class </summary> </member> <member name="M:SuperSocket.SocketEngine.SocketSession.LogError(System.Exception,System.String,System.String,System.Int32)"> <summary> Logs the error, skip the ignored exception </summary> <param name="exception">The exception.</param> <param name="caller">The caller.</param> <param name="callerFilePath">The caller file path.</param> <param name="callerLineNumber">The caller line number.</param> </member> <member name="M:SuperSocket.SocketEngine.SocketSession.LogError(System.String,System.Exception,System.String,System.String,System.Int32)"> <summary> Logs the error, skip the ignored exception </summary> <param name="message">The message.</param> <param name="exception">The exception.</param> <param name="caller">The caller.</param> <param name="callerFilePath">The caller file path.</param> <param name="callerLineNumber">The caller line number.</param> </member> <member name="M:SuperSocket.SocketEngine.SocketSession.LogError(System.Int32,System.String,System.String,System.Int32)"> <summary> Logs the socket error, skip the ignored error </summary> <param name="socketErrorCode">The socket error code.</param> <param name="caller">The caller.</param> <param name="callerFilePath">The caller file path.</param> <param name="callerLineNumber">The caller line number.</param> </member> <member name="M:SuperSocket.SocketEngine.SocketSession.Start"> <summary> Starts this session. </summary> </member> <member name="M:SuperSocket.SocketEngine.SocketSession.StartSession"> <summary> Says the welcome information when a client connectted. </summary> </member> <member name="M:SuperSocket.SocketEngine.SocketSession.OnClosed(SuperSocket.SocketBase.CloseReason)"> <summary> Called when [close]. </summary> </member> <member name="M:SuperSocket.SocketEngine.SocketSession.TrySend(System.Collections.Generic.IList{System.ArraySegment{System.Byte}})"> <summary> Tries to send array segment. </summary> <param name="segments">The segments.</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.SocketSession.TrySend(System.ArraySegment{System.Byte})"> <summary> Tries to send array segment. </summary> <param name="segment">The segment.</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.SocketSession.SendAsync(SuperSocket.Common.SendingQueue)"> <summary> Sends in async mode. </summary> <param name="queue">The queue.</param> </member> <member name="M:SuperSocket.SocketEngine.SocketSession.SendSync(SuperSocket.Common.SendingQueue)"> <summary> Sends in sync mode. </summary> <param name="queue">The queue.</param> </member> <member name="M:SuperSocket.SocketEngine.SocketSession.ValidateNotInSendingReceiving"> <summary> Validates the socket is not in the sending or receiving operation. </summary> <returns></returns> </member> <member name="P:SuperSocket.SocketEngine.SocketSession.SessionID"> <summary> Gets or sets the session ID. </summary> <value>The session ID.</value> </member> <member name="P:SuperSocket.SocketEngine.SocketSession.Config"> <summary> Gets or sets the config. </summary> <value> The config. </value> </member> <member name="P:SuperSocket.SocketEngine.SocketSession.Closed"> <summary> Occurs when [closed]. </summary> </member> <member name="P:SuperSocket.SocketEngine.SocketSession.Client"> <summary> Gets or sets the client. </summary> <value>The client.</value> </member> <member name="P:SuperSocket.SocketEngine.SocketSession.LocalEndPoint"> <summary> Gets the local end point. </summary> <value>The local end point.</value> </member> <member name="P:SuperSocket.SocketEngine.SocketSession.RemoteEndPoint"> <summary> Gets the remote end point. </summary> <value>The remote end point.</value> </member> <member name="P:SuperSocket.SocketEngine.SocketSession.SecureProtocol"> <summary> Gets or sets the secure protocol. </summary> <value>The secure protocol.</value> </member> <member name="M:SuperSocket.SocketEngine.MarshalAppServer.#ctor(System.String)"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.AppDomainAppServer"/> class. </summary> <param name="serviceTypeName">Name of the service type.</param> </member> <member name="M:SuperSocket.SocketEngine.MarshalAppServer.Setup(SuperSocket.SocketBase.IBootstrap,SuperSocket.SocketBase.Config.IServerConfig,SuperSocket.SocketBase.Provider.ProviderFactoryInfo[])"> <summary> Setups the specified root config. </summary> <param name="bootstrap">The bootstrap.</param> <param name="config">The socket server instance config.</param> <param name="factories">The providers.</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.MarshalAppServer.ReportPotentialConfigChange(SuperSocket.SocketBase.Config.IServerConfig)"> <summary> Reports the potential configuration change. </summary> <param name="config">The server config which may be changed.</param> <exception cref="T:System.NotImplementedException"></exception> </member> <member name="M:SuperSocket.SocketEngine.MarshalAppServer.Start"> <summary> Starts this server instance. </summary> <returns> return true if start successfull, else false </returns> </member> <member name="M:SuperSocket.SocketEngine.MarshalAppServer.Stop"> <summary> Stops this server instance. </summary> </member> <member name="M:SuperSocket.SocketEngine.MarshalAppServer.InitializeLifetimeService"> <summary> Obtains a lifetime service object to control the lifetime policy for this instance. </summary> <returns> An object of type <see cref="T:System.Runtime.Remoting.Lifetime.ILease" /> used to control the lifetime policy for this instance. This is the current lifetime service object for this instance if one exists; otherwise, a new lifetime service object initialized to the value of the <see cref="P:System.Runtime.Remoting.Lifetime.LifetimeServices.LeaseManagerPollTime" /> property. </returns> <PermissionSet> <IPermission class="System.Security.Permissions.SecurityPermission, mscorlib, Version=2.0.3600.0, Culture=neutral, PublicKeyToken=b77a5c561934e089" version="1" Flags="RemotingConfiguration, Infrastructure" /> </PermissionSet> </member> <member name="P:SuperSocket.SocketEngine.MarshalAppServer.Name"> <summary> Gets the name of the server instance. </summary> </member> <member name="P:SuperSocket.SocketEngine.MarshalAppServer.Config"> <summary> Gets the server's config. </summary> <value> The server's config. </value> </member> <member name="P:SuperSocket.SocketEngine.MarshalAppServer.State"> <summary> Gets the current state of the work item. </summary> <value> The state. </value> </member> <member name="P:SuperSocket.SocketEngine.MarshalAppServer.SessionCount"> <summary> Gets the total session count. </summary> </member> <member name="T:SuperSocket.SocketEngine.ISocketListener"> <summary> The interface for socket listener </summary> </member> <member name="M:SuperSocket.SocketEngine.ISocketListener.Start(SuperSocket.SocketBase.Config.IServerConfig)"> <summary> Starts to listen </summary> <param name="config">The server config.</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.ISocketListener.Stop"> <summary> Stops listening </summary> </member> <member name="P:SuperSocket.SocketEngine.ISocketListener.Info"> <summary> Gets the info of listener </summary> </member> <member name="P:SuperSocket.SocketEngine.ISocketListener.EndPoint"> <summary> Gets the end point the listener is working on </summary> </member> <member name="E:SuperSocket.SocketEngine.ISocketListener.NewClientAccepted"> <summary> Occurs when new client accepted. </summary> </member> <member name="E:SuperSocket.SocketEngine.ISocketListener.Error"> <summary> Occurs when error got. </summary> </member> <member name="E:SuperSocket.SocketEngine.ISocketListener.Stopped"> <summary> Occurs when [stopped]. </summary> </member> <member name="M:SuperSocket.SocketEngine.SocketListenerBase.Start(SuperSocket.SocketBase.Config.IServerConfig)"> <summary> Starts to listen </summary> <param name="config">The server config.</param> <returns></returns> </member> <member name="E:SuperSocket.SocketEngine.SocketListenerBase.Stopped"> <summary> Occurs when [stopped]. </summary> </member> <member name="T:SuperSocket.SocketEngine.TcpAsyncSocketListener"> <summary> Tcp socket listener in async mode </summary> </member> <member name="M:SuperSocket.SocketEngine.TcpAsyncSocketListener.Start(SuperSocket.SocketBase.Config.IServerConfig)"> <summary> Starts to listen </summary> <param name="config">The server config.</param> <returns></returns> </member> <member name="P:SuperSocket.SocketEngine.SocketServerBase.SendingQueuePool"> <summary> Gets the sending queue manager. </summary> <value> The sending queue manager. </value> </member> <member name="T:SuperSocket.SocketEngine.INegotiateSocketSession"> <summary> The interface for socket session which requires negotiation before communication </summary> </member> <member name="M:SuperSocket.SocketEngine.INegotiateSocketSession.Negotiate"> <summary> Start negotiates </summary> </member> <member name="P:SuperSocket.SocketEngine.INegotiateSocketSession.Result"> <summary> Gets a value indicating whether this <see cref="T:SuperSocket.SocketEngine.INegotiateSocketSession"/> is result. </summary> <value> <c>true</c> if result; otherwise, <c>false</c>. </value> </member> <member name="P:SuperSocket.SocketEngine.INegotiateSocketSession.AppSession"> <summary> Gets the app session. </summary> <value> The app session. </value> </member> <member name="E:SuperSocket.SocketEngine.INegotiateSocketSession.NegotiateCompleted"> <summary> Occurs when [negotiate completed]. </summary> </member> <member name="M:SuperSocket.SocketEngine.AsyncStreamSocketSession.Start"> <summary> Starts this session communication. </summary> </member> <member name="T:SuperSocket.SocketEngine.Configuration.CertificateConfig"> <summary> Certificate configuration </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.CertificateConfig.FilePath"> <summary> Gets the certificate file path. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.CertificateConfig.Password"> <summary> Gets the password. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.CertificateConfig.StoreName"> <summary> Gets the the store where certificate locates. </summary> <value> The name of the store. </value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.CertificateConfig.StoreLocation"> <summary> Gets the store location of the certificate. </summary> <value> The store location. </value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.CertificateConfig.Thumbprint"> <summary> Gets the thumbprint. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.CertificateConfig.ClientCertificateRequired"> <summary> Gets a value indicating whether [client certificate required]. </summary> <value> <c>true</c> if [client certificate required]; otherwise, <c>false</c>. </value> </member> <member name="P:SuperSocket.SocketEngine.Configuration.CertificateConfig.KeyStorageFlags"> <summary> Gets a value that will be used to instantiate the X509Certificate2 object in the CertificateManager </summary> </member> <member name="T:SuperSocket.SocketEngine.Configuration.Listener"> <summary> Listener configuration </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Listener.Ip"> <summary> Gets the ip of listener </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Listener.Port"> <summary> Gets the port of listener </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Listener.Backlog"> <summary> Gets the backlog. </summary> </member> <member name="P:SuperSocket.SocketEngine.Configuration.Listener.Security"> <summary> Gets the security option, None/Default/Tls/Ssl/... </summary> </member> <member name="T:SuperSocket.SocketEngine.Configuration.ListenerConfigCollection"> <summary> Listener configuration collection </summary> </member> <member name="T:SuperSocket.SocketEngine.Configuration.ServerCollection"> <summary> Server configuration collection </summary> </member> <member name="M:SuperSocket.SocketEngine.Configuration.ServerCollection.AddNew(SuperSocket.SocketEngine.Configuration.Server)"> <summary> Adds the new server element. </summary> <param name="newServer">The new server.</param> </member> <member name="M:SuperSocket.SocketEngine.Configuration.ServerCollection.Remove(System.String)"> <summary> Removes the specified server from the configuration. </summary> <param name="name">The name.</param> </member> <member name="T:SuperSocket.SocketEngine.SocketServerFactory"> <summary> Default socket server factory </summary> </member> <member name="M:SuperSocket.SocketEngine.SocketServerFactory.CreateSocketServer``1(SuperSocket.SocketBase.IAppServer,SuperSocket.SocketBase.ListenerInfo[],SuperSocket.SocketBase.Config.IServerConfig)"> <summary> Creates the socket server. </summary> <typeparam name="TRequestInfo">The type of the request info.</typeparam> <param name="appServer">The app server.</param> <param name="listeners">The listeners.</param> <param name="config">The config.</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.UdpSocketListener.Start(SuperSocket.SocketBase.Config.IServerConfig)"> <summary> Starts to listen </summary> <param name="config">The server config.</param> <returns></returns> </member> <member name="M:SuperSocket.SocketEngine.UdpSocketServer`1.#ctor(SuperSocket.SocketBase.IAppServer,SuperSocket.SocketBase.ListenerInfo[])"> <summary> Initializes a new instance of the <see cref="T:SuperSocket.SocketEngine.UdpSocketServer`1"/> class. </summary> <param name="appServer">The app server.</param> <param name="listeners">The listeners.</param> </member> <member name="M:SuperSocket.SocketEngine.UdpSocketServer`1.OnNewClientAccepted(SuperSocket.SocketEngine.ISocketListener,System.Net.Sockets.Socket,System.Object)"> <summary> Called when [new client accepted]. </summary> <param name="listener">The listener.</param> <param name="client">The client.</param> <param name="state">The state.</param> </member> <member name="M:SuperSocket.SocketEngine.UdpSocketSession.UpdateRemoteEndPoint(System.Net.IPEndPoint)"> <summary> Updates the remote end point of the client. </summary> <param name="remoteEndPoint">The remote end point.</param> </member> </members> </doc> Libs/SuperSocket.SocketEngine.dllBinary files differ
Libs/SupersocketCommon.dllBinary files differ
Libs/System.Runtime.Serialization.dllBinary files differ
Libs/SystemSetting.dllBinary files differ
Libs/UserInfo.dllBinary files differ
Libs/UserInfo.dll.config
New file @@ -0,0 +1,22 @@ <?xml version="1.0" encoding="utf-8" ?> <configuration> <configSections> <section name="unity" type="Microsoft.Practices.Unity.Configuration.UnityConfigurationSection, Microsoft.Practices.Unity.Configuration" /> </configSections> <unity> <containers> <container name="MyContainer"> <types> <!--type为对象的名称,mapTo为注入对象的名称 写法为用逗号隔开两部分，一是类的全部，包括命名空间，二是程序集名称--> <register type="UserInfo.IUser,UserInfo" mapTo="UserInfo.UserExp,UserInfo"> <lifetime type="singleton" /> </register> </types> </container> </containers> </unity> <startup> <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5.2" /> </startup> </configuration> Libs/UserInfo.xml
New file @@ -0,0 +1,253 @@ <?xml version="1.0"?> <doc> <assembly> <name>UserInfo</name> </assembly> <members> <member name="T:UserInfo.Constants"> <summary> 常量类 </summary> </member> <member name="F:UserInfo.Constants.ContainerUserInfoName"> <summary> 用户信息容器名 </summary> </member> <member name="F:UserInfo.Constants.ContainerChangeLanguageName"> <summary> 更改语言容器名 </summary> </member> <member name="F:UserInfo.Constants.ContainerBasicName"> <summary> 更改基础设置容器名 </summary> </member> <member name="T:UserInfo.IUser"> <summary> 当前登录用户信息接口 </summary> </member> <member name="M:UserInfo.IUser.GetLoginUserJson"> <summary> 获取当前用户登录信息 </summary> <returns>当前登录用户信息，如Json格式：{"CurrentUserName":"Admin"， "PassWord":"asdfg123 （加密）"，"CurrentRoleName":"Admin （加密）"}</returns> </member> <member name="M:UserInfo.IUser.GetRoleInfoJson"> <summary> 获取当前角色信息 </summary> <returns>当前登录用户角色信息</returns> </member> <member name="T:UserInfo.MenuName"> <summary> 菜单名称 </summary> </member> <member name="F:UserInfo.MenuName.name_EN"> <summary> 菜单英文名 </summary> </member> <member name="F:UserInfo.MenuName.showName"> <summary> 菜单显示名 </summary> </member> <member name="F:UserInfo.MenuName.menuLevel"> <summary> 菜单等级 </summary> </member> <member name="F:UserInfo.MenuName.parentNo"> <summary> 父菜单编号 </summary> </member> <member name="F:UserInfo.MenuName.no"> <summary> 菜单编号 </summary> </member> <member name="P:UserInfo.MenuName.Name_EN"> <summary> 菜单英文名 </summary> </member> <member name="P:UserInfo.MenuName.ShowName"> <summary> 菜单显示名 </summary> </member> <member name="P:UserInfo.MenuName.MenuLevel"> <summary> 父菜单编号 </summary> </member> <member name="P:UserInfo.MenuName.ParentNo"> <summary> 父菜单编号 </summary> </member> <member name="P:UserInfo.MenuName.No"> <summary> 菜单编号 </summary> </member> <member name="T:UserInfo.UserAutoLoadHelper"> <summary> 用户自动登录帮助类 </summary> </member> <member name="F:UserInfo.UserAutoLoadHelper.isAutoLoad"> <summary> 是否自动登录 </summary> </member> <member name="F:UserInfo.UserAutoLoadHelper.userName"> <summary> 用户名 </summary> </member> <member name="F:UserInfo.UserAutoLoadHelper.passWord"> <summary> 用户密码 </summary> </member> <member name="P:UserInfo.UserAutoLoadHelper.IsAutoLoad"> <summary> 是否自动登录 </summary> </member> <member name="P:UserInfo.UserAutoLoadHelper.UserName"> <summary> 用户名 </summary> </member> <member name="P:UserInfo.UserAutoLoadHelper.PassWord"> <summary> 用户密码 </summary> </member> <member name="T:UserInfo.UserExp"> <summary> 模块获得用户信息测试例子类 </summary> </member> <member name="M:UserInfo.UserExp.GetLoginUserJson"> <summary> 获得当前登录用户信息（测试用） </summary> <returns>当前登录用户信息</returns> </member> <member name="M:UserInfo.UserExp.GetRoleInfoJson"> <summary> 获得当前登录用户角色信息（测试用） </summary> <returns>当前登录用户角色信息</returns> </member> <member name="T:UserInfo.UserInfoProtocol"> <summary> 用户信息传输协议 </summary> </member> <member name="F:UserInfo.UserInfoProtocol.CurrentUserNameKey"> <summary> 用户名称Key </summary> </member> <member name="F:UserInfo.UserInfoProtocol.CurrentUserPasswordKey"> <summary> 用户密码Key </summary> </member> <member name="F:UserInfo.UserInfoProtocol.CurrentRoleNameKey"> <summary> 用户角色名Key </summary> </member> <member name="F:UserInfo.UserInfoProtocol.SercureKey"> <summary> 加密密匙8位 </summary> </member> <member name="M:UserInfo.UserInfoProtocol.UserInfoJson(System.String,System.String,System.String)"> <summary> 用户信息格式 </summary> <param name="CurrentUserName">当前用户名称</param> <param name="CurrentUserPassword">当前用户密码</param> <param name="CurrentRoleName">当前用户角色名称</param> </member> <member name="T:UserInfo.UserUnitySingleton"> <summary> Unity IOC单例模式 </summary> </member> <member name="F:UserInfo.UserUnitySingleton.instance"> <summary> 单例 </summary> </member> <member name="F:UserInfo.UserUnitySingleton.container"> <summary> ioc容器 </summary> </member> <member name="M:UserInfo.UserUnitySingleton.getInstance"> <summary> 获得实例 </summary> <returns>实例</returns> </member> <member name="M:UserInfo.UserUnitySingleton.GetInstanceDAL``1"> <summary> IOC注入实体 </summary> <typeparam name="T">接口名</typeparam> <returns>实例</returns> </member> <member name="M:UserInfo.UserUnitySingleton.GetInstanceDAL``1(System.String)"> <summary> IOC注入实体 </summary> <typeparam name="T">接口名</typeparam> <param name="name">对象名</param> <returns>实例</returns> </member> <member name="M:UserInfo.UserUnitySingleton.SetInstance(UserInfo.UserUnitySingleton)"> <summary> 初始化实例 </summary> <param name="_instance">IOC单例模式对象</param> </member> <member name="T:IBasic"> <summary> 主框架基础设置接口 </summary> </member> <member name="M:IBasic.SetCompanyPic"> <summary> 设置公司logo </summary> </member> <member name="M:IBasic.SetTitleText"> <summary> 设置主标题 </summary> </member> <member name="T:IChangeLanguage"> <summary> 更改语言接口 </summary> </member> <member name="M:IChangeLanguage.ChangeLanguage(System.String)"> <summary> 改语言方法 </summary> </member> </members> </doc> Libs/WcfServer.dllBinary files differ
Libs/WcfServer.dll.config
New file @@ -0,0 +1,6 @@ <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="BaseAddress" value="http://localhost:9058/console/UserInfoServer/"/> </appSettings> </configuration> Libs/WcfServer.xml
New file @@ -0,0 +1,51 @@ <?xml version="1.0"?> <doc> <assembly> <name>WcfServer</name> </assembly> <members> <member name="T:WcfServer.UserInfoConfig"> <summary> 创建服务类 </summary> </member> <member name="F:WcfServer.UserInfoConfig.instance"> <summary> 单例 </summary> </member> <member name="M:WcfServer.UserInfoConfig.getInstance"> <summary> 获得实例 </summary> <returns>实例</returns> </member> <member name="M:WcfServer.UserInfoConfig.CreatServer"> <summary> 创建服务 </summary> </member> <member name="M:WcfServer.UserInfoConfig.OpenServer"> <summary> 打开服务 </summary> </member> <member name="M:WcfServer.UserInfoConfig.CloseServer"> <summary> 关闭服务 </summary> </member> <member name="M:WcfServer.UserInfoServer.GetUserInfo"> <summary> 获得用户信息 </summary> <returns>用户信息</returns> </member> <member name="M:WcfServer.UserInfoServer.GetRoleInfo"> <summary> 获得角色信息 </summary> <returns>角色信息</returns> </member> </members> </doc> Libs/WcfServiceContract.dllBinary files differ
Libs/WcfServiceContract.xml
New file @@ -0,0 +1,25 @@ <?xml version="1.0"?> <doc> <assembly> <name>WcfServiceContract</name> </assembly> <members> <member name="T:WcfServer.IUserInfoServer"> <summary> 用户服务契约 </summary> </member> <member name="M:WcfServer.IUserInfoServer.GetUserInfo"> <summary> 获得用户信息 </summary> <returns>用户信息</returns> </member> <member name="M:WcfServer.IUserInfoServer.GetRoleInfo"> <summary> 获得角色信息 </summary> <returns>角色信息</returns> </member> </members> </doc> Libs/languageHelper.dllBinary files differ
Libs/languageHelper.dll.config
New file @@ -0,0 +1,6 @@ <?xml version="1.0" encoding="utf-8" ?> <configuration> <startup> <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5.2" /> </startup> </configuration> Libs/log4net.dllBinary files differ
Libs/mscorlib.dllBinary files differ
Libs/stdole.dllBinary files differ
