Win32 API 日本語リファレンス
ホームNetworking.WindowsWebServices › WS_HTTP_MESSAGE_MAPPING

WS_HTTP_MESSAGE_MAPPING

構造体
サイズx64: 40 バイト / x86: 24 バイト

サイズ=各フィールドのバイト数(x64/x86 で異なる場合は x64/x86 と併記)。x64/x86 列=フィールドのバイトオフセット(HSPで dupptr / lpoke / wpoke 等に使用)。

フィールド

フィールドサイズx64x86説明
requestMappingOptionsDWORD4+0+0HTTP 要求内の情報をメッセージオブジェクトにどのようにマップするかを制御するオプションです。
responseMappingOptionsDWORD4+4+4HTTP 応答内の情報をメッセージオブジェクトにどのようにマップするかを制御するオプションです。
requestHeaderMappingsWS_HTTP_HEADER_MAPPING**8/4+8+8HTTP 要求について、どの HTTP ヘッダーをメッセージオブジェクトのヘッダーとの間でマップするかを記述するマッピングへのポインターの配列です。この配列内のポインターを NULL にすることはできません。
requestHeaderMappingCountDWORD4+16+12requestHeaderMappings 配列内の項目数です。
responseHeaderMappingsWS_HTTP_HEADER_MAPPING**8/4+24+16HTTP 応答について、どの HTTP ヘッダーをメッセージオブジェクトのヘッダーとの間でマップするかを記述するマッピングへのポインターの配列です。この配列内のポインターを NULL にすることはできません。
responseHeaderMappingCountDWORD4+32+20responseHeaderMappings 配列内の項目数です。

公式ドキュメント

HTTP 要求または応答をメッセージオブジェクト内でどのように表現するかに関する情報を指定します。

解説(Remarks)

メッセージには、メッセージエンベロープの一部ではないトランスポート固有の追加情報が含まれる場合があります。このトランスポート固有の情報は、メッセージオブジェクトのヘッダーとしてプログラムから公開できます。これらのヘッダーはマップされたヘッダー (mapped header) と呼ばれます。

マップされた各ヘッダーは、メッセージのヘッダー内に通常のヘッダー要素として格納されます (WS_MESSAGE_PROPERTY_HEADER_BUFFER を参照してください)。マップされたヘッダーには空の XML 名前空間 ("") が使用されます。

この構造体は、HTTP 要求または応答とメッセージオブジェクトのマップされたヘッダーとの間で、どのようにマッピングが行われるかを指定します。この構造体は WS_CHANNEL_PROPERTY_HTTP_MESSAGE_MAPPING プロパティを使用して指定できます。

次の図は、HTTP ヘッダーがメッセージのヘッダーにどのようにマップされるかを示しています。 :::image type="content" source="images/MappedHeaders.png" border="false" alt-text="MyHeader 要素が強調表示された Message オブジェクトと、HTTP 要求内の MyHeader 行を指す矢印を示す図。":::

メッセージを受信すると、HTTP チャネルは指定された HTTP ヘッダーを要求または応答からメッセージオブジェクトのヘッダーへ自動的にコピーします。その後、アプリケーションは WsGetMappedHeader を使用して、マップされたヘッダーの値を取得できます。

メッセージを送信する前に、アプリケーションは WsAddMappedHeader を使用して、マップされたヘッダーをメッセージオブジェクトに追加できます。メッセージが送信されると、HTTP チャネルは指定されたヘッダーをメッセージオブジェクトのヘッダーから自動的に削除し (そのためエンベロープ内には現れません)、HTTP 要求ヘッダーまたは応答ヘッダーとして追加します。

HTTP チャネルは、requestHeaderMappings フィールドまたは responseHeaderMappings フィールドで指定された HTTP ヘッダーに対してのみ、このマッピングを実行します。各ヘッダーの指定には WS_HTTP_HEADER_MAPPING を使用し、メッセージヘッダーと HTTP ヘッダーの間でどのように変換するかの指示も含まれます。

HTTP ヘッダーに対応しない HTTP 要求または応答内のその他の情報は、requestMappingOptions または responseMappingOptions を設定することで、メッセージオブジェクトのヘッダーにマップできます。マップされたこれらの値は WsGetMappedHeader を使用して取得できます。メッセージヘッダーにマップできる情報については、WS_HTTP_REQUEST_MAPPING_OPTIONS または WS_HTTP_RESPONSE_MAPPING_OPTIONS を参照してください。

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

各言語での定義

#include <windows.h>

// WS_HTTP_MESSAGE_MAPPING  (x64 40 / x86 24 バイト)
typedef struct WS_HTTP_MESSAGE_MAPPING {
    DWORD requestMappingOptions;
    DWORD responseMappingOptions;
    WS_HTTP_HEADER_MAPPING** requestHeaderMappings;
    DWORD requestHeaderMappingCount;
    WS_HTTP_HEADER_MAPPING** responseHeaderMappings;
    DWORD responseHeaderMappingCount;
} WS_HTTP_MESSAGE_MAPPING;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct WS_HTTP_MESSAGE_MAPPING
{
    public uint requestMappingOptions;
    public uint responseMappingOptions;
    public IntPtr requestHeaderMappings;
    public uint requestHeaderMappingCount;
    public IntPtr responseHeaderMappings;
    public uint responseHeaderMappingCount;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure WS_HTTP_MESSAGE_MAPPING
    Public requestMappingOptions As UInteger
    Public responseMappingOptions As UInteger
    Public requestHeaderMappings As IntPtr
    Public requestHeaderMappingCount As UInteger
    Public responseHeaderMappings As IntPtr
    Public responseHeaderMappingCount As UInteger
End Structure
import ctypes
from ctypes import wintypes

class WS_HTTP_MESSAGE_MAPPING(ctypes.Structure):
    _fields_ = [
        ("requestMappingOptions", wintypes.DWORD),
        ("responseMappingOptions", wintypes.DWORD),
        ("requestHeaderMappings", ctypes.c_void_p),
        ("requestHeaderMappingCount", wintypes.DWORD),
        ("responseHeaderMappings", ctypes.c_void_p),
        ("responseHeaderMappingCount", wintypes.DWORD),
    ]
#[repr(C)]
pub struct WS_HTTP_MESSAGE_MAPPING {
    pub requestMappingOptions: u32,
    pub responseMappingOptions: u32,
    pub requestHeaderMappings: *mut core::ffi::c_void,
    pub requestHeaderMappingCount: u32,
    pub responseHeaderMappings: *mut core::ffi::c_void,
    pub responseHeaderMappingCount: u32,
}
import "golang.org/x/sys/windows"

type WS_HTTP_MESSAGE_MAPPING struct {
	requestMappingOptions uint32
	responseMappingOptions uint32
	requestHeaderMappings uintptr
	requestHeaderMappingCount uint32
	responseHeaderMappings uintptr
	responseHeaderMappingCount uint32
}
type
  WS_HTTP_MESSAGE_MAPPING = record
    requestMappingOptions: DWORD;
    responseMappingOptions: DWORD;
    requestHeaderMappings: Pointer;
    requestHeaderMappingCount: DWORD;
    responseHeaderMappings: Pointer;
    responseHeaderMappingCount: DWORD;
  end;
const WS_HTTP_MESSAGE_MAPPING = extern struct {
    requestMappingOptions: u32,
    responseMappingOptions: u32,
    requestHeaderMappings: ?*anyopaque,
    requestHeaderMappingCount: u32,
    responseHeaderMappings: ?*anyopaque,
    responseHeaderMappingCount: u32,
};
type
  WS_HTTP_MESSAGE_MAPPING {.bycopy.} = object
    requestMappingOptions: uint32
    responseMappingOptions: uint32
    requestHeaderMappings: pointer
    requestHeaderMappingCount: uint32
    responseHeaderMappings: pointer
    responseHeaderMappingCount: uint32
struct WS_HTTP_MESSAGE_MAPPING
{
    uint requestMappingOptions;
    uint responseMappingOptions;
    void* requestHeaderMappings;
    uint requestHeaderMappingCount;
    void* responseHeaderMappings;
    uint responseHeaderMappingCount;
}

HSP用 定義

HSP3.7/3.8 は構造体機能が無いため4byte整数配列(dim)+peek/poke で操作(32/64bitでサイズ・位置が異なる場合はタブで分割)。IronHSP は NSTRUCT(#defstruct/stdim/->)で32/64bit共通。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; WS_HTTP_MESSAGE_MAPPING サイズ: 24 バイト(x86)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; requestMappingOptions : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; responseMappingOptions : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; requestHeaderMappings : WS_HTTP_HEADER_MAPPING** (+8, 4byte)  varptr(st)+8 を基点に操作(4byte:入れ子/配列)
; requestHeaderMappingCount : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; responseHeaderMappings : WS_HTTP_HEADER_MAPPING** (+16, 4byte)  varptr(st)+16 を基点に操作(4byte:入れ子/配列)
; responseHeaderMappingCount : DWORD (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; WS_HTTP_MESSAGE_MAPPING サイズ: 40 バイト(x64)
dim st, 10    ; 4byte整数×10(構造体サイズ 40 / 4 切り上げ)
; requestMappingOptions : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; responseMappingOptions : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; requestHeaderMappings : WS_HTTP_HEADER_MAPPING** (+8, 8byte)  varptr(st)+8 を基点に操作(8byte:入れ子/配列)
; requestHeaderMappingCount : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; responseHeaderMappings : WS_HTTP_HEADER_MAPPING** (+24, 8byte)  varptr(st)+24 を基点に操作(8byte:入れ子/配列)
; responseHeaderMappingCount : DWORD (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global WS_HTTP_MESSAGE_MAPPING
    #field int requestMappingOptions
    #field int responseMappingOptions
    #field intptr requestHeaderMappings
    #field int requestHeaderMappingCount
    #field intptr responseHeaderMappings
    #field int responseHeaderMappingCount
#endstruct

stdim st, WS_HTTP_MESSAGE_MAPPING        ; NSTRUCT 変数を確保
st->requestMappingOptions = 100
mes "requestMappingOptions=" + st->requestMappingOptions