NetDfsSetInfo 関数 (lmdfs.h)
特定の分散ファイル システム (DFS) ルート、ルート ターゲット、リンク、またはリンク ターゲットに関する情報を設定または変更します。
構文
NET_API_STATUS NET_API_FUNCTION NetDfsSetInfo(
[in] LPWSTR DfsEntryPath,
[in, optional] LPWSTR ServerName,
[in, optional] LPWSTR ShareName,
[in] DWORD Level,
[in] 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
or
\\Domainname\DomDfsname
ここで、名前の値は前に説明したものと同じです。
[in, optional] ServerName
DFS リンク ターゲット サーバー名を指定する文字列へのポインター。 このパラメーターは省略可能です。 詳細については、「解説」を参照してください。
[in, optional] ShareName
DFS リンク ターゲット共有名を指定する文字列へのポインター。 これは、共有に対する相対パスを持つ共有名である場合もあります。 たとえば、"share1\mydir1\mydir2" などです。 このパラメーターは省略可能です。 詳細については、「解説」を参照してください。
[in] Level
データの情報レベルを指定します。 このパラメーターには、次の値のいずれかを指定できます。
100
DfsEntryPath パラメーターで指定された DFS ルートまたはリンクに関連付けられているコメントを設定します。 Buffer パラメーターは、DFS_INFO_100構造体を指します。
101
DfsEntryPath パラメーターで指定された DFS ルートまたはリンクに関連付けられているストレージ状態を設定します。 Buffer パラメーターは、DFS_INFO_101構造体を指します。
102
DfsEntryPath パラメーターで指定された DFS ルートまたはリンクに関連付けられているタイムアウト値を設定します。 Buffer パラメーターは、DFS_INFO_102構造体を指します。
103
DfsEntryPath パラメーターで指定された DFS ルートまたはリンクのプロパティ フラグを設定します。 Buffer パラメーターは、DFS_INFO_103構造体を指します。
104
DfsEntryPath パラメーターで指定されたルート ターゲットまたはリンク ターゲットのターゲット優先度ランクとクラスを設定します。 Buffer パラメーターは、DFS_INFO_104構造体を指します。
105
DfsEntryPath パラメーターで指定された DFS ルートまたはリンクのコメント、状態、タイムアウト情報、およびプロパティ フラグを設定します。 Buffer パラメーターは、DFS_INFO_105構造体を指します。
106
DfsEntryPath パラメーターで指定されたルート ターゲットまたはリンク ターゲットのターゲットの状態と優先度を設定します。 この情報は、DFS 名前空間のルートまたはリンクに対しては設定できず、ルート ターゲットまたはリンク ターゲットに対してのみ設定できます。 Buffer パラメーターは、DFS_INFO_106構造体を指します。
107
DfsEntryPath パラメーターで指定された DFS ルートまたはリンクのコメント、状態、タイムアウト情報、およびプロパティ フラグを設定します。 DFS リンクの場合は、リンクの再解析ポイントのセキュリティ記述子を設定することもできます。 Buffer パラメーターは、DFS_INFO_107構造体を指します。
150
DFS リンクの再解析ポイントのセキュリティ記述子を設定します。 Buffer パラメーターは、DFS_INFO_150構造体を指します。
[in] Buffer
データを指定するバッファーへのポインター。 このデータの形式は 、Level パラメーターの値によって異なります。 詳細については、「 ネットワーク管理関数バッファー」を参照してください。
戻り値
関数が成功した場合、戻り値はNERR_Success。
関数が失敗した場合、戻り値はシステム エラー コードです。 エラー コードの一覧については、「 システム エラー コード」を参照してください。
解説
呼び出し元には、DFS サーバーに対する管理者特権が必要です。 管理者特権を必要とする関数の呼び出しの詳細については、「 特別な特権を使用した実行」を参照してください。
ServerName パラメーターと ShareName パラメーターの両方を指定した場合、NetDfsSetInfo 関数は、そのルート ターゲットまたはリンク ターゲットに固有の情報を設定または変更します。 パラメーターが NULL の場合、関数は、特定の DFS ルート ターゲットまたはリンク ターゲットではなく、DFS 名前空間ルートまたは DFS リンクに固有の情報を設定または変更します。
DFS ルートまたはリンクに設定できるコメントとタイムアウトは 1 つだけであるため、情報レベル 100 および 102 では ServerName パラメーターと ShareName パラメーターは無視されます。 これらのパラメーターは、レベル 101 に必要です。
情報レベル 101 の場合、 DFS 名前空間に複数の DFS ルート ターゲットがある場合、特定のドメイン ベースの DFS ルートに対して、 DFS_VOLUME_STATE_RESYNCHRONIZEとDFS_VOLUME_STATE_STANDBY 状態の値を次のように設定できます。
DfsEntryPath パラメーターはドメインベースの DFS 名前空間を指定し、ServerName パラメーターと ShareName パラメーターを組み合わせると、set-information 操作を実行する DFS ルート ターゲットが指定されます。
例
次のコード サンプルは、 NetDfsSetInfo 関数の呼び出しを使用して、コメントを DFS リンクに関連付ける方法を示しています。 このサンプルでは、情報レベル 100 (DFS_INFO_100) を指定します。
#include <windows.h>
#include <lm.h>
#include <lmdfs.h>
#include <stdio.h>
#pragma comment(lib, "Netapi32.lib")
void wmain(int argc, wchar_t *argv[])
{
DFS_INFO_100 dfsData;
DWORD res;
//
// Check command line arguments.
//
if (argc<2)
wprintf(L"Syntax: %s DfsEntryPath [\"Comment\"]\n", argv[0]);
else
{
//
// Fill in DFS_INFO_100 structure member.
//
dfsData.Comment = argc < 3 ? NULL : argv[2];
//
// Call the NetDfsSetInfo function, specifying level 100.
//
res = NetDfsSetInfo(argv[1], NULL, NULL, 100, (LPBYTE) &dfsData);
//
// Display the result of the call.
//
if(res == 0)
printf("Comment set.\n");
else
printf("Error: %u", res);
}
return;
}
要件
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | lmdfs.h (LmDfs.h、Lm.h を含む) |
| Library | Netapi32.lib |
| [DLL] | Netapi32.dll |