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

DSBITEMW

構造体
サイズx64: 688 バイト / x86: 676 バイト

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

フィールド

フィールドサイズx64x86説明
cbStructDWORD4+0+0構造体のサイズをバイト単位で格納します。
pszADsPathLPWSTR8/4+8+4項目の ADsPath を格納する、null で終わる Unicode 文字列へのポインターです。
pszClassLPWSTR8/4+16+8項目のオブジェクト クラス名を格納する、null で終わる Unicode 文字列へのポインターです。
dwMaskDWORD4+24+12

構造体のどのメンバーが有効なデータを格納しているかを示すフラグのセットを格納します。0、または次の値の 1 つ以上の組み合わせを指定できます。

DSBF_DISPLAYNAME

szDisplayName メンバーが有効なデータを格納しています。

DSBF_ICONLOCATION

szIconLocation メンバーと iIconResID メンバーが有効なデータを格納しています。

DSBF_STATE

dwState メンバーと dwStateMask メンバーが有効なデータを格納しています。

dwStateDWORD4+28+16

項目の状態を示すフラグのセットを格納します。0、または次の値の 1 つ以上の組み合わせを指定できます。

DSBS_CHECKED

このフラグが設定されている場合、項目は選択されています。設定されていない場合、項目は選択されていません。このフラグは現在サポートされていません。

DSBS_HIDDEN

このフラグが設定されている場合、項目は非表示です。設定されていない場合、項目は表示されます。

DSBS_ROOT

このフラグが設定されている場合、項目はルート項目です。設定されていない場合、項目はルート項目ではありません。

dwStateMaskDWORD4+32+20

dwState メンバーのどのフラグが有効なデータを格納しているかを示すフラグのセットを格納します。0、または次の値の 1 つ以上の組み合わせを指定できます。たとえば、dwStateMaskDSBS_HIDDEN フラグが設定されていて、dwStateDSBS_HIDDEN フラグが設定されていない場合、その項目は表示されます。dwStateMaskDSBS_HIDDEN フラグが設定されていない場合、dwStateDSBS_HIDDEN フラグは無視されなければなりません。

DSBS_CHECKED

dwState メンバーの DSBS_CHECKED フラグが有効なデータを格納しています。

DSBS_HIDDEN

dwState メンバーの DSBS_HIDDEN フラグが有効なデータを格納しています。

DSBS_ROOT

dwState メンバーの DSBS_ROOT フラグが有効なデータを格納しています。

szDisplayNameWCHAR128+36+24項目の表示名を格納する、null で終わる文字列へのポインターです。項目の表示名は、新しい表示名をこのメンバーにコピーし、dwMask メンバーに DSBF_DISPLAYNAME フラグを設定して、BFFCallBack から 0 以外の値を返すことで変更できます。
szIconLocationWCHAR520+164+152項目に表示するアイコンを含む .exe、.dll、または .ico ファイルの名前を格納する、null で終わる文字列へのポインターです。ExtractIcon 関数に渡すことができるファイルの種類であれば指定できます。このアイコンのインデックスは iIconResID で指定します。項目に表示されるアイコンを変更するには、アイコンのソース ファイル名をこのメンバーにコピーし、iIconResID にアイコンの 0 から始まるインデックスを設定し、dwMask メンバーに DSBF_ICONLOCATION フラグを設定して、BFFCallBack から 0 以外の値を返します。
iIconResIDINT4+684+672

項目に表示するアイコンの 0 から始まるインデックスを格納します。

注意 これはアイコンのリソース識別子ではありません。
- dwMask.DSBF_DISPLAYNAME

szDisplayName メンバーが有効なデータを格納しています。

- dwMask.DSBF_ICONLOCATION

szIconLocation メンバーと iIconResID メンバーが有効なデータを格納しています。

- dwMask.DSBF_STATE

dwState メンバーと dwStateMask メンバーが有効なデータを格納しています。

- dwState.DSBS_CHECKED

このフラグが設定されている場合、項目は選択されています。設定されていない場合、項目は選択されていません。このフラグは現在サポートされていません。

- dwState.DSBS_HIDDEN

このフラグが設定されている場合、項目は非表示です。設定されていない場合、項目は表示されます。

- dwState.DSBS_ROOT

このフラグが設定されている場合、項目はルート項目です。設定されていない場合、項目はルート項目ではありません。

- dwStateMask.DSBS_CHECKED

dwState メンバーの DSBS_CHECKED フラグが有効なデータを格納しています。

- dwStateMask.DSBS_HIDDEN

dwState メンバーの DSBS_HIDDEN フラグが有効なデータを格納しています。

- dwStateMask.DSBS_ROOT

dwState メンバーの DSBS_ROOT フラグが有効なデータを格納しています。

公式ドキュメント

DSBITEM 構造体は、Active Directory コンテナー ブラウザー ダイアログ ボックス内の項目に関するデータを格納します。この構造体は、DSBM_QUERYINSERT 通知とともに BFFCallBack コールバック関数に渡されます。コンテナー ブラウザー ダイアログ ボックスは、DsBrowseForContainer 関数によって作成されます。

解説(Remarks)

メモ

dsclient.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして DSBITEM を定義しています。エンコード中立のエイリアスと、エンコード中立でないコードを混在させて使用すると、不一致が生じ、コンパイル エラーや実行時エラーの原因となることがあります。詳細については、「Conventions for Function Prototypes」を参照してください。

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

各言語での定義

#include <windows.h>

// DSBITEMW  (x64 688 / x86 676 バイト)
typedef struct DSBITEMW {
    DWORD cbStruct;
    LPWSTR pszADsPath;
    LPWSTR pszClass;
    DWORD dwMask;
    DWORD dwState;
    DWORD dwStateMask;
    WCHAR szDisplayName[64];
    WCHAR szIconLocation[260];
    INT iIconResID;
} DSBITEMW;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct DSBITEMW
{
    public uint cbStruct;
    public IntPtr pszADsPath;
    public IntPtr pszClass;
    public uint dwMask;
    public uint dwState;
    public uint dwStateMask;
    [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 64)] public string szDisplayName;
    [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 260)] public string szIconLocation;
    public int iIconResID;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure DSBITEMW
    Public cbStruct As UInteger
    Public pszADsPath As IntPtr
    Public pszClass As IntPtr
    Public dwMask As UInteger
    Public dwState As UInteger
    Public dwStateMask As UInteger
    <MarshalAs(UnmanagedType.ByValTStr, SizeConst:=64)> Public szDisplayName As String
    <MarshalAs(UnmanagedType.ByValTStr, SizeConst:=260)> Public szIconLocation As String
    Public iIconResID As Integer
End Structure
import ctypes
from ctypes import wintypes

class DSBITEMW(ctypes.Structure):
    _fields_ = [
        ("cbStruct", wintypes.DWORD),
        ("pszADsPath", ctypes.c_void_p),
        ("pszClass", ctypes.c_void_p),
        ("dwMask", wintypes.DWORD),
        ("dwState", wintypes.DWORD),
        ("dwStateMask", wintypes.DWORD),
        ("szDisplayName", ctypes.c_wchar * 64),
        ("szIconLocation", ctypes.c_wchar * 260),
        ("iIconResID", ctypes.c_int),
    ]
#[repr(C)]
pub struct DSBITEMW {
    pub cbStruct: u32,
    pub pszADsPath: *mut core::ffi::c_void,
    pub pszClass: *mut core::ffi::c_void,
    pub dwMask: u32,
    pub dwState: u32,
    pub dwStateMask: u32,
    pub szDisplayName: [u16; 64],
    pub szIconLocation: [u16; 260],
    pub iIconResID: i32,
}
import "golang.org/x/sys/windows"

type DSBITEMW struct {
	cbStruct uint32
	pszADsPath uintptr
	pszClass uintptr
	dwMask uint32
	dwState uint32
	dwStateMask uint32
	szDisplayName [64]uint16
	szIconLocation [260]uint16
	iIconResID int32
}
type
  DSBITEMW = record
    cbStruct: DWORD;
    pszADsPath: Pointer;
    pszClass: Pointer;
    dwMask: DWORD;
    dwState: DWORD;
    dwStateMask: DWORD;
    szDisplayName: array[0..63] of WideChar;
    szIconLocation: array[0..259] of WideChar;
    iIconResID: Integer;
  end;
const DSBITEMW = extern struct {
    cbStruct: u32,
    pszADsPath: ?*anyopaque,
    pszClass: ?*anyopaque,
    dwMask: u32,
    dwState: u32,
    dwStateMask: u32,
    szDisplayName: [64]u16,
    szIconLocation: [260]u16,
    iIconResID: i32,
};
type
  DSBITEMW {.bycopy.} = object
    cbStruct: uint32
    pszADsPath: pointer
    pszClass: pointer
    dwMask: uint32
    dwState: uint32
    dwStateMask: uint32
    szDisplayName: array[64, uint16]
    szIconLocation: array[260, uint16]
    iIconResID: int32
struct DSBITEMW
{
    uint cbStruct;
    void* pszADsPath;
    void* pszClass;
    uint dwMask;
    uint dwState;
    uint dwStateMask;
    wchar[64] szDisplayName;
    wchar[260] szIconLocation;
    int iIconResID;
}

HSP用 定義

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

; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x86 レイアウト)
; DSBITEMW サイズ: 676 バイト(x86)
dim st, 169    ; 4byte整数×169(構造体サイズ 676 / 4 切り上げ)
; cbStruct : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; pszADsPath : LPWSTR (+4, 4byte)  st.1 = 値  /  値 = st.1   (lpoke/lpeek も可)
; pszClass : LPWSTR (+8, 4byte)  st.2 = 値  /  値 = st.2   (lpoke/lpeek も可)
; dwMask : DWORD (+12, 4byte)  st.3 = 値  /  値 = st.3   (lpoke/lpeek も可)
; dwState : DWORD (+16, 4byte)  st.4 = 値  /  値 = st.4   (lpoke/lpeek も可)
; dwStateMask : DWORD (+20, 4byte)  st.5 = 値  /  値 = st.5   (lpoke/lpeek も可)
; szDisplayName : WCHAR (+24, 128byte)  varptr(st)+24 を基点に操作(128byte:入れ子/配列)
; szIconLocation : WCHAR (+152, 520byte)  varptr(st)+152 を基点に操作(520byte:入れ子/配列)
; iIconResID : INT (+672, 4byte)  st.168 = 値  /  値 = st.168   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; HSP3.7/3.8 は構造体機能が無いため、4byte整数の配列変数で操作します。(x64 レイアウト)
; DSBITEMW サイズ: 688 バイト(x64)
dim st, 172    ; 4byte整数×172(構造体サイズ 688 / 4 切り上げ)
; cbStruct : DWORD (+0, 4byte)  st.0 = 値  /  値 = st.0   (lpoke/lpeek も可)
; pszADsPath : LPWSTR (+8, 8byte)  qpoke st,8,値 / qpeek(st,8)  ※IronHSPのみ。3.7/3.8は lpoke st,8,下位 : lpoke st,12,上位
; pszClass : LPWSTR (+16, 8byte)  qpoke st,16,値 / qpeek(st,16)  ※IronHSPのみ。3.7/3.8は lpoke st,16,下位 : lpoke st,20,上位
; dwMask : DWORD (+24, 4byte)  st.6 = 値  /  値 = st.6   (lpoke/lpeek も可)
; dwState : DWORD (+28, 4byte)  st.7 = 値  /  値 = st.7   (lpoke/lpeek も可)
; dwStateMask : DWORD (+32, 4byte)  st.8 = 値  /  値 = st.8   (lpoke/lpeek も可)
; szDisplayName : WCHAR (+36, 128byte)  varptr(st)+36 を基点に操作(128byte:入れ子/配列)
; szIconLocation : WCHAR (+164, 520byte)  varptr(st)+164 を基点に操作(520byte:入れ子/配列)
; iIconResID : INT (+684, 4byte)  st.171 = 値  /  値 = st.171   (lpoke/lpeek も可)
; ※4byte境界の整数は添字 st.N(N=オフセット/4)で読み書き可。それ以外は peek/poke 系を使用。
; IronHSP は NSTRUCT(構造体)をサポート。32bit/64bit どちらでも同じコードで動作します。
#defstruct global DSBITEMW
    #field int cbStruct
    #field intptr pszADsPath
    #field intptr pszClass
    #field int dwMask
    #field int dwState
    #field int dwStateMask
    #field wchar szDisplayName 64
    #field wchar szIconLocation 260
    #field int iIconResID
#endstruct

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