ホーム › Devices.WebServicesOnDevices › IWSDInboundAttachment

IWSDInboundAttachment

COM

📘 Microsoft Learn (日本語) · English

IID5bd6ca65-233c-4fb8-9f7a-2641619655c9継承元IWSDAttachment自前メソッド開始 vtbl3

公式ドキュメント

アプリケーションが受信メッセージから MIME エンコードされた添付データを読み取れるようにします。

解説(Remarks)

添付ストリームがメッセージの一部として受信されると、WSDAPI はこのインターフェイスを実装したオブジェクトを提供します。

メソッド 2

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

vtbl 3 HRESULT Read(BYTE* pBuffer, DWORD dwBytesToRead, DWORD* pdwNumberOfBytesRead)

リモートホストから送信されたメッセージから添付データを取得します。

pBuffer	BYTE*	out	添付ストリームから読み取ったデータを受け取るバッファーへのポインター。このデータバッファーの割り当てと解放はアプリケーションプログラムが行います。
dwBytesToRead	DWORD	in	入力バッファー pBuffer のサイズ (バイト単位)。
pdwNumberOfBytesRead	DWORD*	out	添付ストリームから入力バッファー pBuffer に読み取られたデータのバイト数を格納する DWORD へのポインター。

戻り値

戻り値には次のものが含まれますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは正常に完了しました。
S_FALSE	添付ストリームの終端に達しました。
E_INVALIDARG	pBuffer が NULL です。
E_POINTER	pdwNumberofBytesRead が NULL です。

解説(Remarks)

Read メソッドを使用すると、アプリケーションは MIME でカプセル化されたメッセージの添付として、リモートホストから任意のデータを受信できます。添付ストリームがメッセージの一部として受信されると、WSDAPI はこのインターフェイスを実装したオブジェクトを提供します。Read を呼び出すと、受信側の添付ストリームが開かれ、添付データがアプリケーションのバッファーに転送されます。Read が S_OK または S_FALSE を返した場合、pdwNumberofBytesRead には読み取られたバイト数が設定されます。この値はバッファーのサイズより小さい場合があります。Read の呼び出しは、ネットワークトラフィックによってブロックされることがあります。

vtbl 4 HRESULT Close()

現在の添付 MIME データストリームを閉じます。(IWSDInboundAttachment.Close)

戻り値

このメソッドは次の値のいずれかを返すことがあります。

戻り値には次のものが含まれますが、これらに限定されません。

戻り値	説明
S_OK	メソッドは正常に完了しました。

解説(Remarks)

このメソッドは、受信中の添付の転送を進行中に中断するために使用できます。

通常、IWSDInboundAttachment インターフェイスに対して Release() を呼び出す前に、Close を呼び出す必要があります。Close の呼び出しが不要なのは、Read が S_FALSE を返した場合、つまり添付ストリームの終端に達したことを示す場合のみです。その場合は、IWSDInboundAttachment インターフェイスに対して Release() を呼び出すだけで済みます。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IWSDInboundAttachment "{5BD6CA65-233C-4FB8-9F7A-2641619655C9}"
#usecom global IWSDInboundAttachment IID_IWSDInboundAttachment "{}"
#comfunc global IWSDInboundAttachment_Read   3 var,int,var
#comfunc global IWSDInboundAttachment_Close  4
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。#define global IID_IWSDInboundAttachment "{5BD6CA65-233C-4FB8-9F7A-2641619655C9}"
#usecom global IWSDInboundAttachment IID_IWSDInboundAttachment "{}"
#comfunc global IWSDInboundAttachment_Read   3 sptr,int,sptr
#comfunc global IWSDInboundAttachment_Close  4
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。