zhusenlin/serein-flow
1
0
Fork 0
mirror of https://gitee.com/langsisi_admin/serein-flow synced 2026-04-09 01:16:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

优化了示例工程

Browse Source
This commit is contained in:
fengjiayi
2024-09-28 23:55:19 +08:00
parent 51bdbab4d1
commit 10e5d172c6
56 changed files with 9920 additions and 455 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@@ -23,3 +23,4 @@ obj/
# 排除某些项目
Net461DllTest/Enums/PlcVarEnum.cs

5
Library/Entity/ExplicitData.cs
View File

@@ -20,9 +20,9 @@ namespace Serein.Library.Entity
/// </summary>
public bool IsExplicitData { get; set; }
/// <summary>
/// 是否为值转换器
/// 转换器 IEnumConvertor<,>
/// </summary>
public bool IsEnumConvertor { get; set; }
public Func<object, object> Convertor { get; set; }
///// <summary>
///// 显式类型
///// </summary>
@@ -57,6 +57,7 @@ namespace Serein.Library.Entity
IsExplicitData = IsExplicitData,
ExplicitType = ExplicitType,
ExplicitTypeName = ExplicitTypeName,
Convertor = Convertor,
DataType = DataType,
ParameterName = ParameterName,
DataValue = string.IsNullOrEmpty(DataValue) ? string.Empty : DataValue,

8
Library/Entity/MethodDetails.cs
View File

@@ -7,11 +7,13 @@ namespace Serein.Library.Entity
{
/// <summary>
/// 每个节点有独自的MethodDetails实例
/// </summary>
public class MethodDetails
{
/// <summary>
/// 拷贝
/// 从DLL拖动出来时拷贝新的实例
/// </summary>
/// <returns></returns>
public MethodDetails Clone()
@@ -37,7 +39,7 @@ namespace Serein.Library.Entity
/// <summary>
/// 是否保护参数
/// </summary>
public bool IsProtectionParameter { get; set; } = false;
public bool IsProtectionParameter { get; set; } = true;
/// <summary>
/// 作用实例的类型

74
Library/NodeAttribute.cs
View File

@@ -9,6 +9,14 @@ namespace Serein.Library.Attributes
[AttributeUsage(AttributeTargets.Property)]
public sealed class AutoInjectionAttribute : Attribute
{
}
/// <summary>
/// 表示该类自动注册
/// </summary>
[AttributeUsage(AttributeTargets.Class)]
public sealed class AutoRegisterAttribute : Attribute
{
}
/// <summary>
@@ -95,54 +103,30 @@ namespace Serein.Library.Attributes
}
}
[AttributeUsage(AttributeTargets.Field)]
public class PLCValueAttribute : Attribute
/// <summary>
/// 绑定转换器
/// </summary>
[AttributeUsage(AttributeTargets.Parameter)]
public class BindConvertorAttribute : Attribute
{
public enum VarType
public Type EnumType { get; }
public Type ConvertorType { get; }
public BindConvertorAttribute(Type @enum, Type convertor)
{
/// <summary>
/// 可写入值
/// </summary>
Write,
/// <summary>
/// 定时读取的可写入值（用来写入前判断），应该几乎不会有这种类型？
/// </summary>
TimingReadOrWrite,
/// <summary>
/// 只读取值（使用时刷新）
/// </summary>
ReadOnly,
/// <summary>
/// 定时刷新的只读取值（定时刷新用来触发触发器）
/// </summary>
TimingReadOnly,
}
public bool IsProtected { get; }
public Type DataType { get; }
public string Var { get; }
//public int Length { get; }
//public double Offset { get; }
public VarType Type { get; }
//public int RefreshInterval { get; }
public PLCValueAttribute(Type type,
string @var,
VarType varType
//int refreshInterval = 100
)
{
DataType = type;
Var = @var;
//Offset = offset;
//RefreshInterval = refreshInterval;
Type = varType;
//Length = length;
this.EnumType = @enum;
this.ConvertorType = convertor;
}
}
/// <summary>
/// 枚举转换器接口
/// </summary>
/// <typeparam name="TEnum"></typeparam>
/// <typeparam name="TValue"></typeparam>
public interface IEnumConvertor<TEnum, TValue>
{
TValue Convertor(TEnum e);
}
}

18
Library/Utils/EnumHelper.cs
View File

@@ -24,16 +24,16 @@ namespace Serein.Library.Utils
return attribute != null ? valueSelector(attribute) : default;
}
//public static TResult GetBoundValue<TEnum, TAttribute, TResult>(TEnum enumValue,
// Func<TAttribute, TResult> valueSelector)
// where TEnum : Enum
// where TAttribute : Attribute
//{
// var fieldInfo = typeof(TEnum).GetField(enumValue.ToString());
// var attribute = fieldInfo.GetCustomAttribute<TAttribute>();
public static TResult GetBoundValue<TEnum, TAttribute, TResult>(TEnum enumValue,
Func<TAttribute, TResult> valueSelector)
where TEnum : Enum
where TAttribute : Attribute
{
var fieldInfo = typeof(TEnum).GetField(enumValue.ToString());
var attribute = fieldInfo.GetCustomAttribute<TAttribute>();
// return attribute != null ? valueSelector(attribute) : default;
//}
return attribute != null ? valueSelector(attribute) : default;
}

15
Net461DllTest/Data/MyData.cs
View File

@@ -1,15 +0,0 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace Net461DllTest.Data
{
public class MyData
{
public int[] Values { get; set; } = new int[] { 1, 1, 4, 5, 1, 4, 1, 9, 9, 9 };
public int Count { get; set; }
public string Tips { get; set; }
}
}

48
Net461DllTest/Device/PlcDevice.cs
View File

@@ -1,48 +0,0 @@
using Net461DllTest.Data;
using Net461DllTest.Signal;
using Serein.Library.Attributes;
using Serein.Library.NodeFlow.Tool;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace Net461DllTest.Device
{
public class PlcDevice : ChannelFlowTrigger<OrderSignal>
{
[AutoInjection]
public MyData MyData { get; set; }
public PlcDevice()
{
PlcId = 114514 + 10000000 * new Random().Next(1, 9);
}
public int PlcId { get; set; }
public void InitDevice(string ip, int port, string tips)
{
Write($"模拟设备初始化 :{Environment.NewLine}" +
$" ip :{ip}{Environment.NewLine}" +
$"port:{port}{Environment.NewLine}" +
$"tips:{tips}{Environment.NewLine}");
}
public void Write<T>(T value)
{
Console.WriteLine($"{value}");
}
public void Read<T>()
{
Console.WriteLine($"读取数据：... ");
}
public void Disconnect()
{
Console.WriteLine($"断开连接...");
}
}
}

18
Net461DllTest/Device/PrakingDevice.cs Normal file
View File

@@ -0,0 +1,18 @@
using Net461DllTest.LogicControl;
using Serein.Library.Attributes;
using Serein.Library.NodeFlow.Tool;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace Net461DllTest.Device
{
[AutoRegister]
public class PrakingDevice : ChannelFlowTrigger<ParkingCommand>
{
}
}

70
Net461DllTest/Device/SiemensPlcDevice.cs Normal file
View File

@@ -0,0 +1,70 @@
using IoTClient.Clients.PLC;
using Net461DllTest.Enums;
using Net461DllTest.Signal;
using Net461DllTest.Utils;
using Serein.Library.NodeFlow.Tool;
using System;
namespace Net461DllTest.Device
{
/// <summary>
/// 官方文档：如果没有主动Open，则会每次读写操作的时候自动打开自动和关闭连接，这样会使读写效率大大减低。所以建议手动Open和Close。
/// </summary>
public class SiemensPlcDevice : ChannelFlowTrigger<OrderSignal>
{
public SiemensClient Client { get; set; }
public IoTClient.Common.Enums.SiemensVersion Version { get; set; }
public string IP { get; set; }
public int Port { get; set; }
public PlcState State { get; set; } = PlcState.PowerOff;
public void Init(IoTClient.Common.Enums.SiemensVersion version,string ip, int port)
{
Client = new SiemensClient(version, ip, port);
Version = version;
IP = ip;
Port = port;
}
public void ResetDevice()
{
Client?.Close();
Client = null;
}
public void Write(PlcVarInfo plcValue, object value)
{
try
{
Client.WriteToPlcValue(plcValue, value);
}
catch (Exception ex)
{
Console.WriteLine($"写入出错:{this}{plcValue}。{ex.Message}");
throw;
}
}
public object Read(PlcVarInfo plcValue)
{
try
{
return Client.ReadToPlcValue(plcValue);
}
catch (Exception ex)
{
Console.WriteLine($"读取出错:{this}{plcValue}。{ex.Message}");
throw;
}
}
public override string ToString()
{
return $"西门子Plc[{this.Version}-{this.IP}:{this.Port}]";
}
}
}

19
Net461DllTest/Enums/FromValue.cs Normal file
View File

@@ -0,0 +1,19 @@
using Net461DllTest.View;
using Serein.Library.Attributes;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace Net461DllTest.Signal
{
public enum FromValue
{
None,
[BindValue(typeof(FromWorkBenchView))]
FromWorkBenchView,
[BindValue(typeof(TestFormView))]
TestFormView,
}
}

28
Net461DllTest/Enums/PlcState.cs Normal file
View File

@@ -0,0 +1,28 @@
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace Net461DllTest.Enums
{
public enum PlcState
{
/// <summary>
/// 关机
/// </summary>
PowerOff,
/// <summary>
/// 正在运行
/// </summary>
Runing,
/// <summary>
/// 发生异常
/// </summary>
Error,
/// <summary>
/// 维护中
/// </summary>
Maintenance,
}
}

131
Net461DllTest/Flow/LogicControl.cs
View File

@@ -1,131 +0,0 @@
using Net461DllTest.Data;
using Net461DllTest.Device;
using Net461DllTest.Signal;
using Net461DllTest.Web;
using Serein.Library.Api;
using Serein.Library.Attributes;
using Serein.Library.Enums;
using Serein.Library.Ex;
using Serein.Library.Framework.NodeFlow;
using Serein.Library.NodeFlow.Tool;
using Serein.Library.Web;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace Net461DllTest.Flow
{
[DynamicFlow]
public class LogicControl
{
[AutoInjection]
public PlcDevice MyPlc { get; set; }
#region 初始化、初始化完成以及退出的事件
[NodeAction(NodeType.Init)] // Init ： 初始化事件，流程启动时执行
public void Init(IDynamicContext context)
{
context.Env.IOC.Register<PlcDevice>(); // 注册Plc设备
context.Env.IOC.Register<MyData>(); // 注册数据类
context.Env.IOC.Register<WebServer>(); // 注册Web服务
// // 注册控制器
context.Env.IOC.Run<IRouter>(router => {
router.RegisterController(typeof(ApiController));
});
}
[NodeAction(NodeType.Loading)] // Loading 初始化完成已注入依赖项，可以开始逻辑上的操作
public void Loading(IDynamicContext context)
{
context.Env.IOC.Run<WebServer>((web) =>
{
web.Start("http://*:8089/"); // 开启 Web 服务
});
}
[NodeAction(NodeType.Exit)] // 流程结束时自动执行
public void Exit(IDynamicContext context)
{
MyPlc.Disconnect();
MyPlc.CancelAllTasks();
}
#endregion
#region 触发器
[NodeAction(NodeType.Flipflop, "等待信号触发", ReturnType = typeof(int))]
public async Task<IFlipflopContext> WaitTask(OrderSignal order = OrderSignal.Command_1)
{
try
{
TriggerData triggerData = await MyPlc.CreateChannelWithTimeoutAsync(order, TimeSpan.FromMinutes(5), 0);
if (triggerData.Type == TriggerType.Overtime)
{
throw new FlipflopException("超时取消");
}
//int.TryParse(triggerData.Value.ToString(),out int result);
MyPlc.MyData.Count += (int)triggerData.Value;
return new FlipflopContext(FlipflopStateType.Succeed, MyPlc.MyData.Count);
}
catch (FlipflopException)
{
throw;
}
catch (Exception)
{
return new FlipflopContext(FlipflopStateType.Error);
}
}
#endregion
#region 动作
[NodeAction(NodeType.Action, "初始化")]
public PlcDevice PlcInit(string ip = "192.168.1.1",
int port = 6688,
string tips = "测试")
{
MyPlc.InitDevice(ip, port, tips);
return MyPlc;
}
[NodeAction(NodeType.Action, "自增")]
public PlcDevice 自增(int number = 1)
{
MyPlc.MyData.Count += number;
return MyPlc;
}
[NodeAction(NodeType.Action, "重置计数")]
public void 重置计数()
{
MyPlc.MyData.Count = 0;
}
[NodeAction(NodeType.Action, "触发信号")]
public void 光电1信号触发(int data)
{
MyPlc.Write($"{MyPlc.PlcId.ToString("00000")} - 信号源[光电1] - 模拟写入 : {data}{Environment.NewLine}");
}
//[NodeAction(NodeType.Action, "触发光电2")]
//public void 光电2信号触发(int data)
//{
// MyPlc.Write($"{MyPlc.PlcId.ToString("00000")} - 信号源[光电2] - 模拟写入 : {data}{Environment.NewLine}");
//}
//[NodeAction(NodeType.Action, "触发光电3")]
//public void 光电3信号触发(int data)
//{
// MyPlc.Write($"{MyPlc.PlcId.ToString("00000")} - 信号源[光电3] - 模拟写入 : {data}{Environment.NewLine}");
//}
#endregion
}
}

91
Net461DllTest/LogicControl/ParkingLogicControl.cs Normal file
View File

@@ -0,0 +1,91 @@
using Net461DllTest.Device;
using Net461DllTest.Signal;
using Net461DllTest.ViewModel;
using Serein.Library.Api;
using Serein.Library.Attributes;
using Serein.Library.Enums;
using Serein.Library.Ex;
using Serein.Library.Framework.NodeFlow;
using Serein.Library.NodeFlow.Tool;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace Net461DllTest.LogicControl
{
public enum ParkingCommand
{
GetPparkingSpace,
}
[DynamicFlow]
public class ParkingLogicControl
{
[AutoInjection]
public PrakingDevice PrakingDevice { get; set; }
[NodeAction(NodeType.Init)]
public void Init(IDynamicContext context)
{
context.Env.IOC.Register<PrakingDevice>();
}
[NodeAction(NodeType.Flipflop, "等待车位调取命令",ReturnType=typeof(string))]
public async Task<IFlipflopContext> GetPparkingSpace(ParkingCommand parkingCommand = ParkingCommand.GetPparkingSpace)
{
try
{
TriggerData triggerData = await PrakingDevice.CreateChannelWithTimeoutAsync(parkingCommand, TimeSpan.FromMinutes(5), 0);
if (triggerData.Type == TriggerType.Overtime)
{
throw new FlipflopException("超时取消");
}
if(triggerData.Value is string spaceNum)
{
await Console.Out.WriteLineAsync("收到命令：调取车位，车位号"+ spaceNum);
return new FlipflopContext(FlipflopStateType.Succeed, spaceNum);
}
else
{
throw new FlipflopException("并非车位号");
}
}
catch (FlipflopException)
{
throw;
}
catch (Exception)
{
return new FlipflopContext(FlipflopStateType.Error);
}
}
[NodeAction(NodeType.Action, "手动触发模拟调取车位")]
public void Storage(string spaceNum = "101")
{
if (PrakingDevice.TriggerSignal(ParkingCommand.GetPparkingSpace, spaceNum))
{
Console.WriteLine("发送命令成功：调取车位" + spaceNum);
}
else
{
Console.WriteLine("发送命令失败：调取车位" + spaceNum);
}
}
}
}

191
Net461DllTest/LogicControl/PlcLogicControl.cs Normal file
View File

@@ -0,0 +1,191 @@
using IoTClient.Clients.PLC;
using IoTClient.Common.Enums;
using Net461DllTest.Device;
using Net461DllTest.Enums;
using Net461DllTest.Signal;
using Net461DllTest.Web;
using Serein.Library.Api;
using Serein.Library.Attributes;
using Serein.Library.Enums;
using Serein.Library.Ex;
using Serein.Library.Framework.NodeFlow;
using Serein.Library.NodeFlow.Tool;
using Serein.Library.Utils;
using Serein.Library.Web;
using System;
using System.ComponentModel;
using System.Reflection;
using System.Threading.Tasks;
namespace Net461DllTest.LogicControl
{
[DynamicFlow]
public class PlcLogicControl
{
[AutoInjection]
public SiemensPlcDevice MyPlc { get; set; }
#region 初始化、初始化完成以及退出的事件
[NodeAction(NodeType.Init)] // Init ： 初始化事件，流程启动时执行
public void Init(IDynamicContext context)
{
context.Env.IOC.Register<SiemensPlcDevice>(); // 注册Plc设备
context.Env.IOC.Register<WebServer>(); // 注册Web服务
// // 注册控制器
context.Env.IOC.Run<IRouter>(router => {
router.RegisterController(typeof(ApiController));
});
}
[NodeAction(NodeType.Loading)] // Loading 初始化完成已注入依赖项，可以开始逻辑上的操作
public void Loading(IDynamicContext context)
{
context.Env.IOC.Run<WebServer>((web) =>
{
web.Start("http://*:8089/"); // 开启 Web 服务
});
}
[NodeAction(NodeType.Exit)] // 流程结束时自动执行
public void Exit(IDynamicContext context)
{
MyPlc.ResetDevice();
MyPlc.CancelAllTasks();
}
#endregion
#region 触发器节点
[NodeAction(NodeType.Flipflop, "等待信号触发", ReturnType = typeof(int))]
public async Task<IFlipflopContext> WaitTask(OrderSignal order = OrderSignal.Command_1)
{
try
{
TriggerData triggerData = await MyPlc.CreateChannelWithTimeoutAsync(order, TimeSpan.FromMinutes(5), 0);
if (triggerData.Type == TriggerType.Overtime)
{
throw new FlipflopException("超时取消");
}
//int.TryParse(triggerData.Value.ToString(),out int result);
return new FlipflopContext(FlipflopStateType.Succeed, triggerData.Value);
}
catch (FlipflopException)
{
throw;
}
catch (Exception)
{
return new FlipflopContext(FlipflopStateType.Error);
}
}
#endregion
#region 动作节点
[NodeAction(NodeType.Action, "初始化")]
public SiemensPlcDevice PlcInit(SiemensVersion version = SiemensVersion.None,
string ip = "192.168.10.100",
int port = 102)
{
if (MyPlc.Client is null)
{
try
{
MyPlc.Init(version, ip, port);
Console.WriteLine($"西门子PLC初始化成功[{version},{ip}:{port}]");
}
catch (Exception ex)
{
Console.WriteLine($"西门子PLC[{version},{ip}:{port}]初始化异常:{ex.Message}");
}
}
else
{
Console.WriteLine( $"西门子PLC已经初始化[{version},{ip}:{port}]");
}
return MyPlc;
}
[NodeAction(NodeType.Action, "设置PLC状态")]
public SiemensPlcDevice SetState(PlcState state = PlcState.PowerOff)
{
if(MyPlc.Client != null)
{
var oldState = MyPlc.State;
MyPlc.State = state;
Console.WriteLine($"PLC状态从[{oldState}]转为[{state}]");
return MyPlc;
}
else
{
Console.WriteLine($"PLC尚未初始化");
return MyPlc;
}
}
[NodeAction(NodeType.Action, "PLC获取变量")]
public object ReadVar([BindConvertor(typeof(PlcVarEnum), typeof(PlcVarConvertor))] PlcVarInfo varInfo)
{
var result = MyPlc.Read(varInfo);
Console.WriteLine($"获取变量成功：({varInfo})\t result = {result}");
return result;
}
[NodeAction(NodeType.Action, "PLC写入变量")]
public SiemensPlcDevice WriteVar2(object value, [BindConvertor(typeof(PlcVarEnum), typeof(PlcVarConvertor))] PlcVarInfo varInfo)
{
if (MyPlc.State == PlcState.Runing)
{
if (!varInfo.IsProtected)
{
MyPlc.Write(varInfo, value);
Console.WriteLine($"PLC变量{varInfo}写入数据：{value}");
}
else
{
Console.WriteLine($"PLC变量{varInfo}当前禁止写入");
}
}
else
{
Console.WriteLine($"PLC处于非预期状态{MyPlc.State}");
}
return MyPlc;
}
/// <summary>
/// 转换器，用于将枚举转为自定义特性中的数据
/// </summary>
public class PlcVarConvertor: IEnumConvertor<PlcVarEnum, PlcVarInfo>
{
public PlcVarInfo Convertor(PlcVarEnum plcVarValue)
{
if (plcVarValue == PlcVarEnum.None)
{
throw new Exception("非预期枚举值");
}
var plcValue = EnumHelper.GetBoundValue<PlcVarEnum, PlcValueAttribute, PlcVarInfo>(plcVarValue, attr => attr.PlcInfo)
?? throw new Exception($"获取变量异常：{plcVarValue}，没有标记PlcValueAttribute");
if (string.IsNullOrEmpty(plcValue.VarAddress))
{
throw new Exception($"获取变量异常：{plcVarValue}，变量地址为空");
}
return plcValue;
}
}
#endregion
}
}

28
Net461DllTest/Flow/ViewLogicControl.cs → Net461DllTest/LogicControl/ViewLogicControl.cs
View File

@@ -1,6 +1,4 @@
using Net461DllTest.Data;
using Net461DllTest.Device;
using Net461DllTest.View;
using Net461DllTest.Signal;
using Net461DllTest.ViewModel;
using Serein.Library.Api;
using Serein.Library.Attributes;
@@ -9,10 +7,9 @@ using Serein.Library.Utils;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using System.Windows.Forms;
namespace Net461DllTest.Flow
namespace Net461DllTest.LogicControl
{
public class ViewManagement
@@ -44,14 +41,7 @@ namespace Net461DllTest.Flow
}
public enum FromId
{
None,
[BindValue(typeof(FromWorkBenchView))]
FromWorkBenchView,
[BindValue(typeof(TeseFormView))]
TeseFormView,
}
[DynamicFlow]
public class ViewLogicControl
@@ -68,9 +58,9 @@ namespace Net461DllTest.Flow
[NodeAction(NodeType.Action, "打开窗体（指定枚举值）")]
public void OpenForm(IDynamicContext context, FromId fromId = FromId.None, bool isTop = true)
public void OpenForm(IDynamicContext context, FromValue fromId = FromValue.None, bool isTop = true)
{
var fromType = EnumHelper.GetBoundValue<FromId, Type>(fromId, attr => attr.Value);
var fromType = EnumHelper.GetBoundValue<FromValue, Type>(fromId, attr => attr.Value);
if (fromType is null) return;
if (context.Env.IOC.Instantiate(fromType) is Form form)
{
@@ -79,16 +69,17 @@ namespace Net461DllTest.Flow
}
[NodeAction(NodeType.Action, "打开窗体（使用转换器）")]
public void OpenForm2([EnumTypeConvertor(typeof(FromId))] Form form, bool isTop = true)
public void OpenForm2([EnumTypeConvertor(typeof(FromValue))] Form form, bool isTop = true)
{
ViewManagement.OpenView(form, isTop);
}
[NodeAction(NodeType.Action, "关闭窗体")]
public void CloseForm(IDynamicContext context, FromId fromId = FromId.None)
public void CloseForm(IDynamicContext context, FromValue fromId = FromValue.None)
{
var fromType = EnumHelper.GetBoundValue<FromId, Type>(fromId, attr => attr.Value);
var fromType = EnumHelper.GetBoundValue<FromValue, Type>(fromId, attr => attr.Value);
if (fromType is null) return;
ViewManagement.CloseView(fromType);
}
@@ -96,5 +87,6 @@ namespace Net461DllTest.Flow
}
}

32
Net461DllTest/Net461DllTest.csproj
View File

@@ -39,9 +39,15 @@
<StartupObject />
</PropertyGroup>
<ItemGroup>
<Reference Include="IoTClient, Version=1.0.40.0, Culture=neutral, processorArchitecture=MSIL">
<HintPath>..\packages\IoTClient.1.0.40\lib\netstandard2.0\IoTClient.dll</HintPath>
</Reference>
<Reference Include="System" />
<Reference Include="System.Core" />
<Reference Include="System.Drawing" />
<Reference Include="System.IO.Ports, Version=4.0.2.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51, processorArchitecture=MSIL">
<HintPath>..\packages\System.IO.Ports.4.6.0\lib\net461\System.IO.Ports.dll</HintPath>
</Reference>
<Reference Include="System.ValueTuple, Version=4.0.3.0, Culture=neutral, PublicKeyToken=cc7b13ffcd2ddd51, processorArchitecture=MSIL">
<HintPath>..\packages\System.ValueTuple.4.5.0\lib\net461\System.ValueTuple.dll</HintPath>
</Reference>
@@ -54,11 +60,17 @@
<Reference Include="System.Xml" />
</ItemGroup>
<ItemGroup>
<Compile Include="Data\MyData.cs" />
<Compile Include="Device\PlcDevice.cs" />
<Compile Include="Flow\LogicControl.cs" />
<Compile Include="Flow\ViewLogicControl.cs" />
<Compile Include="Device\SiemensPlcDevice.cs" />
<Compile Include="Device\PrakingDevice.cs" />
<Compile Include="Enums\PlcState.cs" />
<Compile Include="Enums\PlcVarEnum.cs" />
<Compile Include="LogicControl\PlcLogicControl.cs" />
<Compile Include="LogicControl\ParkingLogicControl.cs" />
<Compile Include="LogicControl\ViewLogicControl.cs" />
<Compile Include="Enums\FromValue.cs" />
<Compile Include="Signal\OrderSignal.cs" />
<Compile Include="Signal\PLCVarSignal.cs" />
<Compile Include="Utils\ToValue.cs" />
<Compile Include="ViewModel\FromWorkBenchViewModel.cs" />
<Compile Include="View\FromWorkBenchView.cs">
<SubType>Form</SubType>
@@ -66,12 +78,11 @@
<Compile Include="View\FromWorkBenchView.Designer.cs">
<DependentUpon>FromWorkBenchView.cs</DependentUpon>
</Compile>
<Compile Include="Signal\Signal.cs" />
<Compile Include="View\TeseFormView.cs">
<Compile Include="View\TestFormView.cs">
<SubType>Form</SubType>
</Compile>
<Compile Include="View\TeseFormView.Designer.cs">
<DependentUpon>TeseFormView.cs</DependentUpon>
<Compile Include="View\TestFormView.Designer.cs">
<DependentUpon>TestFormView.cs</DependentUpon>
</Compile>
<Compile Include="Web\ApiController.cs" />
</ItemGroup>
@@ -89,14 +100,15 @@
<EmbeddedResource Include="View\FromWorkBenchView.resx">
<DependentUpon>FromWorkBenchView.cs</DependentUpon>
</EmbeddedResource>
<EmbeddedResource Include="View\TeseFormView.resx">
<DependentUpon>TeseFormView.cs</DependentUpon>
<EmbeddedResource Include="View\TestFormView.resx">
<DependentUpon>TestFormView.cs</DependentUpon>
</EmbeddedResource>
</ItemGroup>
<ItemGroup>
<Folder Include="Properties\" />
</ItemGroup>
<ItemGroup>
<None Include="app.config" />
<None Include="packages.config" />
</ItemGroup>
<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />

19
Net461DllTest/Signal/OrderSignal.cs
View File

@@ -1,18 +1,15 @@
using Serein.Library.Attributes;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using static Serein.Library.Attributes.PLCValueAttribute;
namespace Net461DllTest.Signal
namespace Net461DllTest.Signal
{
public enum OrderSignal
{
View_1,
View_2,
Command_1,
Command_2,
Command_3,
Command_4,
Command_5,
Command_6,
Command_7,
Command_8,
Command_9,
}
}

64
Net461DllTest/Signal/PLCVarSignal.cs Normal file
View File

@@ -0,0 +1,64 @@
using Serein.Library.Attributes;
using System;
using static Net461DllTest.Signal.PlcValueAttribute;
namespace Net461DllTest.Signal
{
[AttributeUsage(AttributeTargets.Field)]
public class PlcValueAttribute : Attribute
{
/// <summary>
/// 变量类型
/// </summary>
public enum VarType
{
/// <summary>
/// 只读取的值
/// </summary>
ReadOnly,
/// <summary>
/// 可写入的值
/// </summary>
Writable,
}
/// <summary>
/// 变量属性
/// </summary>
public PlcVarInfo PlcInfo { get; }
public PlcValueAttribute(Type type,
string @var,
VarType varType
)
{
PlcInfo = new PlcVarInfo(type, var, varType);
}
}
public class PlcVarInfo
{
public PlcVarInfo(Type type,
string @var,
VarType varType
)
{
DataType = type;
VarAddress = @var;
Type = varType;
}
public bool IsProtected { get; }
public Type DataType { get; }
public string VarAddress { get; }
public VarType Type { get; }
public override string ToString()
{
return $"数据类型:{DataType} 地址:{VarAddress}";
}
}
}

13
Net461DllTest/Signal/Signal.cs
View File

@@ -1,13 +0,0 @@
using Net461DllTest.Flow;
using Serein.Library.Attributes;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace Net461DllTest.Signal
{
}

231
Net461DllTest/Utils/ToValue.cs Normal file
View File

@@ -0,0 +1,231 @@
using IoTClient;
using IoTClient.Clients.PLC;
using IoTClient.Enums;
using Net461DllTest.Signal;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Runtime.CompilerServices;
using System.Text;
using System.Threading.Tasks;
namespace Net461DllTest.Utils
{
internal static class MyPlcExtension
{
public static DataTypeEnum ToDataTypeEnum(this PlcVarInfo varInfo)
{
Type dataType = varInfo.DataType;
DataTypeEnum plcDataType;
switch (dataType)
{
case Type _ when dataType == typeof(string):
plcDataType = DataTypeEnum.String;
break;
case Type _ when dataType == typeof(char):
plcDataType = DataTypeEnum.String;
break;
case Type _ when dataType == typeof(bool):
plcDataType = DataTypeEnum.Bool;
break;
case Type _ when dataType == typeof(float):
plcDataType = DataTypeEnum.Float;
break;
case Type _ when dataType == typeof(double):
plcDataType = DataTypeEnum.Double;
break;
case Type _ when dataType == typeof(byte):
plcDataType = DataTypeEnum.Byte;
break;
case Type _ when dataType == typeof(short):
plcDataType = DataTypeEnum.Int16;
break;
case Type _ when dataType == typeof(ushort):
plcDataType = DataTypeEnum.UInt16;
break;
case Type _ when dataType == typeof(int):
plcDataType = DataTypeEnum.Int32;
break;
case Type _ when dataType == typeof(uint):
plcDataType = DataTypeEnum.UInt32;
break;
case Type _ when dataType == typeof(long):
plcDataType = DataTypeEnum.Int64;
break;
case Type _ when dataType == typeof(ulong):
plcDataType = DataTypeEnum.UInt64;
break;
default:
plcDataType = DataTypeEnum.None;
break;
}
return plcDataType;
}
/// <summary>
/// 读取设备的值
/// </summary>
/// <param name="client"></param>
/// <param name="varInfo"></param>
/// <returns></returns>
/// <exception cref="Exception"></exception>
public static object ReadToPlcValue(this SiemensClient client,PlcVarInfo varInfo)
{
Type dataType = varInfo.DataType;
object resultvalue;
if (dataType == typeof(string))
{
var result = client.ReadString(varInfo.VarAddress);
if (!result.IsSucceed) throw new Exception(result.Err);
resultvalue = result.Value;
}
else if (dataType == typeof(char))
{
var result = client.ReadString(varInfo.VarAddress);
if (!result.IsSucceed) throw new Exception(result.Err);
resultvalue = result.Value;
}
else if (dataType == typeof(bool))
{
var result = client.ReadBoolean(varInfo.VarAddress);
if (!result.IsSucceed) throw new Exception(result.Err);
resultvalue = result.Value;
}
else if (dataType == typeof(float))
{
var result = client.ReadFloat(varInfo.VarAddress);
if (!result.IsSucceed) throw new Exception(result.Err);
resultvalue = result.Value;
}
else if (dataType == typeof(double))
{
var result = client.ReadDouble(varInfo.VarAddress);
if (!result.IsSucceed) throw new Exception(result.Err);
resultvalue = result.Value;
}
else if (dataType == typeof(byte))
{
var result = client.ReadByte(varInfo.VarAddress);
if (!result.IsSucceed) throw new Exception(result.Err);
resultvalue = result.Value;
}
else if (dataType == typeof(short))
{
var result = client.ReadInt16(varInfo.VarAddress);
if (!result.IsSucceed) throw new Exception(result.Err);
resultvalue = result.Value;
}
else if (dataType == typeof(ushort))
{
var result = client.ReadUInt16(varInfo.VarAddress);
if (!result.IsSucceed) throw new Exception(result.Err);
resultvalue = result.Value;
}
else if (dataType == typeof(int))
{
var result = client.ReadInt32(varInfo.VarAddress);
if (!result.IsSucceed) throw new Exception(result.Err);
resultvalue = result.Value;
}
else if (dataType == typeof(uint))
{
var result = client.ReadUInt32(varInfo.VarAddress);
if (!result.IsSucceed) throw new Exception(result.Err);
resultvalue = result.Value;
}
else if (dataType == typeof(long))
{
var result = client.ReadInt64(varInfo.VarAddress);
if (!result.IsSucceed) throw new Exception(result.Err);
resultvalue = result.Value;
}
else if (dataType == typeof(ulong))
{
var result = client.ReadUInt64(varInfo.VarAddress);
if (!result.IsSucceed) throw new Exception(result.Err);
resultvalue = result.Value;
}
else
{
resultvalue = default;
}
return resultvalue;
}
public static void WriteToPlcValue(this SiemensClient client, PlcVarInfo varInfo ,object value)
{
if(client == null) throw new ArgumentNullException("client");
Type dataType = varInfo.DataType;
Result result = null;
if (dataType == typeof(string))
{
result = client.Write(varInfo.VarAddress, value.ToString());
}
else if (dataType == typeof(char))
{
result = client.Write(varInfo.VarAddress, value.ToString());
}
else if (dataType == typeof(bool))
{
var @bool = bool.Parse(value.ToString());
result = client.Write(varInfo.VarAddress, @bool);
}
else if (dataType == typeof(float))
{
var @float = float.Parse(value.ToString());
result = client.Write(varInfo.VarAddress, @float);
}
else if (dataType == typeof(double))
{
var @double = double.Parse(value.ToString());
result = client.Write(varInfo.VarAddress, @double);
}
else if (dataType == typeof(byte))
{
var @byte = byte.Parse(value.ToString());
result = client.Write(varInfo.VarAddress, @byte);
}
else if (dataType == typeof(short))
{
var @short = short.Parse(value.ToString());
result = client.Write(varInfo.VarAddress, @short);
}
else if (dataType == typeof(ushort))
{
var @ushort = ushort.Parse(value.ToString());
result = client.Write(varInfo.VarAddress, @ushort);
}
else if (dataType == typeof(int))
{
var @int = int.Parse(value.ToString());
result = client.Write(varInfo.VarAddress, @int);
}
else if (dataType == typeof(uint))
{
var @uint = uint.Parse(value.ToString());
result = client.Write(varInfo.VarAddress, @uint);
}
else if (dataType == typeof(long))
{
var @long = long.Parse(value.ToString());
result = client.Write(varInfo.VarAddress, @long);
}
else if (dataType == typeof(ulong))
{
var @ulong = ulong.Parse(value.ToString());
result = client.Write(varInfo.VarAddress, @ulong);
}
if (result is null)
{
throw new Exception($"未定义的数据类型");
}
if(!result.IsSucceed)
{
throw new Exception(result.Err);
}
}
}
}

36
Net461DllTest/View/FromWorkBenchView.Designer.cs generated
View File

@@ -29,33 +29,35 @@
private void InitializeComponent()
{
this.button1 = new System.Windows.Forms.Button();
this.textBox1 = new System.Windows.Forms.TextBox();
this.textBoxPlcInfo = new System.Windows.Forms.TextBox();
this.button2 = new System.Windows.Forms.Button();
this.listBox1 = new System.Windows.Forms.ListBox();
this.textBoxSpaceNum = new System.Windows.Forms.TextBox();
this.SuspendLayout();
//
// button1
//
this.button1.Location = new System.Drawing.Point(187, 22);
this.button1.Location = new System.Drawing.Point(220, 56);
this.button1.Name = "button1";
this.button1.Size = new System.Drawing.Size(98, 23);
this.button1.Size = new System.Drawing.Size(65, 23);
this.button1.TabIndex = 0;
this.button1.Text = "查看状态";
this.button1.UseVisualStyleBackColor = true;
this.button1.Click += new System.EventHandler(this.button1_Click);
//
// textBox1
// textBoxPlcInfo
//
this.textBox1.Location = new System.Drawing.Point(35, 24);
this.textBox1.Name = "textBox1";
this.textBox1.Size = new System.Drawing.Size(137, 21);
this.textBox1.TabIndex = 1;
this.textBoxPlcInfo.Location = new System.Drawing.Point(35, 24);
this.textBoxPlcInfo.Name = "textBoxPlcInfo";
this.textBoxPlcInfo.ReadOnly = true;
this.textBoxPlcInfo.Size = new System.Drawing.Size(250, 21);
this.textBoxPlcInfo.TabIndex = 1;
//
// button2
//
this.button2.Location = new System.Drawing.Point(178, 179);
this.button2.Location = new System.Drawing.Point(205, 181);
this.button2.Name = "button2";
this.button2.Size = new System.Drawing.Size(107, 23);
this.button2.Size = new System.Drawing.Size(80, 23);
this.button2.TabIndex = 2;
this.button2.Text = "触发";
this.button2.UseVisualStyleBackColor = true;
@@ -70,14 +72,23 @@
this.listBox1.Size = new System.Drawing.Size(250, 88);
this.listBox1.TabIndex = 6;
//
// textBoxSpaceNum
//
this.textBoxSpaceNum.Location = new System.Drawing.Point(35, 183);
this.textBoxSpaceNum.Name = "textBoxSpaceNum";
this.textBoxSpaceNum.Size = new System.Drawing.Size(106, 21);
this.textBoxSpaceNum.TabIndex = 7;
this.textBoxSpaceNum.Text = "104";
//
// FromWorkBenchView
//
this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 12F);
this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font;
this.ClientSize = new System.Drawing.Size(341, 251);
this.Controls.Add(this.textBoxSpaceNum);
this.Controls.Add(this.listBox1);
this.Controls.Add(this.button2);
this.Controls.Add(this.textBox1);
this.Controls.Add(this.textBoxPlcInfo);
this.Controls.Add(this.button1);
this.Name = "FromWorkBenchView";
this.Text = "Form1";
@@ -89,8 +100,9 @@
#endregion
private System.Windows.Forms.Button button1;
private System.Windows.Forms.TextBox textBox1;
private System.Windows.Forms.TextBox textBoxPlcInfo;
private System.Windows.Forms.Button button2;
private System.Windows.Forms.ListBox listBox1;
private System.Windows.Forms.TextBox textBoxSpaceNum;
}
}

10
Net461DllTest/View/FromWorkBenchView.cs
View File

@@ -31,17 +31,21 @@ namespace Net461DllTest
private void button1_Click(object sender, EventArgs e)
{
textBox1.Text = ViewModel.GetDeviceInfo();
textBoxPlcInfo.Text = ViewModel.GetDeviceInfo();
}
private void button2_Click(object sender, EventArgs e)
{
if(listBox1.SelectedItem is null)
{
return;
}
string type = listBox1.SelectedItem.ToString();
if (Enum.TryParse(type, out OrderSignal signal) && Enum.IsDefined(typeof(OrderSignal), signal))
if (!string.IsNullOrEmpty(type) && Enum.TryParse(type, out OrderSignal signal) && Enum.IsDefined(typeof(OrderSignal), signal))
{
Console.WriteLine($"Trigger : {type}");
ViewModel.Trigger(signal);
ViewModel.Trigger(signal,textBoxSpaceNum.Text);
}
}

33
Net461DllTest/View/TeseFormView.cs
View File

@@ -1,33 +0,0 @@
using Net461DllTest.Data;
using Net461DllTest.Signal;
using Serein.Library.Attributes;
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;
using static System.Windows.Forms.VisualStyles.VisualStyleElement;
namespace Net461DllTest.View
{
public partial class TeseFormView : Form
{
[AutoInjection]
public MyData MyData { get; set; }
public TeseFormView()
{
InitializeComponent();
}
private void button1_Click(object sender, EventArgs e)
{
MyData.Count = 0;
}
}
}

12
Net461DllTest/View/TeseFormView.Designer.cs → Net461DllTest/View/TestFormView.Designer.cs generated
View File

@@ -1,6 +1,8 @@
namespace Net461DllTest.View
using System;
namespace Net461DllTest.View
{
partial class TeseFormView
partial class TestFormView
{
/// <summary>
/// Required designer variable.
@@ -37,17 +39,17 @@
this.button1.Name = "button1";
this.button1.Size = new System.Drawing.Size(75, 23);
this.button1.TabIndex = 0;
this.button1.Text = "清空";
this.button1.Text = "测试";
this.button1.UseVisualStyleBackColor = true;
this.button1.Click += new System.EventHandler(this.button1_Click);
//
// TeseFormView
// TestFormView
//
this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 12F);
this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font;
this.ClientSize = new System.Drawing.Size(254, 118);
this.Controls.Add(this.button1);
this.Name = "TeseFormView";
this.Name = "TestFormView";
this.Text = "TeseForm";
this.ResumeLayout(false);

19
Net461DllTest/View/TestFormView.cs Normal file
View File

@@ -0,0 +1,19 @@
using System;
using System.Windows.Forms;
namespace Net461DllTest.View
{
public partial class TestFormView : Form
{
public TestFormView()
{
InitializeComponent();
}
private void button1_Click(object sender, EventArgs e)
{
}
}
}

0
Net461DllTest/View/TeseFormView.resx → Net461DllTest/View/TestFormView.resx
View File

15
Net461DllTest/ViewModel/FromWorkBenchViewModel.cs
View File

@@ -12,22 +12,21 @@ namespace Net461DllTest.ViewModel
public class FromWorkBenchViewModel
{
[AutoInjection]
public PlcDevice Device { get; set; }
public SiemensPlcDevice Device { get; set; }
public string Name { get; set; }
public string GetDeviceInfo()
{
if(Device is null)
{
return string.Empty;
}
return "PLC ID:" + Device.PlcId + " - " + Device.MyData.Count.ToString();
return Device?.ToString();
}
public void Trigger(OrderSignal signal)
public void Trigger(OrderSignal signal,string spcaeNumber)
{
Device.TriggerSignal(signal, 0);
_ = Task.Run(() =>
{
Device.TriggerSignal(signal, spcaeNumber);
});
}

2
Net461DllTest/Web/ApiController.cs
View File

@@ -14,7 +14,7 @@ namespace Net461DllTest.Web
public class ApiController : ControllerBase
{
[AutoInjection]
public PlcDevice PlcDevice { get; set; }
public SiemensPlcDevice PlcDevice { get; set; }
[WebApi(API.POST)]
public dynamic Trigger([Url] string type, int value)

11
Net461DllTest/app.config Normal file
View File

@@ -0,0 +1,11 @@
<?xml version="1.0" encoding="utf-8"?>
<configuration>
<runtime>
<assemblyBinding xmlns="urn:schemas-microsoft-com:asm.v1">
<dependentAssembly>
<assemblyIdentity name="System.IO.Ports" publicKeyToken="cc7b13ffcd2ddd51" culture="neutral" />
<bindingRedirect oldVersion="0.0.0.0-4.0.2.0" newVersion="4.0.2.0" />
</dependentAssembly>
</assemblyBinding>
</runtime>
</configuration>

2
Net461DllTest/packages.config
View File

@@ -1,4 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<packages>
<package id="IoTClient" version="1.0.40" targetFramework="net461" />
<package id="System.IO.Ports" version="4.6.0" targetFramework="net461" />
<package id="System.ValueTuple" version="4.5.0" targetFramework="net461" />
</packages>

21
NodeFlow/Base/NodeModelBaseFunc.cs
View File

@@ -223,6 +223,7 @@ namespace Serein.NodeFlow.Base
}
catch (Exception ex)
{
await Console.Out.WriteLineAsync(ex.ToString());
NextOrientation = ConnectionType.IsError;
RuningException = ex;
return null;
@@ -292,7 +293,23 @@ namespace Serein.NodeFlow.Base
inputParameter = flowData; // 使用上一节点的对象
}
// 存在转换器
if (ed.Convertor is not null)
{
if (Enum.TryParse(ed.ExplicitType, ed.DataValue, out var resultEnum))
{
var value = ed.Convertor(resultEnum);
if (value is not null)
{
parameters[i] = value;
continue;
}
else
{
throw new InvalidOperationException("转换器调用失败");
}
}
}
//var attribute = ed.DataType.GetCustomAttribute<EnumTypeConvertorAttribute>();
//if (attribute is not null && attribute.EnumType.IsEnum) // 获取枚举转换器中记录的枚举
@@ -312,6 +329,8 @@ namespace Serein.NodeFlow.Base
}
}
}
try

51
NodeFlow/FlowEnvironment.cs
View File

@@ -311,11 +311,11 @@ namespace Serein.NodeFlow
foreach (var dll in dllPaths)
{
var dllFilePath = System.IO.Path.GetFullPath(System.IO.Path.Combine(filePath, dll));
(var assembly, var list) = LoadAssembly(dllFilePath);
if (assembly is not null && list.Count > 0)
(var assembly, var registerTypes, var mdlist) = LoadAssembly(dllFilePath);
if (assembly is not null && mdlist.Count > 0)
{
MethodDetailss.AddRange(list); // 暂存方法描述
OnDllLoad?.Invoke(new LoadDLLEventArgs(assembly, list)); // 通知UI创建dll面板显示
MethodDetailss.AddRange(mdlist); // 暂存方法描述
OnDllLoad?.Invoke(new LoadDLLEventArgs(assembly, mdlist)); // 通知UI创建dll面板显示
}
}
// 方法加载完成，缓存到运行环境中。
@@ -435,6 +435,7 @@ namespace Serein.NodeFlow
OnProjectLoaded?.Invoke(new ProjectLoadedEventArgs());
}
/// <summary>
/// 保存项目为项目文件
/// </summary>
@@ -457,17 +458,20 @@ namespace Serein.NodeFlow
/// <returns></returns>
public void LoadDll(string dllPath)
{
(var assembly, var list) = LoadAssembly(dllPath);
(var assembly, _, var list) = LoadAssembly(dllPath);
if (assembly is not null && list.Count > 0)
{
MethodDetailss.AddRange(list);
OnDllLoad?.Invoke(new LoadDLLEventArgs(assembly, list));
}
}
/// <summary>
/// 运行时创建节点
/// </summary>
/// <param name="nodeBase"></param>
/// <param name="nodeControlType"></param>
/// <param name="position"></param>
/// <param name="methodDetails"></param>
public void CreateNode(NodeControlType nodeControlType, Position position, MethodDetails? methodDetails = null)
{
var nodeModel = CreateNode(nodeControlType, methodDetails);
@@ -477,8 +481,7 @@ namespace Serein.NodeFlow
&& nodeControlType == NodeControlType.Flipflop
&& nodeModel is SingleFlipflopNode flipflopNode)
{
// 当前添加节点属于触发器，且当前正在运行，则加载到运行环境中
flowStarter?.AddFlipflopInRuning(flipflopNode, this);
_ = flowStarter?.RunGlobalFlipflopAsync(this, flipflopNode); // 当前添加节点属于触发器，且当前正在运行，则加载到运行环境中
}
// 通知UI更改
@@ -504,6 +507,11 @@ namespace Serein.NodeFlow
{
return;
}
if (remoteNode is SingleFlipflopNode flipflopNode)
{
flowStarter?.TerminateGlobalFlipflopRuning(flipflopNode); // 假设被移除的是全局触发器，尝试从启动器移除
}
// 遍历所有父节点，从那些父节点中的子节点集合移除该节点
foreach (var pnc in remoteNode.PreviousNodes)
@@ -512,7 +520,6 @@ namespace Serein.NodeFlow
for (int i = 0; i < pnc.Value.Count; i++)
{
NodeModelBase? pNode = pnc.Value[i];
//pNode.SuccessorNodes[pCType].RemoveAt(i);
pNode.SuccessorNodes[pCType].Remove(pNode);
OnNodeConnectChange?.Invoke(new NodeConnectChangeEventArgs(pNode.Guid,
@@ -588,13 +595,13 @@ namespace Serein.NodeFlow
{
fromNode.SuccessorNodes[connectionType].Remove(toNode);
toNode.PreviousNodes[connectionType].Remove(fromNode);
if (toNode is SingleFlipflopNode flipflopNode)
if (toNode is SingleFlipflopNode flipflopNode) // 子节点为触发器
{
if (flowStarter?.FlowState != RunState.Completion
&& flipflopNode.NotExitPreviousNode())
if (flowStarter?.FlowState != RunState.Completion
&& flipflopNode.NotExitPreviousNode()) // 正在运行，且该触发器没有上游节点
{
// 被父节点移除连接关系的子节点若为触发器，且无上级节点，则当前流程正在运行，则加载到运行环境中
flowStarter?.AddFlipflopInRuning(flipflopNode, this);
flowStarter?.RunGlobalFlipflopAsync(this, flipflopNode); // 被父节点移除连接关系的子节点若为触发器，且无上级节点，则当前流程正在运行，则加载到运行环境中
}
}
@@ -844,17 +851,19 @@ namespace Serein.NodeFlow
/// 加载指定路径的DLL文件
/// </summary>
/// <param name="dllPath"></param>
private (Assembly?, List<MethodDetails>) LoadAssembly(string dllPath)
private (Assembly?, List<Type> ,List<MethodDetails>) LoadAssembly(string dllPath)
{
try
{
Assembly assembly = Assembly.LoadFrom(dllPath); // 加载DLL文件
Type[] types = assembly.GetTypes(); // 获取程序集中的所有类型
List<Type> autoRegisterTypes = assembly.GetTypes().Where(t => t.GetCustomAttribute<AutoRegisterAttribute>() is not null).ToList();
List<Type> scanTypes = assembly.GetTypes().Where(t => t.GetCustomAttribute<DynamicFlowAttribute>()?.Scan == true).ToList();
if (scanTypes.Count == 0)
{
return (null, []);
return (null, [], []);
}
List<MethodDetails> methodDetails = new List<MethodDetails>();
@@ -874,14 +883,15 @@ namespace Serein.NodeFlow
}
LoadedAssemblies.Add(assembly); // 将加载的程序集添加到列表中
LoadedAssemblyPaths.Add(dllPath); // 记录加载的DLL路径
return (assembly, methodDetails);
return (assembly, autoRegisterTypes , methodDetails);
}
catch (Exception ex)
{
Console.WriteLine(ex.ToString());
return (null, []);
return (null, [],[]);
}
}
/// <summary>
/// 运行环节加载了项目文件，需要创建节点控件
/// </summary>
@@ -985,6 +995,11 @@ namespace Serein.NodeFlow
ConnectionType.IsFail,
ConnectionType.IsError,
ConnectionType.Upstream];
if (toNode is SingleFlipflopNode flipflopNode)
{
flowStarter?.TerminateGlobalFlipflopRuning(flipflopNode); // 假设被连接的是全局触发器，尝试移除
}
foreach (ConnectionType ctType in ct)
{
var FToTo = fromNode.SuccessorNodes[ctType].Where(it => it.Guid.Equals(toNode.Guid)).ToArray();

89
NodeFlow/FlowStarter.cs
View File

@@ -6,6 +6,7 @@ using Serein.Library.Utils;
using Serein.Library.Web;
using Serein.NodeFlow.Base;
using Serein.NodeFlow.Model;
using System.Collections.Concurrent;
using System.ComponentModel.Design;
using System.Runtime.CompilerServices;
using System.Xml.Linq;
@@ -238,6 +239,8 @@ namespace Serein.NodeFlow
((Action<object, object?[]?>)md.MethodDelegate).Invoke(md.ActingInstance, [Context]);
}
TerminateAllGlobalFlipflop();
if (_flipFlopCts != null && !_flipFlopCts.IsCancellationRequested)
{
_flipFlopCts?.Cancel();
@@ -245,6 +248,7 @@ namespace Serein.NodeFlow
}
FlowState = RunState.Completion;
FlipFlopState = RunState.Completion;
};
#endregion
@@ -263,7 +267,7 @@ namespace Serein.NodeFlow
// 使用 TaskCompletionSource 创建未启动的触发器任务
var tasks = flipflopNodes.Select(async node =>
{
await FlipflopExecute(env,node);
await RunGlobalFlipflopAsync(env,node);
}).ToArray();
_ = Task.WhenAll(tasks);
}
@@ -288,31 +292,68 @@ namespace Serein.NodeFlow
#endregion
}
public void AddFlipflopInRuning(SingleFlipflopNode singleFlipFlopNode, IFlowEnvironment env)
private ConcurrentDictionary<SingleFlipflopNode, CancellationTokenSource> dictGlobalFlipflop = [];
/// <summary>
/// 尝试添加全局触发器
/// </summary>
/// <param name="singleFlipFlopNode"></param>
/// <param name="env"></param>
public async Task RunGlobalFlipflopAsync(IFlowEnvironment env, SingleFlipflopNode singleFlipFlopNode)
{
_ = Task.Run(async () =>
if (dictGlobalFlipflop.TryAdd(singleFlipFlopNode, new CancellationTokenSource()))
{
// 设置对象
singleFlipFlopNode.MethodDetails.ActingInstance = env.IOC.GetOrRegisterInstantiate(singleFlipFlopNode.MethodDetails.ActingInstanceType);
await FlipflopExecute(env,singleFlipFlopNode); // 启动触发器
});
singleFlipFlopNode.MethodDetails.ActingInstance ??= env.IOC.GetOrRegisterInstantiate(singleFlipFlopNode.MethodDetails.ActingInstanceType);
await FlipflopExecuteAsync(env, singleFlipFlopNode, dictGlobalFlipflop[singleFlipFlopNode]);
}
}
/// <summary>
/// 尝试移除全局触发器
/// </summary>
/// <param name="singleFlipFlopNode"></param>
public void TerminateGlobalFlipflopRuning(SingleFlipflopNode singleFlipFlopNode)
{
if (dictGlobalFlipflop.TryRemove(singleFlipFlopNode, out var cts))
{
if (!cts.IsCancellationRequested)
{
cts.Cancel();
}
cts.Dispose();
}
}
/// <summary>
/// 总结所有全局触发器
/// </summary>
private void TerminateAllGlobalFlipflop()
{
foreach ((var node, var cts) in dictGlobalFlipflop)
{
if (!cts.IsCancellationRequested)
{
cts.Cancel();
}
cts.Dispose();
}
dictGlobalFlipflop.Clear();
}
/// <summary>
/// 启动全局触发器
/// </summary>
/// <param name="env">流程运行全局环境</param>
/// <param name="singleFlipFlopNode">需要全局监听信号的触发器</param>
/// <returns></returns>
private async Task FlipflopExecute(IFlowEnvironment env,SingleFlipflopNode singleFlipFlopNode)
private async Task FlipflopExecuteAsync(IFlowEnvironment env, SingleFlipflopNode singleFlipFlopNode, CancellationTokenSource cts)
{
var context = new DynamicContext(env); // 启动全局触发器时新建上下文
while (!_flipFlopCts.IsCancellationRequested)
while (!_flipFlopCts.IsCancellationRequested && !cts.IsCancellationRequested)
{
try
{
var newFlowData = await singleFlipFlopNode.ExecutingAsync(context); // 获取触发器等待Task
var waitTask = singleFlipFlopNode.ExecutingAsync(context); // 获取触发器等待Task
var newFlowData = await waitTask;
await NodeModelBase.RefreshFlowDataAndExpInterrupt(context, singleFlipFlopNode, newFlowData); // 全局触发器触发后刷新该触发器的节点数据
if (singleFlipFlopNode.NextOrientation != ConnectionType.None)
{
@@ -339,32 +380,6 @@ namespace Serein.NodeFlow
}
}
//MethodDetails md = singleFlipFlopNode.MethodDetails;
//var del = md.MethodDelegate;
//object?[]? parameters = singleFlipFlopNode.GetParameters(context, singleFlipFlopNode.MethodDetails); // 启动全局触发器时获取入参参数
//// 设置委托对象
//var func = md.ExplicitDatas.Length == 0 ?
// (Func<object, object, Task<IFlipflopContext>>)del :
// (Func<object, object[], Task<IFlipflopContext>>)del;
//if(t)
//{
// IFlipflopContext flipflopContext = await ((Func<object, Task<IFlipflopContext>>)del.Clone()).Invoke(md.ActingInstance);// 开始等待全局触发器的触发
// var connectionType = flipflopContext.State.ToContentType();
// if (connectionType != ConnectionType.None)
// {
// await GlobalFlipflopExecute(context, singleFlipFlopNode, connectionType, cts);
// }
//}
//else
//{
// IFlipflopContext flipflopContext = await ((Func<object, object[], Task<IFlipflopContext>>)del.Clone()).Invoke(md.ActingInstance, parameters);// 开始等待全局触发器的触发
// var connectionType = flipflopContext.State.ToContentType();
// if (connectionType != ConnectionType.None)
// {
// await GlobalFlipflopExecute(context, singleFlipFlopNode, connectionType, cts);
// }
//}
}

26
NodeFlow/Model/SingleFlipflopNode.cs
View File

@@ -19,6 +19,7 @@ namespace Serein.NodeFlow.Model
//}
public override async Task<object?> ExecutingAsync(IDynamicContext context)
{
#region 执行前中断
@@ -26,11 +27,6 @@ namespace Serein.NodeFlow.Model
{
string guid = this.Guid.ToString();
var cancelType = await this.DebugSetting.GetInterruptTask();
//if (cancelType == CancelType.Discard)
//{
// this.NextOrientation = ConnectionType.None;
// return null;
//}
await Console.Out.WriteLineAsync($"[{this.MethodDetails.MethodName}]中断已{cancelType}，开始执行后继分支");
}
#endregion
@@ -42,11 +38,21 @@ namespace Serein.NodeFlow.Model
try
{
// 调用委托并获取结果
Task<IFlipflopContext> flipflopTask = md.ExplicitDatas.Length switch
//Task<IFlipflopContext> flipflopTask = md.ExplicitDatas.Length switch
//{
// 0 => ((Func<object, Task<IFlipflopContext>>)del).Invoke(md.ActingInstance),
// _ => ((Func<object, object?[]?, Task<IFlipflopContext>>)del).Invoke(md.ActingInstance, GetParameters(context, this, md)), // 执行流程中的触发器方法时获取入参参数
//};
Task<IFlipflopContext> flipflopTask;
if (md.ExplicitDatas.Length == 0)
{
0 => ((Func<object, Task<IFlipflopContext>>)del).Invoke(md.ActingInstance),
_ => ((Func<object, object?[]?, Task<IFlipflopContext>>)del).Invoke(md.ActingInstance, GetParameters(context, this, md)), // 执行流程中的触发器方法时获取入参参数
};
flipflopTask = ((Func<object, Task<IFlipflopContext>>)del).Invoke(md.ActingInstance);
}
else
{
var parameters = GetParameters(context, this, md);
flipflopTask = ((Func<object, object?[]?, Task<IFlipflopContext>>)del).Invoke(md.ActingInstance, parameters);
}
IFlipflopContext flipflopContext = (await flipflopTask) ?? throw new FlipflopException("没有返回上下文");
NextOrientation = flipflopContext.State.ToContentType();
@@ -58,12 +64,14 @@ namespace Serein.NodeFlow.Model
}
catch (FlipflopException ex)
{
await Console.Out.WriteLineAsync(ex.ToString());
NextOrientation = ConnectionType.None;
RuningException = ex;
return null;
}
catch (Exception ex)
{
await Console.Out.WriteLineAsync(ex.ToString());
NextOrientation = ConnectionType.IsError;
RuningException = ex;
return null;

102
NodeFlow/Tool/MethodDetailsHelper.cs
View File

@@ -4,6 +4,7 @@ using Serein.Library.Core.NodeFlow;
using Serein.Library.Entity;
using System;
using System.Collections.Concurrent;
using System.ComponentModel;
using System.Reflection;
namespace Serein.NodeFlow.Tool;
@@ -89,6 +90,9 @@ public static class MethodDetailsHelperTmp
}
private static ConcurrentDictionary<string, (object, MethodInfo)> ConvertorInstance =[];
/// <summary>
/// 获取参数信息
/// </summary>
@@ -100,36 +104,90 @@ public static class MethodDetailsHelperTmp
return parameters.Select((it, index) =>
{
Type paremType;
var attribute = it.GetCustomAttribute<EnumTypeConvertorAttribute>();
if (attribute is not null)
if (it.GetCustomAttribute<EnumTypeConvertorAttribute>() is EnumTypeConvertorAttribute attribute1 && attribute1 is not null)
{
// 存在选择器
paremType = attribute.EnumType;
// 存在类型选择器
paremType = attribute1.EnumType;
return GetExplicitDataOfParameter(it, index, paremType, true);
}
else if (it.GetCustomAttribute<BindConvertorAttribute>() is BindConvertorAttribute attribute2 && attribute2 is not null)
{
paremType = attribute2.EnumType;
string key = typeof(IEnumConvertor<,>).FullName + attribute2.EnumType.FullName + attribute2.ConvertorType.FullName;
if (!ConvertorInstance.ContainsKey(key))
{
Type enumConvertorType = typeof(IEnumConvertor<,>);
// 定义具体类型
Type specificType = enumConvertorType.MakeGenericType(attribute2.EnumType, it.ParameterType);
// 获取实现类的类型
Type implementorType = attribute2.ConvertorType;
// 创建实现类的实例
object instance = Activator.CreateInstance(implementorType);
// 调用 Convert 方法
MethodInfo convertMethod = implementorType.GetMethod("Convertor");
ConvertorInstance[key] = (instance, convertMethod);
}
Func<object, object> func = (enumValue) =>
{
(var obj,var methodInfo) = ConvertorInstance[key];
return methodInfo?.Invoke(obj, [enumValue]);
};
// 确保实例实现了所需接口
ExplicitData ed = GetExplicitDataOfParameter(it, index, paremType, true, func);
return ed;
}
else
{
paremType = it.ParameterType;
return GetExplicitDataOfParameter(it, index, it.ParameterType, it.HasDefaultValue);
}
string explicitTypeName = GetExplicitTypeName(paremType);
var items = GetExplicitItems(paremType, explicitTypeName);
if ("Bool".Equals(explicitTypeName)) explicitTypeName = "Select"; // 布尔值 转为 可选类型
return new ExplicitData
{
IsExplicitData = attribute is null ? it.HasDefaultValue: true,
Index = index,
ExplicitTypeName = explicitTypeName,
ExplicitType = paremType,
DataType = it.ParameterType,
ParameterName = it.Name,
DataValue = it.HasDefaultValue ? it.DefaultValue.ToString() : "",
Items = items.ToArray(),
};
//string explicitTypeName = GetExplicitTypeName(paremType);
//var items = GetExplicitItems(paremType, explicitTypeName);
//if ("Bool".Equals(explicitTypeName)) explicitTypeName = "Select"; // 布尔值 转为 可选类型
//return new ExplicitData
//{
// IsExplicitData = attribute is null ? it.HasDefaultValue: true,
// Index = index,
// ExplicitTypeName = explicitTypeName,
// ExplicitType = paremType,
// DataType = it.ParameterType,
// ParameterName = it.Name,
// DataValue = it.HasDefaultValue ? it?.DefaultValue?.ToString() : "",
// Items = items.ToArray(),
//};
}).ToArray();
}
private static ExplicitData GetExplicitDataOfParameter(ParameterInfo parameterInfo,
int index,
Type paremType,
bool isExplicitData,
Func<object, object> func = null)
{
string explicitTypeName = GetExplicitTypeName(paremType);
var items = GetExplicitItems(paremType, explicitTypeName);
if ("Bool".Equals(explicitTypeName)) explicitTypeName = "Select"; // 布尔值 转为 可选类型
return new ExplicitData
{
IsExplicitData = isExplicitData, //attribute is null ? parameterInfo.HasDefaultValue : true,
Index = index,
ExplicitTypeName = explicitTypeName,
ExplicitType = paremType,
Convertor = func,
DataType = parameterInfo.ParameterType,
ParameterName = parameterInfo.Name,
DataValue = parameterInfo.HasDefaultValue ? parameterInfo?.DefaultValue?.ToString() : "",
Items = items.ToArray(),
};
}
/// <summary>
/// 判断使用输入器还是选择器
/// </summary>

2
WorkBench/MainWindow.xaml.cs
View File

@@ -213,7 +213,7 @@ namespace Serein.WorkBench
private LogWindow InitConsoleOut()
{
var logWindow = new LogWindow();
logWindow.Show();
//logWindow.Show();
// 重定向 Console 输出
var logTextWriter = new LogTextWriter(msg => logWindow.AppendText(msg), () => logWindow.Clear()); ;
Console.SetOut(logTextWriter);

BIN
packages/IoTClient.1.0.40/.signature.p7s vendored Normal file
View File

Binary file not shown.

BIN
packages/IoTClient.1.0.40/IoTClient.1.0.40.nupkg vendored Normal file
View File

Binary file not shown.

4113
packages/IoTClient.1.0.40/lib/netstandard2.0/IoTClient.xml vendored Normal file
View File

File diff suppressed because it is too large Load Diff

BIN
packages/System.IO.Ports.4.6.0/.signature.p7s vendored Normal file
View File

Binary file not shown.

23
packages/System.IO.Ports.4.6.0/LICENSE.TXT vendored Normal file
View File

@@ -0,0 +1,23 @@
The MIT License (MIT)
Copyright (c) .NET Foundation and Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

BIN
packages/System.IO.Ports.4.6.0/System.IO.Ports.4.6.0.nupkg vendored Normal file
View File

Binary file not shown.

375
packages/System.IO.Ports.4.6.0/THIRD-PARTY-NOTICES.TXT vendored Normal file
View File

@@ -0,0 +1,375 @@
.NET Core uses third-party libraries or other resources that may be
distributed under licenses different than the .NET Core software.
In the event that we accidentally failed to list a required notice, please
bring it to our attention. Post an issue or email us:
dotnet@microsoft.com
The attached notices are provided for information only.
License notice for ASP.NET
-------------------------------
Copyright (c) .NET Foundation. All rights reserved.
Licensed under the Apache License, Version 2.0.
Available at
https://github.com/aspnet/AspNetCore/blob/master/LICENSE.txt
License notice for Slicing-by-8
-------------------------------
http://sourceforge.net/projects/slicing-by-8/
Copyright (c) 2004-2006 Intel Corporation - All Rights Reserved
This software program is licensed subject to the BSD License, available at
http://www.opensource.org/licenses/bsd-license.html.
License notice for Unicode data
-------------------------------
http://www.unicode.org/copyright.html#License
Copyright © 1991-2017 Unicode, Inc. All rights reserved.
Distributed under the Terms of Use in http://www.unicode.org/copyright.html.
Permission is hereby granted, free of charge, to any person obtaining
a copy of the Unicode data files and any associated documentation
(the "Data Files") or Unicode software and any associated documentation
(the "Software") to deal in the Data Files or Software
without restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, and/or sell copies of
the Data Files or Software, and to permit persons to whom the Data Files
or Software are furnished to do so, provided that either
(a) this copyright and permission notice appear with all copies
of the Data Files or Software, or
(b) this copyright and permission notice appear in associated
Documentation.
THE DATA FILES AND SOFTWARE ARE PROVIDED "AS IS", WITHOUT WARRANTY OF
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT OF THIRD PARTY RIGHTS.
IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS
NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL
DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
PERFORMANCE OF THE DATA FILES OR SOFTWARE.
Except as contained in this notice, the name of a copyright holder
shall not be used in advertising or otherwise to promote the sale,
use or other dealings in these Data Files or Software without prior
written authorization of the copyright holder.
License notice for Zlib
-----------------------
https://github.com/madler/zlib
http://zlib.net/zlib_license.html
/* zlib.h -- interface of the 'zlib' general purpose compression library
version 1.2.11, January 15th, 2017
Copyright (C) 1995-2017 Jean-loup Gailly and Mark Adler
This software is provided 'as-is', without any express or implied
warranty. In no event will the authors be held liable for any damages
arising from the use of this software.
Permission is granted to anyone to use this software for any purpose,
including commercial applications, and to alter it and redistribute it
freely, subject to the following restrictions:
1. The origin of this software must not be misrepresented; you must not
claim that you wrote the original software. If you use this software
in a product, an acknowledgment in the product documentation would be
appreciated but is not required.
2. Altered source versions must be plainly marked as such, and must not be
misrepresented as being the original software.
3. This notice may not be removed or altered from any source distribution.
Jean-loup Gailly Mark Adler
jloup@gzip.org madler@alumni.caltech.edu
*/
License notice for Mono
-------------------------------
http://www.mono-project.com/docs/about-mono/
Copyright (c) .NET Foundation Contributors
MIT License
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the Software), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
License notice for International Organization for Standardization
-----------------------------------------------------------------
Portions (C) International Organization for Standardization 1986:
Permission to copy in any form is granted for use with
conforming SGML systems and applications as defined in
ISO 8879, provided this notice is included in all copies.
License notice for Intel
------------------------
"Copyright (c) 2004-2006 Intel Corporation - All Rights Reserved
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License notice for Xamarin and Novell
-------------------------------------
Copyright (c) 2015 Xamarin, Inc (http://www.xamarin.com)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
Copyright (c) 2011 Novell, Inc (http://www.novell.com)
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
Third party notice for W3C
--------------------------
"W3C SOFTWARE AND DOCUMENT NOTICE AND LICENSE
Status: This license takes effect 13 May, 2015.
This work is being provided by the copyright holders under the following license.
License
By obtaining and/or copying this work, you (the licensee) agree that you have read, understood, and will comply with the following terms and conditions.
Permission to copy, modify, and distribute this work, with or without modification, for any purpose and without fee or royalty is hereby granted, provided that you include the following on ALL copies of the work or portions thereof, including modifications:
The full text of this NOTICE in a location viewable to users of the redistributed or derivative work.
Any pre-existing intellectual property disclaimers, notices, or terms and conditions. If none exist, the W3C Software and Document Short Notice should be included.
Notice of any changes or modifications, through a copyright statement on the new code or document such as "This software or document includes material copied from or derived from [title and URI of the W3C document]. Copyright © [YEAR] W3C® (MIT, ERCIM, Keio, Beihang)."
Disclaimers
THIS WORK IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR DOCUMENT WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENT.
The name and trademarks of copyright holders may NOT be used in advertising or publicity pertaining to the work without specific, written prior permission. Title to copyright in this work will at all times remain with copyright holders."
License notice for Bit Twiddling Hacks
--------------------------------------
Bit Twiddling Hacks
By Sean Eron Anderson
seander@cs.stanford.edu
Individually, the code snippets here are in the public domain (unless otherwise
noted) — feel free to use them however you please. The aggregate collection and
descriptions are © 1997-2005 Sean Eron Anderson. The code and descriptions are
distributed in the hope that they will be useful, but WITHOUT ANY WARRANTY and
without even the implied warranty of merchantability or fitness for a particular
purpose.
License notice for Brotli
--------------------------------------
Copyright (c) 2009, 2010, 2013-2016 by the Brotli Authors.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
compress_fragment.c:
Copyright (c) 2011, Google Inc.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
* Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
""AS IS"" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
decode_fuzzer.c:
Copyright (c) 2015 The Chromium Authors. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
* Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following disclaimer
in the documentation and/or other materials provided with the
distribution.
* Neither the name of Google Inc. nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
""AS IS"" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE."
License notice for Json.NET
-------------------------------
https://github.com/JamesNK/Newtonsoft.Json/blob/master/LICENSE.md
The MIT License (MIT)
Copyright (c) 2007 James Newton-King
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
License notice for vectorized base64 encoding / decoding
--------------------------------------------------------
Copyright (c) 2005-2007, Nick Galbreath
Copyright (c) 2013-2017, Alfred Klomp
Copyright (c) 2015-2017, Wojciech Mula
Copyright (c) 2016-2017, Matthieu Darbois
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
- Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

541
packages/System.IO.Ports.4.6.0/lib/net461/System.IO.Ports.xml vendored Normal file
View File

@@ -0,0 +1,541 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>System.IO.Ports</name>
</assembly>
<members>
<member name="T:System.IO.Ports.Handshake">
<summary>Specifies the control protocol used in establishing a serial port communication for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.None">
<summary>No control is used for the handshake.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.RequestToSend">
<summary>Request-to-Send (RTS) hardware flow control is used. RTS signals that data is available for transmission. If the input buffer becomes full, the RTS line will be set to <see langword="false" />. The RTS line will be set to <see langword="true" /> when more room becomes available in the input buffer.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.RequestToSendXOnXOff">
<summary>Both the Request-to-Send (RTS) hardware control and the XON/XOFF software controls are used.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.XOnXOff">
<summary>The XON/XOFF software control protocol is used. The XOFF control is sent to stop the transmission of data. The XON control is sent to resume the transmission. These software controls are used instead of Request to Send (RTS) and Clear to Send (CTS) hardware controls.</summary>
</member>
<member name="T:System.IO.Ports.Parity">
<summary>Specifies the parity bit for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Even">
<summary>Sets the parity bit so that the count of bits set is an even number.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Mark">
<summary>Leaves the parity bit set to 1.</summary>
</member>
<member name="F:System.IO.Ports.Parity.None">
<summary>No parity check occurs.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Odd">
<summary>Sets the parity bit so that the count of bits set is an odd number.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Space">
<summary>Leaves the parity bit set to 0.</summary>
</member>
<member name="T:System.IO.Ports.SerialData">
<summary>Specifies the type of character that was received on the serial port of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialData.Chars">
<summary>A character was received and placed in the input buffer.</summary>
</member>
<member name="F:System.IO.Ports.SerialData.Eof">
<summary>The end of file character was received and placed in the input buffer.</summary>
</member>
<member name="T:System.IO.Ports.SerialDataReceivedEventArgs">
<summary>Provides data for the <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialDataReceivedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialData" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialDataReceivedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The sender of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialDataReceivedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialError">
<summary>Specifies errors that occur on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.Frame">
<summary>The hardware detected a framing error.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.Overrun">
<summary>A character-buffer overrun has occurred. The next character is lost.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.RXOver">
<summary>An input buffer overflow has occurred. There is either no room in the input buffer, or a character was received after the end-of-file (EOF) character.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.RXParity">
<summary>The hardware detected a parity error.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.TXFull">
<summary>The application tried to transmit a character, but the output buffer was full.</summary>
</member>
<member name="T:System.IO.Ports.SerialErrorReceivedEventArgs">
<summary>Prepares data for the <see cref="E:System.IO.Ports.SerialPort.ErrorReceived" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialErrorReceivedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialError" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialErrorReceivedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.ErrorReceived" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The sender of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialErrorReceivedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialPinChange">
<summary>Specifies the type of change that occurred on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.Break">
<summary>A break was detected on input.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.CDChanged">
<summary>The Carrier Detect (CD) signal changed state. This signal is used to indicate whether a modem is connected to a working phone line and a data carrier signal is detected.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.CtsChanged">
<summary>The Clear to Send (CTS) signal changed state. This signal is used to indicate whether data can be sent over the serial port.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.DsrChanged">
<summary>The Data Set Ready (DSR) signal changed state. This signal is used to indicate whether the device on the serial port is ready to operate.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.Ring">
<summary>A ring indicator was detected.</summary>
</member>
<member name="T:System.IO.Ports.SerialPinChangedEventArgs">
<summary>Provides data for the <see cref="E:System.IO.Ports.SerialPort.PinChanged" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialPinChangedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialPinChange" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialPinChangedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.PinChanged" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The source of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialPinChangedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialPort">
<summary>Represents a serial port resource.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.ComponentModel.IContainer)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified <see cref="T:System.ComponentModel.IContainer" /> object.</summary>
<param name="container">An interface to a container.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name and baud rate.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, and parity bit.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity,System.Int32)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, parity bit, and data bits.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<param name="dataBits">The data bits value.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity,System.Int32,System.IO.Ports.StopBits)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, parity bit, data bits, and stop bit.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<param name="dataBits">The data bits value.</param>
<param name="stopBits">One of the <see cref="P:System.IO.Ports.SerialPort.StopBits" /> values.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BaseStream">
<summary>Gets the underlying <see cref="T:System.IO.Stream" /> object for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>A <see cref="T:System.IO.Stream" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
<exception cref="T:System.NotSupportedException">The stream is in a .NET Compact Framework application and one of the following methods was called:
<see cref="M:System.IO.Stream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /><see cref="M:System.IO.Stream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /><see cref="M:System.IO.Stream.EndRead(System.IAsyncResult)" /><see cref="M:System.IO.Stream.EndWrite(System.IAsyncResult)" />
The .NET Compact Framework does not support the asynchronous model with base streams.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BaudRate">
<summary>Gets or sets the serial baud rate.</summary>
<returns>The baud rate.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The baud rate specified is less than or equal to zero, or is greater than the maximum allowable baud rate for the device.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BreakState">
<summary>Gets or sets the break signal state.</summary>
<returns>
<see langword="true" /> if the port is in a break state; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BytesToRead">
<summary>Gets the number of bytes of data in the receive buffer.</summary>
<returns>The number of bytes of data in the receive buffer.</returns>
<exception cref="T:System.InvalidOperationException">The port is not open.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BytesToWrite">
<summary>Gets the number of bytes of data in the send buffer.</summary>
<returns>The number of bytes of data in the send buffer.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.CDHolding">
<summary>Gets the state of the Carrier Detect line for the port.</summary>
<returns>
<see langword="true" /> if the carrier is detected; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Close">
<summary>Closes the port connection, sets the <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> property to <see langword="false" />, and disposes of the internal <see cref="T:System.IO.Stream" /> object.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.CtsHolding">
<summary>Gets the state of the Clear-to-Send line.</summary>
<returns>
<see langword="true" /> if the Clear-to-Send line is detected; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DataBits">
<summary>Gets or sets the standard length of data bits per byte.</summary>
<returns>The data bits length.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The data bits value is less than 5 or more than 8.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.DataReceived">
<summary>Indicates that data has been received through a port represented by the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.DiscardInBuffer">
<summary>Discards data from the serial driver's receive buffer.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DiscardNull">
<summary>Gets or sets a value indicating whether null bytes are ignored when transmitted between the port and the receive buffer.</summary>
<returns>
<see langword="true" /> if null bytes are ignored; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.DiscardOutBuffer">
<summary>Discards data from the serial driver's transmit buffer.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Dispose(System.Boolean)">
<summary>Releases the unmanaged resources used by the <see cref="T:System.IO.Ports.SerialPort" /> and optionally releases the managed resources.</summary>
<param name="disposing">
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DsrHolding">
<summary>Gets the state of the Data Set Ready (DSR) signal.</summary>
<returns>
<see langword="true" /> if a Data Set Ready signal has been sent to the port; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DtrEnable">
<summary>Gets or sets a value that enables the Data Terminal Ready (DTR) signal during serial communication.</summary>
<returns>
<see langword="true" /> to enable Data Terminal Ready (DTR); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Encoding">
<summary>Gets or sets the byte encoding for pre- and post-transmission conversion of text.</summary>
<returns>An <see cref="T:System.Text.Encoding" /> object. The default is <see cref="T:System.Text.ASCIIEncoding" />.</returns>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.Encoding" /> property was set to <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.Encoding" /> property was set to an encoding that is not <see cref="T:System.Text.ASCIIEncoding" />, <see cref="T:System.Text.UTF8Encoding" />, <see cref="T:System.Text.UTF32Encoding" />, <see cref="T:System.Text.UnicodeEncoding" />, one of the Windows single byte encodings, or one of the Windows double byte encodings.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.ErrorReceived">
<summary>Indicates that an error has occurred with a port represented by a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.GetPortNames">
<summary>Gets an array of serial port names for the current computer.</summary>
<returns>An array of serial port names for the current computer.</returns>
<exception cref="T:System.ComponentModel.Win32Exception">The serial port names could not be queried.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Handshake">
<summary>Gets or sets the handshaking protocol for serial port transmission of data using a value from <see cref="T:System.IO.Ports.Handshake" />.</summary>
<returns>One of the <see cref="T:System.IO.Ports.Handshake" /> values. The default is <see langword="None" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value passed is not a valid value in the <see cref="T:System.IO.Ports.Handshake" /> enumeration.</exception>
</member>
<member name="F:System.IO.Ports.SerialPort.InfiniteTimeout">
<summary>Indicates that no time-out should occur.</summary>
</member>
<member name="P:System.IO.Ports.SerialPort.IsOpen">
<summary>Gets a value indicating the open or closed status of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>
<see langword="true" /> if the serial port is open; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> value passed is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> value passed is an empty string ("").</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.NewLine">
<summary>Gets or sets the value used to interpret the end of a call to the <see cref="M:System.IO.Ports.SerialPort.ReadLine" /> and <see cref="M:System.IO.Ports.SerialPort.WriteLine(System.String)" /> methods.</summary>
<returns>A value that represents the end of a line. The default is a line feed ("\n" in C# or <see cref="F:Microsoft.VisualBasic.Constants.vbLf" /> in Visual Basic).</returns>
<exception cref="T:System.ArgumentException">The property value is empty.</exception>
<exception cref="T:System.ArgumentNullException">The property value is <see langword="null" />.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Open">
<summary>Opens a new serial port connection.</summary>
<exception cref="T:System.UnauthorizedAccessException">Access is denied to the port.
-or-
The current process, or another process on the system, already has the specified COM port open either by a <see cref="T:System.IO.Ports.SerialPort" /> instance or in unmanaged code.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">One or more of the properties for this instance are invalid. For example, the <see cref="P:System.IO.Ports.SerialPort.Parity" />, <see cref="P:System.IO.Ports.SerialPort.DataBits" />, or <see cref="P:System.IO.Ports.SerialPort.Handshake" /> properties are not valid values; the <see cref="P:System.IO.Ports.SerialPort.BaudRate" /> is less than or equal to zero; the <see cref="P:System.IO.Ports.SerialPort.ReadTimeout" /> or <see cref="P:System.IO.Ports.SerialPort.WriteTimeout" /> property is less than zero and is not <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
<exception cref="T:System.ArgumentException">The port name does not begin with "COM".
-or-
The file type of the port is not supported.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The specified port on the current instance of the <see cref="T:System.IO.Ports.SerialPort" /> is already open.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Parity">
<summary>Gets or sets the parity-checking protocol.</summary>
<returns>One of the enumeration values that represents the parity-checking protocol. The default is <see cref="F:System.IO.Ports.Parity.None" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.Parity" /> value passed is not a valid value in the <see cref="T:System.IO.Ports.Parity" /> enumeration.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ParityReplace">
<summary>Gets or sets the byte that replaces invalid bytes in a data stream when a parity error occurs.</summary>
<returns>A byte that replaces invalid bytes.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.PinChanged">
<summary>Indicates that a non-data signal event has occurred on the port represented by the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="P:System.IO.Ports.SerialPort.PortName">
<summary>Gets or sets the port for communications, including but not limited to all available COM ports.</summary>
<returns>The communications port. The default is COM1.</returns>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to a value with a length of zero.
-or-
The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to a value that starts with "\\".
-or-
The port name was not valid.</exception>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is open.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Read(System.Byte[],System.Int32,System.Int32)">
<summary>Reads a number of bytes from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer and writes those bytes into a byte array at the specified offset.</summary>
<param name="buffer">The byte array to write the input to.</param>
<param name="offset">The offset in <paramref name="buffer" /> at which to write the bytes.</param>
<param name="count">The maximum number of bytes to read. Fewer bytes are read if <paramref name="count" /> is greater than the number of bytes in the input buffer.</param>
<returns>The number of bytes read.</returns>
<exception cref="T:System.ArgumentNullException">The buffer passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.TimeoutException">No bytes were available to read.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Read(System.Char[],System.Int32,System.Int32)">
<summary>Reads a number of characters from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer and writes them into an array of characters at a given offset.</summary>
<param name="buffer">The character array to write the input to.</param>
<param name="offset">The offset in <paramref name="buffer" /> at which to write the characters.</param>
<param name="count">The maximum number of characters to read. Fewer characters are read if <paramref name="count" /> is greater than the number of characters in the input buffer.</param>
<returns>The number of characters read.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the buffer.
-or-
<paramref name="count" /> is 1 and there is a surrogate character in the buffer.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">No characters were available to read.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReadBufferSize">
<summary>Gets or sets the size of the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The buffer size, in bytes. The default value is 4096; the maximum value is that of a positive int, or 2147483647.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> value set is less than or equal to zero.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> property was set while the stream was open.</exception>
<exception cref="T:System.IO.IOException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> property was set to an odd integer value.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadByte">
<summary>Synchronously reads one byte from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The byte, cast to an <see cref="T:System.Int32" />, or -1 if the end of the stream has been read.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No byte was read.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadChar">
<summary>Synchronously reads one character from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The character that was read.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No character was available in the allotted time-out period.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadExisting">
<summary>Reads all immediately available bytes, based on the encoding, in both the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>The contents of the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadLine">
<summary>Reads up to the <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value in the input buffer.</summary>
<returns>The contents of the input buffer up to the first occurrence of a <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No bytes were read.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReadTimeout">
<summary>Gets or sets the number of milliseconds before a time-out occurs when a read operation does not finish.</summary>
<returns>The number of milliseconds before a time-out occurs when a read operation does not finish.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The read time-out value is less than zero and not equal to <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadTo(System.String)">
<summary>Reads a string up to the specified <paramref name="value" /> in the input buffer.</summary>
<param name="value">A value that indicates where the read operation stops.</param>
<returns>The contents of the input buffer up to the specified <paramref name="value" />.</returns>
<exception cref="T:System.ArgumentException">The length of the <paramref name="value" /> parameter is 0.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="value" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold">
<summary>Gets or sets the number of bytes in the internal input buffer before a <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event occurs.</summary>
<returns>The number of bytes in the internal input buffer before a <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event is fired. The default is 1.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold" /> value is less than or equal to zero.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.RtsEnable">
<summary>Gets or sets a value indicating whether the Request to Send (RTS) signal is enabled during serial communication.</summary>
<returns>
<see langword="true" /> to enable Request to Transmit (RTS); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.InvalidOperationException">The value of the <see cref="P:System.IO.Ports.SerialPort.RtsEnable" /> property was set or retrieved while the <see cref="P:System.IO.Ports.SerialPort.Handshake" /> property is set to the <see cref="F:System.IO.Ports.Handshake.RequestToSend" /> value or the <see cref="F:System.IO.Ports.Handshake.RequestToSendXOnXOff" /> value.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.StopBits">
<summary>Gets or sets the standard number of stopbits per byte.</summary>
<returns>One of the <see cref="T:System.IO.Ports.StopBits" /> values.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.StopBits" /> value is <see cref="F:System.IO.Ports.StopBits.None" />.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.Byte[],System.Int32,System.Int32)">
<summary>Writes a specified number of bytes to the serial port using data from a buffer.</summary>
<param name="buffer">The byte array that contains the data to write to the port.</param>
<param name="offset">The zero-based byte offset in the <paramref name="buffer" /> parameter at which to begin copying bytes to the port.</param>
<param name="count">The number of bytes to write.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.Char[],System.Int32,System.Int32)">
<summary>Writes a specified number of characters to the serial port using data from a buffer.</summary>
<param name="buffer">The character array that contains the data to write to the port.</param>
<param name="offset">The zero-based byte offset in the <paramref name="buffer" /> parameter at which to begin copying bytes to the port.</param>
<param name="count">The number of characters to write.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.String)">
<summary>Writes the specified string to the serial port.</summary>
<param name="text">The string for output.</param>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="text" /> is <see langword="null" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.WriteBufferSize">
<summary>Gets or sets the size of the serial port output buffer.</summary>
<returns>The size of the output buffer. The default is 2048.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> value is less than or equal to zero.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> property was set while the stream was open.</exception>
<exception cref="T:System.IO.IOException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> property was set to an odd integer value.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.WriteLine(System.String)">
<summary>Writes the specified string and the <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value to the output buffer.</summary>
<param name="text">The string to write to the output buffer.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="text" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The <see cref="M:System.IO.Ports.SerialPort.WriteLine(System.String)" /> method could not write to the stream.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.WriteTimeout">
<summary>Gets or sets the number of milliseconds before a time-out occurs when a write operation does not finish.</summary>
<returns>The number of milliseconds before a time-out occurs. The default is <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.WriteTimeout" /> value is less than zero and not equal to <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
</member>
<member name="T:System.IO.Ports.StopBits">
<summary>Specifies the number of stop bits used on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.None">
<summary>No stop bits are used. This value is not supported by the <see cref="P:System.IO.Ports.SerialPort.StopBits" /> property.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.One">
<summary>One stop bit is used.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.OnePointFive">
<summary>1.5 stop bits are used.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.Two">
<summary>Two stop bits are used.</summary>
</member>
</members>
</doc>

541
packages/System.IO.Ports.4.6.0/lib/netstandard2.0/System.IO.Ports.xml vendored Normal file
View File

@@ -0,0 +1,541 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>System.IO.Ports</name>
</assembly>
<members>
<member name="T:System.IO.Ports.Handshake">
<summary>Specifies the control protocol used in establishing a serial port communication for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.None">
<summary>No control is used for the handshake.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.RequestToSend">
<summary>Request-to-Send (RTS) hardware flow control is used. RTS signals that data is available for transmission. If the input buffer becomes full, the RTS line will be set to <see langword="false" />. The RTS line will be set to <see langword="true" /> when more room becomes available in the input buffer.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.RequestToSendXOnXOff">
<summary>Both the Request-to-Send (RTS) hardware control and the XON/XOFF software controls are used.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.XOnXOff">
<summary>The XON/XOFF software control protocol is used. The XOFF control is sent to stop the transmission of data. The XON control is sent to resume the transmission. These software controls are used instead of Request to Send (RTS) and Clear to Send (CTS) hardware controls.</summary>
</member>
<member name="T:System.IO.Ports.Parity">
<summary>Specifies the parity bit for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Even">
<summary>Sets the parity bit so that the count of bits set is an even number.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Mark">
<summary>Leaves the parity bit set to 1.</summary>
</member>
<member name="F:System.IO.Ports.Parity.None">
<summary>No parity check occurs.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Odd">
<summary>Sets the parity bit so that the count of bits set is an odd number.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Space">
<summary>Leaves the parity bit set to 0.</summary>
</member>
<member name="T:System.IO.Ports.SerialData">
<summary>Specifies the type of character that was received on the serial port of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialData.Chars">
<summary>A character was received and placed in the input buffer.</summary>
</member>
<member name="F:System.IO.Ports.SerialData.Eof">
<summary>The end of file character was received and placed in the input buffer.</summary>
</member>
<member name="T:System.IO.Ports.SerialDataReceivedEventArgs">
<summary>Provides data for the <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialDataReceivedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialData" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialDataReceivedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The sender of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialDataReceivedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialError">
<summary>Specifies errors that occur on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.Frame">
<summary>The hardware detected a framing error.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.Overrun">
<summary>A character-buffer overrun has occurred. The next character is lost.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.RXOver">
<summary>An input buffer overflow has occurred. There is either no room in the input buffer, or a character was received after the end-of-file (EOF) character.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.RXParity">
<summary>The hardware detected a parity error.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.TXFull">
<summary>The application tried to transmit a character, but the output buffer was full.</summary>
</member>
<member name="T:System.IO.Ports.SerialErrorReceivedEventArgs">
<summary>Prepares data for the <see cref="E:System.IO.Ports.SerialPort.ErrorReceived" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialErrorReceivedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialError" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialErrorReceivedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.ErrorReceived" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The sender of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialErrorReceivedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialPinChange">
<summary>Specifies the type of change that occurred on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.Break">
<summary>A break was detected on input.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.CDChanged">
<summary>The Carrier Detect (CD) signal changed state. This signal is used to indicate whether a modem is connected to a working phone line and a data carrier signal is detected.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.CtsChanged">
<summary>The Clear to Send (CTS) signal changed state. This signal is used to indicate whether data can be sent over the serial port.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.DsrChanged">
<summary>The Data Set Ready (DSR) signal changed state. This signal is used to indicate whether the device on the serial port is ready to operate.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.Ring">
<summary>A ring indicator was detected.</summary>
</member>
<member name="T:System.IO.Ports.SerialPinChangedEventArgs">
<summary>Provides data for the <see cref="E:System.IO.Ports.SerialPort.PinChanged" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialPinChangedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialPinChange" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialPinChangedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.PinChanged" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The source of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialPinChangedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialPort">
<summary>Represents a serial port resource.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.ComponentModel.IContainer)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified <see cref="T:System.ComponentModel.IContainer" /> object.</summary>
<param name="container">An interface to a container.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name and baud rate.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, and parity bit.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity,System.Int32)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, parity bit, and data bits.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<param name="dataBits">The data bits value.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity,System.Int32,System.IO.Ports.StopBits)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, parity bit, data bits, and stop bit.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<param name="dataBits">The data bits value.</param>
<param name="stopBits">One of the <see cref="P:System.IO.Ports.SerialPort.StopBits" /> values.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BaseStream">
<summary>Gets the underlying <see cref="T:System.IO.Stream" /> object for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>A <see cref="T:System.IO.Stream" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
<exception cref="T:System.NotSupportedException">The stream is in a .NET Compact Framework application and one of the following methods was called:
<see cref="M:System.IO.Stream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /><see cref="M:System.IO.Stream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /><see cref="M:System.IO.Stream.EndRead(System.IAsyncResult)" /><see cref="M:System.IO.Stream.EndWrite(System.IAsyncResult)" />
The .NET Compact Framework does not support the asynchronous model with base streams.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BaudRate">
<summary>Gets or sets the serial baud rate.</summary>
<returns>The baud rate.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The baud rate specified is less than or equal to zero, or is greater than the maximum allowable baud rate for the device.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BreakState">
<summary>Gets or sets the break signal state.</summary>
<returns>
<see langword="true" /> if the port is in a break state; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BytesToRead">
<summary>Gets the number of bytes of data in the receive buffer.</summary>
<returns>The number of bytes of data in the receive buffer.</returns>
<exception cref="T:System.InvalidOperationException">The port is not open.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BytesToWrite">
<summary>Gets the number of bytes of data in the send buffer.</summary>
<returns>The number of bytes of data in the send buffer.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.CDHolding">
<summary>Gets the state of the Carrier Detect line for the port.</summary>
<returns>
<see langword="true" /> if the carrier is detected; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Close">
<summary>Closes the port connection, sets the <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> property to <see langword="false" />, and disposes of the internal <see cref="T:System.IO.Stream" /> object.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.CtsHolding">
<summary>Gets the state of the Clear-to-Send line.</summary>
<returns>
<see langword="true" /> if the Clear-to-Send line is detected; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DataBits">
<summary>Gets or sets the standard length of data bits per byte.</summary>
<returns>The data bits length.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The data bits value is less than 5 or more than 8.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.DataReceived">
<summary>Indicates that data has been received through a port represented by the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.DiscardInBuffer">
<summary>Discards data from the serial driver's receive buffer.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DiscardNull">
<summary>Gets or sets a value indicating whether null bytes are ignored when transmitted between the port and the receive buffer.</summary>
<returns>
<see langword="true" /> if null bytes are ignored; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.DiscardOutBuffer">
<summary>Discards data from the serial driver's transmit buffer.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Dispose(System.Boolean)">
<summary>Releases the unmanaged resources used by the <see cref="T:System.IO.Ports.SerialPort" /> and optionally releases the managed resources.</summary>
<param name="disposing">
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DsrHolding">
<summary>Gets the state of the Data Set Ready (DSR) signal.</summary>
<returns>
<see langword="true" /> if a Data Set Ready signal has been sent to the port; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DtrEnable">
<summary>Gets or sets a value that enables the Data Terminal Ready (DTR) signal during serial communication.</summary>
<returns>
<see langword="true" /> to enable Data Terminal Ready (DTR); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Encoding">
<summary>Gets or sets the byte encoding for pre- and post-transmission conversion of text.</summary>
<returns>An <see cref="T:System.Text.Encoding" /> object. The default is <see cref="T:System.Text.ASCIIEncoding" />.</returns>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.Encoding" /> property was set to <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.Encoding" /> property was set to an encoding that is not <see cref="T:System.Text.ASCIIEncoding" />, <see cref="T:System.Text.UTF8Encoding" />, <see cref="T:System.Text.UTF32Encoding" />, <see cref="T:System.Text.UnicodeEncoding" />, one of the Windows single byte encodings, or one of the Windows double byte encodings.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.ErrorReceived">
<summary>Indicates that an error has occurred with a port represented by a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.GetPortNames">
<summary>Gets an array of serial port names for the current computer.</summary>
<returns>An array of serial port names for the current computer.</returns>
<exception cref="T:System.ComponentModel.Win32Exception">The serial port names could not be queried.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Handshake">
<summary>Gets or sets the handshaking protocol for serial port transmission of data using a value from <see cref="T:System.IO.Ports.Handshake" />.</summary>
<returns>One of the <see cref="T:System.IO.Ports.Handshake" /> values. The default is <see langword="None" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value passed is not a valid value in the <see cref="T:System.IO.Ports.Handshake" /> enumeration.</exception>
</member>
<member name="F:System.IO.Ports.SerialPort.InfiniteTimeout">
<summary>Indicates that no time-out should occur.</summary>
</member>
<member name="P:System.IO.Ports.SerialPort.IsOpen">
<summary>Gets a value indicating the open or closed status of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>
<see langword="true" /> if the serial port is open; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> value passed is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> value passed is an empty string ("").</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.NewLine">
<summary>Gets or sets the value used to interpret the end of a call to the <see cref="M:System.IO.Ports.SerialPort.ReadLine" /> and <see cref="M:System.IO.Ports.SerialPort.WriteLine(System.String)" /> methods.</summary>
<returns>A value that represents the end of a line. The default is a line feed ("\n" in C# or <see cref="F:Microsoft.VisualBasic.Constants.vbLf" /> in Visual Basic).</returns>
<exception cref="T:System.ArgumentException">The property value is empty.</exception>
<exception cref="T:System.ArgumentNullException">The property value is <see langword="null" />.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Open">
<summary>Opens a new serial port connection.</summary>
<exception cref="T:System.UnauthorizedAccessException">Access is denied to the port.
-or-
The current process, or another process on the system, already has the specified COM port open either by a <see cref="T:System.IO.Ports.SerialPort" /> instance or in unmanaged code.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">One or more of the properties for this instance are invalid. For example, the <see cref="P:System.IO.Ports.SerialPort.Parity" />, <see cref="P:System.IO.Ports.SerialPort.DataBits" />, or <see cref="P:System.IO.Ports.SerialPort.Handshake" /> properties are not valid values; the <see cref="P:System.IO.Ports.SerialPort.BaudRate" /> is less than or equal to zero; the <see cref="P:System.IO.Ports.SerialPort.ReadTimeout" /> or <see cref="P:System.IO.Ports.SerialPort.WriteTimeout" /> property is less than zero and is not <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
<exception cref="T:System.ArgumentException">The port name does not begin with "COM".
-or-
The file type of the port is not supported.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The specified port on the current instance of the <see cref="T:System.IO.Ports.SerialPort" /> is already open.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Parity">
<summary>Gets or sets the parity-checking protocol.</summary>
<returns>One of the enumeration values that represents the parity-checking protocol. The default is <see cref="F:System.IO.Ports.Parity.None" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.Parity" /> value passed is not a valid value in the <see cref="T:System.IO.Ports.Parity" /> enumeration.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ParityReplace">
<summary>Gets or sets the byte that replaces invalid bytes in a data stream when a parity error occurs.</summary>
<returns>A byte that replaces invalid bytes.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.PinChanged">
<summary>Indicates that a non-data signal event has occurred on the port represented by the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="P:System.IO.Ports.SerialPort.PortName">
<summary>Gets or sets the port for communications, including but not limited to all available COM ports.</summary>
<returns>The communications port. The default is COM1.</returns>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to a value with a length of zero.
-or-
The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to a value that starts with "\\".
-or-
The port name was not valid.</exception>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is open.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Read(System.Byte[],System.Int32,System.Int32)">
<summary>Reads a number of bytes from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer and writes those bytes into a byte array at the specified offset.</summary>
<param name="buffer">The byte array to write the input to.</param>
<param name="offset">The offset in <paramref name="buffer" /> at which to write the bytes.</param>
<param name="count">The maximum number of bytes to read. Fewer bytes are read if <paramref name="count" /> is greater than the number of bytes in the input buffer.</param>
<returns>The number of bytes read.</returns>
<exception cref="T:System.ArgumentNullException">The buffer passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.TimeoutException">No bytes were available to read.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Read(System.Char[],System.Int32,System.Int32)">
<summary>Reads a number of characters from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer and writes them into an array of characters at a given offset.</summary>
<param name="buffer">The character array to write the input to.</param>
<param name="offset">The offset in <paramref name="buffer" /> at which to write the characters.</param>
<param name="count">The maximum number of characters to read. Fewer characters are read if <paramref name="count" /> is greater than the number of characters in the input buffer.</param>
<returns>The number of characters read.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the buffer.
-or-
<paramref name="count" /> is 1 and there is a surrogate character in the buffer.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">No characters were available to read.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReadBufferSize">
<summary>Gets or sets the size of the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The buffer size, in bytes. The default value is 4096; the maximum value is that of a positive int, or 2147483647.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> value set is less than or equal to zero.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> property was set while the stream was open.</exception>
<exception cref="T:System.IO.IOException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> property was set to an odd integer value.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadByte">
<summary>Synchronously reads one byte from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The byte, cast to an <see cref="T:System.Int32" />, or -1 if the end of the stream has been read.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No byte was read.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadChar">
<summary>Synchronously reads one character from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The character that was read.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No character was available in the allotted time-out period.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadExisting">
<summary>Reads all immediately available bytes, based on the encoding, in both the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>The contents of the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadLine">
<summary>Reads up to the <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value in the input buffer.</summary>
<returns>The contents of the input buffer up to the first occurrence of a <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No bytes were read.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReadTimeout">
<summary>Gets or sets the number of milliseconds before a time-out occurs when a read operation does not finish.</summary>
<returns>The number of milliseconds before a time-out occurs when a read operation does not finish.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The read time-out value is less than zero and not equal to <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadTo(System.String)">
<summary>Reads a string up to the specified <paramref name="value" /> in the input buffer.</summary>
<param name="value">A value that indicates where the read operation stops.</param>
<returns>The contents of the input buffer up to the specified <paramref name="value" />.</returns>
<exception cref="T:System.ArgumentException">The length of the <paramref name="value" /> parameter is 0.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="value" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold">
<summary>Gets or sets the number of bytes in the internal input buffer before a <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event occurs.</summary>
<returns>The number of bytes in the internal input buffer before a <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event is fired. The default is 1.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold" /> value is less than or equal to zero.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.RtsEnable">
<summary>Gets or sets a value indicating whether the Request to Send (RTS) signal is enabled during serial communication.</summary>
<returns>
<see langword="true" /> to enable Request to Transmit (RTS); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.InvalidOperationException">The value of the <see cref="P:System.IO.Ports.SerialPort.RtsEnable" /> property was set or retrieved while the <see cref="P:System.IO.Ports.SerialPort.Handshake" /> property is set to the <see cref="F:System.IO.Ports.Handshake.RequestToSend" /> value or the <see cref="F:System.IO.Ports.Handshake.RequestToSendXOnXOff" /> value.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.StopBits">
<summary>Gets or sets the standard number of stopbits per byte.</summary>
<returns>One of the <see cref="T:System.IO.Ports.StopBits" /> values.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.StopBits" /> value is <see cref="F:System.IO.Ports.StopBits.None" />.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.Byte[],System.Int32,System.Int32)">
<summary>Writes a specified number of bytes to the serial port using data from a buffer.</summary>
<param name="buffer">The byte array that contains the data to write to the port.</param>
<param name="offset">The zero-based byte offset in the <paramref name="buffer" /> parameter at which to begin copying bytes to the port.</param>
<param name="count">The number of bytes to write.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.Char[],System.Int32,System.Int32)">
<summary>Writes a specified number of characters to the serial port using data from a buffer.</summary>
<param name="buffer">The character array that contains the data to write to the port.</param>
<param name="offset">The zero-based byte offset in the <paramref name="buffer" /> parameter at which to begin copying bytes to the port.</param>
<param name="count">The number of characters to write.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.String)">
<summary>Writes the specified string to the serial port.</summary>
<param name="text">The string for output.</param>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="text" /> is <see langword="null" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.WriteBufferSize">
<summary>Gets or sets the size of the serial port output buffer.</summary>
<returns>The size of the output buffer. The default is 2048.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> value is less than or equal to zero.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> property was set while the stream was open.</exception>
<exception cref="T:System.IO.IOException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> property was set to an odd integer value.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.WriteLine(System.String)">
<summary>Writes the specified string and the <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value to the output buffer.</summary>
<param name="text">The string to write to the output buffer.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="text" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The <see cref="M:System.IO.Ports.SerialPort.WriteLine(System.String)" /> method could not write to the stream.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.WriteTimeout">
<summary>Gets or sets the number of milliseconds before a time-out occurs when a write operation does not finish.</summary>
<returns>The number of milliseconds before a time-out occurs. The default is <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.WriteTimeout" /> value is less than zero and not equal to <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
</member>
<member name="T:System.IO.Ports.StopBits">
<summary>Specifies the number of stop bits used on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.None">
<summary>No stop bits are used. This value is not supported by the <see cref="P:System.IO.Ports.SerialPort.StopBits" /> property.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.One">
<summary>One stop bit is used.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.OnePointFive">
<summary>1.5 stop bits are used.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.Two">
<summary>Two stop bits are used.</summary>
</member>
</members>
</doc>

0
packages/System.IO.Ports.4.6.0/lib/uap10.0.16299/_._ vendored Normal file
View File

541
packages/System.IO.Ports.4.6.0/ref/net461/System.IO.Ports.xml vendored Normal file
View File

@@ -0,0 +1,541 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>System.IO.Ports</name>
</assembly>
<members>
<member name="T:System.IO.Ports.Handshake">
<summary>Specifies the control protocol used in establishing a serial port communication for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.None">
<summary>No control is used for the handshake.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.RequestToSend">
<summary>Request-to-Send (RTS) hardware flow control is used. RTS signals that data is available for transmission. If the input buffer becomes full, the RTS line will be set to <see langword="false" />. The RTS line will be set to <see langword="true" /> when more room becomes available in the input buffer.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.RequestToSendXOnXOff">
<summary>Both the Request-to-Send (RTS) hardware control and the XON/XOFF software controls are used.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.XOnXOff">
<summary>The XON/XOFF software control protocol is used. The XOFF control is sent to stop the transmission of data. The XON control is sent to resume the transmission. These software controls are used instead of Request to Send (RTS) and Clear to Send (CTS) hardware controls.</summary>
</member>
<member name="T:System.IO.Ports.Parity">
<summary>Specifies the parity bit for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Even">
<summary>Sets the parity bit so that the count of bits set is an even number.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Mark">
<summary>Leaves the parity bit set to 1.</summary>
</member>
<member name="F:System.IO.Ports.Parity.None">
<summary>No parity check occurs.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Odd">
<summary>Sets the parity bit so that the count of bits set is an odd number.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Space">
<summary>Leaves the parity bit set to 0.</summary>
</member>
<member name="T:System.IO.Ports.SerialData">
<summary>Specifies the type of character that was received on the serial port of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialData.Chars">
<summary>A character was received and placed in the input buffer.</summary>
</member>
<member name="F:System.IO.Ports.SerialData.Eof">
<summary>The end of file character was received and placed in the input buffer.</summary>
</member>
<member name="T:System.IO.Ports.SerialDataReceivedEventArgs">
<summary>Provides data for the <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialDataReceivedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialData" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialDataReceivedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The sender of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialDataReceivedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialError">
<summary>Specifies errors that occur on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.Frame">
<summary>The hardware detected a framing error.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.Overrun">
<summary>A character-buffer overrun has occurred. The next character is lost.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.RXOver">
<summary>An input buffer overflow has occurred. There is either no room in the input buffer, or a character was received after the end-of-file (EOF) character.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.RXParity">
<summary>The hardware detected a parity error.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.TXFull">
<summary>The application tried to transmit a character, but the output buffer was full.</summary>
</member>
<member name="T:System.IO.Ports.SerialErrorReceivedEventArgs">
<summary>Prepares data for the <see cref="E:System.IO.Ports.SerialPort.ErrorReceived" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialErrorReceivedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialError" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialErrorReceivedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.ErrorReceived" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The sender of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialErrorReceivedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialPinChange">
<summary>Specifies the type of change that occurred on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.Break">
<summary>A break was detected on input.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.CDChanged">
<summary>The Carrier Detect (CD) signal changed state. This signal is used to indicate whether a modem is connected to a working phone line and a data carrier signal is detected.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.CtsChanged">
<summary>The Clear to Send (CTS) signal changed state. This signal is used to indicate whether data can be sent over the serial port.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.DsrChanged">
<summary>The Data Set Ready (DSR) signal changed state. This signal is used to indicate whether the device on the serial port is ready to operate.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.Ring">
<summary>A ring indicator was detected.</summary>
</member>
<member name="T:System.IO.Ports.SerialPinChangedEventArgs">
<summary>Provides data for the <see cref="E:System.IO.Ports.SerialPort.PinChanged" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialPinChangedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialPinChange" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialPinChangedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.PinChanged" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The source of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialPinChangedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialPort">
<summary>Represents a serial port resource.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.ComponentModel.IContainer)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified <see cref="T:System.ComponentModel.IContainer" /> object.</summary>
<param name="container">An interface to a container.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name and baud rate.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, and parity bit.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity,System.Int32)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, parity bit, and data bits.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<param name="dataBits">The data bits value.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity,System.Int32,System.IO.Ports.StopBits)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, parity bit, data bits, and stop bit.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<param name="dataBits">The data bits value.</param>
<param name="stopBits">One of the <see cref="P:System.IO.Ports.SerialPort.StopBits" /> values.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BaseStream">
<summary>Gets the underlying <see cref="T:System.IO.Stream" /> object for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>A <see cref="T:System.IO.Stream" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
<exception cref="T:System.NotSupportedException">The stream is in a .NET Compact Framework application and one of the following methods was called:
<see cref="M:System.IO.Stream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /><see cref="M:System.IO.Stream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /><see cref="M:System.IO.Stream.EndRead(System.IAsyncResult)" /><see cref="M:System.IO.Stream.EndWrite(System.IAsyncResult)" />
The .NET Compact Framework does not support the asynchronous model with base streams.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BaudRate">
<summary>Gets or sets the serial baud rate.</summary>
<returns>The baud rate.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The baud rate specified is less than or equal to zero, or is greater than the maximum allowable baud rate for the device.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BreakState">
<summary>Gets or sets the break signal state.</summary>
<returns>
<see langword="true" /> if the port is in a break state; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BytesToRead">
<summary>Gets the number of bytes of data in the receive buffer.</summary>
<returns>The number of bytes of data in the receive buffer.</returns>
<exception cref="T:System.InvalidOperationException">The port is not open.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BytesToWrite">
<summary>Gets the number of bytes of data in the send buffer.</summary>
<returns>The number of bytes of data in the send buffer.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.CDHolding">
<summary>Gets the state of the Carrier Detect line for the port.</summary>
<returns>
<see langword="true" /> if the carrier is detected; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Close">
<summary>Closes the port connection, sets the <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> property to <see langword="false" />, and disposes of the internal <see cref="T:System.IO.Stream" /> object.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.CtsHolding">
<summary>Gets the state of the Clear-to-Send line.</summary>
<returns>
<see langword="true" /> if the Clear-to-Send line is detected; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DataBits">
<summary>Gets or sets the standard length of data bits per byte.</summary>
<returns>The data bits length.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The data bits value is less than 5 or more than 8.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.DataReceived">
<summary>Indicates that data has been received through a port represented by the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.DiscardInBuffer">
<summary>Discards data from the serial driver's receive buffer.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DiscardNull">
<summary>Gets or sets a value indicating whether null bytes are ignored when transmitted between the port and the receive buffer.</summary>
<returns>
<see langword="true" /> if null bytes are ignored; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.DiscardOutBuffer">
<summary>Discards data from the serial driver's transmit buffer.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Dispose(System.Boolean)">
<summary>Releases the unmanaged resources used by the <see cref="T:System.IO.Ports.SerialPort" /> and optionally releases the managed resources.</summary>
<param name="disposing">
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DsrHolding">
<summary>Gets the state of the Data Set Ready (DSR) signal.</summary>
<returns>
<see langword="true" /> if a Data Set Ready signal has been sent to the port; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DtrEnable">
<summary>Gets or sets a value that enables the Data Terminal Ready (DTR) signal during serial communication.</summary>
<returns>
<see langword="true" /> to enable Data Terminal Ready (DTR); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Encoding">
<summary>Gets or sets the byte encoding for pre- and post-transmission conversion of text.</summary>
<returns>An <see cref="T:System.Text.Encoding" /> object. The default is <see cref="T:System.Text.ASCIIEncoding" />.</returns>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.Encoding" /> property was set to <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.Encoding" /> property was set to an encoding that is not <see cref="T:System.Text.ASCIIEncoding" />, <see cref="T:System.Text.UTF8Encoding" />, <see cref="T:System.Text.UTF32Encoding" />, <see cref="T:System.Text.UnicodeEncoding" />, one of the Windows single byte encodings, or one of the Windows double byte encodings.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.ErrorReceived">
<summary>Indicates that an error has occurred with a port represented by a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.GetPortNames">
<summary>Gets an array of serial port names for the current computer.</summary>
<returns>An array of serial port names for the current computer.</returns>
<exception cref="T:System.ComponentModel.Win32Exception">The serial port names could not be queried.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Handshake">
<summary>Gets or sets the handshaking protocol for serial port transmission of data using a value from <see cref="T:System.IO.Ports.Handshake" />.</summary>
<returns>One of the <see cref="T:System.IO.Ports.Handshake" /> values. The default is <see langword="None" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value passed is not a valid value in the <see cref="T:System.IO.Ports.Handshake" /> enumeration.</exception>
</member>
<member name="F:System.IO.Ports.SerialPort.InfiniteTimeout">
<summary>Indicates that no time-out should occur.</summary>
</member>
<member name="P:System.IO.Ports.SerialPort.IsOpen">
<summary>Gets a value indicating the open or closed status of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>
<see langword="true" /> if the serial port is open; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> value passed is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> value passed is an empty string ("").</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.NewLine">
<summary>Gets or sets the value used to interpret the end of a call to the <see cref="M:System.IO.Ports.SerialPort.ReadLine" /> and <see cref="M:System.IO.Ports.SerialPort.WriteLine(System.String)" /> methods.</summary>
<returns>A value that represents the end of a line. The default is a line feed ("\n" in C# or <see cref="F:Microsoft.VisualBasic.Constants.vbLf" /> in Visual Basic).</returns>
<exception cref="T:System.ArgumentException">The property value is empty.</exception>
<exception cref="T:System.ArgumentNullException">The property value is <see langword="null" />.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Open">
<summary>Opens a new serial port connection.</summary>
<exception cref="T:System.UnauthorizedAccessException">Access is denied to the port.
-or-
The current process, or another process on the system, already has the specified COM port open either by a <see cref="T:System.IO.Ports.SerialPort" /> instance or in unmanaged code.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">One or more of the properties for this instance are invalid. For example, the <see cref="P:System.IO.Ports.SerialPort.Parity" />, <see cref="P:System.IO.Ports.SerialPort.DataBits" />, or <see cref="P:System.IO.Ports.SerialPort.Handshake" /> properties are not valid values; the <see cref="P:System.IO.Ports.SerialPort.BaudRate" /> is less than or equal to zero; the <see cref="P:System.IO.Ports.SerialPort.ReadTimeout" /> or <see cref="P:System.IO.Ports.SerialPort.WriteTimeout" /> property is less than zero and is not <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
<exception cref="T:System.ArgumentException">The port name does not begin with "COM".
-or-
The file type of the port is not supported.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The specified port on the current instance of the <see cref="T:System.IO.Ports.SerialPort" /> is already open.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Parity">
<summary>Gets or sets the parity-checking protocol.</summary>
<returns>One of the enumeration values that represents the parity-checking protocol. The default is <see cref="F:System.IO.Ports.Parity.None" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.Parity" /> value passed is not a valid value in the <see cref="T:System.IO.Ports.Parity" /> enumeration.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ParityReplace">
<summary>Gets or sets the byte that replaces invalid bytes in a data stream when a parity error occurs.</summary>
<returns>A byte that replaces invalid bytes.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.PinChanged">
<summary>Indicates that a non-data signal event has occurred on the port represented by the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="P:System.IO.Ports.SerialPort.PortName">
<summary>Gets or sets the port for communications, including but not limited to all available COM ports.</summary>
<returns>The communications port. The default is COM1.</returns>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to a value with a length of zero.
-or-
The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to a value that starts with "\\".
-or-
The port name was not valid.</exception>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is open.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Read(System.Byte[],System.Int32,System.Int32)">
<summary>Reads a number of bytes from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer and writes those bytes into a byte array at the specified offset.</summary>
<param name="buffer">The byte array to write the input to.</param>
<param name="offset">The offset in <paramref name="buffer" /> at which to write the bytes.</param>
<param name="count">The maximum number of bytes to read. Fewer bytes are read if <paramref name="count" /> is greater than the number of bytes in the input buffer.</param>
<returns>The number of bytes read.</returns>
<exception cref="T:System.ArgumentNullException">The buffer passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.TimeoutException">No bytes were available to read.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Read(System.Char[],System.Int32,System.Int32)">
<summary>Reads a number of characters from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer and writes them into an array of characters at a given offset.</summary>
<param name="buffer">The character array to write the input to.</param>
<param name="offset">The offset in <paramref name="buffer" /> at which to write the characters.</param>
<param name="count">The maximum number of characters to read. Fewer characters are read if <paramref name="count" /> is greater than the number of characters in the input buffer.</param>
<returns>The number of characters read.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the buffer.
-or-
<paramref name="count" /> is 1 and there is a surrogate character in the buffer.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">No characters were available to read.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReadBufferSize">
<summary>Gets or sets the size of the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The buffer size, in bytes. The default value is 4096; the maximum value is that of a positive int, or 2147483647.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> value set is less than or equal to zero.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> property was set while the stream was open.</exception>
<exception cref="T:System.IO.IOException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> property was set to an odd integer value.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadByte">
<summary>Synchronously reads one byte from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The byte, cast to an <see cref="T:System.Int32" />, or -1 if the end of the stream has been read.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No byte was read.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadChar">
<summary>Synchronously reads one character from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The character that was read.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No character was available in the allotted time-out period.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadExisting">
<summary>Reads all immediately available bytes, based on the encoding, in both the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>The contents of the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadLine">
<summary>Reads up to the <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value in the input buffer.</summary>
<returns>The contents of the input buffer up to the first occurrence of a <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No bytes were read.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReadTimeout">
<summary>Gets or sets the number of milliseconds before a time-out occurs when a read operation does not finish.</summary>
<returns>The number of milliseconds before a time-out occurs when a read operation does not finish.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The read time-out value is less than zero and not equal to <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadTo(System.String)">
<summary>Reads a string up to the specified <paramref name="value" /> in the input buffer.</summary>
<param name="value">A value that indicates where the read operation stops.</param>
<returns>The contents of the input buffer up to the specified <paramref name="value" />.</returns>
<exception cref="T:System.ArgumentException">The length of the <paramref name="value" /> parameter is 0.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="value" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold">
<summary>Gets or sets the number of bytes in the internal input buffer before a <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event occurs.</summary>
<returns>The number of bytes in the internal input buffer before a <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event is fired. The default is 1.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold" /> value is less than or equal to zero.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.RtsEnable">
<summary>Gets or sets a value indicating whether the Request to Send (RTS) signal is enabled during serial communication.</summary>
<returns>
<see langword="true" /> to enable Request to Transmit (RTS); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.InvalidOperationException">The value of the <see cref="P:System.IO.Ports.SerialPort.RtsEnable" /> property was set or retrieved while the <see cref="P:System.IO.Ports.SerialPort.Handshake" /> property is set to the <see cref="F:System.IO.Ports.Handshake.RequestToSend" /> value or the <see cref="F:System.IO.Ports.Handshake.RequestToSendXOnXOff" /> value.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.StopBits">
<summary>Gets or sets the standard number of stopbits per byte.</summary>
<returns>One of the <see cref="T:System.IO.Ports.StopBits" /> values.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.StopBits" /> value is <see cref="F:System.IO.Ports.StopBits.None" />.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.Byte[],System.Int32,System.Int32)">
<summary>Writes a specified number of bytes to the serial port using data from a buffer.</summary>
<param name="buffer">The byte array that contains the data to write to the port.</param>
<param name="offset">The zero-based byte offset in the <paramref name="buffer" /> parameter at which to begin copying bytes to the port.</param>
<param name="count">The number of bytes to write.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.Char[],System.Int32,System.Int32)">
<summary>Writes a specified number of characters to the serial port using data from a buffer.</summary>
<param name="buffer">The character array that contains the data to write to the port.</param>
<param name="offset">The zero-based byte offset in the <paramref name="buffer" /> parameter at which to begin copying bytes to the port.</param>
<param name="count">The number of characters to write.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.String)">
<summary>Writes the specified string to the serial port.</summary>
<param name="text">The string for output.</param>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="text" /> is <see langword="null" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.WriteBufferSize">
<summary>Gets or sets the size of the serial port output buffer.</summary>
<returns>The size of the output buffer. The default is 2048.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> value is less than or equal to zero.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> property was set while the stream was open.</exception>
<exception cref="T:System.IO.IOException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> property was set to an odd integer value.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.WriteLine(System.String)">
<summary>Writes the specified string and the <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value to the output buffer.</summary>
<param name="text">The string to write to the output buffer.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="text" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The <see cref="M:System.IO.Ports.SerialPort.WriteLine(System.String)" /> method could not write to the stream.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.WriteTimeout">
<summary>Gets or sets the number of milliseconds before a time-out occurs when a write operation does not finish.</summary>
<returns>The number of milliseconds before a time-out occurs. The default is <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.WriteTimeout" /> value is less than zero and not equal to <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
</member>
<member name="T:System.IO.Ports.StopBits">
<summary>Specifies the number of stop bits used on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.None">
<summary>No stop bits are used. This value is not supported by the <see cref="P:System.IO.Ports.SerialPort.StopBits" /> property.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.One">
<summary>One stop bit is used.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.OnePointFive">
<summary>1.5 stop bits are used.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.Two">
<summary>Two stop bits are used.</summary>
</member>
</members>
</doc>

541
packages/System.IO.Ports.4.6.0/ref/netstandard2.0/System.IO.Ports.xml vendored Normal file
View File

@@ -0,0 +1,541 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>System.IO.Ports</name>
</assembly>
<members>
<member name="T:System.IO.Ports.Handshake">
<summary>Specifies the control protocol used in establishing a serial port communication for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.None">
<summary>No control is used for the handshake.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.RequestToSend">
<summary>Request-to-Send (RTS) hardware flow control is used. RTS signals that data is available for transmission. If the input buffer becomes full, the RTS line will be set to <see langword="false" />. The RTS line will be set to <see langword="true" /> when more room becomes available in the input buffer.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.RequestToSendXOnXOff">
<summary>Both the Request-to-Send (RTS) hardware control and the XON/XOFF software controls are used.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.XOnXOff">
<summary>The XON/XOFF software control protocol is used. The XOFF control is sent to stop the transmission of data. The XON control is sent to resume the transmission. These software controls are used instead of Request to Send (RTS) and Clear to Send (CTS) hardware controls.</summary>
</member>
<member name="T:System.IO.Ports.Parity">
<summary>Specifies the parity bit for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Even">
<summary>Sets the parity bit so that the count of bits set is an even number.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Mark">
<summary>Leaves the parity bit set to 1.</summary>
</member>
<member name="F:System.IO.Ports.Parity.None">
<summary>No parity check occurs.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Odd">
<summary>Sets the parity bit so that the count of bits set is an odd number.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Space">
<summary>Leaves the parity bit set to 0.</summary>
</member>
<member name="T:System.IO.Ports.SerialData">
<summary>Specifies the type of character that was received on the serial port of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialData.Chars">
<summary>A character was received and placed in the input buffer.</summary>
</member>
<member name="F:System.IO.Ports.SerialData.Eof">
<summary>The end of file character was received and placed in the input buffer.</summary>
</member>
<member name="T:System.IO.Ports.SerialDataReceivedEventArgs">
<summary>Provides data for the <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialDataReceivedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialData" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialDataReceivedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The sender of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialDataReceivedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialError">
<summary>Specifies errors that occur on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.Frame">
<summary>The hardware detected a framing error.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.Overrun">
<summary>A character-buffer overrun has occurred. The next character is lost.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.RXOver">
<summary>An input buffer overflow has occurred. There is either no room in the input buffer, or a character was received after the end-of-file (EOF) character.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.RXParity">
<summary>The hardware detected a parity error.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.TXFull">
<summary>The application tried to transmit a character, but the output buffer was full.</summary>
</member>
<member name="T:System.IO.Ports.SerialErrorReceivedEventArgs">
<summary>Prepares data for the <see cref="E:System.IO.Ports.SerialPort.ErrorReceived" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialErrorReceivedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialError" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialErrorReceivedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.ErrorReceived" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The sender of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialErrorReceivedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialPinChange">
<summary>Specifies the type of change that occurred on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.Break">
<summary>A break was detected on input.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.CDChanged">
<summary>The Carrier Detect (CD) signal changed state. This signal is used to indicate whether a modem is connected to a working phone line and a data carrier signal is detected.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.CtsChanged">
<summary>The Clear to Send (CTS) signal changed state. This signal is used to indicate whether data can be sent over the serial port.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.DsrChanged">
<summary>The Data Set Ready (DSR) signal changed state. This signal is used to indicate whether the device on the serial port is ready to operate.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.Ring">
<summary>A ring indicator was detected.</summary>
</member>
<member name="T:System.IO.Ports.SerialPinChangedEventArgs">
<summary>Provides data for the <see cref="E:System.IO.Ports.SerialPort.PinChanged" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialPinChangedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialPinChange" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialPinChangedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.PinChanged" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The source of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialPinChangedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialPort">
<summary>Represents a serial port resource.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.ComponentModel.IContainer)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified <see cref="T:System.ComponentModel.IContainer" /> object.</summary>
<param name="container">An interface to a container.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name and baud rate.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, and parity bit.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity,System.Int32)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, parity bit, and data bits.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<param name="dataBits">The data bits value.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity,System.Int32,System.IO.Ports.StopBits)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, parity bit, data bits, and stop bit.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<param name="dataBits">The data bits value.</param>
<param name="stopBits">One of the <see cref="P:System.IO.Ports.SerialPort.StopBits" /> values.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BaseStream">
<summary>Gets the underlying <see cref="T:System.IO.Stream" /> object for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>A <see cref="T:System.IO.Stream" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
<exception cref="T:System.NotSupportedException">The stream is in a .NET Compact Framework application and one of the following methods was called:
<see cref="M:System.IO.Stream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /><see cref="M:System.IO.Stream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /><see cref="M:System.IO.Stream.EndRead(System.IAsyncResult)" /><see cref="M:System.IO.Stream.EndWrite(System.IAsyncResult)" />
The .NET Compact Framework does not support the asynchronous model with base streams.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BaudRate">
<summary>Gets or sets the serial baud rate.</summary>
<returns>The baud rate.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The baud rate specified is less than or equal to zero, or is greater than the maximum allowable baud rate for the device.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BreakState">
<summary>Gets or sets the break signal state.</summary>
<returns>
<see langword="true" /> if the port is in a break state; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BytesToRead">
<summary>Gets the number of bytes of data in the receive buffer.</summary>
<returns>The number of bytes of data in the receive buffer.</returns>
<exception cref="T:System.InvalidOperationException">The port is not open.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BytesToWrite">
<summary>Gets the number of bytes of data in the send buffer.</summary>
<returns>The number of bytes of data in the send buffer.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.CDHolding">
<summary>Gets the state of the Carrier Detect line for the port.</summary>
<returns>
<see langword="true" /> if the carrier is detected; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Close">
<summary>Closes the port connection, sets the <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> property to <see langword="false" />, and disposes of the internal <see cref="T:System.IO.Stream" /> object.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.CtsHolding">
<summary>Gets the state of the Clear-to-Send line.</summary>
<returns>
<see langword="true" /> if the Clear-to-Send line is detected; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DataBits">
<summary>Gets or sets the standard length of data bits per byte.</summary>
<returns>The data bits length.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The data bits value is less than 5 or more than 8.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.DataReceived">
<summary>Indicates that data has been received through a port represented by the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.DiscardInBuffer">
<summary>Discards data from the serial driver's receive buffer.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DiscardNull">
<summary>Gets or sets a value indicating whether null bytes are ignored when transmitted between the port and the receive buffer.</summary>
<returns>
<see langword="true" /> if null bytes are ignored; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.DiscardOutBuffer">
<summary>Discards data from the serial driver's transmit buffer.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Dispose(System.Boolean)">
<summary>Releases the unmanaged resources used by the <see cref="T:System.IO.Ports.SerialPort" /> and optionally releases the managed resources.</summary>
<param name="disposing">
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DsrHolding">
<summary>Gets the state of the Data Set Ready (DSR) signal.</summary>
<returns>
<see langword="true" /> if a Data Set Ready signal has been sent to the port; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DtrEnable">
<summary>Gets or sets a value that enables the Data Terminal Ready (DTR) signal during serial communication.</summary>
<returns>
<see langword="true" /> to enable Data Terminal Ready (DTR); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Encoding">
<summary>Gets or sets the byte encoding for pre- and post-transmission conversion of text.</summary>
<returns>An <see cref="T:System.Text.Encoding" /> object. The default is <see cref="T:System.Text.ASCIIEncoding" />.</returns>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.Encoding" /> property was set to <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.Encoding" /> property was set to an encoding that is not <see cref="T:System.Text.ASCIIEncoding" />, <see cref="T:System.Text.UTF8Encoding" />, <see cref="T:System.Text.UTF32Encoding" />, <see cref="T:System.Text.UnicodeEncoding" />, one of the Windows single byte encodings, or one of the Windows double byte encodings.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.ErrorReceived">
<summary>Indicates that an error has occurred with a port represented by a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.GetPortNames">
<summary>Gets an array of serial port names for the current computer.</summary>
<returns>An array of serial port names for the current computer.</returns>
<exception cref="T:System.ComponentModel.Win32Exception">The serial port names could not be queried.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Handshake">
<summary>Gets or sets the handshaking protocol for serial port transmission of data using a value from <see cref="T:System.IO.Ports.Handshake" />.</summary>
<returns>One of the <see cref="T:System.IO.Ports.Handshake" /> values. The default is <see langword="None" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value passed is not a valid value in the <see cref="T:System.IO.Ports.Handshake" /> enumeration.</exception>
</member>
<member name="F:System.IO.Ports.SerialPort.InfiniteTimeout">
<summary>Indicates that no time-out should occur.</summary>
</member>
<member name="P:System.IO.Ports.SerialPort.IsOpen">
<summary>Gets a value indicating the open or closed status of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>
<see langword="true" /> if the serial port is open; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> value passed is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> value passed is an empty string ("").</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.NewLine">
<summary>Gets or sets the value used to interpret the end of a call to the <see cref="M:System.IO.Ports.SerialPort.ReadLine" /> and <see cref="M:System.IO.Ports.SerialPort.WriteLine(System.String)" /> methods.</summary>
<returns>A value that represents the end of a line. The default is a line feed ("\n" in C# or <see cref="F:Microsoft.VisualBasic.Constants.vbLf" /> in Visual Basic).</returns>
<exception cref="T:System.ArgumentException">The property value is empty.</exception>
<exception cref="T:System.ArgumentNullException">The property value is <see langword="null" />.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Open">
<summary>Opens a new serial port connection.</summary>
<exception cref="T:System.UnauthorizedAccessException">Access is denied to the port.
-or-
The current process, or another process on the system, already has the specified COM port open either by a <see cref="T:System.IO.Ports.SerialPort" /> instance or in unmanaged code.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">One or more of the properties for this instance are invalid. For example, the <see cref="P:System.IO.Ports.SerialPort.Parity" />, <see cref="P:System.IO.Ports.SerialPort.DataBits" />, or <see cref="P:System.IO.Ports.SerialPort.Handshake" /> properties are not valid values; the <see cref="P:System.IO.Ports.SerialPort.BaudRate" /> is less than or equal to zero; the <see cref="P:System.IO.Ports.SerialPort.ReadTimeout" /> or <see cref="P:System.IO.Ports.SerialPort.WriteTimeout" /> property is less than zero and is not <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
<exception cref="T:System.ArgumentException">The port name does not begin with "COM".
-or-
The file type of the port is not supported.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The specified port on the current instance of the <see cref="T:System.IO.Ports.SerialPort" /> is already open.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Parity">
<summary>Gets or sets the parity-checking protocol.</summary>
<returns>One of the enumeration values that represents the parity-checking protocol. The default is <see cref="F:System.IO.Ports.Parity.None" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.Parity" /> value passed is not a valid value in the <see cref="T:System.IO.Ports.Parity" /> enumeration.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ParityReplace">
<summary>Gets or sets the byte that replaces invalid bytes in a data stream when a parity error occurs.</summary>
<returns>A byte that replaces invalid bytes.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.PinChanged">
<summary>Indicates that a non-data signal event has occurred on the port represented by the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="P:System.IO.Ports.SerialPort.PortName">
<summary>Gets or sets the port for communications, including but not limited to all available COM ports.</summary>
<returns>The communications port. The default is COM1.</returns>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to a value with a length of zero.
-or-
The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to a value that starts with "\\".
-or-
The port name was not valid.</exception>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is open.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Read(System.Byte[],System.Int32,System.Int32)">
<summary>Reads a number of bytes from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer and writes those bytes into a byte array at the specified offset.</summary>
<param name="buffer">The byte array to write the input to.</param>
<param name="offset">The offset in <paramref name="buffer" /> at which to write the bytes.</param>
<param name="count">The maximum number of bytes to read. Fewer bytes are read if <paramref name="count" /> is greater than the number of bytes in the input buffer.</param>
<returns>The number of bytes read.</returns>
<exception cref="T:System.ArgumentNullException">The buffer passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.TimeoutException">No bytes were available to read.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Read(System.Char[],System.Int32,System.Int32)">
<summary>Reads a number of characters from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer and writes them into an array of characters at a given offset.</summary>
<param name="buffer">The character array to write the input to.</param>
<param name="offset">The offset in <paramref name="buffer" /> at which to write the characters.</param>
<param name="count">The maximum number of characters to read. Fewer characters are read if <paramref name="count" /> is greater than the number of characters in the input buffer.</param>
<returns>The number of characters read.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the buffer.
-or-
<paramref name="count" /> is 1 and there is a surrogate character in the buffer.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">No characters were available to read.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReadBufferSize">
<summary>Gets or sets the size of the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The buffer size, in bytes. The default value is 4096; the maximum value is that of a positive int, or 2147483647.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> value set is less than or equal to zero.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> property was set while the stream was open.</exception>
<exception cref="T:System.IO.IOException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> property was set to an odd integer value.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadByte">
<summary>Synchronously reads one byte from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The byte, cast to an <see cref="T:System.Int32" />, or -1 if the end of the stream has been read.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No byte was read.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadChar">
<summary>Synchronously reads one character from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The character that was read.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No character was available in the allotted time-out period.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadExisting">
<summary>Reads all immediately available bytes, based on the encoding, in both the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>The contents of the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadLine">
<summary>Reads up to the <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value in the input buffer.</summary>
<returns>The contents of the input buffer up to the first occurrence of a <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No bytes were read.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReadTimeout">
<summary>Gets or sets the number of milliseconds before a time-out occurs when a read operation does not finish.</summary>
<returns>The number of milliseconds before a time-out occurs when a read operation does not finish.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The read time-out value is less than zero and not equal to <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadTo(System.String)">
<summary>Reads a string up to the specified <paramref name="value" /> in the input buffer.</summary>
<param name="value">A value that indicates where the read operation stops.</param>
<returns>The contents of the input buffer up to the specified <paramref name="value" />.</returns>
<exception cref="T:System.ArgumentException">The length of the <paramref name="value" /> parameter is 0.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="value" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold">
<summary>Gets or sets the number of bytes in the internal input buffer before a <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event occurs.</summary>
<returns>The number of bytes in the internal input buffer before a <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event is fired. The default is 1.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold" /> value is less than or equal to zero.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.RtsEnable">
<summary>Gets or sets a value indicating whether the Request to Send (RTS) signal is enabled during serial communication.</summary>
<returns>
<see langword="true" /> to enable Request to Transmit (RTS); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.InvalidOperationException">The value of the <see cref="P:System.IO.Ports.SerialPort.RtsEnable" /> property was set or retrieved while the <see cref="P:System.IO.Ports.SerialPort.Handshake" /> property is set to the <see cref="F:System.IO.Ports.Handshake.RequestToSend" /> value or the <see cref="F:System.IO.Ports.Handshake.RequestToSendXOnXOff" /> value.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.StopBits">
<summary>Gets or sets the standard number of stopbits per byte.</summary>
<returns>One of the <see cref="T:System.IO.Ports.StopBits" /> values.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.StopBits" /> value is <see cref="F:System.IO.Ports.StopBits.None" />.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.Byte[],System.Int32,System.Int32)">
<summary>Writes a specified number of bytes to the serial port using data from a buffer.</summary>
<param name="buffer">The byte array that contains the data to write to the port.</param>
<param name="offset">The zero-based byte offset in the <paramref name="buffer" /> parameter at which to begin copying bytes to the port.</param>
<param name="count">The number of bytes to write.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.Char[],System.Int32,System.Int32)">
<summary>Writes a specified number of characters to the serial port using data from a buffer.</summary>
<param name="buffer">The character array that contains the data to write to the port.</param>
<param name="offset">The zero-based byte offset in the <paramref name="buffer" /> parameter at which to begin copying bytes to the port.</param>
<param name="count">The number of characters to write.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.String)">
<summary>Writes the specified string to the serial port.</summary>
<param name="text">The string for output.</param>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="text" /> is <see langword="null" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.WriteBufferSize">
<summary>Gets or sets the size of the serial port output buffer.</summary>
<returns>The size of the output buffer. The default is 2048.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> value is less than or equal to zero.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> property was set while the stream was open.</exception>
<exception cref="T:System.IO.IOException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> property was set to an odd integer value.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.WriteLine(System.String)">
<summary>Writes the specified string and the <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value to the output buffer.</summary>
<param name="text">The string to write to the output buffer.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="text" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The <see cref="M:System.IO.Ports.SerialPort.WriteLine(System.String)" /> method could not write to the stream.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.WriteTimeout">
<summary>Gets or sets the number of milliseconds before a time-out occurs when a write operation does not finish.</summary>
<returns>The number of milliseconds before a time-out occurs. The default is <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.WriteTimeout" /> value is less than zero and not equal to <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
</member>
<member name="T:System.IO.Ports.StopBits">
<summary>Specifies the number of stop bits used on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.None">
<summary>No stop bits are used. This value is not supported by the <see cref="P:System.IO.Ports.SerialPort.StopBits" /> property.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.One">
<summary>One stop bit is used.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.OnePointFive">
<summary>1.5 stop bits are used.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.Two">
<summary>Two stop bits are used.</summary>
</member>
</members>
</doc>

0
packages/System.IO.Ports.4.6.0/ref/uap10.0.16299/_._ vendored Normal file
View File

541
packages/System.IO.Ports.4.6.0/runtimes/linux/lib/netstandard2.0/System.IO.Ports.xml vendored Normal file
View File

@@ -0,0 +1,541 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>System.IO.Ports</name>
</assembly>
<members>
<member name="T:System.IO.Ports.Handshake">
<summary>Specifies the control protocol used in establishing a serial port communication for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.None">
<summary>No control is used for the handshake.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.RequestToSend">
<summary>Request-to-Send (RTS) hardware flow control is used. RTS signals that data is available for transmission. If the input buffer becomes full, the RTS line will be set to <see langword="false" />. The RTS line will be set to <see langword="true" /> when more room becomes available in the input buffer.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.RequestToSendXOnXOff">
<summary>Both the Request-to-Send (RTS) hardware control and the XON/XOFF software controls are used.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.XOnXOff">
<summary>The XON/XOFF software control protocol is used. The XOFF control is sent to stop the transmission of data. The XON control is sent to resume the transmission. These software controls are used instead of Request to Send (RTS) and Clear to Send (CTS) hardware controls.</summary>
</member>
<member name="T:System.IO.Ports.Parity">
<summary>Specifies the parity bit for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Even">
<summary>Sets the parity bit so that the count of bits set is an even number.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Mark">
<summary>Leaves the parity bit set to 1.</summary>
</member>
<member name="F:System.IO.Ports.Parity.None">
<summary>No parity check occurs.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Odd">
<summary>Sets the parity bit so that the count of bits set is an odd number.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Space">
<summary>Leaves the parity bit set to 0.</summary>
</member>
<member name="T:System.IO.Ports.SerialData">
<summary>Specifies the type of character that was received on the serial port of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialData.Chars">
<summary>A character was received and placed in the input buffer.</summary>
</member>
<member name="F:System.IO.Ports.SerialData.Eof">
<summary>The end of file character was received and placed in the input buffer.</summary>
</member>
<member name="T:System.IO.Ports.SerialDataReceivedEventArgs">
<summary>Provides data for the <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialDataReceivedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialData" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialDataReceivedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The sender of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialDataReceivedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialError">
<summary>Specifies errors that occur on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.Frame">
<summary>The hardware detected a framing error.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.Overrun">
<summary>A character-buffer overrun has occurred. The next character is lost.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.RXOver">
<summary>An input buffer overflow has occurred. There is either no room in the input buffer, or a character was received after the end-of-file (EOF) character.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.RXParity">
<summary>The hardware detected a parity error.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.TXFull">
<summary>The application tried to transmit a character, but the output buffer was full.</summary>
</member>
<member name="T:System.IO.Ports.SerialErrorReceivedEventArgs">
<summary>Prepares data for the <see cref="E:System.IO.Ports.SerialPort.ErrorReceived" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialErrorReceivedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialError" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialErrorReceivedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.ErrorReceived" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The sender of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialErrorReceivedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialPinChange">
<summary>Specifies the type of change that occurred on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.Break">
<summary>A break was detected on input.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.CDChanged">
<summary>The Carrier Detect (CD) signal changed state. This signal is used to indicate whether a modem is connected to a working phone line and a data carrier signal is detected.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.CtsChanged">
<summary>The Clear to Send (CTS) signal changed state. This signal is used to indicate whether data can be sent over the serial port.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.DsrChanged">
<summary>The Data Set Ready (DSR) signal changed state. This signal is used to indicate whether the device on the serial port is ready to operate.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.Ring">
<summary>A ring indicator was detected.</summary>
</member>
<member name="T:System.IO.Ports.SerialPinChangedEventArgs">
<summary>Provides data for the <see cref="E:System.IO.Ports.SerialPort.PinChanged" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialPinChangedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialPinChange" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialPinChangedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.PinChanged" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The source of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialPinChangedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialPort">
<summary>Represents a serial port resource.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.ComponentModel.IContainer)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified <see cref="T:System.ComponentModel.IContainer" /> object.</summary>
<param name="container">An interface to a container.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name and baud rate.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, and parity bit.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity,System.Int32)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, parity bit, and data bits.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<param name="dataBits">The data bits value.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity,System.Int32,System.IO.Ports.StopBits)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, parity bit, data bits, and stop bit.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<param name="dataBits">The data bits value.</param>
<param name="stopBits">One of the <see cref="P:System.IO.Ports.SerialPort.StopBits" /> values.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BaseStream">
<summary>Gets the underlying <see cref="T:System.IO.Stream" /> object for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>A <see cref="T:System.IO.Stream" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
<exception cref="T:System.NotSupportedException">The stream is in a .NET Compact Framework application and one of the following methods was called:
<see cref="M:System.IO.Stream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /><see cref="M:System.IO.Stream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /><see cref="M:System.IO.Stream.EndRead(System.IAsyncResult)" /><see cref="M:System.IO.Stream.EndWrite(System.IAsyncResult)" />
The .NET Compact Framework does not support the asynchronous model with base streams.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BaudRate">
<summary>Gets or sets the serial baud rate.</summary>
<returns>The baud rate.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The baud rate specified is less than or equal to zero, or is greater than the maximum allowable baud rate for the device.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BreakState">
<summary>Gets or sets the break signal state.</summary>
<returns>
<see langword="true" /> if the port is in a break state; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BytesToRead">
<summary>Gets the number of bytes of data in the receive buffer.</summary>
<returns>The number of bytes of data in the receive buffer.</returns>
<exception cref="T:System.InvalidOperationException">The port is not open.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BytesToWrite">
<summary>Gets the number of bytes of data in the send buffer.</summary>
<returns>The number of bytes of data in the send buffer.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.CDHolding">
<summary>Gets the state of the Carrier Detect line for the port.</summary>
<returns>
<see langword="true" /> if the carrier is detected; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Close">
<summary>Closes the port connection, sets the <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> property to <see langword="false" />, and disposes of the internal <see cref="T:System.IO.Stream" /> object.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.CtsHolding">
<summary>Gets the state of the Clear-to-Send line.</summary>
<returns>
<see langword="true" /> if the Clear-to-Send line is detected; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DataBits">
<summary>Gets or sets the standard length of data bits per byte.</summary>
<returns>The data bits length.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The data bits value is less than 5 or more than 8.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.DataReceived">
<summary>Indicates that data has been received through a port represented by the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.DiscardInBuffer">
<summary>Discards data from the serial driver's receive buffer.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DiscardNull">
<summary>Gets or sets a value indicating whether null bytes are ignored when transmitted between the port and the receive buffer.</summary>
<returns>
<see langword="true" /> if null bytes are ignored; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.DiscardOutBuffer">
<summary>Discards data from the serial driver's transmit buffer.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Dispose(System.Boolean)">
<summary>Releases the unmanaged resources used by the <see cref="T:System.IO.Ports.SerialPort" /> and optionally releases the managed resources.</summary>
<param name="disposing">
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DsrHolding">
<summary>Gets the state of the Data Set Ready (DSR) signal.</summary>
<returns>
<see langword="true" /> if a Data Set Ready signal has been sent to the port; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DtrEnable">
<summary>Gets or sets a value that enables the Data Terminal Ready (DTR) signal during serial communication.</summary>
<returns>
<see langword="true" /> to enable Data Terminal Ready (DTR); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Encoding">
<summary>Gets or sets the byte encoding for pre- and post-transmission conversion of text.</summary>
<returns>An <see cref="T:System.Text.Encoding" /> object. The default is <see cref="T:System.Text.ASCIIEncoding" />.</returns>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.Encoding" /> property was set to <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.Encoding" /> property was set to an encoding that is not <see cref="T:System.Text.ASCIIEncoding" />, <see cref="T:System.Text.UTF8Encoding" />, <see cref="T:System.Text.UTF32Encoding" />, <see cref="T:System.Text.UnicodeEncoding" />, one of the Windows single byte encodings, or one of the Windows double byte encodings.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.ErrorReceived">
<summary>Indicates that an error has occurred with a port represented by a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.GetPortNames">
<summary>Gets an array of serial port names for the current computer.</summary>
<returns>An array of serial port names for the current computer.</returns>
<exception cref="T:System.ComponentModel.Win32Exception">The serial port names could not be queried.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Handshake">
<summary>Gets or sets the handshaking protocol for serial port transmission of data using a value from <see cref="T:System.IO.Ports.Handshake" />.</summary>
<returns>One of the <see cref="T:System.IO.Ports.Handshake" /> values. The default is <see langword="None" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value passed is not a valid value in the <see cref="T:System.IO.Ports.Handshake" /> enumeration.</exception>
</member>
<member name="F:System.IO.Ports.SerialPort.InfiniteTimeout">
<summary>Indicates that no time-out should occur.</summary>
</member>
<member name="P:System.IO.Ports.SerialPort.IsOpen">
<summary>Gets a value indicating the open or closed status of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>
<see langword="true" /> if the serial port is open; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> value passed is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> value passed is an empty string ("").</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.NewLine">
<summary>Gets or sets the value used to interpret the end of a call to the <see cref="M:System.IO.Ports.SerialPort.ReadLine" /> and <see cref="M:System.IO.Ports.SerialPort.WriteLine(System.String)" /> methods.</summary>
<returns>A value that represents the end of a line. The default is a line feed ("\n" in C# or <see cref="F:Microsoft.VisualBasic.Constants.vbLf" /> in Visual Basic).</returns>
<exception cref="T:System.ArgumentException">The property value is empty.</exception>
<exception cref="T:System.ArgumentNullException">The property value is <see langword="null" />.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Open">
<summary>Opens a new serial port connection.</summary>
<exception cref="T:System.UnauthorizedAccessException">Access is denied to the port.
-or-
The current process, or another process on the system, already has the specified COM port open either by a <see cref="T:System.IO.Ports.SerialPort" /> instance or in unmanaged code.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">One or more of the properties for this instance are invalid. For example, the <see cref="P:System.IO.Ports.SerialPort.Parity" />, <see cref="P:System.IO.Ports.SerialPort.DataBits" />, or <see cref="P:System.IO.Ports.SerialPort.Handshake" /> properties are not valid values; the <see cref="P:System.IO.Ports.SerialPort.BaudRate" /> is less than or equal to zero; the <see cref="P:System.IO.Ports.SerialPort.ReadTimeout" /> or <see cref="P:System.IO.Ports.SerialPort.WriteTimeout" /> property is less than zero and is not <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
<exception cref="T:System.ArgumentException">The port name does not begin with "COM".
-or-
The file type of the port is not supported.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The specified port on the current instance of the <see cref="T:System.IO.Ports.SerialPort" /> is already open.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Parity">
<summary>Gets or sets the parity-checking protocol.</summary>
<returns>One of the enumeration values that represents the parity-checking protocol. The default is <see cref="F:System.IO.Ports.Parity.None" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.Parity" /> value passed is not a valid value in the <see cref="T:System.IO.Ports.Parity" /> enumeration.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ParityReplace">
<summary>Gets or sets the byte that replaces invalid bytes in a data stream when a parity error occurs.</summary>
<returns>A byte that replaces invalid bytes.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.PinChanged">
<summary>Indicates that a non-data signal event has occurred on the port represented by the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="P:System.IO.Ports.SerialPort.PortName">
<summary>Gets or sets the port for communications, including but not limited to all available COM ports.</summary>
<returns>The communications port. The default is COM1.</returns>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to a value with a length of zero.
-or-
The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to a value that starts with "\\".
-or-
The port name was not valid.</exception>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is open.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Read(System.Byte[],System.Int32,System.Int32)">
<summary>Reads a number of bytes from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer and writes those bytes into a byte array at the specified offset.</summary>
<param name="buffer">The byte array to write the input to.</param>
<param name="offset">The offset in <paramref name="buffer" /> at which to write the bytes.</param>
<param name="count">The maximum number of bytes to read. Fewer bytes are read if <paramref name="count" /> is greater than the number of bytes in the input buffer.</param>
<returns>The number of bytes read.</returns>
<exception cref="T:System.ArgumentNullException">The buffer passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.TimeoutException">No bytes were available to read.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Read(System.Char[],System.Int32,System.Int32)">
<summary>Reads a number of characters from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer and writes them into an array of characters at a given offset.</summary>
<param name="buffer">The character array to write the input to.</param>
<param name="offset">The offset in <paramref name="buffer" /> at which to write the characters.</param>
<param name="count">The maximum number of characters to read. Fewer characters are read if <paramref name="count" /> is greater than the number of characters in the input buffer.</param>
<returns>The number of characters read.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the buffer.
-or-
<paramref name="count" /> is 1 and there is a surrogate character in the buffer.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">No characters were available to read.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReadBufferSize">
<summary>Gets or sets the size of the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The buffer size, in bytes. The default value is 4096; the maximum value is that of a positive int, or 2147483647.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> value set is less than or equal to zero.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> property was set while the stream was open.</exception>
<exception cref="T:System.IO.IOException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> property was set to an odd integer value.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadByte">
<summary>Synchronously reads one byte from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The byte, cast to an <see cref="T:System.Int32" />, or -1 if the end of the stream has been read.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No byte was read.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadChar">
<summary>Synchronously reads one character from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The character that was read.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No character was available in the allotted time-out period.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadExisting">
<summary>Reads all immediately available bytes, based on the encoding, in both the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>The contents of the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadLine">
<summary>Reads up to the <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value in the input buffer.</summary>
<returns>The contents of the input buffer up to the first occurrence of a <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No bytes were read.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReadTimeout">
<summary>Gets or sets the number of milliseconds before a time-out occurs when a read operation does not finish.</summary>
<returns>The number of milliseconds before a time-out occurs when a read operation does not finish.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The read time-out value is less than zero and not equal to <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadTo(System.String)">
<summary>Reads a string up to the specified <paramref name="value" /> in the input buffer.</summary>
<param name="value">A value that indicates where the read operation stops.</param>
<returns>The contents of the input buffer up to the specified <paramref name="value" />.</returns>
<exception cref="T:System.ArgumentException">The length of the <paramref name="value" /> parameter is 0.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="value" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold">
<summary>Gets or sets the number of bytes in the internal input buffer before a <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event occurs.</summary>
<returns>The number of bytes in the internal input buffer before a <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event is fired. The default is 1.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold" /> value is less than or equal to zero.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.RtsEnable">
<summary>Gets or sets a value indicating whether the Request to Send (RTS) signal is enabled during serial communication.</summary>
<returns>
<see langword="true" /> to enable Request to Transmit (RTS); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.InvalidOperationException">The value of the <see cref="P:System.IO.Ports.SerialPort.RtsEnable" /> property was set or retrieved while the <see cref="P:System.IO.Ports.SerialPort.Handshake" /> property is set to the <see cref="F:System.IO.Ports.Handshake.RequestToSend" /> value or the <see cref="F:System.IO.Ports.Handshake.RequestToSendXOnXOff" /> value.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.StopBits">
<summary>Gets or sets the standard number of stopbits per byte.</summary>
<returns>One of the <see cref="T:System.IO.Ports.StopBits" /> values.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.StopBits" /> value is <see cref="F:System.IO.Ports.StopBits.None" />.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.Byte[],System.Int32,System.Int32)">
<summary>Writes a specified number of bytes to the serial port using data from a buffer.</summary>
<param name="buffer">The byte array that contains the data to write to the port.</param>
<param name="offset">The zero-based byte offset in the <paramref name="buffer" /> parameter at which to begin copying bytes to the port.</param>
<param name="count">The number of bytes to write.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.Char[],System.Int32,System.Int32)">
<summary>Writes a specified number of characters to the serial port using data from a buffer.</summary>
<param name="buffer">The character array that contains the data to write to the port.</param>
<param name="offset">The zero-based byte offset in the <paramref name="buffer" /> parameter at which to begin copying bytes to the port.</param>
<param name="count">The number of characters to write.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.String)">
<summary>Writes the specified string to the serial port.</summary>
<param name="text">The string for output.</param>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="text" /> is <see langword="null" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.WriteBufferSize">
<summary>Gets or sets the size of the serial port output buffer.</summary>
<returns>The size of the output buffer. The default is 2048.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> value is less than or equal to zero.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> property was set while the stream was open.</exception>
<exception cref="T:System.IO.IOException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> property was set to an odd integer value.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.WriteLine(System.String)">
<summary>Writes the specified string and the <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value to the output buffer.</summary>
<param name="text">The string to write to the output buffer.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="text" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The <see cref="M:System.IO.Ports.SerialPort.WriteLine(System.String)" /> method could not write to the stream.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.WriteTimeout">
<summary>Gets or sets the number of milliseconds before a time-out occurs when a write operation does not finish.</summary>
<returns>The number of milliseconds before a time-out occurs. The default is <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.WriteTimeout" /> value is less than zero and not equal to <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
</member>
<member name="T:System.IO.Ports.StopBits">
<summary>Specifies the number of stop bits used on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.None">
<summary>No stop bits are used. This value is not supported by the <see cref="P:System.IO.Ports.SerialPort.StopBits" /> property.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.One">
<summary>One stop bit is used.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.OnePointFive">
<summary>1.5 stop bits are used.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.Two">
<summary>Two stop bits are used.</summary>
</member>
</members>
</doc>

541
packages/System.IO.Ports.4.6.0/runtimes/osx/lib/netstandard2.0/System.IO.Ports.xml vendored Normal file
View File

@@ -0,0 +1,541 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>System.IO.Ports</name>
</assembly>
<members>
<member name="T:System.IO.Ports.Handshake">
<summary>Specifies the control protocol used in establishing a serial port communication for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.None">
<summary>No control is used for the handshake.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.RequestToSend">
<summary>Request-to-Send (RTS) hardware flow control is used. RTS signals that data is available for transmission. If the input buffer becomes full, the RTS line will be set to <see langword="false" />. The RTS line will be set to <see langword="true" /> when more room becomes available in the input buffer.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.RequestToSendXOnXOff">
<summary>Both the Request-to-Send (RTS) hardware control and the XON/XOFF software controls are used.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.XOnXOff">
<summary>The XON/XOFF software control protocol is used. The XOFF control is sent to stop the transmission of data. The XON control is sent to resume the transmission. These software controls are used instead of Request to Send (RTS) and Clear to Send (CTS) hardware controls.</summary>
</member>
<member name="T:System.IO.Ports.Parity">
<summary>Specifies the parity bit for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Even">
<summary>Sets the parity bit so that the count of bits set is an even number.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Mark">
<summary>Leaves the parity bit set to 1.</summary>
</member>
<member name="F:System.IO.Ports.Parity.None">
<summary>No parity check occurs.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Odd">
<summary>Sets the parity bit so that the count of bits set is an odd number.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Space">
<summary>Leaves the parity bit set to 0.</summary>
</member>
<member name="T:System.IO.Ports.SerialData">
<summary>Specifies the type of character that was received on the serial port of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialData.Chars">
<summary>A character was received and placed in the input buffer.</summary>
</member>
<member name="F:System.IO.Ports.SerialData.Eof">
<summary>The end of file character was received and placed in the input buffer.</summary>
</member>
<member name="T:System.IO.Ports.SerialDataReceivedEventArgs">
<summary>Provides data for the <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialDataReceivedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialData" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialDataReceivedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The sender of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialDataReceivedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialError">
<summary>Specifies errors that occur on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.Frame">
<summary>The hardware detected a framing error.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.Overrun">
<summary>A character-buffer overrun has occurred. The next character is lost.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.RXOver">
<summary>An input buffer overflow has occurred. There is either no room in the input buffer, or a character was received after the end-of-file (EOF) character.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.RXParity">
<summary>The hardware detected a parity error.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.TXFull">
<summary>The application tried to transmit a character, but the output buffer was full.</summary>
</member>
<member name="T:System.IO.Ports.SerialErrorReceivedEventArgs">
<summary>Prepares data for the <see cref="E:System.IO.Ports.SerialPort.ErrorReceived" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialErrorReceivedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialError" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialErrorReceivedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.ErrorReceived" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The sender of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialErrorReceivedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialPinChange">
<summary>Specifies the type of change that occurred on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.Break">
<summary>A break was detected on input.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.CDChanged">
<summary>The Carrier Detect (CD) signal changed state. This signal is used to indicate whether a modem is connected to a working phone line and a data carrier signal is detected.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.CtsChanged">
<summary>The Clear to Send (CTS) signal changed state. This signal is used to indicate whether data can be sent over the serial port.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.DsrChanged">
<summary>The Data Set Ready (DSR) signal changed state. This signal is used to indicate whether the device on the serial port is ready to operate.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.Ring">
<summary>A ring indicator was detected.</summary>
</member>
<member name="T:System.IO.Ports.SerialPinChangedEventArgs">
<summary>Provides data for the <see cref="E:System.IO.Ports.SerialPort.PinChanged" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialPinChangedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialPinChange" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialPinChangedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.PinChanged" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The source of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialPinChangedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialPort">
<summary>Represents a serial port resource.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.ComponentModel.IContainer)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified <see cref="T:System.ComponentModel.IContainer" /> object.</summary>
<param name="container">An interface to a container.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name and baud rate.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, and parity bit.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity,System.Int32)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, parity bit, and data bits.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<param name="dataBits">The data bits value.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity,System.Int32,System.IO.Ports.StopBits)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, parity bit, data bits, and stop bit.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<param name="dataBits">The data bits value.</param>
<param name="stopBits">One of the <see cref="P:System.IO.Ports.SerialPort.StopBits" /> values.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BaseStream">
<summary>Gets the underlying <see cref="T:System.IO.Stream" /> object for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>A <see cref="T:System.IO.Stream" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
<exception cref="T:System.NotSupportedException">The stream is in a .NET Compact Framework application and one of the following methods was called:
<see cref="M:System.IO.Stream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /><see cref="M:System.IO.Stream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /><see cref="M:System.IO.Stream.EndRead(System.IAsyncResult)" /><see cref="M:System.IO.Stream.EndWrite(System.IAsyncResult)" />
The .NET Compact Framework does not support the asynchronous model with base streams.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BaudRate">
<summary>Gets or sets the serial baud rate.</summary>
<returns>The baud rate.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The baud rate specified is less than or equal to zero, or is greater than the maximum allowable baud rate for the device.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BreakState">
<summary>Gets or sets the break signal state.</summary>
<returns>
<see langword="true" /> if the port is in a break state; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BytesToRead">
<summary>Gets the number of bytes of data in the receive buffer.</summary>
<returns>The number of bytes of data in the receive buffer.</returns>
<exception cref="T:System.InvalidOperationException">The port is not open.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BytesToWrite">
<summary>Gets the number of bytes of data in the send buffer.</summary>
<returns>The number of bytes of data in the send buffer.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.CDHolding">
<summary>Gets the state of the Carrier Detect line for the port.</summary>
<returns>
<see langword="true" /> if the carrier is detected; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Close">
<summary>Closes the port connection, sets the <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> property to <see langword="false" />, and disposes of the internal <see cref="T:System.IO.Stream" /> object.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.CtsHolding">
<summary>Gets the state of the Clear-to-Send line.</summary>
<returns>
<see langword="true" /> if the Clear-to-Send line is detected; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DataBits">
<summary>Gets or sets the standard length of data bits per byte.</summary>
<returns>The data bits length.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The data bits value is less than 5 or more than 8.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.DataReceived">
<summary>Indicates that data has been received through a port represented by the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.DiscardInBuffer">
<summary>Discards data from the serial driver's receive buffer.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DiscardNull">
<summary>Gets or sets a value indicating whether null bytes are ignored when transmitted between the port and the receive buffer.</summary>
<returns>
<see langword="true" /> if null bytes are ignored; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.DiscardOutBuffer">
<summary>Discards data from the serial driver's transmit buffer.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Dispose(System.Boolean)">
<summary>Releases the unmanaged resources used by the <see cref="T:System.IO.Ports.SerialPort" /> and optionally releases the managed resources.</summary>
<param name="disposing">
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DsrHolding">
<summary>Gets the state of the Data Set Ready (DSR) signal.</summary>
<returns>
<see langword="true" /> if a Data Set Ready signal has been sent to the port; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DtrEnable">
<summary>Gets or sets a value that enables the Data Terminal Ready (DTR) signal during serial communication.</summary>
<returns>
<see langword="true" /> to enable Data Terminal Ready (DTR); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Encoding">
<summary>Gets or sets the byte encoding for pre- and post-transmission conversion of text.</summary>
<returns>An <see cref="T:System.Text.Encoding" /> object. The default is <see cref="T:System.Text.ASCIIEncoding" />.</returns>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.Encoding" /> property was set to <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.Encoding" /> property was set to an encoding that is not <see cref="T:System.Text.ASCIIEncoding" />, <see cref="T:System.Text.UTF8Encoding" />, <see cref="T:System.Text.UTF32Encoding" />, <see cref="T:System.Text.UnicodeEncoding" />, one of the Windows single byte encodings, or one of the Windows double byte encodings.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.ErrorReceived">
<summary>Indicates that an error has occurred with a port represented by a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.GetPortNames">
<summary>Gets an array of serial port names for the current computer.</summary>
<returns>An array of serial port names for the current computer.</returns>
<exception cref="T:System.ComponentModel.Win32Exception">The serial port names could not be queried.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Handshake">
<summary>Gets or sets the handshaking protocol for serial port transmission of data using a value from <see cref="T:System.IO.Ports.Handshake" />.</summary>
<returns>One of the <see cref="T:System.IO.Ports.Handshake" /> values. The default is <see langword="None" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value passed is not a valid value in the <see cref="T:System.IO.Ports.Handshake" /> enumeration.</exception>
</member>
<member name="F:System.IO.Ports.SerialPort.InfiniteTimeout">
<summary>Indicates that no time-out should occur.</summary>
</member>
<member name="P:System.IO.Ports.SerialPort.IsOpen">
<summary>Gets a value indicating the open or closed status of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>
<see langword="true" /> if the serial port is open; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> value passed is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> value passed is an empty string ("").</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.NewLine">
<summary>Gets or sets the value used to interpret the end of a call to the <see cref="M:System.IO.Ports.SerialPort.ReadLine" /> and <see cref="M:System.IO.Ports.SerialPort.WriteLine(System.String)" /> methods.</summary>
<returns>A value that represents the end of a line. The default is a line feed ("\n" in C# or <see cref="F:Microsoft.VisualBasic.Constants.vbLf" /> in Visual Basic).</returns>
<exception cref="T:System.ArgumentException">The property value is empty.</exception>
<exception cref="T:System.ArgumentNullException">The property value is <see langword="null" />.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Open">
<summary>Opens a new serial port connection.</summary>
<exception cref="T:System.UnauthorizedAccessException">Access is denied to the port.
-or-
The current process, or another process on the system, already has the specified COM port open either by a <see cref="T:System.IO.Ports.SerialPort" /> instance or in unmanaged code.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">One or more of the properties for this instance are invalid. For example, the <see cref="P:System.IO.Ports.SerialPort.Parity" />, <see cref="P:System.IO.Ports.SerialPort.DataBits" />, or <see cref="P:System.IO.Ports.SerialPort.Handshake" /> properties are not valid values; the <see cref="P:System.IO.Ports.SerialPort.BaudRate" /> is less than or equal to zero; the <see cref="P:System.IO.Ports.SerialPort.ReadTimeout" /> or <see cref="P:System.IO.Ports.SerialPort.WriteTimeout" /> property is less than zero and is not <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
<exception cref="T:System.ArgumentException">The port name does not begin with "COM".
-or-
The file type of the port is not supported.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The specified port on the current instance of the <see cref="T:System.IO.Ports.SerialPort" /> is already open.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Parity">
<summary>Gets or sets the parity-checking protocol.</summary>
<returns>One of the enumeration values that represents the parity-checking protocol. The default is <see cref="F:System.IO.Ports.Parity.None" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.Parity" /> value passed is not a valid value in the <see cref="T:System.IO.Ports.Parity" /> enumeration.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ParityReplace">
<summary>Gets or sets the byte that replaces invalid bytes in a data stream when a parity error occurs.</summary>
<returns>A byte that replaces invalid bytes.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.PinChanged">
<summary>Indicates that a non-data signal event has occurred on the port represented by the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="P:System.IO.Ports.SerialPort.PortName">
<summary>Gets or sets the port for communications, including but not limited to all available COM ports.</summary>
<returns>The communications port. The default is COM1.</returns>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to a value with a length of zero.
-or-
The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to a value that starts with "\\".
-or-
The port name was not valid.</exception>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is open.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Read(System.Byte[],System.Int32,System.Int32)">
<summary>Reads a number of bytes from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer and writes those bytes into a byte array at the specified offset.</summary>
<param name="buffer">The byte array to write the input to.</param>
<param name="offset">The offset in <paramref name="buffer" /> at which to write the bytes.</param>
<param name="count">The maximum number of bytes to read. Fewer bytes are read if <paramref name="count" /> is greater than the number of bytes in the input buffer.</param>
<returns>The number of bytes read.</returns>
<exception cref="T:System.ArgumentNullException">The buffer passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.TimeoutException">No bytes were available to read.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Read(System.Char[],System.Int32,System.Int32)">
<summary>Reads a number of characters from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer and writes them into an array of characters at a given offset.</summary>
<param name="buffer">The character array to write the input to.</param>
<param name="offset">The offset in <paramref name="buffer" /> at which to write the characters.</param>
<param name="count">The maximum number of characters to read. Fewer characters are read if <paramref name="count" /> is greater than the number of characters in the input buffer.</param>
<returns>The number of characters read.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the buffer.
-or-
<paramref name="count" /> is 1 and there is a surrogate character in the buffer.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">No characters were available to read.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReadBufferSize">
<summary>Gets or sets the size of the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The buffer size, in bytes. The default value is 4096; the maximum value is that of a positive int, or 2147483647.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> value set is less than or equal to zero.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> property was set while the stream was open.</exception>
<exception cref="T:System.IO.IOException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> property was set to an odd integer value.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadByte">
<summary>Synchronously reads one byte from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The byte, cast to an <see cref="T:System.Int32" />, or -1 if the end of the stream has been read.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No byte was read.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadChar">
<summary>Synchronously reads one character from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The character that was read.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No character was available in the allotted time-out period.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadExisting">
<summary>Reads all immediately available bytes, based on the encoding, in both the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>The contents of the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadLine">
<summary>Reads up to the <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value in the input buffer.</summary>
<returns>The contents of the input buffer up to the first occurrence of a <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No bytes were read.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReadTimeout">
<summary>Gets or sets the number of milliseconds before a time-out occurs when a read operation does not finish.</summary>
<returns>The number of milliseconds before a time-out occurs when a read operation does not finish.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The read time-out value is less than zero and not equal to <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadTo(System.String)">
<summary>Reads a string up to the specified <paramref name="value" /> in the input buffer.</summary>
<param name="value">A value that indicates where the read operation stops.</param>
<returns>The contents of the input buffer up to the specified <paramref name="value" />.</returns>
<exception cref="T:System.ArgumentException">The length of the <paramref name="value" /> parameter is 0.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="value" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold">
<summary>Gets or sets the number of bytes in the internal input buffer before a <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event occurs.</summary>
<returns>The number of bytes in the internal input buffer before a <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event is fired. The default is 1.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold" /> value is less than or equal to zero.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.RtsEnable">
<summary>Gets or sets a value indicating whether the Request to Send (RTS) signal is enabled during serial communication.</summary>
<returns>
<see langword="true" /> to enable Request to Transmit (RTS); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.InvalidOperationException">The value of the <see cref="P:System.IO.Ports.SerialPort.RtsEnable" /> property was set or retrieved while the <see cref="P:System.IO.Ports.SerialPort.Handshake" /> property is set to the <see cref="F:System.IO.Ports.Handshake.RequestToSend" /> value or the <see cref="F:System.IO.Ports.Handshake.RequestToSendXOnXOff" /> value.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.StopBits">
<summary>Gets or sets the standard number of stopbits per byte.</summary>
<returns>One of the <see cref="T:System.IO.Ports.StopBits" /> values.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.StopBits" /> value is <see cref="F:System.IO.Ports.StopBits.None" />.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.Byte[],System.Int32,System.Int32)">
<summary>Writes a specified number of bytes to the serial port using data from a buffer.</summary>
<param name="buffer">The byte array that contains the data to write to the port.</param>
<param name="offset">The zero-based byte offset in the <paramref name="buffer" /> parameter at which to begin copying bytes to the port.</param>
<param name="count">The number of bytes to write.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.Char[],System.Int32,System.Int32)">
<summary>Writes a specified number of characters to the serial port using data from a buffer.</summary>
<param name="buffer">The character array that contains the data to write to the port.</param>
<param name="offset">The zero-based byte offset in the <paramref name="buffer" /> parameter at which to begin copying bytes to the port.</param>
<param name="count">The number of characters to write.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.String)">
<summary>Writes the specified string to the serial port.</summary>
<param name="text">The string for output.</param>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="text" /> is <see langword="null" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.WriteBufferSize">
<summary>Gets or sets the size of the serial port output buffer.</summary>
<returns>The size of the output buffer. The default is 2048.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> value is less than or equal to zero.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> property was set while the stream was open.</exception>
<exception cref="T:System.IO.IOException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> property was set to an odd integer value.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.WriteLine(System.String)">
<summary>Writes the specified string and the <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value to the output buffer.</summary>
<param name="text">The string to write to the output buffer.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="text" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The <see cref="M:System.IO.Ports.SerialPort.WriteLine(System.String)" /> method could not write to the stream.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.WriteTimeout">
<summary>Gets or sets the number of milliseconds before a time-out occurs when a write operation does not finish.</summary>
<returns>The number of milliseconds before a time-out occurs. The default is <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.WriteTimeout" /> value is less than zero and not equal to <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
</member>
<member name="T:System.IO.Ports.StopBits">
<summary>Specifies the number of stop bits used on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.None">
<summary>No stop bits are used. This value is not supported by the <see cref="P:System.IO.Ports.SerialPort.StopBits" /> property.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.One">
<summary>One stop bit is used.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.OnePointFive">
<summary>1.5 stop bits are used.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.Two">
<summary>Two stop bits are used.</summary>
</member>
</members>
</doc>

541
packages/System.IO.Ports.4.6.0/runtimes/win/lib/net461/System.IO.Ports.xml vendored Normal file
View File

@@ -0,0 +1,541 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>System.IO.Ports</name>
</assembly>
<members>
<member name="T:System.IO.Ports.Handshake">
<summary>Specifies the control protocol used in establishing a serial port communication for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.None">
<summary>No control is used for the handshake.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.RequestToSend">
<summary>Request-to-Send (RTS) hardware flow control is used. RTS signals that data is available for transmission. If the input buffer becomes full, the RTS line will be set to <see langword="false" />. The RTS line will be set to <see langword="true" /> when more room becomes available in the input buffer.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.RequestToSendXOnXOff">
<summary>Both the Request-to-Send (RTS) hardware control and the XON/XOFF software controls are used.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.XOnXOff">
<summary>The XON/XOFF software control protocol is used. The XOFF control is sent to stop the transmission of data. The XON control is sent to resume the transmission. These software controls are used instead of Request to Send (RTS) and Clear to Send (CTS) hardware controls.</summary>
</member>
<member name="T:System.IO.Ports.Parity">
<summary>Specifies the parity bit for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Even">
<summary>Sets the parity bit so that the count of bits set is an even number.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Mark">
<summary>Leaves the parity bit set to 1.</summary>
</member>
<member name="F:System.IO.Ports.Parity.None">
<summary>No parity check occurs.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Odd">
<summary>Sets the parity bit so that the count of bits set is an odd number.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Space">
<summary>Leaves the parity bit set to 0.</summary>
</member>
<member name="T:System.IO.Ports.SerialData">
<summary>Specifies the type of character that was received on the serial port of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialData.Chars">
<summary>A character was received and placed in the input buffer.</summary>
</member>
<member name="F:System.IO.Ports.SerialData.Eof">
<summary>The end of file character was received and placed in the input buffer.</summary>
</member>
<member name="T:System.IO.Ports.SerialDataReceivedEventArgs">
<summary>Provides data for the <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialDataReceivedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialData" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialDataReceivedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The sender of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialDataReceivedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialError">
<summary>Specifies errors that occur on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.Frame">
<summary>The hardware detected a framing error.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.Overrun">
<summary>A character-buffer overrun has occurred. The next character is lost.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.RXOver">
<summary>An input buffer overflow has occurred. There is either no room in the input buffer, or a character was received after the end-of-file (EOF) character.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.RXParity">
<summary>The hardware detected a parity error.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.TXFull">
<summary>The application tried to transmit a character, but the output buffer was full.</summary>
</member>
<member name="T:System.IO.Ports.SerialErrorReceivedEventArgs">
<summary>Prepares data for the <see cref="E:System.IO.Ports.SerialPort.ErrorReceived" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialErrorReceivedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialError" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialErrorReceivedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.ErrorReceived" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The sender of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialErrorReceivedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialPinChange">
<summary>Specifies the type of change that occurred on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.Break">
<summary>A break was detected on input.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.CDChanged">
<summary>The Carrier Detect (CD) signal changed state. This signal is used to indicate whether a modem is connected to a working phone line and a data carrier signal is detected.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.CtsChanged">
<summary>The Clear to Send (CTS) signal changed state. This signal is used to indicate whether data can be sent over the serial port.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.DsrChanged">
<summary>The Data Set Ready (DSR) signal changed state. This signal is used to indicate whether the device on the serial port is ready to operate.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.Ring">
<summary>A ring indicator was detected.</summary>
</member>
<member name="T:System.IO.Ports.SerialPinChangedEventArgs">
<summary>Provides data for the <see cref="E:System.IO.Ports.SerialPort.PinChanged" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialPinChangedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialPinChange" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialPinChangedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.PinChanged" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The source of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialPinChangedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialPort">
<summary>Represents a serial port resource.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.ComponentModel.IContainer)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified <see cref="T:System.ComponentModel.IContainer" /> object.</summary>
<param name="container">An interface to a container.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name and baud rate.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, and parity bit.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity,System.Int32)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, parity bit, and data bits.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<param name="dataBits">The data bits value.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity,System.Int32,System.IO.Ports.StopBits)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, parity bit, data bits, and stop bit.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<param name="dataBits">The data bits value.</param>
<param name="stopBits">One of the <see cref="P:System.IO.Ports.SerialPort.StopBits" /> values.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BaseStream">
<summary>Gets the underlying <see cref="T:System.IO.Stream" /> object for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>A <see cref="T:System.IO.Stream" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
<exception cref="T:System.NotSupportedException">The stream is in a .NET Compact Framework application and one of the following methods was called:
<see cref="M:System.IO.Stream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /><see cref="M:System.IO.Stream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /><see cref="M:System.IO.Stream.EndRead(System.IAsyncResult)" /><see cref="M:System.IO.Stream.EndWrite(System.IAsyncResult)" />
The .NET Compact Framework does not support the asynchronous model with base streams.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BaudRate">
<summary>Gets or sets the serial baud rate.</summary>
<returns>The baud rate.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The baud rate specified is less than or equal to zero, or is greater than the maximum allowable baud rate for the device.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BreakState">
<summary>Gets or sets the break signal state.</summary>
<returns>
<see langword="true" /> if the port is in a break state; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BytesToRead">
<summary>Gets the number of bytes of data in the receive buffer.</summary>
<returns>The number of bytes of data in the receive buffer.</returns>
<exception cref="T:System.InvalidOperationException">The port is not open.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BytesToWrite">
<summary>Gets the number of bytes of data in the send buffer.</summary>
<returns>The number of bytes of data in the send buffer.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.CDHolding">
<summary>Gets the state of the Carrier Detect line for the port.</summary>
<returns>
<see langword="true" /> if the carrier is detected; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Close">
<summary>Closes the port connection, sets the <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> property to <see langword="false" />, and disposes of the internal <see cref="T:System.IO.Stream" /> object.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.CtsHolding">
<summary>Gets the state of the Clear-to-Send line.</summary>
<returns>
<see langword="true" /> if the Clear-to-Send line is detected; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DataBits">
<summary>Gets or sets the standard length of data bits per byte.</summary>
<returns>The data bits length.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The data bits value is less than 5 or more than 8.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.DataReceived">
<summary>Indicates that data has been received through a port represented by the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.DiscardInBuffer">
<summary>Discards data from the serial driver's receive buffer.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DiscardNull">
<summary>Gets or sets a value indicating whether null bytes are ignored when transmitted between the port and the receive buffer.</summary>
<returns>
<see langword="true" /> if null bytes are ignored; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.DiscardOutBuffer">
<summary>Discards data from the serial driver's transmit buffer.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Dispose(System.Boolean)">
<summary>Releases the unmanaged resources used by the <see cref="T:System.IO.Ports.SerialPort" /> and optionally releases the managed resources.</summary>
<param name="disposing">
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DsrHolding">
<summary>Gets the state of the Data Set Ready (DSR) signal.</summary>
<returns>
<see langword="true" /> if a Data Set Ready signal has been sent to the port; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DtrEnable">
<summary>Gets or sets a value that enables the Data Terminal Ready (DTR) signal during serial communication.</summary>
<returns>
<see langword="true" /> to enable Data Terminal Ready (DTR); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Encoding">
<summary>Gets or sets the byte encoding for pre- and post-transmission conversion of text.</summary>
<returns>An <see cref="T:System.Text.Encoding" /> object. The default is <see cref="T:System.Text.ASCIIEncoding" />.</returns>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.Encoding" /> property was set to <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.Encoding" /> property was set to an encoding that is not <see cref="T:System.Text.ASCIIEncoding" />, <see cref="T:System.Text.UTF8Encoding" />, <see cref="T:System.Text.UTF32Encoding" />, <see cref="T:System.Text.UnicodeEncoding" />, one of the Windows single byte encodings, or one of the Windows double byte encodings.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.ErrorReceived">
<summary>Indicates that an error has occurred with a port represented by a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.GetPortNames">
<summary>Gets an array of serial port names for the current computer.</summary>
<returns>An array of serial port names for the current computer.</returns>
<exception cref="T:System.ComponentModel.Win32Exception">The serial port names could not be queried.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Handshake">
<summary>Gets or sets the handshaking protocol for serial port transmission of data using a value from <see cref="T:System.IO.Ports.Handshake" />.</summary>
<returns>One of the <see cref="T:System.IO.Ports.Handshake" /> values. The default is <see langword="None" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value passed is not a valid value in the <see cref="T:System.IO.Ports.Handshake" /> enumeration.</exception>
</member>
<member name="F:System.IO.Ports.SerialPort.InfiniteTimeout">
<summary>Indicates that no time-out should occur.</summary>
</member>
<member name="P:System.IO.Ports.SerialPort.IsOpen">
<summary>Gets a value indicating the open or closed status of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>
<see langword="true" /> if the serial port is open; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> value passed is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> value passed is an empty string ("").</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.NewLine">
<summary>Gets or sets the value used to interpret the end of a call to the <see cref="M:System.IO.Ports.SerialPort.ReadLine" /> and <see cref="M:System.IO.Ports.SerialPort.WriteLine(System.String)" /> methods.</summary>
<returns>A value that represents the end of a line. The default is a line feed ("\n" in C# or <see cref="F:Microsoft.VisualBasic.Constants.vbLf" /> in Visual Basic).</returns>
<exception cref="T:System.ArgumentException">The property value is empty.</exception>
<exception cref="T:System.ArgumentNullException">The property value is <see langword="null" />.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Open">
<summary>Opens a new serial port connection.</summary>
<exception cref="T:System.UnauthorizedAccessException">Access is denied to the port.
-or-
The current process, or another process on the system, already has the specified COM port open either by a <see cref="T:System.IO.Ports.SerialPort" /> instance or in unmanaged code.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">One or more of the properties for this instance are invalid. For example, the <see cref="P:System.IO.Ports.SerialPort.Parity" />, <see cref="P:System.IO.Ports.SerialPort.DataBits" />, or <see cref="P:System.IO.Ports.SerialPort.Handshake" /> properties are not valid values; the <see cref="P:System.IO.Ports.SerialPort.BaudRate" /> is less than or equal to zero; the <see cref="P:System.IO.Ports.SerialPort.ReadTimeout" /> or <see cref="P:System.IO.Ports.SerialPort.WriteTimeout" /> property is less than zero and is not <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
<exception cref="T:System.ArgumentException">The port name does not begin with "COM".
-or-
The file type of the port is not supported.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The specified port on the current instance of the <see cref="T:System.IO.Ports.SerialPort" /> is already open.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Parity">
<summary>Gets or sets the parity-checking protocol.</summary>
<returns>One of the enumeration values that represents the parity-checking protocol. The default is <see cref="F:System.IO.Ports.Parity.None" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.Parity" /> value passed is not a valid value in the <see cref="T:System.IO.Ports.Parity" /> enumeration.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ParityReplace">
<summary>Gets or sets the byte that replaces invalid bytes in a data stream when a parity error occurs.</summary>
<returns>A byte that replaces invalid bytes.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.PinChanged">
<summary>Indicates that a non-data signal event has occurred on the port represented by the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="P:System.IO.Ports.SerialPort.PortName">
<summary>Gets or sets the port for communications, including but not limited to all available COM ports.</summary>
<returns>The communications port. The default is COM1.</returns>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to a value with a length of zero.
-or-
The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to a value that starts with "\\".
-or-
The port name was not valid.</exception>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is open.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Read(System.Byte[],System.Int32,System.Int32)">
<summary>Reads a number of bytes from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer and writes those bytes into a byte array at the specified offset.</summary>
<param name="buffer">The byte array to write the input to.</param>
<param name="offset">The offset in <paramref name="buffer" /> at which to write the bytes.</param>
<param name="count">The maximum number of bytes to read. Fewer bytes are read if <paramref name="count" /> is greater than the number of bytes in the input buffer.</param>
<returns>The number of bytes read.</returns>
<exception cref="T:System.ArgumentNullException">The buffer passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.TimeoutException">No bytes were available to read.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Read(System.Char[],System.Int32,System.Int32)">
<summary>Reads a number of characters from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer and writes them into an array of characters at a given offset.</summary>
<param name="buffer">The character array to write the input to.</param>
<param name="offset">The offset in <paramref name="buffer" /> at which to write the characters.</param>
<param name="count">The maximum number of characters to read. Fewer characters are read if <paramref name="count" /> is greater than the number of characters in the input buffer.</param>
<returns>The number of characters read.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the buffer.
-or-
<paramref name="count" /> is 1 and there is a surrogate character in the buffer.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">No characters were available to read.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReadBufferSize">
<summary>Gets or sets the size of the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The buffer size, in bytes. The default value is 4096; the maximum value is that of a positive int, or 2147483647.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> value set is less than or equal to zero.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> property was set while the stream was open.</exception>
<exception cref="T:System.IO.IOException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> property was set to an odd integer value.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadByte">
<summary>Synchronously reads one byte from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The byte, cast to an <see cref="T:System.Int32" />, or -1 if the end of the stream has been read.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No byte was read.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadChar">
<summary>Synchronously reads one character from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The character that was read.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No character was available in the allotted time-out period.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadExisting">
<summary>Reads all immediately available bytes, based on the encoding, in both the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>The contents of the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadLine">
<summary>Reads up to the <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value in the input buffer.</summary>
<returns>The contents of the input buffer up to the first occurrence of a <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No bytes were read.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReadTimeout">
<summary>Gets or sets the number of milliseconds before a time-out occurs when a read operation does not finish.</summary>
<returns>The number of milliseconds before a time-out occurs when a read operation does not finish.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The read time-out value is less than zero and not equal to <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadTo(System.String)">
<summary>Reads a string up to the specified <paramref name="value" /> in the input buffer.</summary>
<param name="value">A value that indicates where the read operation stops.</param>
<returns>The contents of the input buffer up to the specified <paramref name="value" />.</returns>
<exception cref="T:System.ArgumentException">The length of the <paramref name="value" /> parameter is 0.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="value" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold">
<summary>Gets or sets the number of bytes in the internal input buffer before a <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event occurs.</summary>
<returns>The number of bytes in the internal input buffer before a <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event is fired. The default is 1.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold" /> value is less than or equal to zero.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.RtsEnable">
<summary>Gets or sets a value indicating whether the Request to Send (RTS) signal is enabled during serial communication.</summary>
<returns>
<see langword="true" /> to enable Request to Transmit (RTS); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.InvalidOperationException">The value of the <see cref="P:System.IO.Ports.SerialPort.RtsEnable" /> property was set or retrieved while the <see cref="P:System.IO.Ports.SerialPort.Handshake" /> property is set to the <see cref="F:System.IO.Ports.Handshake.RequestToSend" /> value or the <see cref="F:System.IO.Ports.Handshake.RequestToSendXOnXOff" /> value.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.StopBits">
<summary>Gets or sets the standard number of stopbits per byte.</summary>
<returns>One of the <see cref="T:System.IO.Ports.StopBits" /> values.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.StopBits" /> value is <see cref="F:System.IO.Ports.StopBits.None" />.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.Byte[],System.Int32,System.Int32)">
<summary>Writes a specified number of bytes to the serial port using data from a buffer.</summary>
<param name="buffer">The byte array that contains the data to write to the port.</param>
<param name="offset">The zero-based byte offset in the <paramref name="buffer" /> parameter at which to begin copying bytes to the port.</param>
<param name="count">The number of bytes to write.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.Char[],System.Int32,System.Int32)">
<summary>Writes a specified number of characters to the serial port using data from a buffer.</summary>
<param name="buffer">The character array that contains the data to write to the port.</param>
<param name="offset">The zero-based byte offset in the <paramref name="buffer" /> parameter at which to begin copying bytes to the port.</param>
<param name="count">The number of characters to write.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.String)">
<summary>Writes the specified string to the serial port.</summary>
<param name="text">The string for output.</param>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="text" /> is <see langword="null" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.WriteBufferSize">
<summary>Gets or sets the size of the serial port output buffer.</summary>
<returns>The size of the output buffer. The default is 2048.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> value is less than or equal to zero.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> property was set while the stream was open.</exception>
<exception cref="T:System.IO.IOException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> property was set to an odd integer value.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.WriteLine(System.String)">
<summary>Writes the specified string and the <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value to the output buffer.</summary>
<param name="text">The string to write to the output buffer.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="text" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The <see cref="M:System.IO.Ports.SerialPort.WriteLine(System.String)" /> method could not write to the stream.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.WriteTimeout">
<summary>Gets or sets the number of milliseconds before a time-out occurs when a write operation does not finish.</summary>
<returns>The number of milliseconds before a time-out occurs. The default is <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.WriteTimeout" /> value is less than zero and not equal to <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
</member>
<member name="T:System.IO.Ports.StopBits">
<summary>Specifies the number of stop bits used on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.None">
<summary>No stop bits are used. This value is not supported by the <see cref="P:System.IO.Ports.SerialPort.StopBits" /> property.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.One">
<summary>One stop bit is used.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.OnePointFive">
<summary>1.5 stop bits are used.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.Two">
<summary>Two stop bits are used.</summary>
</member>
</members>
</doc>

541
packages/System.IO.Ports.4.6.0/runtimes/win/lib/netstandard2.0/System.IO.Ports.xml vendored Normal file
View File

@@ -0,0 +1,541 @@
<?xml version="1.0" encoding="utf-8"?>
<doc>
<assembly>
<name>System.IO.Ports</name>
</assembly>
<members>
<member name="T:System.IO.Ports.Handshake">
<summary>Specifies the control protocol used in establishing a serial port communication for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.None">
<summary>No control is used for the handshake.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.RequestToSend">
<summary>Request-to-Send (RTS) hardware flow control is used. RTS signals that data is available for transmission. If the input buffer becomes full, the RTS line will be set to <see langword="false" />. The RTS line will be set to <see langword="true" /> when more room becomes available in the input buffer.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.RequestToSendXOnXOff">
<summary>Both the Request-to-Send (RTS) hardware control and the XON/XOFF software controls are used.</summary>
</member>
<member name="F:System.IO.Ports.Handshake.XOnXOff">
<summary>The XON/XOFF software control protocol is used. The XOFF control is sent to stop the transmission of data. The XON control is sent to resume the transmission. These software controls are used instead of Request to Send (RTS) and Clear to Send (CTS) hardware controls.</summary>
</member>
<member name="T:System.IO.Ports.Parity">
<summary>Specifies the parity bit for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Even">
<summary>Sets the parity bit so that the count of bits set is an even number.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Mark">
<summary>Leaves the parity bit set to 1.</summary>
</member>
<member name="F:System.IO.Ports.Parity.None">
<summary>No parity check occurs.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Odd">
<summary>Sets the parity bit so that the count of bits set is an odd number.</summary>
</member>
<member name="F:System.IO.Ports.Parity.Space">
<summary>Leaves the parity bit set to 0.</summary>
</member>
<member name="T:System.IO.Ports.SerialData">
<summary>Specifies the type of character that was received on the serial port of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialData.Chars">
<summary>A character was received and placed in the input buffer.</summary>
</member>
<member name="F:System.IO.Ports.SerialData.Eof">
<summary>The end of file character was received and placed in the input buffer.</summary>
</member>
<member name="T:System.IO.Ports.SerialDataReceivedEventArgs">
<summary>Provides data for the <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialDataReceivedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialData" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialDataReceivedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The sender of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialDataReceivedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialError">
<summary>Specifies errors that occur on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.Frame">
<summary>The hardware detected a framing error.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.Overrun">
<summary>A character-buffer overrun has occurred. The next character is lost.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.RXOver">
<summary>An input buffer overflow has occurred. There is either no room in the input buffer, or a character was received after the end-of-file (EOF) character.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.RXParity">
<summary>The hardware detected a parity error.</summary>
</member>
<member name="F:System.IO.Ports.SerialError.TXFull">
<summary>The application tried to transmit a character, but the output buffer was full.</summary>
</member>
<member name="T:System.IO.Ports.SerialErrorReceivedEventArgs">
<summary>Prepares data for the <see cref="E:System.IO.Ports.SerialPort.ErrorReceived" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialErrorReceivedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialError" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialErrorReceivedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.ErrorReceived" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The sender of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialErrorReceivedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialPinChange">
<summary>Specifies the type of change that occurred on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.Break">
<summary>A break was detected on input.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.CDChanged">
<summary>The Carrier Detect (CD) signal changed state. This signal is used to indicate whether a modem is connected to a working phone line and a data carrier signal is detected.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.CtsChanged">
<summary>The Clear to Send (CTS) signal changed state. This signal is used to indicate whether data can be sent over the serial port.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.DsrChanged">
<summary>The Data Set Ready (DSR) signal changed state. This signal is used to indicate whether the device on the serial port is ready to operate.</summary>
</member>
<member name="F:System.IO.Ports.SerialPinChange.Ring">
<summary>A ring indicator was detected.</summary>
</member>
<member name="T:System.IO.Ports.SerialPinChangedEventArgs">
<summary>Provides data for the <see cref="E:System.IO.Ports.SerialPort.PinChanged" /> event.</summary>
</member>
<member name="P:System.IO.Ports.SerialPinChangedEventArgs.EventType">
<summary>Gets or sets the event type.</summary>
<returns>One of the <see cref="T:System.IO.Ports.SerialPinChange" /> values.</returns>
</member>
<member name="T:System.IO.Ports.SerialPinChangedEventHandler">
<summary>Represents the method that will handle the <see cref="E:System.IO.Ports.SerialPort.PinChanged" /> event of a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<param name="sender">The source of the event, which is the <see cref="T:System.IO.Ports.SerialPort" /> object.</param>
<param name="e">A <see cref="T:System.IO.Ports.SerialPinChangedEventArgs" /> object that contains the event data.</param>
</member>
<member name="T:System.IO.Ports.SerialPort">
<summary>Represents a serial port resource.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.ComponentModel.IContainer)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified <see cref="T:System.ComponentModel.IContainer" /> object.</summary>
<param name="container">An interface to a container.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name and baud rate.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, and parity bit.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity,System.Int32)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, parity bit, and data bits.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<param name="dataBits">The data bits value.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.#ctor(System.String,System.Int32,System.IO.Ports.Parity,System.Int32,System.IO.Ports.StopBits)">
<summary>Initializes a new instance of the <see cref="T:System.IO.Ports.SerialPort" /> class using the specified port name, baud rate, parity bit, data bits, and stop bit.</summary>
<param name="portName">The port to use (for example, COM1).</param>
<param name="baudRate">The baud rate.</param>
<param name="parity">One of the <see cref="P:System.IO.Ports.SerialPort.Parity" /> values.</param>
<param name="dataBits">The data bits value.</param>
<param name="stopBits">One of the <see cref="P:System.IO.Ports.SerialPort.StopBits" /> values.</param>
<exception cref="T:System.IO.IOException">The specified port could not be found or opened.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BaseStream">
<summary>Gets the underlying <see cref="T:System.IO.Stream" /> object for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>A <see cref="T:System.IO.Stream" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
<exception cref="T:System.NotSupportedException">The stream is in a .NET Compact Framework application and one of the following methods was called:
<see cref="M:System.IO.Stream.BeginRead(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /><see cref="M:System.IO.Stream.BeginWrite(System.Byte[],System.Int32,System.Int32,System.AsyncCallback,System.Object)" /><see cref="M:System.IO.Stream.EndRead(System.IAsyncResult)" /><see cref="M:System.IO.Stream.EndWrite(System.IAsyncResult)" />
The .NET Compact Framework does not support the asynchronous model with base streams.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BaudRate">
<summary>Gets or sets the serial baud rate.</summary>
<returns>The baud rate.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The baud rate specified is less than or equal to zero, or is greater than the maximum allowable baud rate for the device.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BreakState">
<summary>Gets or sets the break signal state.</summary>
<returns>
<see langword="true" /> if the port is in a break state; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BytesToRead">
<summary>Gets the number of bytes of data in the receive buffer.</summary>
<returns>The number of bytes of data in the receive buffer.</returns>
<exception cref="T:System.InvalidOperationException">The port is not open.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.BytesToWrite">
<summary>Gets the number of bytes of data in the send buffer.</summary>
<returns>The number of bytes of data in the send buffer.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.CDHolding">
<summary>Gets the state of the Carrier Detect line for the port.</summary>
<returns>
<see langword="true" /> if the carrier is detected; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Close">
<summary>Closes the port connection, sets the <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> property to <see langword="false" />, and disposes of the internal <see cref="T:System.IO.Stream" /> object.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.CtsHolding">
<summary>Gets the state of the Clear-to-Send line.</summary>
<returns>
<see langword="true" /> if the Clear-to-Send line is detected; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DataBits">
<summary>Gets or sets the standard length of data bits per byte.</summary>
<returns>The data bits length.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The data bits value is less than 5 or more than 8.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.DataReceived">
<summary>Indicates that data has been received through a port represented by the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.DiscardInBuffer">
<summary>Discards data from the serial driver's receive buffer.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DiscardNull">
<summary>Gets or sets a value indicating whether null bytes are ignored when transmitted between the port and the receive buffer.</summary>
<returns>
<see langword="true" /> if null bytes are ignored; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.DiscardOutBuffer">
<summary>Discards data from the serial driver's transmit buffer.</summary>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Dispose(System.Boolean)">
<summary>Releases the unmanaged resources used by the <see cref="T:System.IO.Ports.SerialPort" /> and optionally releases the managed resources.</summary>
<param name="disposing">
<see langword="true" /> to release both managed and unmanaged resources; <see langword="false" /> to release only unmanaged resources.</param>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DsrHolding">
<summary>Gets the state of the Data Set Ready (DSR) signal.</summary>
<returns>
<see langword="true" /> if a Data Set Ready signal has been sent to the port; otherwise, <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The stream is closed. This can occur because the <see cref="M:System.IO.Ports.SerialPort.Open" /> method has not been called or the <see cref="M:System.IO.Ports.SerialPort.Close" /> method has been called.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.DtrEnable">
<summary>Gets or sets a value that enables the Data Terminal Ready (DTR) signal during serial communication.</summary>
<returns>
<see langword="true" /> to enable Data Terminal Ready (DTR); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Encoding">
<summary>Gets or sets the byte encoding for pre- and post-transmission conversion of text.</summary>
<returns>An <see cref="T:System.Text.Encoding" /> object. The default is <see cref="T:System.Text.ASCIIEncoding" />.</returns>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.Encoding" /> property was set to <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.Encoding" /> property was set to an encoding that is not <see cref="T:System.Text.ASCIIEncoding" />, <see cref="T:System.Text.UTF8Encoding" />, <see cref="T:System.Text.UTF32Encoding" />, <see cref="T:System.Text.UnicodeEncoding" />, one of the Windows single byte encodings, or one of the Windows double byte encodings.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.ErrorReceived">
<summary>Indicates that an error has occurred with a port represented by a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="M:System.IO.Ports.SerialPort.GetPortNames">
<summary>Gets an array of serial port names for the current computer.</summary>
<returns>An array of serial port names for the current computer.</returns>
<exception cref="T:System.ComponentModel.Win32Exception">The serial port names could not be queried.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Handshake">
<summary>Gets or sets the handshaking protocol for serial port transmission of data using a value from <see cref="T:System.IO.Ports.Handshake" />.</summary>
<returns>One of the <see cref="T:System.IO.Ports.Handshake" /> values. The default is <see langword="None" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The value passed is not a valid value in the <see cref="T:System.IO.Ports.Handshake" /> enumeration.</exception>
</member>
<member name="F:System.IO.Ports.SerialPort.InfiniteTimeout">
<summary>Indicates that no time-out should occur.</summary>
</member>
<member name="P:System.IO.Ports.SerialPort.IsOpen">
<summary>Gets a value indicating the open or closed status of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>
<see langword="true" /> if the serial port is open; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> value passed is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.IsOpen" /> value passed is an empty string ("").</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.NewLine">
<summary>Gets or sets the value used to interpret the end of a call to the <see cref="M:System.IO.Ports.SerialPort.ReadLine" /> and <see cref="M:System.IO.Ports.SerialPort.WriteLine(System.String)" /> methods.</summary>
<returns>A value that represents the end of a line. The default is a line feed ("\n" in C# or <see cref="F:Microsoft.VisualBasic.Constants.vbLf" /> in Visual Basic).</returns>
<exception cref="T:System.ArgumentException">The property value is empty.</exception>
<exception cref="T:System.ArgumentNullException">The property value is <see langword="null" />.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Open">
<summary>Opens a new serial port connection.</summary>
<exception cref="T:System.UnauthorizedAccessException">Access is denied to the port.
-or-
The current process, or another process on the system, already has the specified COM port open either by a <see cref="T:System.IO.Ports.SerialPort" /> instance or in unmanaged code.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">One or more of the properties for this instance are invalid. For example, the <see cref="P:System.IO.Ports.SerialPort.Parity" />, <see cref="P:System.IO.Ports.SerialPort.DataBits" />, or <see cref="P:System.IO.Ports.SerialPort.Handshake" /> properties are not valid values; the <see cref="P:System.IO.Ports.SerialPort.BaudRate" /> is less than or equal to zero; the <see cref="P:System.IO.Ports.SerialPort.ReadTimeout" /> or <see cref="P:System.IO.Ports.SerialPort.WriteTimeout" /> property is less than zero and is not <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
<exception cref="T:System.ArgumentException">The port name does not begin with "COM".
-or-
The file type of the port is not supported.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.InvalidOperationException">The specified port on the current instance of the <see cref="T:System.IO.Ports.SerialPort" /> is already open.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.Parity">
<summary>Gets or sets the parity-checking protocol.</summary>
<returns>One of the enumeration values that represents the parity-checking protocol. The default is <see cref="F:System.IO.Ports.Parity.None" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.Parity" /> value passed is not a valid value in the <see cref="T:System.IO.Ports.Parity" /> enumeration.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ParityReplace">
<summary>Gets or sets the byte that replaces invalid bytes in a data stream when a parity error occurs.</summary>
<returns>A byte that replaces invalid bytes.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="E:System.IO.Ports.SerialPort.PinChanged">
<summary>Indicates that a non-data signal event has occurred on the port represented by the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="P:System.IO.Ports.SerialPort.PortName">
<summary>Gets or sets the port for communications, including but not limited to all available COM ports.</summary>
<returns>The communications port. The default is COM1.</returns>
<exception cref="T:System.ArgumentException">The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to a value with a length of zero.
-or-
The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to a value that starts with "\\".
-or-
The port name was not valid.</exception>
<exception cref="T:System.ArgumentNullException">The <see cref="P:System.IO.Ports.SerialPort.PortName" /> property was set to <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is open.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Read(System.Byte[],System.Int32,System.Int32)">
<summary>Reads a number of bytes from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer and writes those bytes into a byte array at the specified offset.</summary>
<param name="buffer">The byte array to write the input to.</param>
<param name="offset">The offset in <paramref name="buffer" /> at which to write the bytes.</param>
<param name="count">The maximum number of bytes to read. Fewer bytes are read if <paramref name="count" /> is greater than the number of bytes in the input buffer.</param>
<returns>The number of bytes read.</returns>
<exception cref="T:System.ArgumentNullException">The buffer passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.TimeoutException">No bytes were available to read.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Read(System.Char[],System.Int32,System.Int32)">
<summary>Reads a number of characters from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer and writes them into an array of characters at a given offset.</summary>
<param name="buffer">The character array to write the input to.</param>
<param name="offset">The offset in <paramref name="buffer" /> at which to write the characters.</param>
<param name="count">The maximum number of characters to read. Fewer characters are read if <paramref name="count" /> is greater than the number of characters in the input buffer.</param>
<returns>The number of characters read.</returns>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the buffer.
-or-
<paramref name="count" /> is 1 and there is a surrogate character in the buffer.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">No characters were available to read.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReadBufferSize">
<summary>Gets or sets the size of the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The buffer size, in bytes. The default value is 4096; the maximum value is that of a positive int, or 2147483647.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> value set is less than or equal to zero.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> property was set while the stream was open.</exception>
<exception cref="T:System.IO.IOException">The <see cref="P:System.IO.Ports.SerialPort.ReadBufferSize" /> property was set to an odd integer value.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadByte">
<summary>Synchronously reads one byte from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The byte, cast to an <see cref="T:System.Int32" />, or -1 if the end of the stream has been read.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No byte was read.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadChar">
<summary>Synchronously reads one character from the <see cref="T:System.IO.Ports.SerialPort" /> input buffer.</summary>
<returns>The character that was read.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No character was available in the allotted time-out period.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadExisting">
<summary>Reads all immediately available bytes, based on the encoding, in both the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
<returns>The contents of the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadLine">
<summary>Reads up to the <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value in the input buffer.</summary>
<returns>The contents of the input buffer up to the first occurrence of a <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value.</returns>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The operation did not complete before the time-out period ended.
-or-
No bytes were read.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReadTimeout">
<summary>Gets or sets the number of milliseconds before a time-out occurs when a read operation does not finish.</summary>
<returns>The number of milliseconds before a time-out occurs when a read operation does not finish.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The read time-out value is less than zero and not equal to <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.ReadTo(System.String)">
<summary>Reads a string up to the specified <paramref name="value" /> in the input buffer.</summary>
<param name="value">A value that indicates where the read operation stops.</param>
<returns>The contents of the input buffer up to the specified <paramref name="value" />.</returns>
<exception cref="T:System.ArgumentException">The length of the <paramref name="value" /> parameter is 0.</exception>
<exception cref="T:System.ArgumentNullException">The <paramref name="value" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold">
<summary>Gets or sets the number of bytes in the internal input buffer before a <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event occurs.</summary>
<returns>The number of bytes in the internal input buffer before a <see cref="E:System.IO.Ports.SerialPort.DataReceived" /> event is fired. The default is 1.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold" /> value is less than or equal to zero.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.RtsEnable">
<summary>Gets or sets a value indicating whether the Request to Send (RTS) signal is enabled during serial communication.</summary>
<returns>
<see langword="true" /> to enable Request to Transmit (RTS); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
<exception cref="T:System.InvalidOperationException">The value of the <see cref="P:System.IO.Ports.SerialPort.RtsEnable" /> property was set or retrieved while the <see cref="P:System.IO.Ports.SerialPort.Handshake" /> property is set to the <see cref="F:System.IO.Ports.Handshake.RequestToSend" /> value or the <see cref="F:System.IO.Ports.Handshake.RequestToSendXOnXOff" /> value.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.StopBits">
<summary>Gets or sets the standard number of stopbits per byte.</summary>
<returns>One of the <see cref="T:System.IO.Ports.StopBits" /> values.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.StopBits" /> value is <see cref="F:System.IO.Ports.StopBits.None" />.</exception>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.Byte[],System.Int32,System.Int32)">
<summary>Writes a specified number of bytes to the serial port using data from a buffer.</summary>
<param name="buffer">The byte array that contains the data to write to the port.</param>
<param name="offset">The zero-based byte offset in the <paramref name="buffer" /> parameter at which to begin copying bytes to the port.</param>
<param name="count">The number of bytes to write.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.Char[],System.Int32,System.Int32)">
<summary>Writes a specified number of characters to the serial port using data from a buffer.</summary>
<param name="buffer">The character array that contains the data to write to the port.</param>
<param name="offset">The zero-based byte offset in the <paramref name="buffer" /> parameter at which to begin copying bytes to the port.</param>
<param name="count">The number of characters to write.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="buffer" /> passed is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <paramref name="offset" /> or <paramref name="count" /> parameters are outside a valid region of the <paramref name="buffer" /> being passed. Either <paramref name="offset" /> or <paramref name="count" /> is less than zero.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="offset" /> plus <paramref name="count" /> is greater than the length of the <paramref name="buffer" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.Write(System.String)">
<summary>Writes the specified string to the serial port.</summary>
<param name="text">The string for output.</param>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="text" /> is <see langword="null" />.</exception>
<exception cref="T:System.ServiceProcess.TimeoutException">The operation did not complete before the time-out period ended.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.WriteBufferSize">
<summary>Gets or sets the size of the serial port output buffer.</summary>
<returns>The size of the output buffer. The default is 2048.</returns>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> value is less than or equal to zero.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> property was set while the stream was open.</exception>
<exception cref="T:System.IO.IOException">The <see cref="P:System.IO.Ports.SerialPort.WriteBufferSize" /> property was set to an odd integer value.</exception>
</member>
<member name="M:System.IO.Ports.SerialPort.WriteLine(System.String)">
<summary>Writes the specified string and the <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value to the output buffer.</summary>
<param name="text">The string to write to the output buffer.</param>
<exception cref="T:System.ArgumentNullException">The <paramref name="text" /> parameter is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
<exception cref="T:System.TimeoutException">The <see cref="M:System.IO.Ports.SerialPort.WriteLine(System.String)" /> method could not write to the stream.</exception>
</member>
<member name="P:System.IO.Ports.SerialPort.WriteTimeout">
<summary>Gets or sets the number of milliseconds before a time-out occurs when a write operation does not finish.</summary>
<returns>The number of milliseconds before a time-out occurs. The default is <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</returns>
<exception cref="T:System.IO.IOException">The port is in an invalid state.
-or-
An attempt to set the state of the underlying port failed. For example, the parameters passed from this <see cref="T:System.IO.Ports.SerialPort" /> object were invalid.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.WriteTimeout" /> value is less than zero and not equal to <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</exception>
</member>
<member name="T:System.IO.Ports.StopBits">
<summary>Specifies the number of stop bits used on the <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.None">
<summary>No stop bits are used. This value is not supported by the <see cref="P:System.IO.Ports.SerialPort.StopBits" /> property.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.One">
<summary>One stop bit is used.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.OnePointFive">
<summary>1.5 stop bits are used.</summary>
</member>
<member name="F:System.IO.Ports.StopBits.Two">
<summary>Two stop bits are used.</summary>
</member>
</members>
</doc>

0
packages/System.IO.Ports.4.6.0/runtimes/win/lib/uap10.0.16299/_._ vendored Normal file
View File

0
packages/System.IO.Ports.4.6.0/useSharedDesignerContext.txt vendored Normal file
View File

1
packages/System.IO.Ports.4.6.0/version.txt vendored Normal file
View File

@@ -0,0 +1 @@
4ac4c0367003fe3973a3648eb0715ddb0e3bbcea