Sets low-level operating modes for the Socket using the IOControlCode enumeration to specify control codes.
(in System.dll)
Visual Basic (Declaration)
Public Function IOControl ( _
ioControlCode As IOControlCode, _
optionInValue As Byte(), _
optionOutValue As Byte() _
) As Integer
Dim instance As Socket
Dim ioControlCode As IOControlCode
Dim optionInValue As Byte()
Dim optionOutValue As Byte()
Dim returnValue As Integer
returnValue = instance.IOControl(ioControlCode, _
optionInValue, optionOutValue)
public int IOControl(
IOControlCode ioControlCode,
byte[] optionInValue,
byte[] optionOutValue
)
public:
int IOControl(
IOControlCode ioControlCode,
array<unsigned char>^ optionInValue,
array<unsigned char>^ optionOutValue
)
public function IOControl(
ioControlCode : IOControlCode,
optionInValue : byte[],
optionOutValue : byte[]
) : int
Return Value
Type:
System..::.Int32The number of bytes in the optionOutValue parameter.
This method provides low-level access to the operating system Socket underlying the current instance of the Socket class. For more, see the WSAIoctl documentation in the MSDN library.
.gif) Note: |
|---|
If you receive a SocketException, use the SocketException..::.ErrorCode property to obtain the specific error code. After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation in the MSDN library for a detailed description of the error. |
| Note: |
|---|
This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing. |
The following code example compares the results of calling IOControl with DataToRead and the Available property.
static void DisplayPendingByteCount(Socket s)
{
byte[] outValue = BitConverter.GetBytes(0);
// Check how many bytes have been received.
s.IOControl(IOControlCode.DataToRead, null, outValue);
uint bytesAvailable = BitConverter.ToUInt32(outValue, 0);
Console.Write("server has {0} bytes pending. ",
bytesAvailable);
Console.WriteLine("Available property says {1}.",
s.Available);
return;
}
void DisplayPendingByteCount( Socket^ s )
{
array<Byte>^ outValue = BitConverter::GetBytes( 0 );
// Check how many bytes have been received.
s->IOControl( IOControlCode::DataToRead, nullptr, outValue );
UInt32 bytesAvailable = BitConverter::ToUInt32( outValue, 0 );
Console::Write( "server has {0} bytes pending,",
bytesAvailable );
Console::WriteLine( "Available property says {1}.",
s->Available );
return;
}
Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98
The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
.NET Framework
Supported in: 3.5, 3.0, 2.0
Reference