Socket.IOControl メソッド

定義

Socket の下位操作モードを設定します。Sets low-level operating modes for the Socket.

オーバーロード

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

IOControlCode 列挙型を使用して制御コードを指定し、Socket の下位操作モードを設定します。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[])

IOControlCode 列挙型を使用して制御コードを指定し、Socket の下位操作モードを設定します。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

パラメーター

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.

戻り値

optionOutValue パラメーターのバイト数。The number of bytes in the optionOutValue parameter.

例外

ソケットへのアクセスを試行しているときにエラーが発生しました。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.

次のコード例では、IOControl を呼び出した結果を DataToReadAvailable プロパティと比較しています。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;
}

注釈

このメソッドは、Socket クラスの現在のインスタンスの基になるオペレーティングシステム Socket に低レベルのアクセスを提供します。This method provides low-level access to the operating system Socket underlying the current instance of the Socket class. 詳細については、 Wsaioctlのドキュメントを参照してください。For more, see the WSAIoctl documentation.

注意

SocketExceptionを受け取った場合は、SocketException.ErrorCode プロパティを使用して、特定のエラーコードを取得します。If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code. このコードを取得したら、 Windows Sockets version 2 API エラーコードのドキュメントを参照して、エラーの詳細な説明を参照してください。After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.

注意

このメンバーは、アプリケーションでネットワーク トレースが有効にされている場合にトレース情報を出力します。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.

セキュリティ

SecurityPermission
アンマネージコードを実行する場合は。to execute unmanaged code. UnmanagedCode (関連する列挙体)Associated enumeration: UnmanagedCode.

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

パラメーター

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.

戻り値

optionOutValue パラメーターのバイト数。The number of bytes in the optionOutValue parameter.

例外

ソケットへのアクセスを試行しているときにエラーが発生しました。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.

次のコード例では、FIONREAD と使用可能なプロパティの結果を比較します。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;
 }

注釈

IOControl メソッドは、Socket クラスの現在のインスタンスの基になるオペレーティングシステム Socket に低レベルのアクセスを提供します。The IOControl method provides low-level access to the operating system Socket underlying the current instance of the Socket class. 詳細については、 Wsaioctlのドキュメントを参照してください。For more information, see the WSAIoctl documentation.

注意

SocketExceptionを受け取った場合は、SocketException.ErrorCode プロパティを使用して、特定のエラーコードを取得します。If you receive a SocketException, use the SocketException.ErrorCode property to obtain the specific error code. このコードを取得したら、 Windows Sockets version 2 API エラーコードのドキュメントを参照して、エラーの詳細な説明を参照してください。After you have obtained this code, refer to the Windows Sockets version 2 API error code documentation for a detailed description of the error.

注意

このメンバーは、アプリケーションでネットワーク トレースが有効にされている場合にトレース情報を出力します。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.

セキュリティ

SecurityPermission
アンマネージコードを実行する場合は。to execute unmanaged code. UnmanagedCode (関連する列挙体)Associated enumeration: UnmanagedCode.

適用対象