Win32 API 日本語リファレンス
ホームStorage.DistributedFileSystem › DFS_INFO_2

DFS_INFO_2

構造体
サイズx64: 24 バイト / x86: 16 バイト

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

フィールド

フィールドサイズx64x86説明
EntryPathLPWSTR8/4+0+0

DFS のルートまたはリンクの汎用名前付け規則 (UNC) パスを指定する、null で終わる Unicode 文字列へのポインターです。

リンクの場合、文字列は 2 つの形式のいずれかを取ります。1 つ目の形式は次のとおりです。

\\ServerName\DfsName\link_path

ここで ServerName はスタンドアロン DFS 名前空間をホストするルート ターゲット サーバーの名前、DfsName は DFS 名前空間の名前、link_path は DFS リンクです。

2 つ目の形式は次のとおりです。

\\DomainName\DomDfsname\link_path

ここで DomainName はドメインベースの DFS 名前空間をホストするドメインの名前、DomDfsname は DFS 名前空間の名前、link_path は DFS リンクです。

ルートの場合、文字列は次の 2 つの形式のいずれかを取ります。

\\ServerName\DfsName

または

\\DomainName\DomDfsname

これらの名前の値は、前述の説明と同じです。

CommentLPWSTR8/4+8+4DFS のルートまたはリンクに関連付けられたコメントを格納する、null で終わる Unicode 文字列へのポインターです。
StateDWORD4+16+8

DFS のルートまたはリンクを表すビット フラグのセットを指定します。DFS_VOLUME_STATE フラグが 1 つ設定され、DFS_VOLUME_FLAVOR フラグが 1 つ設定されます。DFS 名前空間のフレーバーを取り出すには DFS_VOLUME_FLAVORS ビットマスク (0x00000300) を使用し、このメンバーから DFS のルートまたはリンクの状態を取り出すには DFS_VOLUME_STATES ビットマスク (0x0000000F) を使用しなければなりません。フラグの解釈を示す例については、後述の「解説」セクションを参照してください。

DFS_VOLUME_STATE_OK (0x00000001)

指定された DFS のルートまたはリンクは正常な状態です。

DFS_VOLUME_STATE_INCONSISTENT (0x00000002)

内部の DFS データベースが、指定された DFS のルートまたはリンクと矛盾しています。不整合の修復は失敗しました。

DFS_VOLUME_STATE_OFFLINE (0x00000003)

指定された DFS のルートまたはリンクはオフラインであるか、利用できません。

DFS_VOLUME_STATE_ONLINE (0x00000004)

指定された DFS のルートまたはリンクは利用可能です。

DFS_VOLUME_FLAVOR_STANDALONE (0x00000100)

ルートがスタンドアロン DFS 名前空間に関連付けられている場合、システムはこのフラグを設定します。

DFS_VOLUME_FLAVOR_AD_BLOB (0x00000200)

ルートがドメインベースの DFS 名前空間に関連付けられている場合、システムはこのフラグを設定します。

NumberOfStoragesDWORD4+20+12DFS ターゲットの数を指定します。

公式ドキュメント

分散ファイル システム (DFS) のルートまたはリンクに関する情報を格納します。この構造体には、ルートまたはリンクの名前、 状態、および DFS ターゲットの数が含まれます。この構造体は、 NetDfsEnumNetDfsGetClientInfo、および NetDfsGetInfo の各関数と FSCTL_DFS_GET_PKT_ENTRY_STATE 制御コードでのみ 使用されます。

解説(Remarks)

DFS 関数は、DFS のルートまたはリンクに関する情報を取得するために DFS_INFO_2 構造体を使用します。

次に、State メンバーで返される可能性のあるフラグの解釈を示す例を 示します。

FlavorBits = (Flags & DFS_VOLUME_FLAVORS)
If (FlavorBits == DFS_VOLUME_FLAVOR_STANDALONE)   // namespace is stand-alone DFS
else if (FlavorBits == DFS_VOLUME_FLAVOR_AD_BLOB) // namespace is AD blob
else                                              // unknown flavor

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

各言語での定義

#include <windows.h>

// DFS_INFO_2  (x64 24 / x86 16 バイト)
typedef struct DFS_INFO_2 {
    LPWSTR EntryPath;
    LPWSTR Comment;
    DWORD State;
    DWORD NumberOfStorages;
} DFS_INFO_2;
using System;
using System.Runtime.InteropServices;

[StructLayout(LayoutKind.Sequential, CharSet = CharSet.Unicode)]
public struct DFS_INFO_2
{
    public IntPtr EntryPath;
    public IntPtr Comment;
    public uint State;
    public uint NumberOfStorages;
}
Imports System.Runtime.InteropServices

<StructLayout(LayoutKind.Sequential, CharSet:=CharSet.Unicode)>
Public Structure DFS_INFO_2
    Public EntryPath As IntPtr
    Public Comment As IntPtr
    Public State As UInteger
    Public NumberOfStorages As UInteger
End Structure
import ctypes
from ctypes import wintypes

class DFS_INFO_2(ctypes.Structure):
    _fields_ = [
        ("EntryPath", ctypes.c_void_p),
        ("Comment", ctypes.c_void_p),
        ("State", wintypes.DWORD),
        ("NumberOfStorages", wintypes.DWORD),
    ]
#[repr(C)]
pub struct DFS_INFO_2 {
    pub EntryPath: *mut core::ffi::c_void,
    pub Comment: *mut core::ffi::c_void,
    pub State: u32,
    pub NumberOfStorages: u32,
}
import "golang.org/x/sys/windows"

type DFS_INFO_2 struct {
	EntryPath uintptr
	Comment uintptr
	State uint32
	NumberOfStorages uint32
}
type
  DFS_INFO_2 = record
    EntryPath: Pointer;
    Comment: Pointer;
    State: DWORD;
    NumberOfStorages: DWORD;
  end;
const DFS_INFO_2 = extern struct {
    EntryPath: ?*anyopaque,
    Comment: ?*anyopaque,
    State: u32,
    NumberOfStorages: u32,
};
type
  DFS_INFO_2 {.bycopy.} = object
    EntryPath: pointer
    Comment: pointer
    State: uint32
    NumberOfStorages: uint32
struct DFS_INFO_2
{
    void* EntryPath;
    void* Comment;
    uint State;
    uint NumberOfStorages;
}

HSP用 定義

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

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

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