Win32 API 日本語リファレンス
ホームMedia.MediaFoundation › IMFHttpDownloadSession

IMFHttpDownloadSession

COM
IID71fa9a2c-53ce-4662-a132-1a7e8cbf62db継承元IUnknown自前メソッド開始 vtbl3

公式ドキュメント

アプリケーションは、Microsoft Media Foundation が使用する HTTP および HTTPS プロトコルの既定の実装をオーバーライドするために、このインターフェイスを実装します。(IMFHttpDownloadSession)

メソッド 3

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

vtbl 3 HRESULT SetServer(LPWSTR szServerName, DWORD nPort)

この IMFHttpDownloadSession のインスタンスが作成するすべての要求に共通するパラメーターを指定するために、Microsoft Media Foundation から呼び出されます。

szServerNameLPWSTRin要求の送信先となる HTTP サーバーのホスト名、完全修飾 DNS 名、または IP アドレスです。
nPortDWORDinサーバーの TCP ポート番号です。

戻り値

このメソッドは HRESULT を返します。取り得る値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値 説明
S_OK
指定されたデータを正常に格納しました。
E_OUTOFMEMORY
操作を完了するためのメモリが不足しています。
vtbl 4 HRESULT CreateRequest(LPWSTR szObjectName, BOOL fBypassProxyCache, BOOL fSecure, LPWSTR szVerb, LPWSTR szReferrer, IMFHttpDownloadRequest** ppRequest)

単一の HTTP または HTTPS 要求を送信するために使用される IMFHttpDownloadRequest インターフェイスを実装するオブジェクトを作成するために、Microsoft Media Foundation から呼び出されます。

szObjectNameLPWSTRin指定された HTTP 動詞の対象リソース名を格納する文字列へのポインターです。通常は、ファイル名、実行可能モジュール、または検索指定子です。対象リソースは常にスラッシュ文字で始まり、URL に含まれていたクエリ文字列があればそれを含みます。
fBypassProxyCacheBOOLinTRUE に設定した場合、プロキシサーバーからキャッシュされたリソースのバージョンを送信するのではなく、要求を発信元のサーバーに転送すべきであることを示します。このフラグを TRUE に設定した場合は、要求に "Pragma: no-cache" ヘッダーを追加する必要があります。HTTP/1.1 要求を作成する場合は、"Cache-Control: no-cache" も追加する必要があります。
fSecureBOOLinTRUE に設定した場合、該当するときはプロトコルのセキュアなバリアントを使用させます。たとえば、IMFHttpDownloadSession が HTTP/HTTPS 用である場合、fSecure を TRUE に設定すると要求は HTTPS を使用します。それ以外の場合は、プロトコルの非セキュアなバリアント(この例では HTTP)が使用されます。
szVerbLPWSTRinoptional

要求で使用する HTTP 動詞を格納する文字列へのポインターです。このパラメーターが NULL の場合、関数は HTTP 動詞として GET を使用します。

注意 この文字列はすべて大文字にする必要があります。多くのサーバーは HTTP 動詞を大文字と小文字を区別して扱い、また Internet Engineering Task Force (IETF) の Requests for Comments (RFC) ではこれらの動詞を大文字のみで表記しています。
szReferrerLPWSTRinoptional要求内の szObjectName の URL の取得元となったドキュメントの URL を指定する文字列へのポインターです。このパラメーターを NULL に設定した場合、参照元ドキュメントは指定されません。
ppRequestIMFHttpDownloadRequest**outメソッドが正常に戻ると、このパラメーターには IMFHttpDownloadRequest インターフェイスが設定されます。

戻り値

このメソッドは HRESULT を返します。取り得る値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値 説明
S_OK
指定された情報を正常に格納しました。
E_OUTOFMEMORY
操作を完了するためのメモリが不足しています。
MF_E_INVALIDREQUEST
メソッドが Close の後、または SetServer が呼び出される前に呼び出されました。
vtbl 5 HRESULT Close()

これ以上 HTTP 要求が作成されないことを指定するために Microsoft Media Foundation から呼び出され、IMFHttpDownloadSession が内部リソースを解放できるようにします。

戻り値

このメソッドは HRESULT を返します。取り得る値には、次の表に示すものが含まれますが、これらに限定されません。

戻り値 説明
S_OK
セッションを正常に閉じました。
出典・ライセンス: 上記「公式ドキュメント」の内容は 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_IMFHttpDownloadSession "{71FA9A2C-53CE-4662-A132-1A7E8CBF62DB}"
#usecom global IMFHttpDownloadSession IID_IMFHttpDownloadSession "{}"
#comfunc global IMFHttpDownloadSession_SetServer      3 wstr,int
#comfunc global IMFHttpDownloadSession_CreateRequest  4 wstr,int,int,wstr,wstr,sptr
#comfunc global IMFHttpDownloadSession_Close          5
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。