大更新
This commit is contained in:
13118993771@163.com
BIN
packages/System.IO.Ports.5.0.0/.signature.p7s
vendored
Normal file
BIN
packages/System.IO.Ports.5.0.0/.signature.p7s
vendored
Normal file
Binary file not shown.
BIN
packages/System.IO.Ports.5.0.0/Icon.png
vendored
Normal file
BIN
packages/System.IO.Ports.5.0.0/Icon.png
vendored
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 6.8 KiB |
23
packages/System.IO.Ports.5.0.0/LICENSE.TXT
vendored
Normal file
23
packages/System.IO.Ports.5.0.0/LICENSE.TXT
vendored
Normal 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.5.0.0/System.IO.Ports.5.0.0.nupkg
vendored
Normal file
BIN
packages/System.IO.Ports.5.0.0/System.IO.Ports.5.0.0.nupkg
vendored
Normal file
Binary file not shown.
884
packages/System.IO.Ports.5.0.0/THIRD-PARTY-NOTICES.TXT
vendored
Normal file
884
packages/System.IO.Ports.5.0.0/THIRD-PARTY-NOTICES.TXT
vendored
Normal file
@@ -0,0 +1,884 @@
|
||||
.NET Runtime uses third-party libraries or other resources that may be
|
||||
distributed under licenses different than the .NET Runtime 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
|
||||
-------------------------------
|
||||
|
||||
https://www.unicode.org/license.html
|
||||
|
||||
Copyright © 1991-2020 Unicode, Inc. All rights reserved.
|
||||
Distributed under the Terms of Use in https://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.
|
||||
|
||||
License notice for RFC 3492
|
||||
---------------------------
|
||||
|
||||
The punycode implementation is based on the sample code in RFC 3492
|
||||
|
||||
Copyright (C) The Internet Society (2003). All Rights Reserved.
|
||||
|
||||
This document and translations of it may be copied and furnished to
|
||||
others, and derivative works that comment on or otherwise explain it
|
||||
or assist in its implementation may be prepared, copied, published
|
||||
and distributed, in whole or in part, without restriction of any
|
||||
kind, provided that the above copyright notice and this paragraph are
|
||||
included on all such copies and derivative works. However, this
|
||||
document itself may not be modified in any way, such as by removing
|
||||
the copyright notice or references to the Internet Society or other
|
||||
Internet organizations, except as needed for the purpose of
|
||||
developing Internet standards in which case the procedures for
|
||||
copyrights defined in the Internet Standards process must be
|
||||
followed, or as required to translate it into languages other than
|
||||
English.
|
||||
|
||||
The limited permissions granted above are perpetual and will not be
|
||||
revoked by the Internet Society or its successors or assigns.
|
||||
|
||||
This document and the information contained herein is provided on an
|
||||
"AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
|
||||
TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
|
||||
BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
|
||||
HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
|
||||
|
||||
License notice for Algorithm from Internet Draft document "UUIDs and GUIDs"
|
||||
---------------------------------------------------------------------------
|
||||
|
||||
Copyright (c) 1990- 1993, 1996 Open Software Foundation, Inc.
|
||||
Copyright (c) 1989 by Hewlett-Packard Company, Palo Alto, Ca. &
|
||||
Digital Equipment Corporation, Maynard, Mass.
|
||||
To anyone who acknowledges that this file is provided "AS IS"
|
||||
without any express or implied warranty: permission to use, copy,
|
||||
modify, and distribute this file for any purpose is hereby
|
||||
granted without fee, provided that the above copyright notices and
|
||||
this notice appears in all source code copies, and that none of
|
||||
the names of Open Software Foundation, Inc., Hewlett-Packard
|
||||
Company, or Digital Equipment Corporation be used in advertising
|
||||
or publicity pertaining to distribution of the software without
|
||||
specific, written prior permission. Neither Open Software
|
||||
Foundation, Inc., Hewlett-Packard Company, Microsoft, nor Digital Equipment
|
||||
Corporation makes any representations about the suitability of
|
||||
this software for any purpose.
|
||||
|
||||
Copyright(C) The Internet Society 1997. All Rights Reserved.
|
||||
|
||||
This document and translations of it may be copied and furnished to others,
|
||||
and derivative works that comment on or otherwise explain it or assist in
|
||||
its implementation may be prepared, copied, published and distributed, in
|
||||
whole or in part, without restriction of any kind, provided that the above
|
||||
copyright notice and this paragraph are included on all such copies and
|
||||
derivative works.However, this document itself may not be modified in any
|
||||
way, such as by removing the copyright notice or references to the Internet
|
||||
Society or other Internet organizations, except as needed for the purpose of
|
||||
developing Internet standards in which case the procedures for copyrights
|
||||
defined in the Internet Standards process must be followed, or as required
|
||||
to translate it into languages other than English.
|
||||
|
||||
The limited permissions granted above are perpetual and will not be revoked
|
||||
by the Internet Society or its successors or assigns.
|
||||
|
||||
This document and the information contained herein is provided on an "AS IS"
|
||||
basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE
|
||||
DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO
|
||||
ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY
|
||||
RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A
|
||||
PARTICULAR PURPOSE.
|
||||
|
||||
License notice for Algorithm from RFC 4122 -
|
||||
A Universally Unique IDentifier (UUID) URN Namespace
|
||||
----------------------------------------------------
|
||||
|
||||
Copyright (c) 1990- 1993, 1996 Open Software Foundation, Inc.
|
||||
Copyright (c) 1989 by Hewlett-Packard Company, Palo Alto, Ca. &
|
||||
Digital Equipment Corporation, Maynard, Mass.
|
||||
Copyright (c) 1998 Microsoft.
|
||||
To anyone who acknowledges that this file is provided "AS IS"
|
||||
without any express or implied warranty: permission to use, copy,
|
||||
modify, and distribute this file for any purpose is hereby
|
||||
granted without fee, provided that the above copyright notices and
|
||||
this notice appears in all source code copies, and that none of
|
||||
the names of Open Software Foundation, Inc., Hewlett-Packard
|
||||
Company, Microsoft, or Digital Equipment Corporation be used in
|
||||
advertising or publicity pertaining to distribution of the software
|
||||
without specific, written prior permission. Neither Open Software
|
||||
Foundation, Inc., Hewlett-Packard Company, Microsoft, nor Digital
|
||||
Equipment Corporation makes any representations about the
|
||||
suitability of this software for any purpose."
|
||||
|
||||
License notice for The LLVM Compiler Infrastructure
|
||||
---------------------------------------------------
|
||||
|
||||
Developed by:
|
||||
|
||||
LLVM Team
|
||||
|
||||
University of Illinois at Urbana-Champaign
|
||||
|
||||
http://llvm.org
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
||||
this software and associated documentation files (the "Software"), to deal with
|
||||
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:
|
||||
|
||||
* Redistributions of source code must retain the above copyright notice,
|
||||
this list of conditions and the following disclaimers.
|
||||
|
||||
* Redistributions in binary form must reproduce the above copyright notice,
|
||||
this list of conditions and the following disclaimers in the
|
||||
documentation and/or other materials provided with the distribution.
|
||||
|
||||
* Neither the names of the LLVM Team, University of Illinois at
|
||||
Urbana-Champaign, nor the names of its contributors may be used to
|
||||
endorse or promote products derived from this Software without specific
|
||||
prior written permission.
|
||||
|
||||
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
|
||||
CONTRIBUTORS 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 WITH THE
|
||||
SOFTWARE.
|
||||
|
||||
License notice for Bob Jenkins
|
||||
------------------------------
|
||||
|
||||
By Bob Jenkins, 1996. bob_jenkins@burtleburtle.net. You may use this
|
||||
code any way you wish, private, educational, or commercial. It's free.
|
||||
|
||||
License notice for Greg Parker
|
||||
------------------------------
|
||||
|
||||
Greg Parker gparker@cs.stanford.edu December 2000
|
||||
This code is in the public domain and may be copied or modified without
|
||||
permission.
|
||||
|
||||
License notice for libunwind based code
|
||||
----------------------------------------
|
||||
|
||||
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 Printing Floating-Point Numbers (Dragon4)
|
||||
------------------------------------------------------------
|
||||
|
||||
/******************************************************************************
|
||||
Copyright (c) 2014 Ryan Juckett
|
||||
http://www.ryanjuckett.com/
|
||||
|
||||
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.
|
||||
******************************************************************************/
|
||||
|
||||
License notice for Printing Floating-point Numbers (Grisu3)
|
||||
-----------------------------------------------------------
|
||||
|
||||
Copyright 2012 the V8 project 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 xxHash
|
||||
-------------------------
|
||||
|
||||
xxHash Library
|
||||
Copyright (c) 2012-2014, Yann Collet
|
||||
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.
|
||||
|
||||
License notice for Berkeley SoftFloat Release 3e
|
||||
------------------------------------------------
|
||||
|
||||
https://github.com/ucb-bar/berkeley-softfloat-3
|
||||
https://github.com/ucb-bar/berkeley-softfloat-3/blob/master/COPYING.txt
|
||||
|
||||
License for Berkeley SoftFloat Release 3e
|
||||
|
||||
John R. Hauser
|
||||
2018 January 20
|
||||
|
||||
The following applies to the whole of SoftFloat Release 3e as well as to
|
||||
each source file individually.
|
||||
|
||||
Copyright 2011, 2012, 2013, 2014, 2015, 2016, 2017, 2018 The Regents of the
|
||||
University of California. 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.
|
||||
|
||||
3. Neither the name of the University 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 REGENTS 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 REGENTS 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 Xorshift RNGs
|
||||
--------------------------------
|
||||
|
||||
George Marsaglia
|
||||
2003-07-04
|
||||
Journal of Statistical Software
|
||||
License: http://creativecommons.org/licenses/by/3.0/
|
||||
|
||||
https://www.jstatsoft.org/article/view/v008i14
|
||||
https://www.jstatsoft.org/index.php/jss/article/view/v008i14/xorshift.pdf
|
||||
|
||||
License notice for Xorshift (Wikipedia)
|
||||
---------------------------------------
|
||||
|
||||
https://en.wikipedia.org/wiki/Xorshift
|
||||
License: https://en.wikipedia.org/wiki/Wikipedia:Text_of_Creative_Commons_Attribution-ShareAlike_3.0_Unported_License
|
||||
|
||||
License for fastmod (https://github.com/lemire/fastmod)
|
||||
--------------------------------------
|
||||
|
||||
Copyright 2018 Daniel Lemire
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
|
||||
License notice for The C++ REST SDK
|
||||
-----------------------------------
|
||||
|
||||
C++ REST SDK
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) Microsoft Corporation
|
||||
|
||||
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.
|
||||
|
||||
License notice for MessagePack-CSharp
|
||||
-------------------------------------
|
||||
|
||||
MessagePack for C#
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2017 Yoshifumi Kawai
|
||||
|
||||
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 lz4net
|
||||
-------------------------------------
|
||||
|
||||
lz4net
|
||||
|
||||
Copyright (c) 2013-2017, Milosz Krajewski
|
||||
|
||||
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.
|
||||
|
||||
License notice for Nerdbank.Streams
|
||||
-----------------------------------
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) Andrew Arnott
|
||||
|
||||
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 RapidJSON
|
||||
----------------------------
|
||||
|
||||
Tencent is pleased to support the open source community by making RapidJSON available.
|
||||
|
||||
Copyright (C) 2015 THL A29 Limited, a Tencent company, and Milo Yip. All rights reserved.
|
||||
|
||||
Licensed under the MIT License (the "License"); you may not use this file except
|
||||
in compliance with the License. You may obtain a copy of the License at
|
||||
|
||||
http://opensource.org/licenses/MIT
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software distributed
|
||||
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
|
||||
CONDITIONS OF ANY KIND, either express or implied. See the License for the
|
||||
specific language governing permissions and limitations under the License.
|
||||
|
||||
License notice for DirectX Math Library
|
||||
---------------------------------------
|
||||
|
||||
https://github.com/microsoft/DirectXMath/blob/master/LICENSE
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2011-2020 Microsoft Corp
|
||||
|
||||
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 ldap4net
|
||||
---------------------------
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2018 Alexander Chermyanin
|
||||
|
||||
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 sorting code
|
||||
------------------------------------------
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2020 Dan Shechter
|
||||
|
||||
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.5.0.0/lib/net461/System.IO.Ports.dll
vendored
Normal file
BIN
packages/System.IO.Ports.5.0.0/lib/net461/System.IO.Ports.dll
vendored
Normal file
Binary file not shown.
598
packages/System.IO.Ports.5.0.0/lib/net461/System.IO.Ports.xml
vendored
Normal file
598
packages/System.IO.Ports.5.0.0/lib/net461/System.IO.Ports.xml
vendored
Normal file
@@ -0,0 +1,598 @@
|
||||
<?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="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="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="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="F:System.IO.Ports.SerialPort.InfiniteTimeout">
|
||||
<summary>Indicates that no time-out should occur.</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="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="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="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="M:System.IO.Ports.SerialPort.GetPortNames">
|
||||
<summary>Gets an array of serial port names for the current computer.</summary>
|
||||
<exception cref="T:System.ComponentModel.Win32Exception">The serial port names could not be queried.</exception>
|
||||
<returns>An array of serial port names for the current computer.</returns>
|
||||
</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="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>
|
||||
<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>
|
||||
<returns>The number of bytes read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of characters read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The byte, cast to an <see cref="T:System.Int32" />, or -1 if the end of the stream has been read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The character that was read.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
|
||||
<returns>The contents of the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The contents of the input buffer up to the first occurrence of a <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The contents of the input buffer up to the specified <paramref name="value" />.</returns>
|
||||
</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="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.BaseStream">
|
||||
<summary>Gets the underlying <see cref="T:System.IO.Stream" /> object for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
|
||||
<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>
|
||||
<returns>A <see cref="T:System.IO.Stream" /> object.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BaudRate">
|
||||
<summary>Gets or sets the serial baud rate.</summary>
|
||||
<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>
|
||||
<returns>The baud rate.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BreakState">
|
||||
<summary>Gets or sets the break signal state.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the port is in a break state; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BytesToRead">
|
||||
<summary>Gets the number of bytes of data in the receive buffer.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">The port is not open.</exception>
|
||||
<returns>The number of bytes of data in the receive buffer.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BytesToWrite">
|
||||
<summary>Gets the number of bytes of data in the send buffer.</summary>
|
||||
<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>
|
||||
<returns>The number of bytes of data in the send buffer.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.CDHolding">
|
||||
<summary>Gets the state of the Carrier Detect line for the port.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the carrier is detected; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.CtsHolding">
|
||||
<summary>Gets the state of the Clear-to-Send line.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the Clear-to-Send line is detected; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.DataBits">
|
||||
<summary>Gets or sets the standard length of data bits per byte.</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.ArgumentOutOfRangeException">The data bits value is less than 5 or more than 8.</exception>
|
||||
<returns>The data bits length.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> if null bytes are ignored; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.DsrHolding">
|
||||
<summary>Gets the state of the Data Set Ready (DSR) signal.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if a Data Set Ready signal has been sent to the port; otherwise, <see langword="false" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> to enable Data Terminal Ready (DTR); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>An <see cref="T:System.Text.Encoding" /> object. The default is <see cref="T:System.Text.ASCIIEncoding" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>One of the <see cref="T:System.IO.Ports.Handshake" /> values. The default is <see langword="None" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> if the serial port is open; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.ArgumentException">The property value is empty.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">The property value is <see langword="null" />.</exception>
|
||||
<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>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.Parity">
|
||||
<summary>Gets or sets the parity-checking protocol.</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.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>
|
||||
<returns>One of the enumeration values that represents the parity-checking protocol. The default is <see cref="F:System.IO.Ports.Parity.None" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>A byte that replaces invalid bytes.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The communications port. The default is COM1.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The buffer size, in bytes. The default value is 4096; the maximum value is that of a positive int, or 2147483647.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of milliseconds before a time-out occurs when a read operation does not finish.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold" /> value is less than or equal to zero.</exception>
|
||||
<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>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> to enable Request to Transmit (RTS); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.StopBits">
|
||||
<summary>Gets or sets the standard number of stopbits per byte.</summary>
|
||||
<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>
|
||||
<returns>One of the <see cref="T:System.IO.Ports.StopBits" /> values.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.WriteBufferSize">
|
||||
<summary>Gets or sets the size of the serial port output buffer.</summary>
|
||||
<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>
|
||||
<returns>The size of the output buffer. The default is 2048.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of milliseconds before a time-out occurs. The default is <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</returns>
|
||||
</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>
|
||||
BIN
packages/System.IO.Ports.5.0.0/lib/netstandard2.0/System.IO.Ports.dll
vendored
Normal file
BIN
packages/System.IO.Ports.5.0.0/lib/netstandard2.0/System.IO.Ports.dll
vendored
Normal file
Binary file not shown.
598
packages/System.IO.Ports.5.0.0/lib/netstandard2.0/System.IO.Ports.xml
vendored
Normal file
598
packages/System.IO.Ports.5.0.0/lib/netstandard2.0/System.IO.Ports.xml
vendored
Normal file
@@ -0,0 +1,598 @@
|
||||
<?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="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="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="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="F:System.IO.Ports.SerialPort.InfiniteTimeout">
|
||||
<summary>Indicates that no time-out should occur.</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="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="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="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="M:System.IO.Ports.SerialPort.GetPortNames">
|
||||
<summary>Gets an array of serial port names for the current computer.</summary>
|
||||
<exception cref="T:System.ComponentModel.Win32Exception">The serial port names could not be queried.</exception>
|
||||
<returns>An array of serial port names for the current computer.</returns>
|
||||
</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="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>
|
||||
<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>
|
||||
<returns>The number of bytes read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of characters read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The byte, cast to an <see cref="T:System.Int32" />, or -1 if the end of the stream has been read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The character that was read.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
|
||||
<returns>The contents of the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The contents of the input buffer up to the first occurrence of a <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The contents of the input buffer up to the specified <paramref name="value" />.</returns>
|
||||
</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="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.BaseStream">
|
||||
<summary>Gets the underlying <see cref="T:System.IO.Stream" /> object for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
|
||||
<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>
|
||||
<returns>A <see cref="T:System.IO.Stream" /> object.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BaudRate">
|
||||
<summary>Gets or sets the serial baud rate.</summary>
|
||||
<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>
|
||||
<returns>The baud rate.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BreakState">
|
||||
<summary>Gets or sets the break signal state.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the port is in a break state; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BytesToRead">
|
||||
<summary>Gets the number of bytes of data in the receive buffer.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">The port is not open.</exception>
|
||||
<returns>The number of bytes of data in the receive buffer.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BytesToWrite">
|
||||
<summary>Gets the number of bytes of data in the send buffer.</summary>
|
||||
<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>
|
||||
<returns>The number of bytes of data in the send buffer.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.CDHolding">
|
||||
<summary>Gets the state of the Carrier Detect line for the port.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the carrier is detected; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.CtsHolding">
|
||||
<summary>Gets the state of the Clear-to-Send line.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the Clear-to-Send line is detected; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.DataBits">
|
||||
<summary>Gets or sets the standard length of data bits per byte.</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.ArgumentOutOfRangeException">The data bits value is less than 5 or more than 8.</exception>
|
||||
<returns>The data bits length.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> if null bytes are ignored; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.DsrHolding">
|
||||
<summary>Gets the state of the Data Set Ready (DSR) signal.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if a Data Set Ready signal has been sent to the port; otherwise, <see langword="false" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> to enable Data Terminal Ready (DTR); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>An <see cref="T:System.Text.Encoding" /> object. The default is <see cref="T:System.Text.ASCIIEncoding" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>One of the <see cref="T:System.IO.Ports.Handshake" /> values. The default is <see langword="None" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> if the serial port is open; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.ArgumentException">The property value is empty.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">The property value is <see langword="null" />.</exception>
|
||||
<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>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.Parity">
|
||||
<summary>Gets or sets the parity-checking protocol.</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.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>
|
||||
<returns>One of the enumeration values that represents the parity-checking protocol. The default is <see cref="F:System.IO.Ports.Parity.None" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>A byte that replaces invalid bytes.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The communications port. The default is COM1.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The buffer size, in bytes. The default value is 4096; the maximum value is that of a positive int, or 2147483647.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of milliseconds before a time-out occurs when a read operation does not finish.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold" /> value is less than or equal to zero.</exception>
|
||||
<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>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> to enable Request to Transmit (RTS); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.StopBits">
|
||||
<summary>Gets or sets the standard number of stopbits per byte.</summary>
|
||||
<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>
|
||||
<returns>One of the <see cref="T:System.IO.Ports.StopBits" /> values.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.WriteBufferSize">
|
||||
<summary>Gets or sets the size of the serial port output buffer.</summary>
|
||||
<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>
|
||||
<returns>The size of the output buffer. The default is 2048.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of milliseconds before a time-out occurs. The default is <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</returns>
|
||||
</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.5.0.0/lib/uap10.0.16299/_._
vendored
Normal file
0
packages/System.IO.Ports.5.0.0/lib/uap10.0.16299/_._
vendored
Normal file
BIN
packages/System.IO.Ports.5.0.0/ref/net461/System.IO.Ports.dll
vendored
Normal file
BIN
packages/System.IO.Ports.5.0.0/ref/net461/System.IO.Ports.dll
vendored
Normal file
Binary file not shown.
598
packages/System.IO.Ports.5.0.0/ref/net461/System.IO.Ports.xml
vendored
Normal file
598
packages/System.IO.Ports.5.0.0/ref/net461/System.IO.Ports.xml
vendored
Normal file
@@ -0,0 +1,598 @@
|
||||
<?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="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="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="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="F:System.IO.Ports.SerialPort.InfiniteTimeout">
|
||||
<summary>Indicates that no time-out should occur.</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="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="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="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="M:System.IO.Ports.SerialPort.GetPortNames">
|
||||
<summary>Gets an array of serial port names for the current computer.</summary>
|
||||
<exception cref="T:System.ComponentModel.Win32Exception">The serial port names could not be queried.</exception>
|
||||
<returns>An array of serial port names for the current computer.</returns>
|
||||
</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="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>
|
||||
<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>
|
||||
<returns>The number of bytes read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of characters read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The byte, cast to an <see cref="T:System.Int32" />, or -1 if the end of the stream has been read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The character that was read.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
|
||||
<returns>The contents of the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The contents of the input buffer up to the first occurrence of a <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The contents of the input buffer up to the specified <paramref name="value" />.</returns>
|
||||
</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="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.BaseStream">
|
||||
<summary>Gets the underlying <see cref="T:System.IO.Stream" /> object for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
|
||||
<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>
|
||||
<returns>A <see cref="T:System.IO.Stream" /> object.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BaudRate">
|
||||
<summary>Gets or sets the serial baud rate.</summary>
|
||||
<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>
|
||||
<returns>The baud rate.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BreakState">
|
||||
<summary>Gets or sets the break signal state.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the port is in a break state; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BytesToRead">
|
||||
<summary>Gets the number of bytes of data in the receive buffer.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">The port is not open.</exception>
|
||||
<returns>The number of bytes of data in the receive buffer.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BytesToWrite">
|
||||
<summary>Gets the number of bytes of data in the send buffer.</summary>
|
||||
<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>
|
||||
<returns>The number of bytes of data in the send buffer.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.CDHolding">
|
||||
<summary>Gets the state of the Carrier Detect line for the port.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the carrier is detected; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.CtsHolding">
|
||||
<summary>Gets the state of the Clear-to-Send line.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the Clear-to-Send line is detected; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.DataBits">
|
||||
<summary>Gets or sets the standard length of data bits per byte.</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.ArgumentOutOfRangeException">The data bits value is less than 5 or more than 8.</exception>
|
||||
<returns>The data bits length.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> if null bytes are ignored; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.DsrHolding">
|
||||
<summary>Gets the state of the Data Set Ready (DSR) signal.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if a Data Set Ready signal has been sent to the port; otherwise, <see langword="false" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> to enable Data Terminal Ready (DTR); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>An <see cref="T:System.Text.Encoding" /> object. The default is <see cref="T:System.Text.ASCIIEncoding" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>One of the <see cref="T:System.IO.Ports.Handshake" /> values. The default is <see langword="None" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> if the serial port is open; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.ArgumentException">The property value is empty.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">The property value is <see langword="null" />.</exception>
|
||||
<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>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.Parity">
|
||||
<summary>Gets or sets the parity-checking protocol.</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.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>
|
||||
<returns>One of the enumeration values that represents the parity-checking protocol. The default is <see cref="F:System.IO.Ports.Parity.None" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>A byte that replaces invalid bytes.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The communications port. The default is COM1.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The buffer size, in bytes. The default value is 4096; the maximum value is that of a positive int, or 2147483647.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of milliseconds before a time-out occurs when a read operation does not finish.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold" /> value is less than or equal to zero.</exception>
|
||||
<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>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> to enable Request to Transmit (RTS); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.StopBits">
|
||||
<summary>Gets or sets the standard number of stopbits per byte.</summary>
|
||||
<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>
|
||||
<returns>One of the <see cref="T:System.IO.Ports.StopBits" /> values.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.WriteBufferSize">
|
||||
<summary>Gets or sets the size of the serial port output buffer.</summary>
|
||||
<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>
|
||||
<returns>The size of the output buffer. The default is 2048.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of milliseconds before a time-out occurs. The default is <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</returns>
|
||||
</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>
|
||||
BIN
packages/System.IO.Ports.5.0.0/ref/netstandard2.0/System.IO.Ports.dll
vendored
Normal file
BIN
packages/System.IO.Ports.5.0.0/ref/netstandard2.0/System.IO.Ports.dll
vendored
Normal file
Binary file not shown.
598
packages/System.IO.Ports.5.0.0/ref/netstandard2.0/System.IO.Ports.xml
vendored
Normal file
598
packages/System.IO.Ports.5.0.0/ref/netstandard2.0/System.IO.Ports.xml
vendored
Normal file
@@ -0,0 +1,598 @@
|
||||
<?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="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="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="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="F:System.IO.Ports.SerialPort.InfiniteTimeout">
|
||||
<summary>Indicates that no time-out should occur.</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="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="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="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="M:System.IO.Ports.SerialPort.GetPortNames">
|
||||
<summary>Gets an array of serial port names for the current computer.</summary>
|
||||
<exception cref="T:System.ComponentModel.Win32Exception">The serial port names could not be queried.</exception>
|
||||
<returns>An array of serial port names for the current computer.</returns>
|
||||
</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="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>
|
||||
<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>
|
||||
<returns>The number of bytes read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of characters read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The byte, cast to an <see cref="T:System.Int32" />, or -1 if the end of the stream has been read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The character that was read.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
|
||||
<returns>The contents of the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The contents of the input buffer up to the first occurrence of a <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The contents of the input buffer up to the specified <paramref name="value" />.</returns>
|
||||
</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="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.BaseStream">
|
||||
<summary>Gets the underlying <see cref="T:System.IO.Stream" /> object for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
|
||||
<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>
|
||||
<returns>A <see cref="T:System.IO.Stream" /> object.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BaudRate">
|
||||
<summary>Gets or sets the serial baud rate.</summary>
|
||||
<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>
|
||||
<returns>The baud rate.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BreakState">
|
||||
<summary>Gets or sets the break signal state.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the port is in a break state; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BytesToRead">
|
||||
<summary>Gets the number of bytes of data in the receive buffer.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">The port is not open.</exception>
|
||||
<returns>The number of bytes of data in the receive buffer.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BytesToWrite">
|
||||
<summary>Gets the number of bytes of data in the send buffer.</summary>
|
||||
<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>
|
||||
<returns>The number of bytes of data in the send buffer.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.CDHolding">
|
||||
<summary>Gets the state of the Carrier Detect line for the port.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the carrier is detected; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.CtsHolding">
|
||||
<summary>Gets the state of the Clear-to-Send line.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the Clear-to-Send line is detected; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.DataBits">
|
||||
<summary>Gets or sets the standard length of data bits per byte.</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.ArgumentOutOfRangeException">The data bits value is less than 5 or more than 8.</exception>
|
||||
<returns>The data bits length.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> if null bytes are ignored; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.DsrHolding">
|
||||
<summary>Gets the state of the Data Set Ready (DSR) signal.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if a Data Set Ready signal has been sent to the port; otherwise, <see langword="false" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> to enable Data Terminal Ready (DTR); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>An <see cref="T:System.Text.Encoding" /> object. The default is <see cref="T:System.Text.ASCIIEncoding" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>One of the <see cref="T:System.IO.Ports.Handshake" /> values. The default is <see langword="None" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> if the serial port is open; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.ArgumentException">The property value is empty.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">The property value is <see langword="null" />.</exception>
|
||||
<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>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.Parity">
|
||||
<summary>Gets or sets the parity-checking protocol.</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.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>
|
||||
<returns>One of the enumeration values that represents the parity-checking protocol. The default is <see cref="F:System.IO.Ports.Parity.None" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>A byte that replaces invalid bytes.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The communications port. The default is COM1.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The buffer size, in bytes. The default value is 4096; the maximum value is that of a positive int, or 2147483647.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of milliseconds before a time-out occurs when a read operation does not finish.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold" /> value is less than or equal to zero.</exception>
|
||||
<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>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> to enable Request to Transmit (RTS); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.StopBits">
|
||||
<summary>Gets or sets the standard number of stopbits per byte.</summary>
|
||||
<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>
|
||||
<returns>One of the <see cref="T:System.IO.Ports.StopBits" /> values.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.WriteBufferSize">
|
||||
<summary>Gets or sets the size of the serial port output buffer.</summary>
|
||||
<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>
|
||||
<returns>The size of the output buffer. The default is 2048.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of milliseconds before a time-out occurs. The default is <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</returns>
|
||||
</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.5.0.0/ref/uap10.0.16299/_._
vendored
Normal file
0
packages/System.IO.Ports.5.0.0/ref/uap10.0.16299/_._
vendored
Normal file
BIN
packages/System.IO.Ports.5.0.0/runtimes/linux/lib/netstandard2.0/System.IO.Ports.dll
vendored
Normal file
BIN
packages/System.IO.Ports.5.0.0/runtimes/linux/lib/netstandard2.0/System.IO.Ports.dll
vendored
Normal file
Binary file not shown.
598
packages/System.IO.Ports.5.0.0/runtimes/linux/lib/netstandard2.0/System.IO.Ports.xml
vendored
Normal file
598
packages/System.IO.Ports.5.0.0/runtimes/linux/lib/netstandard2.0/System.IO.Ports.xml
vendored
Normal file
@@ -0,0 +1,598 @@
|
||||
<?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="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="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="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="F:System.IO.Ports.SerialPort.InfiniteTimeout">
|
||||
<summary>Indicates that no time-out should occur.</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="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="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="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="M:System.IO.Ports.SerialPort.GetPortNames">
|
||||
<summary>Gets an array of serial port names for the current computer.</summary>
|
||||
<exception cref="T:System.ComponentModel.Win32Exception">The serial port names could not be queried.</exception>
|
||||
<returns>An array of serial port names for the current computer.</returns>
|
||||
</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="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>
|
||||
<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>
|
||||
<returns>The number of bytes read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of characters read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The byte, cast to an <see cref="T:System.Int32" />, or -1 if the end of the stream has been read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The character that was read.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
|
||||
<returns>The contents of the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The contents of the input buffer up to the first occurrence of a <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The contents of the input buffer up to the specified <paramref name="value" />.</returns>
|
||||
</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="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.BaseStream">
|
||||
<summary>Gets the underlying <see cref="T:System.IO.Stream" /> object for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
|
||||
<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>
|
||||
<returns>A <see cref="T:System.IO.Stream" /> object.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BaudRate">
|
||||
<summary>Gets or sets the serial baud rate.</summary>
|
||||
<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>
|
||||
<returns>The baud rate.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BreakState">
|
||||
<summary>Gets or sets the break signal state.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the port is in a break state; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BytesToRead">
|
||||
<summary>Gets the number of bytes of data in the receive buffer.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">The port is not open.</exception>
|
||||
<returns>The number of bytes of data in the receive buffer.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BytesToWrite">
|
||||
<summary>Gets the number of bytes of data in the send buffer.</summary>
|
||||
<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>
|
||||
<returns>The number of bytes of data in the send buffer.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.CDHolding">
|
||||
<summary>Gets the state of the Carrier Detect line for the port.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the carrier is detected; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.CtsHolding">
|
||||
<summary>Gets the state of the Clear-to-Send line.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the Clear-to-Send line is detected; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.DataBits">
|
||||
<summary>Gets or sets the standard length of data bits per byte.</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.ArgumentOutOfRangeException">The data bits value is less than 5 or more than 8.</exception>
|
||||
<returns>The data bits length.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> if null bytes are ignored; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.DsrHolding">
|
||||
<summary>Gets the state of the Data Set Ready (DSR) signal.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if a Data Set Ready signal has been sent to the port; otherwise, <see langword="false" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> to enable Data Terminal Ready (DTR); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>An <see cref="T:System.Text.Encoding" /> object. The default is <see cref="T:System.Text.ASCIIEncoding" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>One of the <see cref="T:System.IO.Ports.Handshake" /> values. The default is <see langword="None" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> if the serial port is open; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.ArgumentException">The property value is empty.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">The property value is <see langword="null" />.</exception>
|
||||
<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>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.Parity">
|
||||
<summary>Gets or sets the parity-checking protocol.</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.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>
|
||||
<returns>One of the enumeration values that represents the parity-checking protocol. The default is <see cref="F:System.IO.Ports.Parity.None" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>A byte that replaces invalid bytes.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The communications port. The default is COM1.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The buffer size, in bytes. The default value is 4096; the maximum value is that of a positive int, or 2147483647.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of milliseconds before a time-out occurs when a read operation does not finish.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold" /> value is less than or equal to zero.</exception>
|
||||
<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>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> to enable Request to Transmit (RTS); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.StopBits">
|
||||
<summary>Gets or sets the standard number of stopbits per byte.</summary>
|
||||
<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>
|
||||
<returns>One of the <see cref="T:System.IO.Ports.StopBits" /> values.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.WriteBufferSize">
|
||||
<summary>Gets or sets the size of the serial port output buffer.</summary>
|
||||
<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>
|
||||
<returns>The size of the output buffer. The default is 2048.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of milliseconds before a time-out occurs. The default is <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</returns>
|
||||
</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>
|
||||
BIN
packages/System.IO.Ports.5.0.0/runtimes/osx/lib/netstandard2.0/System.IO.Ports.dll
vendored
Normal file
BIN
packages/System.IO.Ports.5.0.0/runtimes/osx/lib/netstandard2.0/System.IO.Ports.dll
vendored
Normal file
Binary file not shown.
598
packages/System.IO.Ports.5.0.0/runtimes/osx/lib/netstandard2.0/System.IO.Ports.xml
vendored
Normal file
598
packages/System.IO.Ports.5.0.0/runtimes/osx/lib/netstandard2.0/System.IO.Ports.xml
vendored
Normal file
@@ -0,0 +1,598 @@
|
||||
<?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="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="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="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="F:System.IO.Ports.SerialPort.InfiniteTimeout">
|
||||
<summary>Indicates that no time-out should occur.</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="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="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="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="M:System.IO.Ports.SerialPort.GetPortNames">
|
||||
<summary>Gets an array of serial port names for the current computer.</summary>
|
||||
<exception cref="T:System.ComponentModel.Win32Exception">The serial port names could not be queried.</exception>
|
||||
<returns>An array of serial port names for the current computer.</returns>
|
||||
</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="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>
|
||||
<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>
|
||||
<returns>The number of bytes read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of characters read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The byte, cast to an <see cref="T:System.Int32" />, or -1 if the end of the stream has been read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The character that was read.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
|
||||
<returns>The contents of the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The contents of the input buffer up to the first occurrence of a <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The contents of the input buffer up to the specified <paramref name="value" />.</returns>
|
||||
</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="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.BaseStream">
|
||||
<summary>Gets the underlying <see cref="T:System.IO.Stream" /> object for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
|
||||
<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>
|
||||
<returns>A <see cref="T:System.IO.Stream" /> object.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BaudRate">
|
||||
<summary>Gets or sets the serial baud rate.</summary>
|
||||
<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>
|
||||
<returns>The baud rate.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BreakState">
|
||||
<summary>Gets or sets the break signal state.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the port is in a break state; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BytesToRead">
|
||||
<summary>Gets the number of bytes of data in the receive buffer.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">The port is not open.</exception>
|
||||
<returns>The number of bytes of data in the receive buffer.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BytesToWrite">
|
||||
<summary>Gets the number of bytes of data in the send buffer.</summary>
|
||||
<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>
|
||||
<returns>The number of bytes of data in the send buffer.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.CDHolding">
|
||||
<summary>Gets the state of the Carrier Detect line for the port.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the carrier is detected; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.CtsHolding">
|
||||
<summary>Gets the state of the Clear-to-Send line.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the Clear-to-Send line is detected; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.DataBits">
|
||||
<summary>Gets or sets the standard length of data bits per byte.</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.ArgumentOutOfRangeException">The data bits value is less than 5 or more than 8.</exception>
|
||||
<returns>The data bits length.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> if null bytes are ignored; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.DsrHolding">
|
||||
<summary>Gets the state of the Data Set Ready (DSR) signal.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if a Data Set Ready signal has been sent to the port; otherwise, <see langword="false" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> to enable Data Terminal Ready (DTR); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>An <see cref="T:System.Text.Encoding" /> object. The default is <see cref="T:System.Text.ASCIIEncoding" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>One of the <see cref="T:System.IO.Ports.Handshake" /> values. The default is <see langword="None" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> if the serial port is open; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.ArgumentException">The property value is empty.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">The property value is <see langword="null" />.</exception>
|
||||
<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>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.Parity">
|
||||
<summary>Gets or sets the parity-checking protocol.</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.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>
|
||||
<returns>One of the enumeration values that represents the parity-checking protocol. The default is <see cref="F:System.IO.Ports.Parity.None" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>A byte that replaces invalid bytes.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The communications port. The default is COM1.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The buffer size, in bytes. The default value is 4096; the maximum value is that of a positive int, or 2147483647.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of milliseconds before a time-out occurs when a read operation does not finish.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold" /> value is less than or equal to zero.</exception>
|
||||
<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>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> to enable Request to Transmit (RTS); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.StopBits">
|
||||
<summary>Gets or sets the standard number of stopbits per byte.</summary>
|
||||
<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>
|
||||
<returns>One of the <see cref="T:System.IO.Ports.StopBits" /> values.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.WriteBufferSize">
|
||||
<summary>Gets or sets the size of the serial port output buffer.</summary>
|
||||
<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>
|
||||
<returns>The size of the output buffer. The default is 2048.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of milliseconds before a time-out occurs. The default is <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</returns>
|
||||
</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>
|
||||
BIN
packages/System.IO.Ports.5.0.0/runtimes/win/lib/net461/System.IO.Ports.dll
vendored
Normal file
BIN
packages/System.IO.Ports.5.0.0/runtimes/win/lib/net461/System.IO.Ports.dll
vendored
Normal file
Binary file not shown.
598
packages/System.IO.Ports.5.0.0/runtimes/win/lib/net461/System.IO.Ports.xml
vendored
Normal file
598
packages/System.IO.Ports.5.0.0/runtimes/win/lib/net461/System.IO.Ports.xml
vendored
Normal file
@@ -0,0 +1,598 @@
|
||||
<?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="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="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="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="F:System.IO.Ports.SerialPort.InfiniteTimeout">
|
||||
<summary>Indicates that no time-out should occur.</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="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="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="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="M:System.IO.Ports.SerialPort.GetPortNames">
|
||||
<summary>Gets an array of serial port names for the current computer.</summary>
|
||||
<exception cref="T:System.ComponentModel.Win32Exception">The serial port names could not be queried.</exception>
|
||||
<returns>An array of serial port names for the current computer.</returns>
|
||||
</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="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>
|
||||
<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>
|
||||
<returns>The number of bytes read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of characters read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The byte, cast to an <see cref="T:System.Int32" />, or -1 if the end of the stream has been read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The character that was read.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
|
||||
<returns>The contents of the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The contents of the input buffer up to the first occurrence of a <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The contents of the input buffer up to the specified <paramref name="value" />.</returns>
|
||||
</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="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.BaseStream">
|
||||
<summary>Gets the underlying <see cref="T:System.IO.Stream" /> object for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
|
||||
<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>
|
||||
<returns>A <see cref="T:System.IO.Stream" /> object.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BaudRate">
|
||||
<summary>Gets or sets the serial baud rate.</summary>
|
||||
<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>
|
||||
<returns>The baud rate.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BreakState">
|
||||
<summary>Gets or sets the break signal state.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the port is in a break state; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BytesToRead">
|
||||
<summary>Gets the number of bytes of data in the receive buffer.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">The port is not open.</exception>
|
||||
<returns>The number of bytes of data in the receive buffer.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BytesToWrite">
|
||||
<summary>Gets the number of bytes of data in the send buffer.</summary>
|
||||
<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>
|
||||
<returns>The number of bytes of data in the send buffer.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.CDHolding">
|
||||
<summary>Gets the state of the Carrier Detect line for the port.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the carrier is detected; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.CtsHolding">
|
||||
<summary>Gets the state of the Clear-to-Send line.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the Clear-to-Send line is detected; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.DataBits">
|
||||
<summary>Gets or sets the standard length of data bits per byte.</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.ArgumentOutOfRangeException">The data bits value is less than 5 or more than 8.</exception>
|
||||
<returns>The data bits length.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> if null bytes are ignored; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.DsrHolding">
|
||||
<summary>Gets the state of the Data Set Ready (DSR) signal.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if a Data Set Ready signal has been sent to the port; otherwise, <see langword="false" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> to enable Data Terminal Ready (DTR); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>An <see cref="T:System.Text.Encoding" /> object. The default is <see cref="T:System.Text.ASCIIEncoding" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>One of the <see cref="T:System.IO.Ports.Handshake" /> values. The default is <see langword="None" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> if the serial port is open; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.ArgumentException">The property value is empty.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">The property value is <see langword="null" />.</exception>
|
||||
<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>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.Parity">
|
||||
<summary>Gets or sets the parity-checking protocol.</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.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>
|
||||
<returns>One of the enumeration values that represents the parity-checking protocol. The default is <see cref="F:System.IO.Ports.Parity.None" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>A byte that replaces invalid bytes.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The communications port. The default is COM1.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The buffer size, in bytes. The default value is 4096; the maximum value is that of a positive int, or 2147483647.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of milliseconds before a time-out occurs when a read operation does not finish.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold" /> value is less than or equal to zero.</exception>
|
||||
<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>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> to enable Request to Transmit (RTS); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.StopBits">
|
||||
<summary>Gets or sets the standard number of stopbits per byte.</summary>
|
||||
<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>
|
||||
<returns>One of the <see cref="T:System.IO.Ports.StopBits" /> values.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.WriteBufferSize">
|
||||
<summary>Gets or sets the size of the serial port output buffer.</summary>
|
||||
<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>
|
||||
<returns>The size of the output buffer. The default is 2048.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of milliseconds before a time-out occurs. The default is <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</returns>
|
||||
</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>
|
||||
BIN
packages/System.IO.Ports.5.0.0/runtimes/win/lib/netstandard2.0/System.IO.Ports.dll
vendored
Normal file
BIN
packages/System.IO.Ports.5.0.0/runtimes/win/lib/netstandard2.0/System.IO.Ports.dll
vendored
Normal file
Binary file not shown.
598
packages/System.IO.Ports.5.0.0/runtimes/win/lib/netstandard2.0/System.IO.Ports.xml
vendored
Normal file
598
packages/System.IO.Ports.5.0.0/runtimes/win/lib/netstandard2.0/System.IO.Ports.xml
vendored
Normal file
@@ -0,0 +1,598 @@
|
||||
<?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="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="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="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="F:System.IO.Ports.SerialPort.InfiniteTimeout">
|
||||
<summary>Indicates that no time-out should occur.</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="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="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="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="M:System.IO.Ports.SerialPort.GetPortNames">
|
||||
<summary>Gets an array of serial port names for the current computer.</summary>
|
||||
<exception cref="T:System.ComponentModel.Win32Exception">The serial port names could not be queried.</exception>
|
||||
<returns>An array of serial port names for the current computer.</returns>
|
||||
</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="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>
|
||||
<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>
|
||||
<returns>The number of bytes read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of characters read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The byte, cast to an <see cref="T:System.Int32" />, or -1 if the end of the stream has been read.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The character that was read.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.InvalidOperationException">The specified port is not open.</exception>
|
||||
<returns>The contents of the stream and the input buffer of the <see cref="T:System.IO.Ports.SerialPort" /> object.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The contents of the input buffer up to the first occurrence of a <see cref="P:System.IO.Ports.SerialPort.NewLine" /> value.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The contents of the input buffer up to the specified <paramref name="value" />.</returns>
|
||||
</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="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.BaseStream">
|
||||
<summary>Gets the underlying <see cref="T:System.IO.Stream" /> object for a <see cref="T:System.IO.Ports.SerialPort" /> object.</summary>
|
||||
<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>
|
||||
<returns>A <see cref="T:System.IO.Stream" /> object.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BaudRate">
|
||||
<summary>Gets or sets the serial baud rate.</summary>
|
||||
<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>
|
||||
<returns>The baud rate.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BreakState">
|
||||
<summary>Gets or sets the break signal state.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the port is in a break state; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BytesToRead">
|
||||
<summary>Gets the number of bytes of data in the receive buffer.</summary>
|
||||
<exception cref="T:System.InvalidOperationException">The port is not open.</exception>
|
||||
<returns>The number of bytes of data in the receive buffer.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.BytesToWrite">
|
||||
<summary>Gets the number of bytes of data in the send buffer.</summary>
|
||||
<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>
|
||||
<returns>The number of bytes of data in the send buffer.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.CDHolding">
|
||||
<summary>Gets the state of the Carrier Detect line for the port.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the carrier is detected; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.CtsHolding">
|
||||
<summary>Gets the state of the Clear-to-Send line.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if the Clear-to-Send line is detected; otherwise, <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.DataBits">
|
||||
<summary>Gets or sets the standard length of data bits per byte.</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.ArgumentOutOfRangeException">The data bits value is less than 5 or more than 8.</exception>
|
||||
<returns>The data bits length.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> if null bytes are ignored; otherwise <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.DsrHolding">
|
||||
<summary>Gets the state of the Data Set Ready (DSR) signal.</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>
|
||||
<returns>
|
||||
<see langword="true" /> if a Data Set Ready signal has been sent to the port; otherwise, <see langword="false" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> to enable Data Terminal Ready (DTR); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>An <see cref="T:System.Text.Encoding" /> object. The default is <see cref="T:System.Text.ASCIIEncoding" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>One of the <see cref="T:System.IO.Ports.Handshake" /> values. The default is <see langword="None" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> if the serial port is open; otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.ArgumentException">The property value is empty.</exception>
|
||||
<exception cref="T:System.ArgumentNullException">The property value is <see langword="null" />.</exception>
|
||||
<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>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.Parity">
|
||||
<summary>Gets or sets the parity-checking protocol.</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.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>
|
||||
<returns>One of the enumeration values that represents the parity-checking protocol. The default is <see cref="F:System.IO.Ports.Parity.None" />.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>A byte that replaces invalid bytes.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The communications port. The default is COM1.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The buffer size, in bytes. The default value is 4096; the maximum value is that of a positive int, or 2147483647.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of milliseconds before a time-out occurs when a read operation does not finish.</returns>
|
||||
</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>
|
||||
<exception cref="T:System.ArgumentOutOfRangeException">The <see cref="P:System.IO.Ports.SerialPort.ReceivedBytesThreshold" /> value is less than or equal to zero.</exception>
|
||||
<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>
|
||||
</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>
|
||||
<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>
|
||||
<returns>
|
||||
<see langword="true" /> to enable Request to Transmit (RTS); otherwise, <see langword="false" />. The default is <see langword="false" />.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.StopBits">
|
||||
<summary>Gets or sets the standard number of stopbits per byte.</summary>
|
||||
<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>
|
||||
<returns>One of the <see cref="T:System.IO.Ports.StopBits" /> values.</returns>
|
||||
</member>
|
||||
<member name="P:System.IO.Ports.SerialPort.WriteBufferSize">
|
||||
<summary>Gets or sets the size of the serial port output buffer.</summary>
|
||||
<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>
|
||||
<returns>The size of the output buffer. The default is 2048.</returns>
|
||||
</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>
|
||||
<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>
|
||||
<returns>The number of milliseconds before a time-out occurs. The default is <see cref="F:System.IO.Ports.SerialPort.InfiniteTimeout" />.</returns>
|
||||
</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.5.0.0/runtimes/win/lib/uap10.0.16299/_._
vendored
Normal file
0
packages/System.IO.Ports.5.0.0/runtimes/win/lib/uap10.0.16299/_._
vendored
Normal file
0
packages/System.IO.Ports.5.0.0/useSharedDesignerContext.txt
vendored
Normal file
0
packages/System.IO.Ports.5.0.0/useSharedDesignerContext.txt
vendored
Normal file
1
packages/System.IO.Ports.5.0.0/version.txt
vendored
Normal file
1
packages/System.IO.Ports.5.0.0/version.txt
vendored
Normal file
@@ -0,0 +1 @@
|
||||
cf258a14b70ad9069470a108f13765e0e5988f51
|
||||
Reference in New Issue
Block a user