linux-packaging-mono/mcs/class/System/Documentation/en/System.IO.Ports/SerialError.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="SerialError" FullName="System.IO.Ports.SerialError">
  <TypeSignature Language="C#" Value="public enum SerialError" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed SerialError extends System.Enum" />
  <AssemblyInfo>
    <AssemblyName>System</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Enum</BaseTypeName>
  </Base>
  <Docs>
    <since version=".NET 2.0" />
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>This enumeration can be useful when handling the <see cref="E:System.IO.Ports.SerialPort.ErrorReceived" /> event to detect and respond to errors when communicating data through a <see cref="T:System.IO.Ports.SerialPort" />. You examine the type of error by retrieving the <see cref="P:System.IO.Ports.SerialErrorReceivedEventArgs.EventType" /> property of the <see cref="T:System.IO.Ports.SerialErrorReceivedEventArgs" /> class. The <see cref="P:System.IO.Ports.SerialErrorReceivedEventArgs.EventType" /> property contains one of the values from the <see cref="T:System.IO.Ports.SerialError" /> enumeration.</para>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Specifies errors that occur on the <see cref="T:System.IO.Ports.SerialPort" /> object.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName="Frame">
      <MemberSignature Language="C#" Value="Frame" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.IO.Ports.SerialError Frame = int32(8)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.IO.Ports.SerialError</ReturnType>
      </ReturnValue>
      <Docs>
        <since version=".NET 2.0" />
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The hardware detected a framing error.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="Overrun">
      <MemberSignature Language="C#" Value="Overrun" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.IO.Ports.SerialError Overrun = int32(2)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.IO.Ports.SerialError</ReturnType>
      </ReturnValue>
      <Docs>
        <since version=".NET 2.0" />
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>A character-buffer overrun has occurred. The next character is lost.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="RXOver">
      <MemberSignature Language="C#" Value="RXOver" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.IO.Ports.SerialError RXOver = int32(1)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.IO.Ports.SerialError</ReturnType>
      </ReturnValue>
      <Docs>
        <since version=".NET 2.0" />
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>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.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="RXParity">
      <MemberSignature Language="C#" Value="RXParity" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.IO.Ports.SerialError RXParity = int32(4)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.IO.Ports.SerialError</ReturnType>
      </ReturnValue>
      <Docs>
        <since version=".NET 2.0" />
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The hardware detected a parity error.</para>
        </summary>
      </Docs>
    </Member>
    <Member MemberName="TXFull">
      <MemberSignature Language="C#" Value="TXFull" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.IO.Ports.SerialError TXFull = int32(256)" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.IO.Ports.SerialError</ReturnType>
      </ReturnValue>
      <Docs>
        <since version=".NET 2.0" />
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The application tried to transmit a character, but the output buffer was full.</para>
        </summary>
      </Docs>
    </Member>
  </Members>
</Type>