2.2.3.2 DFS_INFO_2

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

The DFS_INFO_2 structure has the following format.

 typedef struct _DFS_INFO_2 {
   [string] WCHAR* EntryPath;
   [string] WCHAR* Comment;
   DWORD State;
   DWORD NumberOfStorages;
 } DFS_INFO_2;

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

Comment: A pointer to a null-terminated Unicode string containing a comment that is used for informational purposes and is associated with the DFS root or DFS link. 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: This field has the state of the DFS root or DFS link. For a DFS root, this field also specifies whether the DFS namespace is stand-alone or domain-based.

The DFS_VOLUME_STATES bitmask (0x0000000F) MUST be used to extract the following DFS root or DFS link state from this field. For more information about some of these states, see section 2.2.2.13.

Value

Meaning

DFS_VOLUME_STATE_OK

0x00000001

The specified DFS root or DFS link is in the normal state.

RESERVED

0x00000002

This value is reserved and MUST NOT be used.

DFS_VOLUME_STATE_OFFLINE

0x00000003

The DFS link is offline, and none of the DFS targets will be included in the referral response. This flag is valid only for a DFS link and cannot be set on a DFS root.

This state is persisted to the DFS metadata.

DFS_VOLUME_STATE_ONLINE

0x00000004

The DFS link is online and available for referral request. This flag is valid only for a DFS link and cannot be set on a DFS root.

This state is persisted to the DFS metadata.

The DFS_VOLUME_FLAVORS bitmask (0x00000300) MUST be used to extract the following DFS namespace flavor from this field.

Value

Meaning

DFS_VOLUME_FLAVOR_STANDALONE

0x00000100

Stand-alone DFS namespace.

DFS_VOLUME_FLAVOR_AD_BLOB

0x00000200

domainv1-based or domainv2-based DFS namespace.

NumberOfStorages: Number of DFS targets for the root or link.