NetDfsRemove 関数 (lmdfs.h)
DFS 名前空間内の DFS リンクの分散ファイル システム (DFS) リンクまたは特定のリンク ターゲットを削除します。 特定のリンク ターゲットを削除すると、リンクの最後のリンク ターゲットが削除されると、リンク自体が削除されます。
構文
NET_API_STATUS NET_API_FUNCTION NetDfsRemove(
[in] LPWSTR DfsEntryPath,
[in, optional] LPWSTR ServerName,
[in, optional] LPWSTR ShareName
);
パラメーター
[in] DfsEntryPath
DFS リンクの汎用名前付け規則 (UNC) パスを指定する文字列へのポインター。
文字列は、2 つの形式のいずれかで指定できます。 最初の形式は次のとおりです。
\\ShareName\DfsName\link_path
ここで、ShareName はスタンドアロン DFS 名前空間をホストするルート ターゲット サーバーの名前です。DfsName は DFS 名前空間の名前です。と link_path は DFS リンクです。
2 番目の形式は次のとおりです。
\\Domainname\DomDfsname\link_path
ここで 、DomainName はドメイン ベースの DFS 名前空間をホストするドメインの名前です。 DomDfsname は DFS 名前空間の名前です。と link_path は DFS リンクです。
このパラメーターは必須です。
[in, optional] ServerName
リンク 先のサーバー名を指定する文字列へのポインター。 詳細については、「解説」を参照してください。 リンクとすべてのリンク ターゲットを削除する場合は、このパラメーターを NULL に設定します。
[in, optional] ShareName
リンク 先の共有名を指定する文字列へのポインター。 リンクとすべてのリンク ターゲットを削除する場合は、このパラメーターを NULL に設定します。
戻り値
関数が成功した場合、戻り値は NERR_Success。
関数が失敗した場合、戻り値はシステム エラー コードです。 エラー コードの一覧については、「 システム エラー コード」を参照してください。
解説
呼び出し元には、DFS サーバーに対する管理者特権が必要です。 管理者特権を必要とする関数の呼び出しの詳細については、「 特別な特権を使用した実行」を参照してください。
NetDfsRemove を呼び出してリンクからターゲットを削除する場合は、リンクの作成時に指定した ServerName パラメーターに同じターゲット サーバー名を指定する必要があります。 たとえば、リンクにターゲットを追加したときにターゲット サーバーの DNS 名を指定した場合は、リンクを削除するときに同じ DNS 名を指定する必要があります。 NetBIOS 名を指定することはできません。
例
次のコード サンプルは、 NetDfsRemove 関数の呼び出しを使用して DFS リンクからターゲットを削除する方法を示しています。
#include <windows.h>
#include <lm.h>
#include <lmdfs.h>
#include <stdio.h>
#pragma comment(lib, "Netapi32.lib")
void wmain(int argc, wchar_t *argv[])
{
DWORD res;
//
// All parameters are required.
//
if (argc < 4)
wprintf(L"Syntax: %s DfsEntryPath ServerName ShareName\n", argv[0]);
else
{
//
// Call the NetDfsRemove function
// to remove the DFS link.
//
res = NetDfsRemove(argv[1], argv[2], argv[3]);
//
// Display the result of the call.
//
if(res == 0)
printf("Removed DFS link\n");
else
printf("Error: %u\n", res);
}
return;
}
要件
| サポートされている最小のクライアント | Windows Vista |
| サポートされている最小のサーバー | Windows Server 2008 |
| 対象プラットフォーム | Windows |
| ヘッダー | lmdfs.h (LmDfs.h、Lm.h を含む) |
| Library | Netapi32.lib |
| [DLL] | Netapi32.dll |