ホーム › Devices.WebServicesOnDevices › IWSDHttpMessageParameters

IWSDHttpMessageParameters

COM

📘 Microsoft Learn (日本語) · English

IID540bd122-5c83-4dec-b396-ea62a2697fdf継承元IWSDMessageParameters自前メソッド開始 vtbl8

公式ドキュメント

SOAP-over-HTTP でメッセージを送受信する際に使用される HTTP ヘッダーへのアクセスを提供します。

メソッド 9

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

vtbl 8 HRESULT SetInboundHttpHeaders(LPWSTR pszHeaders)

受信方向の SOAP-over-HTTP 転送で使用する HTTP ヘッダーを設定します。

pszHeaders

LPWSTR

inoptional

設定する HTTP ヘッダー。

戻り値

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

戻り値	説明
S_OK	メソッドは正常に完了しました。
E_INVALIDARG	pszHeaders の文字数が WSD_MAX_TEXT_LENGTH (8192) を超えています。
E_OUTOFMEMORY	操作を完了するためのメモリが不足しています。

vtbl 9 HRESULT GetInboundHttpHeaders(LPWSTR* ppszHeaders)

受信方向の SOAP-over-HTTP 転送で現在使用されている HTTP ヘッダーを取得します。

ppszHeaders

LPWSTR*

out

現在使用中の HTTP ヘッダーを受け取るポインター。このポインターは解放しないでください。

戻り値

このメソッドは次のいずれかの値を返します。

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

戻り値	説明
S_OK	メソッドは正常に完了しました。
E_INVALIDARG	ppszHeaders が NULL です。
E_FAIL	利用可能なヘッダーがありません。

vtbl 10 HRESULT SetOutboundHttpHeaders(LPWSTR pszHeaders)

送信方向の SOAP-over-HTTP 転送で使用する HTTP ヘッダーを設定します。

pszHeaders

LPWSTR

inoptional

設定する HTTP ヘッダー。

戻り値

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

戻り値	説明
S_OK	メソッドは正常に完了しました。
E_INVALIDARG	pszHeaders の文字数が WSD_MAX_TEXT_LENGTH (8192) を超えています。
E_OUTOFMEMORY	操作を完了するためのメモリが不足しています。

vtbl 11 HRESULT GetOutboundHttpHeaders(LPWSTR* ppszHeaders)

送信方向の SOAP-over-HTTP 転送で現在使用されている HTTP ヘッダーを取得します。

ppszHeaders

LPWSTR*

out

現在使用中の HTTP ヘッダーを受け取るポインター。このポインターは解放しないでください。

戻り値

このメソッドは次のいずれかの値を返します。

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

戻り値	説明
S_OK	メソッドは正常に完了しました。
E_INVALIDARG	ppszHeaders が NULL です。
E_FAIL	利用可能なヘッダーがありません。

vtbl 12 HRESULT SetID(LPWSTR pszId)

現在のトランザクションのトランスポート ID を設定します。

pszId

LPWSTR

inoptional

現在のトランザクションに設定するトランスポート ID へのポインター。

戻り値

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

戻り値	説明
S_OK	メソッドは正常に完了しました。
E_INVALIDARG	pszId が NULL であるか、pszId の文字数が WSD_MAX_TEXT_LENGTH (8192) を超えています。
E_OUTOFMEMORY	操作を完了するためのメモリが不足しています。

vtbl 13 HRESULT GetID(LPWSTR* ppszId)

現在のトランザクションのトランスポート ID を取得します。

ppszId

LPWSTR*

out

現在のトランザクションのトランスポート ID を返すために使用されるポインター。このポインターは解放しないでください。

戻り値

このメソッドは次のいずれかの値を返します。

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

戻り値	説明
S_OK	メソッドは正常に完了しました。
E_INVALIDARG	ppszId が NULL です。
E_FAIL	トランスポート ID を利用できません。

vtbl 14 HRESULT SetContext(IUnknown* pContext)

現在のトランザクションのプライベート転送コンテキストを設定します。

pContext

IUnknown*

現在のトランザクションに設定するプライベート転送コンテキストへのポインター。

戻り値

このメソッドは次のいずれかの値を返します。

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

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

vtbl 15 HRESULT GetContext(IUnknown** ppContext)

現在のトランザクションのプライベート転送コンテキストを取得します。

ppContext

IUnknown**

out

現在のトランザクションのプライベート転送コンテキストを取得するために使用されるポインターへのポインター。

戻り値

このメソッドは次のいずれかの値を返します。

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

戻り値	説明
S_OK	メソッドは正常に完了しました。
E_INVALIDARG	ppContext が NULL です。
E_FAIL	コンテキストを取得できませんでした。

vtbl 16 HRESULT Clear()

SOAP-over-HTTP 転送で使用される HTTP ヘッダーをクリアします。

戻り値

このメソッドは次のいずれかの値を返します。

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

戻り値	説明
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_IWSDHttpMessageParameters "{540BD122-5C83-4DEC-B396-EA62A2697FDF}"
#usecom global IWSDHttpMessageParameters IID_IWSDHttpMessageParameters "{}"
#comfunc global IWSDHttpMessageParameters_SetInboundHttpHeaders   8 wstr
#comfunc global IWSDHttpMessageParameters_GetInboundHttpHeaders   9 var
#comfunc global IWSDHttpMessageParameters_SetOutboundHttpHeaders  10 wstr
#comfunc global IWSDHttpMessageParameters_GetOutboundHttpHeaders  11 var
#comfunc global IWSDHttpMessageParameters_SetID                   12 wstr
#comfunc global IWSDHttpMessageParameters_GetID                   13 var
#comfunc global IWSDHttpMessageParameters_SetContext              14 sptr
#comfunc global IWSDHttpMessageParameters_GetContext              15 sptr
#comfunc global IWSDHttpMessageParameters_Clear                   16
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数は var(変数直渡し)。varptr 方式にも切替可。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。#define global IID_IWSDHttpMessageParameters "{540BD122-5C83-4DEC-B396-EA62A2697FDF}"
#usecom global IWSDHttpMessageParameters IID_IWSDHttpMessageParameters "{}"
#comfunc global IWSDHttpMessageParameters_SetInboundHttpHeaders   8 wstr
#comfunc global IWSDHttpMessageParameters_GetInboundHttpHeaders   9 sptr
#comfunc global IWSDHttpMessageParameters_SetOutboundHttpHeaders  10 wstr
#comfunc global IWSDHttpMessageParameters_GetOutboundHttpHeaders  11 sptr
#comfunc global IWSDHttpMessageParameters_SetID                   12 wstr
#comfunc global IWSDHttpMessageParameters_GetID                   13 sptr
#comfunc global IWSDHttpMessageParameters_SetContext              14 sptr
#comfunc global IWSDHttpMessageParameters_GetContext              15 sptr
#comfunc global IWSDHttpMessageParameters_Clear                   16
; ※数字は vtbl インデックス(0始まり)。0/1/2 は IUnknown(QueryInterface/AddRef/Release)。
; ※このインターフェースは直接 CoCreateInstance するクラスIDが無いため "{}"(他メソッド/アクティベーションで取得)。
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; ※ハンドル/void*等の不透明ポインタは IronHSP では intptr 指定が可能。