Socket.IOControl

.NET Framework クラス ライブラリ リファレンス

Socket.IOControl メソッド (IOControlCode, Byte[], Byte[])

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

IOControlCode 列挙体を使用して制御コードを指定し、Socket の低水準操作モードを設定します。

名前空間: System.Net.Sockets
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Function IOControl ( _
    ioControlCode As IOControlCode, _
    optionInValue As Byte(), _
    optionOutValue As Byte() _
) As Integer

Visual Basic (使用法)

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)

C#

public int IOControl (
    IOControlCode ioControlCode,
    byte[] optionInValue,
    byte[] optionOutValue
)

C++

public:
int IOControl (
    IOControlCode ioControlCode, 
    array<unsigned char>^ optionInValue, 
    array<unsigned char>^ optionOutValue
)

J#

public int IOControl (
    IOControlCode ioControlCode, 
    byte[] optionInValue, 
    byte[] optionOutValue
)

JScript

public function IOControl (
    ioControlCode : IOControlCode, 
    optionInValue : byte[], 
    optionOutValue : byte[]
) : int

パラメータ

ioControlCode

実行する演算の制御コードを指定する IOControlCode 値。

optionInValue

演算に必要な入力データを格納する Byte 型の配列。

optionOutValue

演算によって返された出力データを格納する Byte 型の配列。

戻り値
optionOutValue パラメータのバイト数。

例外

例外の種類	条件
SocketException	ソケットへのアクセスを試みているときにエラーが発生しました。詳細については「解説」を参照してください。
ObjectDisposedException	Socket は閉じられています。
InvalidOperationException	Blocking プロパティを使用せずに、ブロッキング モードを変更しようとしました。

解説

このメソッドは、Socket クラスの現在のインスタンスの基になるオペレーティング システム Socket への低水準アクセスを提供します。詳細については、MSDN ライブラリで WSAIoctl のドキュメントを参照してください。

メモ
SocketException が発生した場合は、SocketException.ErrorCode プロパティを使用して具体的なエラー コードを取得してください。このコードを取得したら、Windows Socket Version 2 API エラー コードのドキュメントでエラーの詳細情報を確認してください。これは MSDN ライブラリから入手できます。

メモ
このメンバは、アプリケーションでネットワーク トレースが有効にされている場合にトレース情報を出力します。詳細については、「ネットワークのトレース」を参照してください。

使用例

DataToRead を使用して IOControl を呼び出した場合と、Available プロパティを使用した場合とを比較するコード例を次に示します。

C#

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

C++

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

J#

static void DisplayPendingByteCount(Socket
 s)
{
    ubyte outValue[] = BitConverter.GetBytes(0);
    // Check how many bytes have been received.
    s.IOControl(IOControlCode.DataToRead, null, outValue);
    UInt32 bytesAvailable = BitConverter.ToUInt32(outValue, 0);
    //ToDo: Unsigned Integers not supported- converted to int
    Console.Write("server has {0} bytes pending. ",
        bytesAvailable.ToString());
    Console.WriteLine("Available property says {1}.", 
        (System.Int32)s.get_Available());
    return;
} //DisplayPendingByteCount

.NET Framework のセキュリティ

• SecurityPermission  (アンマネージ コードを実行するために必要なアクセス許可)。UnmanagedCode (関連する列挙体)

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
Socket クラス
Socket メンバ
System.Net.Sockets 名前空間

Socket.IOControl メソッド (Int32, Byte[], Byte[])

数値制御コードを使用して、Socket の低水準操作モードを設定します。

名前空間: System.Net.Sockets
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Function IOControl ( _
    ioControlCode As Integer, _
    optionInValue As Byte(), _
    optionOutValue As Byte() _
) As Integer

Visual Basic (使用法)

Dim instance As Socket
Dim ioControlCode As Integer
Dim optionInValue As Byte()
Dim optionOutValue As Byte()
Dim returnValue As Integer

returnValue = instance.IOControl(ioControlCode, optionInValue, optionOutValue)

C#

public int IOControl (
    int ioControlCode,
    byte[] optionInValue,
    byte[] optionOutValue
)

C++

public:
int IOControl (
    int ioControlCode, 
    array<unsigned char>^ optionInValue, 
    array<unsigned char>^ optionOutValue
)

J#

public int IOControl (
    int ioControlCode, 
    byte[] optionInValue, 
    byte[] optionOutValue
)

JScript

public function IOControl (
    ioControlCode : int, 
    optionInValue : byte[], 
    optionOutValue : byte[]
) : int

パラメータ

ioControlCode

実行する演算の制御コードを指定する Int32 値。

optionInValue

演算に必要な入力データを格納する Byte 配列。

optionOutValue

演算によって返された出力データを格納する Byte 配列。

戻り値
optionOutValue パラメータのバイト数。

例外

例外の種類	条件
SocketException	ソケットへのアクセスを試みているときにエラーが発生しました。詳細については「解説」を参照してください。
ObjectDisposedException	Socket は閉じられています。
InvalidOperationException	Blocking プロパティを使用せずに、ブロッキング モードを変更しようとしました。
SecurityException	コール スタック内の呼び出し元が、要求されたアクセス許可を保持していません。

解説

IOControl メソッドは、Socket クラスの現在のインスタンスの基になるオペレーティング システム Socket への低レベル アクセスを提供します。詳細については、MSDN ライブラリで WSAIoctl のドキュメントを参照してください。

メモ
SocketException が発生した場合は、SocketException.ErrorCode プロパティを使用して具体的なエラー コードを取得してください。このコードを取得したら、Windows Socket Version 2 API エラー コードのドキュメントでエラーの詳細情報を確認してください。これは MSDN ライブラリから入手できます。

メモ
このメンバは、アプリケーションでネットワーク トレースが有効にされている場合にトレース情報を出力します。詳細については、「ネットワークのトレース」を参照してください。

使用例

次に示すのは、FIONREAD を使用した場合と Available プロパティを使用した場合の結果を比較するコード例です。

C#

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

C++

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

J#

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

static void DisplayPendingByteCount(Socket
 s)
{
    ubyte outValue[] = BitConverter.GetBytes(0);
    // Check how many bytes have been received.
    s.IOControl(FIONREAD, null, outValue);

    UInt32 bytesAvailable = BitConverter.ToUInt32(outValue, 0);
    //ToDo: Unsigned Integers not supported- converted to int
    Console.WriteLine("server has {0} bytes pending. Available property "
        + "says {1}.", bytesAvailable.ToString(), 
        (System.Int32)s.get_Available());
    return;
} //DisplayPendingByteCount

.NET Framework のセキュリティ

• SecurityPermission  (アンマネージ コードを実行するために必要なアクセス許可)。UnmanagedCode (関連する列挙体)

プラットフォーム

Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
Socket クラス
Socket メンバ
System.Net.Sockets 名前空間

Socket.IOControl メソッド

Socket の低レベル操作モードを設定します。
オーバーロードの一覧

名前	説明
Socket.IOControl (Int32, Byte[], Byte[])	数値制御コードを使用して、Socket の低水準操作モードを設定します。 .NET Compact Framework によってサポートされています。
Socket.IOControl (IOControlCode, Byte[], Byte[])	IOControlCode 列挙体を使用して制御コードを指定し、Socket の低水準操作モードを設定します。

参照

関連項目

Socket クラス
Socket メンバ
System.Net.Sockets 名前空間