System.Win.ScktComp.TCustomWinSocket.ReceiveBuf

提供: RAD Studio API Documentation
移動先: 案内検索

Delphi

function ReceiveBuf(var Buf; Count: Integer): Integer;

C++

int __fastcall ReceiveBuf(void *Buf, int Count);

プロパティ

種類 可視性 ソース ユニット
function public
System.Win.ScktComp.pas
System.Win.ScktComp.hpp
System.Win.ScktComp TCustomWinSocket

説明

最大で Count に指定したバイト数をソケット接続から Buf パラメータに読み出します。

ReceiveBuf メソッドを呼び出すと,Windows ソケットオブジェクトの OnSocketEvent イベントハンドラ,あるいはソケットコンポーネントの OnRead または OnClientRead イベントハンドラでソケット接続から情報を読み出すことができます。ReceiveBuf は,実際に読み出されたバイト数を返します。データがまったく読み出されなかった場合,ReceiveBuf は -1 を返します。

ReceiveBuf は,非ブロッキング Windows ソケットへの読み出し通知に対する応答として使用されるだけです。ブロッキングソケットの場合は,読み出しに TWinSocketStream を使用する必要があります。TWinSocketStream オブジェクトは,情報の転送を開始する前に,リモートソケットの用意ができるのを待ちます。

メモ:  ReceiveLength メソッドは,ソケットから情報を取得するために必要な推定バッファサイズを返すことができますが,そのバイト数が正確であるとは限りません。

関連項目