VARSTRING

構造体

サイズx64: 24 バイト / x86: 24 バイトパッキング1

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

フィールド

フィールド	型	サイズ	x64	x86	説明
dwTotalSize	DWORD	4	+0	+0	この構造体に割り当てられた合計サイズ (バイト単位)。
dwNeededSize	DWORD	4	+4	+4	返されるすべての情報を保持するために必要な、この構造体のサイズ (バイト単位)。
dwUsedSize	DWORD	4	+8	+8	この構造体のうち、有用な情報が格納されている部分のサイズ (バイト単位)。
dwStringFormat	DWORD	4	+12	+12	文字列の形式。このメンバーは STRINGFORMAT_ Constants のいずれかを使用します。
dwStringSize	DWORD	4	+16	+16	null 終端文字を含む、文字列情報のサイズ (バイト単位)。
dwStringOffset	DWORD	4	+20	+20	構造体の先頭から、文字列情報を格納する可変サイズのデバイスフィールドまでのオフセット。このフィールドのサイズは dwStringSize で指定されます。

公式ドキュメント

VARSTRING 構造体は、可変サイズの文字列を返すために使用されます。line デバイスクラスと phone デバイスクラスの両方で使用されます。

解説(Remarks)

拡張性はありません。

可変構造体で文字列を返せない場合、dwStringSize メンバーと dwStringOffset メンバーは次のいずれかの方法で設定されます。

dwStringSize メンバーと dwStringOffset メンバーの両方が 0 に設定されます。
dwStringOffset が 0 以外で、dwStringSize が 0 です。
dwStringOffset が 0 以外、dwStringSize が 1 で、指定されたオフセットにあるバイトが 0 です。

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

各言語での定義

#include <windows.h>

// VARSTRING  (x64 24 / x86 24 バイト)
#pragma pack(push, 1)
typedef struct VARSTRING {
    DWORD dwTotalSize;
    DWORD dwNeededSize;
    DWORD dwUsedSize;
    DWORD dwStringFormat;
    DWORD dwStringSize;
    DWORD dwStringOffset;
} VARSTRING;
#pragma pack(pop)

using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, Pack = 1, CharSet = CharSet.Unicode)]
public struct VARSTRING
{
    public uint dwTotalSize;
    public uint dwNeededSize;
    public uint dwUsedSize;
    public uint dwStringFormat;
    public uint dwStringSize;
    public uint dwStringOffset;
}

Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, Pack:=1, CharSet:=CharSet.Unicode)>
Public Structure VARSTRING
    Public dwTotalSize As UInteger
    Public dwNeededSize As UInteger
    Public dwUsedSize As UInteger
    Public dwStringFormat As UInteger
    Public dwStringSize As UInteger
    Public dwStringOffset As UInteger
End Structure

import ctypes
from ctypes import wintypes

class VARSTRING(ctypes.Structure):
    _pack_ = 1
    _fields_ = [
        ("dwTotalSize", wintypes.DWORD),
        ("dwNeededSize", wintypes.DWORD),
        ("dwUsedSize", wintypes.DWORD),
        ("dwStringFormat", wintypes.DWORD),
        ("dwStringSize", wintypes.DWORD),
        ("dwStringOffset", wintypes.DWORD),
    ]

#[repr(C, packed(1))]
pub struct VARSTRING {
    pub dwTotalSize: u32,
    pub dwNeededSize: u32,
    pub dwUsedSize: u32,
    pub dwStringFormat: u32,
    pub dwStringSize: u32,
    pub dwStringOffset: u32,
}

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

type VARSTRING struct {
	dwTotalSize uint32
	dwNeededSize uint32
	dwUsedSize uint32
	dwStringFormat uint32
	dwStringSize uint32
	dwStringOffset uint32
}

type
  VARSTRING = packed record
    dwTotalSize: DWORD;
    dwNeededSize: DWORD;
    dwUsedSize: DWORD;
    dwStringFormat: DWORD;
    dwStringSize: DWORD;
    dwStringOffset: DWORD;
  end;

const VARSTRING = extern struct {
    dwTotalSize: u32,
    dwNeededSize: u32,
    dwUsedSize: u32,
    dwStringFormat: u32,
    dwStringSize: u32,
    dwStringOffset: u32,
};

type
  VARSTRING {.packed.} = object
    dwTotalSize: uint32
    dwNeededSize: uint32
    dwUsedSize: uint32
    dwStringFormat: uint32
    dwStringSize: uint32
    dwStringOffset: uint32

align(1)
struct VARSTRING
{
    uint dwTotalSize;
    uint dwNeededSize;
    uint dwUsedSize;
    uint dwStringFormat;
    uint dwStringSize;
    uint dwStringOffset;
}

HSP用定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; VARSTRING サイズ: 24 バイト(x64)
dim st, 6    ; 4byte整数×6(構造体サイズ 24 / 4 切り上げ)
; dwTotalSize : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; dwNeededSize : DWORD (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; dwUsedSize : DWORD (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; dwStringFormat : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; dwStringSize : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; dwStringOffset : DWORD (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。

; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global VARSTRING, pack=1
    #field int dwTotalSize
    #field int dwNeededSize
    #field int dwUsedSize
    #field int dwStringFormat
    #field int dwStringSize
    #field int dwStringOffset
#endstruct

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