Socket.IOControl Method

Definition

Задает низкоуровневые операционные режимы для объекта Socket.Sets low-level operating modes for the Socket.

Overloads

IOControl(IOControlCode, Byte[], Byte[])

Задает низкоуровневые операционные режимы для объекта Socket, используя перечисление IOControlCode, чтобы указать коды элементов управления.Sets low-level operating modes for the Socket using the IOControlCode enumeration to specify control codes.

IOControl(Int32, Byte[], Byte[])

Задает низкоуровневые операционные режимы для объекта Socket, используя цифровые коды элементов управления.Sets low-level operating modes for the Socket using numerical control codes.

IOControl(IOControlCode, Byte[], Byte[])

Задает низкоуровневые операционные режимы для объекта Socket, используя перечисление IOControlCode, чтобы указать коды элементов управления.Sets low-level operating modes for the Socket using the IOControlCode enumeration to specify control codes.

public:
 int IOControl(System::Net::Sockets::IOControlCode ioControlCode, cli::array <System::Byte> ^ optionInValue, cli::array <System::Byte> ^ optionOutValue);
public int IOControl (System.Net.Sockets.IOControlCode ioControlCode, byte[] optionInValue, byte[] optionOutValue);
member this.IOControl : System.Net.Sockets.IOControlCode * byte[] * byte[] -> int
Public Function IOControl (ioControlCode As IOControlCode, optionInValue As Byte(), optionOutValue As Byte()) As Integer

Parameters

ioControlCode
IOControlCode

Значение IOControlCode, задающее код элемента управления для выполняемой операции.A IOControlCode value that specifies the control code of the operation to perform.

optionInValue
Byte[]

Массив типа Byte, который содержит входные данные, необходимые для операции.An array of type Byte that contains the input data required by the operation.

optionOutValue
Byte[]

Массив типа Byte, который содержит выходные данные, возвращенные операцией.An array of type Byte that contains the output data returned by the operation.

Returns

Int32

Число байтов в параметре optionOutValue.The number of bytes in the optionOutValue parameter.

Exceptions

Произошла ошибка при попытке доступа к сокету.An error occurred when attempting to access the socket.

Socket был закрыт.The Socket has been closed.

Была сделана попытка изменения блокирующего режима без использования свойства Blocking.An attempt was made to change the blocking mode without using the Blocking property.

Examples

В следующем примере кода сравниваются результаты вызова IOControl с DataToRead и свойством Available.The following code example compares the results of calling IOControl with DataToRead and the Available property.

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;
}
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;
}

Remarks

Этот метод обеспечивает низкоуровневый доступ к операционной системе Socket базовом экземпляре класса Socket.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.

Note

Если вы получаете SocketException, используйте свойство SocketException.ErrorCode для получения конкретного кода ошибки.If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code. После получения этого кода обратитесь к документации по коду ошибки API Windows Sockets версии 2 для получения подробного описания ошибки.After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.

Note

Данный член генерирует сведения трассировки, если в приложении включена трассировка сети.This member outputs trace information when you enable network tracing in your application. Дополнительные сведения см. в разделе Сетевая трассировка в .NET Framework.For more information, see Network Tracing in the .NET Framework.

IOControl(Int32, Byte[], Byte[])

Задает низкоуровневые операционные режимы для объекта Socket, используя цифровые коды элементов управления.Sets low-level operating modes for the Socket using numerical control codes.

public:
 int IOControl(int ioControlCode, cli::array <System::Byte> ^ optionInValue, cli::array <System::Byte> ^ optionOutValue);
public int IOControl (int ioControlCode, byte[] optionInValue, byte[] optionOutValue);
member this.IOControl : int * byte[] * byte[] -> int
Public Function IOControl (ioControlCode As Integer, optionInValue As Byte(), optionOutValue As Byte()) As Integer

Parameters

ioControlCode
Int32

Значение Int32, задающее код элемента управления для выполняемой операции.An Int32 value that specifies the control code of the operation to perform.

optionInValue
Byte[]

Массив Byte, который содержит входные данные, необходимые для операции.A Byte array that contains the input data required by the operation.

optionOutValue
Byte[]

Массив Byte, который содержит выходные данные, необходимые для операции.A Byte array that contains the output data returned by the operation.

Returns

Int32

Число байтов в параметре optionOutValue.The number of bytes in the optionOutValue parameter.

Exceptions

Произошла ошибка при попытке доступа к сокету.An error occurred when attempting to access the socket.

Socket был закрыт.The Socket has been closed.

Была сделана попытка изменения блокирующего режима без использования свойства Blocking.An attempt was made to change the blocking mode without using the Blocking property.

Вызывающий оператор в стеке вызовов не имеет необходимых разрешений.A caller in the call stack does not have the required permissions.

Examples

В следующем примере кода сравниваются результаты ФИОНРЕАД и доступного свойства.The following code example compares the results of FIONREAD and the Available property.

// FIONREAD is also available as the "Available" property.
const int FIONREAD = 0x4004667F;

void DisplayPendingByteCount( Socket^ s )
{
   array<Byte>^ outValue = BitConverter::GetBytes( 0 );
   
   // Check how many bytes have been received.
   s->IOControl( FIONREAD, nullptr, outValue );

   UInt32 bytesAvailable = BitConverter::ToUInt32( outValue, 0 );
   Console::WriteLine( "server has {0} bytes pending. Available property says {1}.",
      bytesAvailable, s->Available );

   return;
}
 // FIONREAD is also available as the "Available" property.
public const int FIONREAD   = 0x4004667F;

static void DisplayPendingByteCount(Socket s)
 {
     byte[] outValue = BitConverter.GetBytes(0);

     // Check how many bytes have been received.
     s.IOControl(FIONREAD, null, outValue);

     uint bytesAvailable = BitConverter.ToUInt32(outValue, 0);
     Console.WriteLine("server has {0} bytes pending. Available property says {1}.",
         bytesAvailable, s.Available);

     return;
 }

Remarks

Метод IOControl предоставляет низкоуровневый доступ к операционной системе Socket базовому экземпляру класса Socket.The IOControl method provides low-level access to the operating system Socket underlying the current instance of the Socket class. Дополнительные сведения см. в документации по всаиоктл .For more information, see the WSAIoctl documentation.

Note

Если вы получаете SocketException, используйте свойство SocketException.ErrorCode для получения конкретного кода ошибки.If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code. После получения этого кода обратитесь к документации по коду ошибки API Windows Sockets версии 2 для получения подробного описания ошибки.After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.

Note

Данный член генерирует сведения трассировки, если в приложении включена трассировка сети.This member outputs trace information when you enable network tracing in your application. Дополнительные сведения см. в разделе Сетевая трассировка в .NET Framework.For more information, see Network Tracing in the .NET Framework.

Applies to