XmlTextReader.ReadContentAsBinHex メソッド

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

XmlTextReader.ReadContentAsBinHex メソッド

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

コンテンツを読み取り、BinHex でデコードされたバイナリ バイトを返します。

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

Visual Basic (宣言)

Public Overrides Function
 ReadContentAsBinHex ( _
    buffer As Byte(), _
    index As Integer, _
    count As Integer _
) As Integer

Visual Basic (使用法)

Dim instance As XmlTextReader
Dim buffer As Byte()
Dim index As Integer
Dim count As Integer
Dim returnValue As Integer

returnValue = instance.ReadContentAsBinHex(buffer, index, count)

C#

public override int ReadContentAsBinHex (
    byte[] buffer,
    int index,
    int count
)

C++

public:
virtual int ReadContentAsBinHex (
    array<unsigned char>^ buffer, 
    int index, 
    int count
) override

J#

public int ReadContentAsBinHex (
    byte[] buffer, 
    int index, 
    int count
)

JScript

public override function ReadContentAsBinHex
 (
    buffer : byte[], 
    index : int, 
    count : int
) : int

パラメータ

buffer

結果として得られるテキストのコピー先のバッファ。この値を null 参照 (Visual Basic では Nothing) にすることはできません。

index

バッファ内の結果のコピー開始位置を示すオフセット。

count

バッファにコピーする最大バイト数。コピーされた実際のバイト数は、このメソッドから返されます。

戻り値
バッファに書き込まれたバイト数。

例外

例外の種類	条件
ArgumentNullException	buffer 値が null 参照 (Visual Basic では Nothing) です。
InvalidOperationException	ReadContentAsBinHex は、現在のノードではサポートされていません。
ArgumentOutOfRangeException	バッファ内のインデックス、またはインデックスとカウントの合計値が、割り当てられているバッファ サイズを超えています。
NotSupportedException	その XmlTextReader 実装が、このメソッドをサポートしていません。

解説

メモ
Microsoft .NET Framework version 2.0 リリースでは、System.Xml.XmlReader.Create メソッドを使用して XmlReader インスタンスを作成することをお勧めします。これにより、このリリースで導入された新機能を十分に活用できます。詳細については、「XML リーダーの作成」を参照してください。

このメソッドは、コンテンツをストリーム転送し、BinHex のコンテンツをデコードして、デコードされたバイナリ バイト (BinHex でエンコードされたインライン GIF イメージなど) をバッファに返します。このメソッドを連続して呼び出すと、埋め込みテキストの大量のストリームを読み取ることができます。

メモ
ReadContentAsBinHex メソッドを繰り返し呼び出している間は、メソッドから値 0 が返されるまで、リーダーのどのプロパティにもアクセスしないでください。

このメソッドは次のように動作します。

• ReadContentAsBinHex は、操作していたバイト ストリームの末尾に到達すると、値 0 を返します。リーダーは、最初の非コンテンツ ノード上に配置されます。

• ストリーム内に残っているバイト数よりも少ないバイト数、または残っている正確なバイト数を要求した場合は、リーダーの現在の位置は変わりません。

• XML ノード型が Element、XmlDeclaration、None、Document、DocumentType、Notation、Entity、DocumentFragment のいずれかの場合、ReadContentAsBinHex はサポートされません。

プラットフォーム

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
.NET Compact Framework
サポート対象 : 2.0

参照

関連項目
XmlTextReader クラス
XmlTextReader メンバ
System.Xml 名前空間
ReadElementContentAsBinHex
XmlNodeType 列挙体
その他の技術情報
XmlReader による XML の読み取り