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

WS_CUSTOM_TYPE_DESCRIPTION

構造体
📘 Microsoft Learn (日本語) · English
サイズx64: 40 バイト / x86: 24 バイト

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

フィールド

フィールド型サイズx64x86説明
sizeDWORD4+0+0カスタム型のサイズ (バイト単位)。
alignmentDWORD4+4+4カスタム型のアラインメント要件。1 から 8 までの 2 の べき乗でなければなりません。
readCallbackWS_READ_TYPE_CALLBACK8/4+8+8型の読み取りのために呼び出されるコールバックへのポインター。
writeCallbackWS_WRITE_TYPE_CALLBACK8/4+16+12型の書き込みのために呼び出されるコールバックへのポインター。
descriptionDatavoid*8/4+24+16

型に固有の、ユーザー定義の追加データを指すために使用できます。省略可能であり、NULL でもかまいません。

このデータへのポインターは、WS_READ_TYPE_CALLBACK および WS_WRITE_TYPE_CALLBACK に渡されます。これにより、 コールバックはその特定の用途に固有の情報にアクセスできます。

isDefaultValueCallbackWS_IS_DEFAULT_VALUE_CALLBACK8/4+32+20値が既定値かどうかを判定するコールバック関数。NULL可。

公式ドキュメント

C のデータ型と XML 要素との間のカスタムマッピングを表します。実際の読み取りと 書き込みは、ユーザー定義のコールバックを呼び出して行われます。

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

各言語での定義

#include <windows.h>

// WS_CUSTOM_TYPE_DESCRIPTION  (x64 40 / x86 24 バイト)
typedef struct WS_CUSTOM_TYPE_DESCRIPTION {
    DWORD size;
    DWORD alignment;
    WS_READ_TYPE_CALLBACK readCallback;
    WS_WRITE_TYPE_CALLBACK writeCallback;
    void* descriptionData;
    WS_IS_DEFAULT_VALUE_CALLBACK isDefaultValueCallback;
} WS_CUSTOM_TYPE_DESCRIPTION;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct WS_CUSTOM_TYPE_DESCRIPTION
{
    public uint size;
    public uint alignment;
    public IntPtr readCallback;
    public IntPtr writeCallback;
    public IntPtr descriptionData;
    public IntPtr isDefaultValueCallback;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure WS_CUSTOM_TYPE_DESCRIPTION
    Public size As UInteger
    Public alignment As UInteger
    Public readCallback As IntPtr
    Public writeCallback As IntPtr
    Public descriptionData As IntPtr
    Public isDefaultValueCallback As IntPtr
End Structure
import ctypes
from ctypes import wintypes

class WS_CUSTOM_TYPE_DESCRIPTION(ctypes.Structure):
    _fields_ = [
        ("size", wintypes.DWORD),
        ("alignment", wintypes.DWORD),
        ("readCallback", ctypes.c_void_p),
        ("writeCallback", ctypes.c_void_p),
        ("descriptionData", ctypes.c_void_p),
        ("isDefaultValueCallback", ctypes.c_void_p),
    ]
#[repr(C)]
pub struct WS_CUSTOM_TYPE_DESCRIPTION {
    pub size: u32,
    pub alignment: u32,
    pub readCallback: *mut core::ffi::c_void,
    pub writeCallback: *mut core::ffi::c_void,
    pub descriptionData: *mut core::ffi::c_void,
    pub isDefaultValueCallback: *mut core::ffi::c_void,
}
import "golang.org/x/sys/windows"

type WS_CUSTOM_TYPE_DESCRIPTION struct {
	size uint32
	alignment uint32
	readCallback uintptr
	writeCallback uintptr
	descriptionData uintptr
	isDefaultValueCallback uintptr
}
type
  WS_CUSTOM_TYPE_DESCRIPTION = record
    size: DWORD;
    alignment: DWORD;
    readCallback: Pointer;
    writeCallback: Pointer;
    descriptionData: Pointer;
    isDefaultValueCallback: Pointer;
  end;
const WS_CUSTOM_TYPE_DESCRIPTION = extern struct {
    size: u32,
    alignment: u32,
    readCallback: ?*anyopaque,
    writeCallback: ?*anyopaque,
    descriptionData: ?*anyopaque,
    isDefaultValueCallback: ?*anyopaque,
};
type
  WS_CUSTOM_TYPE_DESCRIPTION {.bycopy.} = object
    size: uint32
    alignment: uint32
    readCallback: pointer
    writeCallback: pointer
    descriptionData: pointer
    isDefaultValueCallback: pointer
struct WS_CUSTOM_TYPE_DESCRIPTION
{
    uint size;
    uint alignment;
    void* readCallback;
    void* writeCallback;
    void* descriptionData;
    void* isDefaultValueCallback;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; WS_CUSTOM_TYPE_DESCRIPTION サイズ: 24 バイト(x86)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; size : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; alignment : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; readCallback : WS_READ_TYPE_CALLBACK (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; writeCallback : WS_WRITE_TYPE_CALLBACK (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; descriptionData : void* (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; isDefaultValueCallback : WS_IS_DEFAULT_VALUE_CALLBACK (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; WS_CUSTOM_TYPE_DESCRIPTION サイズ: 40 バイト(x64)
dim st, 10    ; 4byte整数×10(構造体サイズ 40 / 4 切り上げ)
; size : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; alignment : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; readCallback : WS_READ_TYPE_CALLBACK (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; writeCallback : WS_WRITE_TYPE_CALLBACK (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; descriptionData : void* (+24, 8byte)  qpoke st,24,値 / qpeek(st,24)  ※IronHSPのみ。3.7/3.8は lpoke st,24,下位 : lpoke st,28,上位
; isDefaultValueCallback : WS_IS_DEFAULT_VALUE_CALLBACK (+32, 8byte)  qpoke st,32,値 / qpeek(st,32)  ※IronHSPのみ。3.7/3.8は lpoke st,32,下位 : lpoke st,36,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global WS_CUSTOM_TYPE_DESCRIPTION
    #field int size
    #field int alignment
    #field intptr readCallback
    #field intptr writeCallback
    #field intptr descriptionData
    #field intptr isDefaultValueCallback
#endstruct

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