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

CLUSTER_BATCH_COMMAND

構造体
サイズx64: 32 バイト / x86: 20 バイト

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

フィールド

フィールドサイズx64x86説明
CommandCLUSTER_REG_COMMAND4+0+0

この API でサポートされるコマンドで、 CLUSTER_REG_COMMAND 列挙型から選択します。指定できるコマンドは次のとおりです。

CLUSREG_SET_VALUE (1)

最後に実行された CLUSREG_CREATE_KEY コマンドを基準として、または(指定されていない場合) ClusterRegCreateBatch 関数に渡されたキーを基準として、値を設定します。

CLUSREG_CREATE_KEY (2)

指定されたクラスターレジストリキーが存在しない場合は作成し、存在する場合は既存のキーを開きます。

CLUSREG_DELETE_KEY (3)

キーを、すべての値と入れ子のサブキーごと削除します。CLUS_REG_CREATE_KEY が追加されるまで、値を操作するコマンドを CLUSREG_DELETE_KEY の後に続けることはできません。

CLUSREG_DELETE_VALUE (4)

最後に実行された CLUSREG_CREATE_KEY コマンドを基準として、または( 指定されていない場合) ClusterRegCreateBatch 関数に渡されたキーを基準として、値を削除します。

CLUSREG_VALUE_DELETED (6)

特定のクラスターレジストリ値が削除されたか、そのクラスターレジストリ値のデータが変更されたかを示します。このコマンドは、バッチ更新通知ポート経由でのみ返されます。

dwOptionsDWORD4+4+4Command メンバーが CLUSREG_SET_VALUE コマンドまたは CLUSREG_DELETE_VALUE コマンドを取る場合、このメンバーは標準の レジストリ値の型 のいずれかを取ります。そうでない場合、 Command は 0 に設定されます。
wzNameLPWSTR8/4+8+8Command で発行されたコマンドに対応する値またはキーの名前です。
lpDataBYTE*8/4+16+12Command で発行されたコマンドに対応するデータへのポインターです。このメンバーの値は、 CLUSREG_SET_VALUE コマンドと CLUSREG_DELETE_VALUE コマンドを除くすべてのコマンドで NULL です。
cbDataDWORD4+24+16Command で発行されたコマンドに対応するデータのサイズ(バイト単位)です。このメンバーの値は、CLUSREG_SET_VALUE コマンドと CLUSREG_DELETE_VALUE コマンドを除くすべてのコマンドで 0 です。

公式ドキュメント

現在のバッチコマンドのデータが ClusterRegBatchReadCommand 関数に送られる順序を表します。 CLUSTER_BATCH_COMMAND 構造体の値は、 ClusterRegBatchAddCommand 関数に渡されるパラメーターと同一です。唯一の違いは、CLUSREG_DELETE_VALUE の場合に dwOptionslpDatacbData の各メンバーが、CLUSREG_SET_VALUE コマンドと同様に、削除される値に設定される点です。

解説(Remarks)

wzName ポインターと lpData ポインターは、 ClusterRegBatchCloseNotification 関数によってバッチ通知が閉じられるまで有効です。

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

各言語での定義

#include <windows.h>

// CLUSTER_BATCH_COMMAND  (x64 32 / x86 20 バイト)
typedef struct CLUSTER_BATCH_COMMAND {
    CLUSTER_REG_COMMAND Command;
    DWORD dwOptions;
    LPWSTR wzName;
    BYTE* lpData;
    DWORD cbData;
} CLUSTER_BATCH_COMMAND;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct CLUSTER_BATCH_COMMAND
{
    public int Command;
    public uint dwOptions;
    public IntPtr wzName;
    public IntPtr lpData;
    public uint cbData;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure CLUSTER_BATCH_COMMAND
    Public Command As Integer
    Public dwOptions As UInteger
    Public wzName As IntPtr
    Public lpData As IntPtr
    Public cbData As UInteger
End Structure
import ctypes
from ctypes import wintypes

class CLUSTER_BATCH_COMMAND(ctypes.Structure):
    _fields_ = [
        ("Command", ctypes.c_int),
        ("dwOptions", wintypes.DWORD),
        ("wzName", ctypes.c_void_p),
        ("lpData", ctypes.c_void_p),
        ("cbData", wintypes.DWORD),
    ]
#[repr(C)]
pub struct CLUSTER_BATCH_COMMAND {
    pub Command: i32,
    pub dwOptions: u32,
    pub wzName: *mut core::ffi::c_void,
    pub lpData: *mut core::ffi::c_void,
    pub cbData: u32,
}
import "golang.org/x/sys/windows"

type CLUSTER_BATCH_COMMAND struct {
	Command int32
	dwOptions uint32
	wzName uintptr
	lpData uintptr
	cbData uint32
}
type
  CLUSTER_BATCH_COMMAND = record
    Command: Integer;
    dwOptions: DWORD;
    wzName: Pointer;
    lpData: Pointer;
    cbData: DWORD;
  end;
const CLUSTER_BATCH_COMMAND = extern struct {
    Command: i32,
    dwOptions: u32,
    wzName: ?*anyopaque,
    lpData: ?*anyopaque,
    cbData: u32,
};
type
  CLUSTER_BATCH_COMMAND {.bycopy.} = object
    Command: int32
    dwOptions: uint32
    wzName: pointer
    lpData: pointer
    cbData: uint32
struct CLUSTER_BATCH_COMMAND
{
    int Command;
    uint dwOptions;
    void* wzName;
    void* lpData;
    uint cbData;
}

HSP用 定義

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

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

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