NetDfsGetClientInfo

The NetDfsGetClientInfo function retrieves information about a Distributed File System (Dfs) link in the named Dfs root. The information represents the current computer's cached copy of the information about the Dfs link.

Note  This function is currently being evaluated and may or may not be supported in future versions.

Security Requirements

No special group membership is required to successfully execute the NetDfsGetClientInfo function.

NET_API_STATUS NET_API_FUNCTION NetDfsGetClientInfo(
  LPWSTR DfsEntryPath,  // Dfs entry path for the junction point  
  LPWSTR ServerName,    // name of server exporting the storage 
  LPWSTR ShareName,     // name of share exporting the storage 
  DWORD Level,          // level of information requested 
  LPBYTE *Buffer        // receives requested information 
);  

Parameters

DfsEntryPath

[in] Pointer to a null-terminated Unicode character string that specifies the Universal Naming Convention path of a Dfs link in a named Dfs root. The string must be in one of two forms. The first form is as follows:

\\Dfsname\sharename\path_to_link 

where Dfsname is the name of a Windows NT/Windows 2000 server that hosts the root of a stand-alone Dfs implementation; sharename is the name of a share published on the Dfs host server; and path_to_link specifies the path on the physical share.

The second form is as follows:

\\DomainName\DomDfsname\path_to_link 

where DomainName is the name of a Windows NT/Windows 2000 domain that hosts the Dfs root; DomDfsname is the name of the root of a domain-based Dfs implementation published in the domain's directory service; and path_to_link specifies the path on the physical share.

Windows 95/98: The DomDfsname must be identical to the name of the share that hosts the root of the domain-based Dfs.

ServerName

[in] Pointer to a null-terminated Unicode character string that specifies the name of the host server that the Dfs link references. The string must begin with \\. This parameter is optional.

ShareName

[in] Pointer to a null-terminated Unicode character string that specifies the name of the share on the host server that the Dfs link references. This parameter is optional.

Level

[in] Specifies the information level of the request. This parameter can be one of the following values.

Value	Meaning
1	Return the Dfs link name. The Buffer parameter points to a DFS_INFO_1 structure.
2	Return the Dfs link name and additional information. The Buffer parameter points to a DFS_INFO_2 structure.
3	Return Dfs link information and share information. The Buffer parameter points to a DFS_INFO_3 structure.
4	Return Dfs link information, share information, and storage-specific information. The Buffer parameter points to a DFS_INFO_4 structure.

Buffer

[out] Pointer to the address of a buffer that receives the requested information. This buffer is allocated by the system and must be freed using the NetApiBufferFree function.

Return Values

If the function succeeds, the return value is NERR_Success.

If the function fails, the return value is a Win32 API error code. For a list of error codes, see Error Codes.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Windows 95/98: Unsupported.
  Header: Declared in Lmdfs.h; include Lm.h.
  Library: Use Netapi32.lib.

See Also

Network Management Overview, Network Management Functions, Distributed File System (Dfs) Functions, DFS_INFO_1, DFS_INFO_2, DFS_INFO_3, DFS_INFO_4, NetDfsSetClientInfo