NetDfsGetClientInfo 関数 (lmdfs.h)

[アーティクル]
03/05/2024

DFS クライアントによって管理されるキャッシュから、分散ファイルシステム (DFS) ルートまたはリンクに関する情報を取得します。

構文

NET_API_STATUS NET_API_FUNCTION NetDfsGetClientInfo(
  [in]           LPWSTR DfsEntryPath,
  [in, optional] LPWSTR ServerName,
  [in, optional] LPWSTR ShareName,
  [in]           DWORD  Level,
  [out]          LPBYTE *Buffer
);

パラメーター

[in] DfsEntryPath

DFS ルートまたはリンクの汎用名前付け規則 (UNC) パスを指定する文字列へのポインター。

リンクの場合、文字列は 2 つの形式のいずれかで指定できます。最初の形式は次のとおりです。

\\Servername\DfsName\link_path

ここで 、ServerName はスタンドアロン DFS 名前空間をホストするルートターゲットサーバーの名前です。 DfsName は DFS 名前空間の名前です。と link_path は DFS リンクです。

2 番目の形式は次のとおりです。

\\Domainname\DomDfsname\link_path

ここで 、DomainName はドメインベースの DFS 名前空間をホストするドメインの名前です。 DomDfsname は DFS 名前空間の名前です。と link_path は DFS リンクです。

ルートの場合、文字列は次の 2 つの形式のいずれかで指定できます。

\\Servername\DfsName

または

\\Domainname\DomDfsname

ここで、名前の値は前に説明したものと同じです。

このパラメーターは必須です。

[in, optional] ServerName

DFS ルートターゲットまたはリンクターゲットサーバーの名前を指定する文字列へのポインター。このパラメーターは省略可能です。

[in, optional] ShareName

DFS ルートターゲットまたはリンクターゲットに対応する共有の名前を指定する文字列へのポインター。このパラメーターは省略可能です。

[in] Level

要求の情報レベルを指定します。このパラメーターには、次の値のいずれかを指定できます。

1

DFS ルートまたは DFS リンク名を返します。 Buffer パラメーターは、DFS_INFO_1構造体を指します。

2

DFS ルートまたは DFS リンク名、状態、および DFS ターゲットの数を返します。 Buffer パラメーターは、DFS_INFO_2構造体を指します。

3

DFS ルートまたは DFS リンク名、状態、およびターゲット情報を返します。 Buffer パラメーターは、DFS_INFO_3構造体を指します。

4

DFS ルートまたは DFS リンク名、状態、 GUID、タイムアウト、およびターゲット情報を返します。 Buffer パラメーターは、DFS_INFO_4構造体を指します。

[out] Buffer

要求された情報を受信するバッファーのアドレスへのポインター。このバッファーはシステムによって割り当てられ、 NetApiBufferFree 関数を使用して解放する必要があります。詳細については、「ネットワーク管理機能バッファー」および「ネットワーク管理機能バッファーの長さ」を参照してください。

戻り値

関数が成功した場合、戻り値は NERR_Success。

関数が失敗した場合、戻り値はシステムエラーコードです。エラーコードの一覧については、「システムエラーコード」を参照してください。

注釈

NetDfsGetClientInfo 関数を使用するために特別なグループメンバーシップは必要ありません。

要件

要件	値
サポートされている最小のクライアント	Windows Vista
サポートされている最小のサーバー	Windows Server 2008
対象プラットフォーム	Windows
ヘッダー	lmdfs.h (LmDfs.h、Lm.h を含む)
Library	Netapi32.lib
[DLL]	Netapi32.dll