NetDfsGetInfo info  Overview  Group

[This is preliminary documentation and subject to change.]

The NetDfsGetInfo function retrieves information about a junction point in the named Distributed File System (Dfs) tree structure. The function can return information specific to a server and share, or information specific to an entire junction point.

NET_API_STATUS NET_API_FUNCTION NetDfsGetInfo(

LPWSTR DfsEntryPath,	// Dfs entry path for the junction point
LPWSTR ServerName OPTIONAL,	// name of server exporting the storage
LPWSTR ShareName OPTIONAL,	// name of share exporting the storage
DWORD Level,	// level of information requested
LPBYTE* Buffer	// function allocates and returns buffer with requested info
);

Parameters

DfsEntryPath 

[in] Pointer to a null-terminated Unicode character string that specifies the Universal Naming Convention path of a junction point in a Dfs tree structure. The string must be of the form:

\\Dfsname\sharename\path-to-junction-point

where Dfsname is the name of a Windows NT server that hosts the Dfs root volume; sharename is the name of a share that is published on the Dfs host server; and path-to-junction-point specifies the path name on the physical share.

ServerName 

[in] Pointer to a null-terminated Unicode character string that specifies the name of the storage server that the junction point references. This parameter is optional. For additional information, see the following Remarks section.

ShareName 

[in] Pointer to a null-terminated Unicode character string that specifies the name of the share on the storage server that the junction point references. This parameter is optional. For additional information, see the following Remarks section.

Level

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

Value	Meaning
1	Return the Dfs junction point name. The Buffer parameter will contain a DFS_INFO_1 structure.
2	Return the Dfs junction point name with information. The Buffer parameter will contain a DFS_INFO_2 structure.
3	Return the Dfs junction point name with information, and share information. The Buffer parameter will contain a DFS_INFO_3 structure.
100	Return a comment about the Dfs junction point. The Buffer parameter will contain a DFS_INFO_100 structure.

Buffer 

[out] Pointer to the address of a buffer that contains the requested information structures.

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.

Remarks

The NetDfsGetInfo function allocates the memory required for the information structure buffer.

If you specify both the ServerName and ShareName parameters, the NetDfsGetInfo function returns information specific to that server and share. If the parameters are not specified, the function returns information that is specific to the entire junction point.

See Also

DFS_INFO_1, DFS_INFO_2, DFS_INFO_3, DFS_INFO_100, DFS_STORAGE_INFO, NetDfsEnum