dotnet / dotnet/dotnet-api-docs

Incorrect point

Open
#1,500 0 comments 0 reactions 0 assignees View on GitHub
area-System.Net dotnet-api/prod Pri2 untriaged
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
3d 27m
Merged PRs (30d)
49

Description

OobDataRead - states "the return value indicates the number of bytes available." This is incorrect. When I call this function, it puts a 0 in the out bytes if there is data available, or a 1 if data is not available. Yes, it seems backwards. It definitely does not match the documentation in any way shape or form.

Also, it might be worth noting that you can only send one byte of data at a time in an OOB packet. If you try and send more than one byte, only the last one will be included it. It might be worth noting that you can receive more than one byte of OOB data, if more than one packet has arrived since the last read.

---
#### Document Details

⚠ *Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.*

* ID: 614ac836-dc1e-5648-fbcd-db200860ed32
* Version Independent ID: c7c5d2a1-0634-9d4b-0c42-6ed3616ceb1e
* Content: [IOControlCode Enum (System.Net.Sockets)](https://docs.microsoft.com/en-us/dotnet/api/system.net.sockets.iocontrolcode?view=netframework-4.7.2)
* Content Source: [xml/System.Net.Sockets/IOControlCode.xml](https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.Net.Sockets/IOControlCode.xml)
* Product: **dotnet-api**
* GitHub Login: @karelz
* Microsoft Alias: **ncldev**

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.