ホーム › Networking.RemoteDifferentialCompression › IRdcFileReader

IRdcFileReader

COM

📘 Microsoft Learn (日本語) · English

IID96236a74-9dbc-11da-9e3f-0011114ae311継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

IRdcFileReader インターフェイスは、ファイルハンドルに相当するものを提供するために使用します。同期対象のデータは、ディスク上のファイルとして存在するとは限らないためです。

メソッド 3

vtbl = vtable インデックス(0始まり)。HSP等からCOMメソッドをインデックス指定で呼ぶ際に使用します。0〜2 は IUnknown。

vtbl 3 HRESULT GetFileSize(ULONGLONG* fileSize)

ファイルのサイズを返します。

fileSize

ULONGLONG*

out

ULONGLONG のアドレス。正常に終了すると、ファイルのサイズ(バイト単位)が格納されます。

戻り値

このメソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

vtbl 4 HRESULT Read(ULONGLONG offsetFileStart, DWORD bytesToRead, DWORD* bytesActuallyRead, BYTE* buffer, BOOL* eof)

指定した位置から、指定した量のデータを読み取ります。

offsetFileStart	ULONGLONG	in	読み取りを開始する、データの先頭からのオフセット。
bytesToRead	DWORD	in	読み取るバイト数。
bytesActuallyRead	DWORD*	out	読み取ったバイト数を受け取る ULONG のアドレス。
buffer	BYTE*	out	読み取ったデータを受け取るバッファーのアドレス。このバッファーは、少なくとも bytesToRead バイトのサイズが必要です。
eof	BOOL*	out	ファイルの末尾まで読み取った場合に TRUE に設定される BOOL のアドレス。

戻り値

このメソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

解説(Remarks)

通常、RDC はファイルを先頭から末尾まで順に読み取ります。シグネチャを読み取る際には、ファイルを複数回読み取る場合があります。

戻り時に eof パラメーターが指す BOOL が TRUE でない場合、bytesActuallyRead パラメーターが指す値は bytesToRead パラメーターと等しくなければなりません。eof パラメーターが指す値が設定されている場合は、bytesActuallyRead パラメーターが指す値は 0 から bytesToRead パラメーターまでの任意の値になります。

vtbl 5 HRESULT GetFilePosition(ULONGLONG* offsetFromStart)

現在のファイル位置を返します。

offsetFromStart

ULONGLONG*

out

データの先頭からの現在のオフセットを受け取る ULONGLONG のアドレス。

戻り値

このメソッドが成功すると S_OK を返します。それ以外の場合は HRESULT エラーコードを返します。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

HSP用 COM定義

#usecom / #comfunc によるHSPのCOM呼び出し定義。数字は vtbl インデックス(0始まり)。クラスIDが無い場合 #usecom の末尾は "{}"、ある場合は "{CLSID}"。

出力引数:

#define global IID_IRdcFileReader "{96236A74-9DBC-11DA-9E3F-0011114AE311}"
#usecom global IRdcFileReader IID_IRdcFileReader "{}"
#comfunc global IRdcFileReader_GetFileSize      3 var
#comfunc global IRdcFileReader_Read             4 int64,int,var,var,var
#comfunc global IRdcFileReader_GetFilePosition  5 var
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IRdcFileReader "{96236A74-9DBC-11DA-9E3F-0011114AE311}"
#usecom global IRdcFileReader IID_IRdcFileReader "{}"
#comfunc global IRdcFileReader_GetFileSize      3 sptr
#comfunc global IRdcFileReader_Read             4 int64,int,sptr,sptr,sptr
#comfunc global IRdcFileReader_GetFilePosition  5 sptr
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。