DFS_STORAGE_INFO structure (lmdfs.h)

Article
06/24/2021

Contains information about a DFS root or link target in a DFS namespace or from the cache maintained by the DFS client. Information about a DFS root or link target in a DFS namespace is retrieved by calling the NetDfsGetInfo function. Information about a DFS root or link target from the cache maintained by the DFS client is retrieved by calling the NetDfsGetClientInfo function.

Syntax

typedef struct _DFS_STORAGE_INFO {
  ULONG  State;
  LPWSTR ServerName;
  LPWSTR ShareName;
} DFS_STORAGE_INFO, *PDFS_STORAGE_INFO, *LPDFS_STORAGE_INFO;

Members

State

State of the target.

When this structure is returned as a result of calling the NetDfsGetInfo function, this member can be one of the following values.

DFS_STORAGE_STATE_OFFLINE (0x00000001)

The DFS root or link target is offline.

DFS_STORAGE_STATE_ONLINE (0x00000002)

The DFS root or link target is online.

When this structure is returned as a result of calling the NetDfsGetClientInfo function, the DFS_STORAGE_STATE_ONLINE (0x00000002) state is set by default. If the target is the active target in the DFS client cache, the following value is logically combined with the default value via the OR operator.

DFS_STORAGE_STATE_ACTIVE (0x00000004)

The DFS root or link target is the active target.

ServerName

Pointer to a null-terminated Unicode string that specifies the DFS root target or link target server name.

ShareName

Pointer to a null-terminated Unicode string that specifies the DFS root target or link target share name.

Remarks

The DFS_INFO_3 and DFS_INFO_4 structures each contain one or more DFS_STORAGE_INFO structures, one for each DFS target. Only one target can be marked as the active target. It is possible that no targets will be marked active.

Requirements

Requirement	Value
Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008
Header	lmdfs.h (include LmDfs.h, Lm.h)