2.2.3.5 DFS_INFO_5

The DFS_INFO_5 structure contains information for a DFS root or a DFS link.

The DFS_INFO_5 structure has the following format.

 typedef struct _DFS_INFO_5 {
   [string] WCHAR* EntryPath;
   [string] WCHAR* Comment;
   DWORD State;
   unsigned long Timeout;
   GUID Guid;
   unsigned long PropertyFlags;
   unsigned long MetadataSize;
   DWORD NumberOfStorages;
 } DFS_INFO_5;

EntryPath: A pointer to a DFS root or a DFS link path.

Comment: A pointer to a null-terminated Unicode string containing a comment associated with the DFS root or DFS link that is for informational purposes. This string has no protocol-specified restrictions on length or content. The comment is meant for human consumption and does not affect server functionality.

State: Refers to the State field of DFS_INFO_2. For more information, see section 2.2.3.2.

Timeout: The time-out, in seconds, associated with the root or link and used in a DFS referral response to a DFS client.

Guid: The GUID of this root or link.

PropertyFlags: A bit field in which each bit is responsible for a specific property applicable to the entire DFS namespace, the DFS root, or an individual DFS link, depending on the actual property. Any combination of bits is allowed, unless indicated otherwise. The following are valid bit definitions for this field.

Value

Meaning

DFS_PROPERTY_FLAG_INSITE_REFERRALS

0x00000001

When set, indicates that DFS in-site referral mode is enabled.

DFS_PROPERTY_FLAG_ROOT_SCALABILITY

0x00000002

When set, indicates DFS root scalability mode is enabled. This flag is valid only for the DFS root of a domain-based DFS namespace.

DFS_PROPERTY_FLAG_SITE_COSTING

0x00000004

When set, indicates DFS referral site costing is enabled. This flag is valid only for a DFS root.

DFS_PROPERTY_FLAG_TARGET_FAILBACK

0x00000008

When set, indicates DFS client target failback is enabled.

DFS_PROPERTY_FLAG_CLUSTER_ENABLED

0x00000010

When set, indicates clustered DFS namespace is enabled.

DFS_PROPERTY_FLAG_ABDE

0x00000020

When set, enables Access Based Directory Enumeration (ABDE) mode on a domainv2-based DFS namespace or a stand-alone DFS namespace.<5>This flag is not supported on domainv1-based namespaces.

MetadataSize: The size, in bytes, of the DFS metadata of the DFS namespace. For a DFS link, this MUST be 0.

NumberOfStorages: The number of DFS targets for this root or link.