ホーム › Networking.WindowsWebServices › WS_ENUM_DESCRIPTION

WS_ENUM_DESCRIPTION

構造体

サイズx64: 24 バイト / x86: 16 バイト

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

フィールド

フィールド	型	サイズ	x64	x86	説明
values	WS_ENUM_VALUE*	8/4	+0	+0	列挙型の値と、それに対応する名前の配列を指します。配列内に重複する値または重複する名前があってはなりません。
valueCount	DWORD	4	+8	+4	values 配列内の項目数です。
maxByteCount	DWORD	4	+12	+8	values 配列内で最も長い名前の長さ (UTF8 バイト単位)。
nameIndices	DWORD*	8/4	+16	+12	列挙型の値と名前を相互にマップする処理の性能を向上させることができる情報を提供する省略可能な配列です。この配列は NULL でもかまいません。その場合は O(n) の検索が使用されますが、列挙値の数が少なければ十分な場合があります。 NULL 以外の場合は、次の条件を満たしていなければなりません。 values 配列は値の昇順に並べ替えられている必要があります。 nameIndices 配列は、valueCount 個の項目を持つ配列を指します。 nameIndices 配列は、values 配列の項目を名前の昇順に並べ替えた場合のインデックスを提供します。名前は utf-8 文字列のバイト単位の比較によって並べ替える必要があります。

公式ドキュメント

WS_ENUM_TYPE と共に使用される型記述であり、必須です。列挙型の値をシリアル化および逆シリアル化する際に使用される情報を提供します。

解説(Remarks)

次の例は、列挙型の記述 (enum description) を初期化する方法を示しています。この例では nameIndices フィールドの使用方法を示していますが、このフィールドは代わりに NULL にすることもできます。

enum
{
    Red = 10,
    Green = 20,
    Blue = 30,
};

WS_XML_STRING redString = WS_XML_STRING_VALUE("red");
WS_XML_STRING greenString = WS_XML_STRING_VALUE("green");
WS_XML_STRING blueString = WS_XML_STRING_VALUE("blue");

// sorted by ascending numeric value
WS_ENUM_VALUE valueArray[3] =
{
    { Red, &redString },
    { Green, &greenString },
    { Blue, &blueString },
};

// sorted by ascending name
ULONG nameIndices[3] =
{
    2, // "blue"
    1, // "green"
    0, // "red"
};

WS_ENUM_DESCRIPTION enumDescription;
enumDescription.maxByteCount = 5; // "green"
enumDescription.values = valueArray;
enumDescription.valueCount = 3;
enumDescription.nameIndices = nameIndices;

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

各言語での定義

#include <windows.h>

// WS_ENUM_DESCRIPTION  (x64 24 / x86 16 バイト)
typedef struct WS_ENUM_DESCRIPTION {
    WS_ENUM_VALUE* values;
    DWORD valueCount;
    DWORD maxByteCount;
    DWORD* nameIndices;
} WS_ENUM_DESCRIPTION;

using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct WS_ENUM_DESCRIPTION
{
    public IntPtr values;
    public uint valueCount;
    public uint maxByteCount;
    public IntPtr nameIndices;
}

Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure WS_ENUM_DESCRIPTION
    Public values As IntPtr
    Public valueCount As UInteger
    Public maxByteCount As UInteger
    Public nameIndices As IntPtr
End Structure

import ctypes
from ctypes import wintypes

class WS_ENUM_DESCRIPTION(ctypes.Structure):
    _fields_ = [
        ("values", ctypes.c_void_p),
        ("valueCount", wintypes.DWORD),
        ("maxByteCount", wintypes.DWORD),
        ("nameIndices", ctypes.c_void_p),
    ]

#[repr(C)]
pub struct WS_ENUM_DESCRIPTION {
    pub values: *mut core::ffi::c_void,
    pub valueCount: u32,
    pub maxByteCount: u32,
    pub nameIndices: *mut core::ffi::c_void,
}

import "golang.org/x/sys/windows"

type WS_ENUM_DESCRIPTION struct {
	values uintptr
	valueCount uint32
	maxByteCount uint32
	nameIndices uintptr
}

type
  WS_ENUM_DESCRIPTION = record
    values: Pointer;
    valueCount: DWORD;
    maxByteCount: DWORD;
    nameIndices: Pointer;
  end;

const WS_ENUM_DESCRIPTION = extern struct {
    values: ?*anyopaque,
    valueCount: u32,
    maxByteCount: u32,
    nameIndices: ?*anyopaque,
};

type
  WS_ENUM_DESCRIPTION {.bycopy.} = object
    values: pointer
    valueCount: uint32
    maxByteCount: uint32
    nameIndices: pointer

struct WS_ENUM_DESCRIPTION
{
    void* values;
    uint valueCount;
    uint maxByteCount;
    void* nameIndices;
}

HSP用定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; WS_ENUM_DESCRIPTION サイズ: 16 バイト(x86)
dim st, 4    ; 4byte整数×4(構造体サイズ 16 / 4 切り上げ)
; values : WS_ENUM_VALUE* (+0, 4byte)  varptr(st)+0 を基点に操作(4byte:入れ子/配列)
; valueCount : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; maxByteCount : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; nameIndices : DWORD* (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; WS_ENUM_DESCRIPTION サイズ: 24 バイト(x64)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; values : WS_ENUM_VALUE* (+0, 8byte)  varptr(st)+0 を基点に操作(8byte:入れ子/配列)
; valueCount : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; maxByteCount : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; nameIndices : DWORD* (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global WS_ENUM_DESCRIPTION
    #field intptr values
    #field int valueCount
    #field int maxByteCount
    #field intptr nameIndices
#endstruct

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